Crestron e-Schedule Programmer's Manual
Crestron e-Schedule Programmer's Manual

Crestron e-Schedule Programmer's Manual

Web-based software package

Advertisement

Quick Links

Crestron e-Schedule
Programmer's Guide
Programmer's Guide
Crestron e-Schedule
Crestron Electronics, Inc.

Advertisement

Table of Contents
loading
Need help?

Need help?

Do you have a question about the e-Schedule and is the answer not in the manual?

Questions and answers

Subscribe to Our Youtube Channel

Summary of Contents for Crestron e-Schedule

  • Page 1 Crestron e-Schedule Programmer’s Guide Programmer's Guide Crestron e-Schedule Crestron Electronics, Inc.
  • Page 2: Table Of Contents

    SIMPL Windows Programming ...32 ActiveCNX Interface Definitions...37 Destination (Classroom) ActiveCNX Interface...37 Source ActiveCNX Interface ...45 Software License Agreement Return and Warranty Policies Merchandise Returns / Repair Service ...51 CRESTRON Limited Warranty...51 Programmer’s Guide Programmer’s Guide e-Schedule – DOC. 5919 • i...
  • Page 3: System Overview

    General Information and Terminology An e-Schedule system usually consists of at least one head end, one or more destinations, and the scheduling software computer(s), all networked through Ethernet. The head end is a central area that contains all the system’s A/V source devices, such as VCRs, laser discs and television tuners.
  • Page 4 Rooms can also be assigned to one or more groups, (i.e., All First Year Classes or All 8:00 a.m.Classes). As with the head end, a room must be controlled by a Crestron control system that supports Ethernet communication such as the CNMSX, or more typically the CEN-TVAV.
  • Page 5: System Components And Cnx Gateway Licensing

    Tiered Switching e-Schedule does not currently support tiered switching, i.e., any environment that does not offer full crosspoint capability. For the e-Schedule system to function properly it must be able to switch any source to any destination without interfering with the routes of other sources or destinations or requiring allocation of a limited number of intermediate channels.
  • Page 6: Leading Specifications

    The CNX Gateway runs as a service, not an application, meaning that it starts when the computer boots up, and stops when the computer shuts down. After installation, the Crestron swirl icon will appear in the system tray of the Windows status bar. Right-click the system tray icon to check the current version, add licensing, or simply see the connections that the CNX Gateway is servicing.
  • Page 7: Minimum System Requirements

    Web Server PC (no additional memory is required for a one-computer configuration). *Although any Web browser should work with e-Schedule since Crestron conforms to Java specifications, Netscape Navigator on a PC platform may improperly display objects on top of other objects, and Netscape Navigator on a MacIntosh platform may not display Java objects in the correct position.
  • Page 8: System Connections

    0,1 or more Ethernet-connected destinations Programmer’s Guide 0,1 or more Head Ends Source1 SourceN CNMSX CNMSX Misc CN-TVAV equip Misc Xmit equip (opt) 0,1 or more Cresnet-connected 0,1 or more Cresnet-connected destinations Programmer’s Guide Ethernet e-Schedule – DOC. 5919 • 6...
  • Page 9: Data Flow

    Crestron e-Schedule Data Flow Browser Browser Browser Browser Scheduling information Real time information Programmer’s Guide Databases Server/ Gateway Programmer’s Guide Real-Time Engine/ CNX Gateway Crestron Devices e-Schedule – DOC. 5919 • 7...
  • Page 10: Configuring The E-Schedule Database

    Crestron e-Schedule Configuring the e-Schedule Database Database Categories The e-Schedule Database Directory is divided into four categories: 1) Configuration 2) Web Browser 3) Resource and 4) System. The Microsoft Access databases in Scheduler_Configuration.mdb must be completed for each installation. Configuration Databases...
  • Page 11: Database Configuration

    The following two tables define the Web Server and Real-Time Engine computer(s). Example 1 – Configuration tables for two e-Schedule computers. (Alternatively, the Web Server and Real-Time Engine can be located on the same computer, in which case the IP Addresses would be the same.)
  • Page 12: Areas

    NOTE: The system must have at least one location, one group and one room. Programmer’s Guide Cfg_Area_Locations Field Name LocationId Each location (building) in the e-Schedule system must be assigned a unique identifier, starting with 1 and proceeding sequentially—gaps are permitted. LocationName The name of the location (i.e., Law School), referenced by the Location ID, and displayed in the user interface.
  • Page 13 Law School Room 1 Room 2 Group 1 Cfg_Area_Locations Cfg_Area_Groups Programmer’s Guide Room 4 Room 3 Room 6 Group 2 Cfg_Area_SubLocations Cfg_Area_MapTable Programmer’s Guide Business School Room 5 Room 7 Group 3 e-Schedule – DOC. 5919 • 11...
  • Page 14: Head End And Source Devices

    Check box that indicates if the device requires that a media title be physically loaded into it. (For example, a VCR or CD player requires manual loading, whereas the television tuner does not). Programmer’s Guide Description Description e-Schedule – DOC. 5919 • 12...
  • Page 15 Check box that enables or disables the channel setting. When disabled, the channel will be skipped during a Channel Up or Channel Down request, as well as during a scheduling request. Programmer’s Guide Description e-Schedule – DOC. 5919 • 13...
  • Page 16 In broadband systems only, this ID number must be the same as the ChannelId taken from the table Cfg_Hardware_LegalChannels. (Ignored in baseband systems.) Enable Check box to enable or “remove” the device in the system. Programmer’s Guide Description e-Schedule – DOC. 5919 • 14...
  • Page 17 SwitcherName IPAddress IPID Database Table: Cfg_Hardware_Source_FormatType FormatTypeId Format Database Table: RealTimePages BasicPageId Comment Database Table: Cfg_Hardware_LegalChannels ChannelId ChannelNumber ChannelName VCR-1 SwitcherInput 0 (ignored in broadband) ValidChannel Programmer’s Guide Description Ready Law School AutoPatch 192.168.2.173 e-Schedule – DOC. 5919 • 15...
  • Page 18 Crestron e-Schedule Programmer’s Guide Example 4 (continued) e-Schedule – DOC. 5919 • 16 Programmer’s Guide...
  • Page 19: Destination Devices

    Programmer’s Guide Cfg_System_Variables Field Name GlobalSafeChannel The default television channel for the entire e-Schedule system, both at startup and at the end of a scheduled event, taken from the ChannelId field of Cfg_Hardware_LegalChannels. BasebandOrBroadband 0 = Baseband; 1 = Broadband.
  • Page 20 Option 3 should be enabled if a “location” denotes a separate building. In this way media that is physically located in one building will not be scheduled for viewing in another building. Programmer’s Guide Description Description e-Schedule – DOC. 5919 • 18...
  • Page 21: Signals

    Scheduler_RealTimeControl.mdb. Specifies whether the signal is an input command or output command. 0 (zero) = output (global), 1 = input (auto-start). Enable Check box to enable or “remove” signal from system. Programmer’s Guide Description e-Schedule – DOC. 5919 • 19...
  • Page 22 Crestron e-Schedule The following four tables can be used to change the labelling of the folders that are displayed in the e-Schedule user interface during scheduling requests. The two main folders, Event Start and Event End, cannot be modified. Programmer’s Guide...
  • Page 23 IO: 0=Output from the Real-Time Engine, 1=Real-Time Engine will receive this signal from the hardware. IOType: 1=Digital, 2=Analog, 3=Serial CNXType: 0=None, 1=Source, 2=SetTopBox, 4=HeadEnd HardwareId: SourceId, SwitcherId or SetTopBoxId that will act on the join number. e-Schedule – DOC. 5919 • 21...
  • Page 24: Signal Macros

    Crestron e-Schedule Signal Macros Signal Macros are now implemented in e-Schedule v3.02. Signal Macros combine groups of individual signals and eliminate the need for the user to select each signal separately. Signal Macros can be be used at the beginning and/or end of a Media Event and in Global Signal Events.
  • Page 25: Privileges

    The order of the field values is extremely important since this table is very closely tied to the front end web pages. Please make sure the order here and in e-Schedule matches exactly when editing this table: Administrator (The recommended default values below assume that the administrator’s user ID is 1.)
  • Page 26: Join Number Pass-Throughs

    When selected, this check box indicates that the specified join numbers will in fact be programmed as pass-throughs in SIMPL Windows. IOType 1=Digital, 2=Analog. Comment Comment for database—not used by scheduing software. Programmer’s Guide Description e-Schedule – DOC. 5919 • 24...
  • Page 27: Real-Time Engine (Scheduler.exe)

    Start Real Time Engine shortcut icon or select Crestron | e-Schedule | Scheduler.exe from the Windows Start menu. The e-Schedule icon will appear in the system tray of the Windows status bar. Right-click the system tray icon and then select Show e-Schedule Event Manager…...
  • Page 28: Setting Preferences

    File Paths Select Edit | Preferences to open the Preferences dialog box, which consists of a tabbed page. The File Paths tab displays the path that points to the Crestron e-Schedule Database Directory, containing all the e-Schedule databases. Programmer’s Guide Programmer’s Guide...
  • Page 29 The Real Time Machine tab of the Preferences dialog box is used to specify IP Addresses and other system settings. NOTE: Crestron recommends using the default settings for periodic system checks, as lengthening or shortening the time interval may adversely affect system response.
  • Page 30 Real-Time Engine will continuously poll all hardware at the specified interval, to make sure a connection is active and valid. (See NOTE, below.) NOTE: Crestron recommends using the default settings for periodic system checks, as lengthening or shortening the time interval may adversely affect system response.
  • Page 31: Diagnostic Utilities

    NOTE: The “Watch Signals” window should only be used for debugging, since the system slows down dramatically when this window is open. Programmer’s Guide Programmer’s Guide e-Schedule – DOC. 5919 • 29...
  • Page 32: Configuration

    The Status window will list any errors or omissions. NOTE: Whenever a new e-Schedule version is installed or upgraded the Database Update Utility is automotically launched. This will ensure that the database tables are in the correct format.
  • Page 33 Crestron e-Schedule Programmer’s Guide e-Schedule – DOC. 5919 • 31 Programmer’s Guide...
  • Page 34: E-Schedule Interface To Control Systems

    Crestron e-Schedule e-Schedule Interface to Control Systems SIMPL Windows Programming The e-Schedule Documents directory contains various programs that define the sample system illustrated in Figure 1. Together with the completed configuration databases (also included), these can be used as programming models.
  • Page 35 IP ID 09 192.168.2.173 Cresnet Touchpanel DVD2 ID 03 IP ID 0B RS-232 Tuner Switcher IP ID 0C IP ID 08 Classroom 1 CN-TVAV ID 50 Cresnet Local Touchpanel ID 04 CNECI-4 ID 7E e-Schedule – DOC. 5919 • 33...
  • Page 36: Sample System Configuration

    Crestron e-Schedule Sample System Configuration As illustrated in Figure 1, the sample system consists of two e-Schedule computers and one head end that controls three classrooms. The head end has six video sources on a CNMSX-Pro, although any Ethernet-enabled control system can be used.
  • Page 37 An ActiveCNX Interface is considered an Ethernet "device," and therefore gets an IP ID and an entry in the IP Table, which references the IP Address of the CNX Gateway. The e-Schedule system uses four ActiveCNX Interfaces, each with different definitions for 1) Sources 2) Switchers 3) Destinations and 4) Global Signals.
  • Page 38: Points To Remember

    Power, Mute, Volume, Source Control and View Channel. Points to Remember Programmer’s Guide • All components of an e-Schedule system—the Web Server, Real-Time Engine, CNX Gateway(s), and Crestron control systems—must have static IP addresses. • e-Schedule defines three ActiveCNX Interfaces, each with different signals for 1) Sources 2) Switchers and 3) Destinations.
  • Page 39: Activecnx Interface Definitions

    Crestron e-Schedule ActiveCNX Interface Definitions The definitions that are outlined in this section are contained in the Definitions subfolder of the e-Schedule Documents Directory. They are listed as follows: Destination (Classroom) ActiveCNX Interface Digital Join Numbers Signals on the left represent data being sent to the Scheduler (input to the Scheduler);...
  • Page 40 TV Power must be managed in the room's control program. (Feature reserved for future use.) dig o47 TV Power: Sends feedback to the Web browser when a local TV Power button is pressed. Programmer’s Guide Programmer’s Guide e-Schedule – DOC. 5919 • 38...
  • Page 41 This is useful for display purposes (such as putting up a flag on a touchpanel so that a user in a non-controlling room will know that they cannot control settings). Programmer’s Guide Programmer’s Guide e-Schedule – DOC. 5919 • 39...
  • Page 42 Through and a Global Event. For example, to pass a LIGHTS-ON command from a Web browser to a room and to schedule it as a global event would require two separate join numbers. Programmer’s Guide Programmer’s Guide e-Schedule – DOC. 5919 • 40...
  • Page 43 Generic Transport Controls: Can be customized for specified SourceA – SourceF transport controls that may not exist in the database. (i.e. Super Fast Rewind). dig i105 – i124 Generic Transport controls: Feedback from the customized generic transport control. Programmer’s Guide Programmer’s Guide e-Schedule – DOC. 5919 • 41...
  • Page 44 Crestron is currently developing support for this range of reserved join numbers (defined in the fixed database, Scheduler_RealTimeControl.mdb.), to be used to indicate the unique page on a Crestron touchpanel that would display the transport controls of a device. For example, if the signal indicates SourceA, then the touchpanel would display a page containing the transport controls for SourceA.
  • Page 45: Analog Signals

    Status of the event—can be Waiting, Ready, In Progress, Done, Cancelled, or Modified. i21 – i26 Status of SourceA – SourceF for an event—can be Ready or Not Ready. TV channel name. Programmer’s Guide Programmer’s Guide e-Schedule – DOC. 5919 • 43...
  • Page 46 Programmer’s Guide Field Description Format Hour 00-23 Minutes 00-59 Seconds 00-59 Month 01-12 01-31 YYYY Year 4 digits Programmer’s Guide e-Schedule – DOC. 5919 • 44...
  • Page 47: Source Activecnx Interface

    (typically tied to logic for the device or to an IR driver). o21 – o40 Transport feedback for the source, routed from the Scheduler to the room that is controlling the source. Programmer’s Guide Programmer’s Guide e-Schedule – DOC. 5919 • 45...
  • Page 48 Generic Transport Controls: Feedback for customized transport controls. Analog Signals Ready status of the source: When initialized to 0, indicates that the source is READY; when initialized to 1, the source is NOT READY. Programmer’s Guide Programmer’s Guide e-Schedule – DOC. 5919 • 46...
  • Page 49 NOTE: Logic can be written in the control system to compare the "should be" media title (serial i2) to the "currently loaded" one (serial i3), and if they are different, to send the "NOT READY" value (identified by analog o1). Programmer’s Guide Programmer’s Guide e-Schedule – DOC. 5919 • 47...
  • Page 50: Digital Signals

    Main() function, the strings that are sent to the switcher can be slowed to a manageable pace. The program HeadEndMSX.smw contains a SIMPL+ module that does this. Programmer’s Guide Programmer’s Guide e-Schedule – DOC. 5919 • 48...
  • Page 51: Software License Agreement

    This Agreement may only be modified by a writing signed by an authorized officer of Crestron. Updates may be licensed to You by Crestron with additional or different terms. This is the entire agreement between Crestron and You relating to the Software and it supersedes any prior representations, discussions, undertakings, communications or advertising relating to the Software.
  • Page 52 “applets” incorporated into the Software), the accompanying media and printed materials, and any copies of the Software are owned by Crestron or its suppliers. The Software is protected by copyright laws and international treaty provisions. Therefore, you must treat the Software like any other copyrighted material, subject to the provisions of this Agreement.
  • Page 53: Return And Warranty Policies

    CRESTRON shall not be liable to honor the terms of this warranty if the product has been used in any application other than that for which it was intended, or if it has been subjected to misuse, accidental damage, modification, or improper installation procedures.

Table of Contents