Crestron e-Schedule Programmer’s Guide Programmer's Guide Crestron e-Schedule Crestron Electronics, Inc.
Crestron e-Schedule Programmer’s Guide Contents System Overview 1 Product Description.......................................................................................................1 General Information and Terminology .............................................................1 System Components and CNX Gateway Licensing ........................................3 Minimum System Requirements ...................................................................................5 System Connections .
Crestron e-Schedule Programmer’s Guide System Overview Product Description Crestron e-Schedule is a Web-based software package for event scheduling and real-time control of media resources across multiple rooms. It replaces Crestron SchoolNet with a much more flexible and robust system, and includes the following features: • Event scheduling and conflict checking of media resources, rooms and source devices. • Real-time signal routing and control of scheduled events.
Crestron e-Schedule Programmer’s Guide The largest destination defined by e-Schedule is a location (i.e., Law School or Business School), a broad area that usually denotes an entire building or a large section of a building. A location is divided into sublocations, which are simply rooms. Various rooms from the same or different locations can be organized into groups. Rooms can also be assigned to one or more groups, (i.e., All First Year Classes or All 8:00 a.m.Classes).
Crestron e-Schedule Programmer’s Guide NOTE: Crestron runs a demonstration e-Schedule program at http://www.escheduler.crestron-econtrol.com. To gain access, type “guest” as both the User ID and password. Tiered Switching e-Schedule does not currently support tiered switching, i.e., any environment that does not offer full crosspoint capability.
Crestron e-Schedule Programmer’s Guide browser connections, plus two, and the Real-Time Engine would require licenses for all hardware devices with unique IP addresses, plus two. Thus in the example just described, the Web Server would require seven licenses and the Real-Time Engine computer would require eight licenses. 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.
Crestron e-Schedule Programmer’s Guide Minimum System Requirements NOTE: If both the Web Server and Real-Time Engine are to be located on one computer, the memory requirements are the same as those listed below for the Web Server PC (no additional memory is required for a one-computer configuration). Web Server PC Hardware Operating System/ Software Crestron Software/Files 600 MHz Pentium II Processor 512 MB RAM Network Card TCP/IP Windows NT Server 4.0 with Service Pack 4 or later Windows NT 4.
Crestron e-Schedule Programmer’s Guide System Connections 0,1 or more Head Ends Real-Time Engine/CNX Gateway Web Server/ CNX Gateway Source1 SourceN CNMSX Ethernet Browser (optional) CENTVAV IR Transmitter/ Touchpanel (optional) 0,1 or more Ethernet-connected destinations CNMSX Misc equip CN-TVAV IR Xmit (opt) Misc equip 0,1 or more Cresnet-connected 0,1 or more Cresnet-connected destinations Programmer’s Guide e-Schedule – DOC.
Crestron e-Schedule Programmer’s Guide Data Flow Databases Browser Browser Web Server/ CNX Gateway Real-Time Engine/ CNX Gateway Browser Crestron Devices Browser Scheduling information Real time information Programmer’s Guide e-Schedule – DOC.
Crestron e-Schedule Programmer’s Guide 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 Scheduler_Configuration.mdb—defines the hardware, group and room setup, and user information. The programmer must configure the tables in this database.
Crestron e-Schedule Programmer’s Guide Database Configuration Except where noted, all of the tables detailed in this section are located in the Microsoft Access database, Scheduler_Configuration.mdb. The examples appearing in this section correlate with the Sample System on page 31. Scheduling Software Computer(s) The following two tables define the Web Server and Real-Time Engine computer(s).
Crestron e-Schedule Programmer’s Guide Areas The following tables define locations, groups and rooms. NOTE: The system must have at least one location, one group and one room. Cfg_Area_Locations Field Name Description 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.
Crestron e-Schedule Programmer’s Guide Example 2 – Locations, groups and rooms, with corresponding tables mapping the relationships between them. Law School Business School Room 1 Room 4 Room 2 Room 3 Group 1 Room 5 Room 6 Group 2 Room 7 Group 3 Cfg_Area_SubLocations Cfg_Area_Locations Cfg_Area_MapTable Cfg_Area_Groups Programmer’s Guide e-Schedule – DOC.
Crestron e-Schedule Programmer’s Guide Head End and Source Devices The following tables define the attributes of all the head end hardware, as well as format types and television settings. Cfg_Hardware_Switcher Field Name Description SwitcherId If a switcher is used (multiple switchers are not permitted), it must be assigned “1” as its unique identifier. SwitcherName The name of the switcher (i.e., AutoPatch)— reserved for future use.
Crestron e-Schedule Programmer’s Guide Cfg_Hardware_LegalChannels Field Name Description ChannelId Each TV channel must be assigned a unique identifer, beginning with 1 and progressing sequentially (gaps NOT permitted). ChannelNumber In broadband systems, the channel number is the actual channel referenced by the Channel ID. (Ignored in baseband systems—enter 0.) ChannelName The channel name (i.e., Bloomberg, History Channel).
Crestron e-Schedule Programmer’s Guide Cfg_Hardware_Source Field Name Programmer’s Guide Description SrcID Each source device must be assigned a unique identifier, starting with 1 and proceeding sequentially—gaps are permitted. SrcName The name of the device (i.e., TV Tuner), referenced by the Source ID and displayed in the user interface. LocationID The location of the source device. This ID number is taken from the table Cfg_Area_Locations.
Crestron e-Schedule Programmer’s Guide RealTimeSrcStatus (Scheduler_Events.mdb) Field Name Description SrcId The ID number of the source, taken from Cfg_Hardware_Source. SrcStatus This field must be initialized to the default setting of “0”, indicating that the source is “Ready”. Example 4 (below and following page) – Configuration table for head end VCR source device, with corresponding entries in tables for real-time status, location, switcher, format type and channels.
Crestron e-Schedule Programmer’s Guide Example 4 (continued) Programmer’s Guide e-Schedule – DOC.
Crestron e-Schedule Programmer’s Guide Cfg_System_Variables Field Name Description 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.
Crestron e-Schedule Programmer’s Guide RealTime_DstStatus (Scheduler_Events.mdb) Field Name SetTopBoxId Description The ID number of the set-top box (room controller), taken from Cfg_Hardware_SetTopBox. Example 5 – Configuration table for set-top box, with corresponding entries in tables for real-time status, sublocation and switcher. Cfg_ConflictChecking_Options Field Name Description OptionId ID for the conflict-checking option (see below).
Crestron e-Schedule Programmer’s Guide Signals Since the Real-Time Engine routes all signals, it is the reference point for input and output. Thus signals can be defined as either input commands to the Real-Time Engine or output commands from the Real-Time Engine. One example of an input command is an auto-start signal, which is an action such as Rewind or Play that the end-user can schedule to take place automatically at the beginning and/or end of an event.
Crestron e-Schedule Programmer’s Guide 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. Cfg_EventSignals_Folders Field Name Description FolderNameId Each folder that displays auto-start signals must be assigned a unique identifier, starting with 1 and proceeding sequentially—gaps are permitted.
Crestron e-Schedule Programmer’s Guide Example 7 – Configuration of auto-start and global signals 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. Programmer’s Guide e-Schedule – DOC.
Crestron e-Schedule Programmer’s Guide 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. For example, at the beginning of an media event, a user can select a signal, Auto Start, which will automatically execute the signals, TV Power On, Select Source A, and Play.
Crestron e-Schedule Programmer’s Guide Privileges User privileges have been greatly improved in version 3.02 and later. Following are the recommended default privileges for both an administrator level account and a user level account. The order of the field values is extremely important since this table is very closely tied to the front end web pages.
Crestron e-Schedule Programmer’s Guide Join Number Pass-Throughs The Cfg_Hardware_JoinNumPassThrus table defines ranges of join numbers that can be used in SIMPL Windows to specify pass-through signals, which are passed back and forth directly between a set-top box (room controller) and Web browser. This is useful for commands such as Volume Up that don’t need to be transmitted to the head end. The Real-Time Engine routes both the input and output signals, as usual.
Crestron e-Schedule Programmer’s Guide Real-Time Engine (Scheduler.exe) After configuring the databases, it is necessary to launch the Real-Time Engine in order to set preferences and connections. To start the Scheduler.exe program (the CNX Gateway starts automatically when the computer boots up), double-click the 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.
Crestron e-Schedule Programmer’s Guide 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 e-Schedule – DOC.
Crestron e-Schedule Programmer’s Guide Real Time Machine The Real Time Machine tab of the Preferences dialog box is used to specify IP Addresses and other system settings. • Scheduler Gateway IP Address—specifies the IP Address of the CNX Gateway computer for the Real-Time Engine. This IP Address may or may not be the same as that of the Web Server. (See Web Server Gateway IP Address, below.) • Web Server Gateway IP Address—specifies the IP Address of the CNX Gateway computer for the Web Server.
Crestron e-Schedule Programmer’s Guide Connections The Current Connections area of the Connections tab lists the IP Addresses of all hardware devices that are configured to run with the RealTime Engine. Each field also displays the connection status and CNX Gateway connection handle, for debugging purposes.
Crestron e-Schedule Programmer’s Guide Diagnostic Utilities The Configuration menu of the Real-Time Engine application window includes two options for debugging, Watch Signals and Configuration. Watch Signals The Watch Signals window displays information about all the signals that the Real-Time Engine receives and transmits. As stated previously, all signals are defined as either input to the Scheduler or output from the Scheduler, and this is specified in the I/O field.
Crestron e-Schedule Programmer’s Guide Configuration The “Configuration Diagnostics” dialog box includes tabs for each component of the e-Schedule system. Configuration diagnostics should be reviewed whenever the e-Schedule databases are created, modified, or updated. Select a device from the display list to view information about the corresponding entries as they appear in the configuration databases. The Status window will list any errors or omissions.
Crestron e-Schedule Programmer’s Guide Programmer’s Guide e-Schedule – DOC.
Crestron e-Schedule Programmer’s Guide 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. Programming Requirements Firmware/Software Programmer’s Guide Version (Minimum) CNMSX (AV/Pro) 5.12.04x CNRACKX/CNRACKX-DP 5.12.04w CEN-TVAV 5.12.05v SIMPL Windows 1.
Crestron e-Schedule Programmer’s Guide Figure 1: Sample System e-Schedule PC(s) Real-Time Engine 192.168.1.104 Web Server/ CNX Gateway 192.168.1.105 Ethernet Head End VCR1 IP ID 06 VCR2 IP ID 07 Classroom 2 IR IR CEN-TVAV 192.168.2.
Crestron e-Schedule Programmer’s Guide 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. Classroom 1 is controlled locally by a CN-TVAV; Classrooms 2 and 3 are controlled by CEN-TVAVs.
Crestron e-Schedule Programmer’s Guide software. 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. Sources—each source device in the head end must have a corresponding ActiveCNX Interface programmed into the control system.
Crestron e-Schedule Programmer’s Guide Since the CN-TVAV in Classroom 1 does not support Cresnet peripherals, the local touchpanel and CNECI-4 must be wired directly to the Cresnet network and bridged to Ethernet by the head end control system. Thus the control signals for this hardware must also be routed through ISC symbols. InterSystem Communications Symbol An ISC, or InterSystem Communications symbol is used to pass digital, analog and serial signals between control systems.
Crestron e-Schedule Programmer’s Guide 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: • Classroom Definitions.smw • Head End Definitions.
Crestron e-Schedule Programmer’s Guide dig o39 Mute: Sends feedback to the Web browser when a Mute button (defined in the room's control program) is pressed. dig i39 Mute: Enables the Web browser to control a room's Mute button. dig o40 Refreshes the feedback of SourceA - SourceF (digital join numbers i21-i27) and Transport Controls (digital join numbers i84-i104).
Crestron e-Schedule Programmer’s Guide dig o61 – o62 Volume Up/Down: Sends feedback to the Web browser when a Volume Up or Volume Down button (defined in the room's control program) is pressed. dig i61 – i62 Volume Up/Down: Enables the Web browser to control a room's Volume Up or Volume Down button. dig i63 – i64 TV Channel Up/Down: Enables the Web browser to control a room's TV Channel Up or Channel Down button.
Crestron e-Schedule Programmer’s Guide dig o85 – o104 Transport controls for SourceA-SourceF devices. dig i85 – i104 Feedback of the specified source. NOTE: If a join number that specifies a Pass-Through signal is also used by the Scheduler (i.e., join number 21, which identifies SourceA on the “Destination” ActiveCNX Interface), the Pass-Through takes priority and the original command is ignored. A signal cannot be configured as both a PassThrough and a Global Event.
Crestron e-Schedule Programmer’s Guide dig o105 – o124 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 e-Schedule – DOC.
Crestron e-Schedule Programmer’s Guide dig o219 – o230 Numeric Keypad for doing a View Channel: Sends feedback to the Web browser when View Channel keypad buttons in a room are pressed. dig i219 – i230 Numeric Keypad for doing a View Channel: Enables the Web browser to control the View Channel keypad in a room. dig i500 – i600 Crestron is currently developing support for this range of reserved join numbers (defined in the fixed database, Scheduler_RealTimeControl.mdb.
Crestron e-Schedule Programmer’s Guide Analog Signals o3 Indicates to the Scheduler that a particular channel has been requested. i3 Sets the television to the requested channel, if the channel has been checked as a valid channel in the Cfg_Hardware_LegalChannels database table. Serial Signals i6 – i11 Media titles for SourceA - SourceF (i.e., The Matrix). i12 – i17 Device names of SourceA - SourceF (i.e., VCR-5). i18 Group name. i19 Room name.
Crestron e-Schedule Programmer’s Guide i28 Time and Date: Reissued every hour in the format HH:MM:SS\x20MN/DD/YYYY (The \x20 between SS and MN indicates a space.) Field Description Format HH Hour 00-23 MM Minutes 00-59 SS Seconds 00-59 MN Month 01-12 DD Day 01-31 YYYY Year 4 digits NOTE: The Classroom programs of the sample system contain a SIMPL+ module to parse the string and set the time and date in the control system. Programmer’s Guide e-Schedule – DOC.
Crestron e-Schedule Programmer’s Guide Source ActiveCNX Interface Digital Signals i21 – i40 Transport controls: Input from the Scheduler to activate a transport control for the corresponding source (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 e-Schedule – DOC.
Crestron e-Schedule Programmer’s Guide i41 – i60 Generic Transport Controls: Can be customized for any transport controls that may not exist in the database. o41 – o60 Generic Transport Controls: Feedback for customized transport controls. Analog Signals o1 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 e-Schedule – DOC.
Crestron e-Schedule Programmer’s Guide Serial Signals i1 Source Name: The name of the source device (i.e., VCR-1), as entered into the configuration database. i2 Current Media: The media title (such as a movie or CD) that is currently physically loaded into the source device, based on the scheduling information. (See i3, below). i3 Media Name: The media title that should be loaded into the source device for the next event, based on the scheduling information.
Crestron e-Schedule Programmer’s Guide Switcher ActiveCNX Interface Digital Signals i1 Switcher TAKE: When high, triggers analog signals i1 and i2 to determine the appropriate serial string to send to the switcher, in order to execute the switch. Analog Signals i1 Switcher input i2 Switcher output NOTE: In certain cases the Scheduler may try to send many switches in rapid succession to this ActiveCNX Interface.
Crestron e-Schedule Programmer’s Guide Software License Agreement This License Agreement (“Agreement”) is a legal contract between you (either an individual or a single business entity) and Crestron Electronics, Inc. (“Crestron”) for software referenced in this guide, which includes computer software and, as applicable, associated media, printed materials, and “online” or electronic documentation (the “Software”).
Crestron e-Schedule Programmer’s Guide If You are a business or organization, You agree that upon request from Crestron or its authorized agent, You will within thirty (30) days fully document and certify that use of any and all Software at the time of the request is in conformity with Your valid licenses from Crestron of its authorized agent.
Crestron e-Schedule Programmer’s Guide Return and Warranty Policies Merchandise Returns / Repair Service 1. No merchandise may be returned for credit, exchange, or service without prior authorization from CRESTRON. To obtain warranty service for CRESTRON products, contact the factory and request an RMA (Return Merchandise Authorization) number. Enclose a note specifying the nature of the problem, name and phone number of contact person, RMA number, and return address. 2.
