Crestron e-Schedule Manual

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 .....................................................................................................6
Data Flow ......................................................................................................................7
Configuring the e-Schedule Database 8
Database Categories ....................................................................................................8
Database Configuration ................................................................................................9
Scheduling Software Computer(s)...................................................................9
Areas..............................................................................................................10
Head End and Source Devices......................................................................12
Destination Devices .......................................................................................17
Signals ...........................................................................................................19
Signal Macros ................................................................................................21
Signal Macros ................................................................................................22
Privileges........................................................................................................23
Join Number Pass-Throughs .........................................................................24
Real-Time Engine (Scheduler.exe).............................................................................25
Diagnostic Utilities.......................................................................................................29
Watch Signals ................................................................................................29
Configuration..................................................................................................30
e-Schedule Interface to Control Systems 32
SIMPL Windows Programming ...................................................................................32
ActiveCNX Interface Definitions..................................................................................37
Destination (Classroom) ActiveCNX Interface...............................................37
Source ActiveCNX Interface ..........................................................................45
Software License Agreement.....................................................................................49
Return and Warranty Policies....................................................................................51
Merchandise Returns / Repair Service .......................................................................51
CRESTRON Limited Warranty....................................................................................51
Programmer’s Guide e-Schedule – DOC. 5919 •i

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.
• Copying and re-scheduling of one or all of a day's events.
• Scheduling of automatic transport functions such as Source
Select, Play and Rewind.
• Support for broadband and/or baseband switching (as long as
there is full crosspoint capability).
• Multiple-room scheduling and grouping and multiple head ends.
• Global signals.
• Join number pass-throughs for direct communication between a
Web browser and a room.
• Customizable television channel lists.
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. These
sources must be controlled by a Crestron control system that supports
Ethernet communication, such as the CNMSX or CNRACKX. The devices
can be modulated onto broadband video network or switched baseband with
any switcher controllable by Crestron.
Programmer’s Guide e-Schedule – DOC. 5919 •1

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).
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. Crestron supports room processing for the CN-
TVAV as well, using an Ethernet-enabled control system as a “bridge” (see
section titled e-Schedule Interface to Control Systems). Room controllers are
referred to as set-top boxes.
Most systems include local room control of head end sources via Crestron
touchpanels and/or real-time Web browser pages. End users usually control
television settings such as volume, changing channels and turning power on
and off, although e-Schedule supports automatic control of these settings as
well. The Crestron CNIRHT-MM (445 KHz) transmitter can also be used for
real-time control of sources and TV.
Events
The e-Schedule interface consists of various Web pages that the user
navigates in order to schedule events, which are divided into two types:
media events and global events.
To schedule a media event, the user requests up to six media titles, as well as
start and end times and room destinations. In addition, actions called signals
that occur automatically can be scheduled at the beginning and/or end of an
event. For example, start signals might include dimming the lights and
lowering a video screen, while end signals might rewind a VCR tape and
raise the blinds.
After the scheduling software validates the request, it reserves the sources
and media titles for use during the scheduled time. The user who schedules
an event can then control it locally or from a Web browser while the event is
in progress. They can also edit or delete the event using the Web-based
interface.
When scheduling a media event for a group, the first room that the user
selects will be designated as the “controlling room” that sends transport
commands to the head end sources. Only the controlling room can
communicate with the head end, and any action that is initiated in the
controlling room will also take place in the other “eavesdropping” rooms that
make up the group.
Global events differ from media events in that they don’t involve any source
devices, user-specified locations, or end times. Some common examples of
global events are turning lights on or off in a location, activating an alarm
system, or adjusting the setting on a thermostat. Global events can be
scheduled to coincide with media events or they can occur independently.
Programmer’s Guide e-Schedule – DOC. 5919 •2

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. 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.
System Components and CNX Gateway Licensing
The e-Schedule software package consists of the following:
• Active Server Pages—Web server application for scheduling
and conflict checking.
• Real-Time Engine—application for controlling media resources
and signal routing between control systems, source devices and
destination devices.
• e-Schedule Database Directory—divided into four categories:
1) Configuration 2) Web Browser 3) Resource and 4) System.
• Documents/Examples Directory—various SIMPL Windows
and VT Pro-e programs that define an extensive sample system.
Together with the completed configuration databases (also
included), the programs can be used as models for most projects.
In addition, the system requires a CNX Gateway (the software gateway, not
the CNXENET+ card gateway) to enable Ethernet communication with
Crestron equipment. The number of connection licenses depends on the
configuration of the system.
Crestron recommends two possible software configurations. The first is to
have all the software and the CNX Gateway on a single computer. In this
case, the number of connection licenses will be equal to the total number of
IP addresses (meaning all browsers and any hardware with unique IP
addresses), plus two. The two extra licenses enable communication between
the Web Server and Real-Time Engine applications. For example, in the
following system:
• One CNMSX-Pro controlling various sources
• Five CEN-TVAVs
• Five Web browsers
A total of thirteen licenses would be required.
The second possible configuration is to have two computers, one for the Web
Server and the other for the Real-Time Engine, each with its own CNX
Gateway. (The Database Directory should be installed on the Web Server for
efficiency.) The Web Server computer would then require licenses for all
Programmer’s Guide e-Schedule – DOC. 5919 •3

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. 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.
NOTE: Crestron recommends that all e-Schedule components reside on a
separate segment or subnet of the Ethernet network, in order to help ensure
that packets will be routed efficiently and quickly.
Leading Specifications
Maximum number of sources that can
be scheduled to one event at one
time
6
Maximum number of browsers that
can be running simultaneously
90
Maximum number of IP IDs (Crestron
control systems, source devices,
switcher (if any) and browsers)
250
Maximum number of Cresnet
(Crestron Network) devices—i.e., LC-
1000, CN-TVAV, CT-1550—per
CNMSX control system
30, if using only CN-TVAVs with
no touchpanels or
50, with no more than 25 CN-
TVAVs if touchpanels are used
Control system UPZ file 5.12.04x (CNMSX) or later
5.12.04w (CN-RACKX) or later
5.12.05v (CEN-TVAV) or later
SIMPL Windows version 1.40
(1.50.06 if using CN-TVAV)
Programmer’s Guide e-Schedule – DOC. 5919 •4

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 600 MHz Pentium II Processor
512 MB RAM
Network Card
TCP/IP
Operating System/
Software
Windows NT Server 4.0 with Service Pack 4 or later
Windows NT 4.0 Option Pack
(Internet Information Server 4.0 included)
Internet Explorer 5
Microsoft Access 2000
Firewall (optional, but recommended)
Crestron
Software/Files
Crestron e-Control CNX Gateway 2.8.6.0 or later
Active Server Pages
Database Directory
Real-Time Engine PC
Hardware 600 MHz Pentium II Processor
128 MB RAM
Network Card
TCP/IP and UDP/IP
Operating System Windows 95, 98, or NT
Crestron Software Crestron e-Control CNX Gateway 2.8.6.0 or later
Real-Time Engine (Scheduler.exe)
Browser Computers
Hardware 166 MHz Pentium Processor
Microsoft Software Windows 95, 98, or NT
Internet Explorer 5*
*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.
Programmer’s Guide e-Schedule – DOC. 5919 •5

Crestron e-Schedule Programmer’s Guide
System Connections
0,1 or more
Cresnet-connected destinations
0,1 or more
Ethernet-connected
destinations
0,1 or more
Head Ends
SourceN
CNMSX
Source1
0,1 or more
Cresnet
-
connected
Misc
equip
CNMSX
Misc
equip
IR
Xmit
(opt)
CN-TVAV
IR
Transmitter/
Touchpanel
(optional)
CEN-
TVAV
Browser
(optional)
Real-Time
Engine/CNX
Gateway
Web Server/
CNX Gateway
Ethernet
Programmer’s Guide e-Schedule – DOC. 5919 •6

Crestron e-Schedule Programmer’s Guide
Data Flow
Browser
Browser
Browser
Browser
Web
Server/
CNX
Gateway
Real-Time
Engine/
CNX Gateway
Databases
Scheduling information
Real time information
Crestron
D
e
vi
ces
Programmer’s Guide e-Schedule – DOC. 5919 •7

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.
Scheduler_Events.mdb—automatically stores event information by
system, as well as real-time status of sources and destinations.
Resource Databases
Scheduler_Media.mdb—media database containing all media
resources and media attributes.
Web Browser Database (DO NOT MODIFY! This database will be
overwritten with each new installation and/or upgrade.)
Scheduler_WebGUI.mdb—read-only database for the client-side
Web browser.
System Database (DO NOT MODIFY! This database will be
overwritten with each new installation and/or upgrade.)
Scheduler_RealTimeControl.mdb—read-only database for the
scheduling software.
NOTE: After opening any table in Microsoft Access, select Design View
from the View menu for detailed information about each field in the table,
including data types and descriptions.
Programmer’s Guide e-Schedule – DOC. 5919 •8

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).
Cfg_Hardware_ServerMachine
Field Name Description
ServerMachineId The ID number of the Web Server
computer—must be “1”, as e-Schedule does
not currently support multiple Web Servers.
ServerMachineIPAddress The static IP Address of the Web Server
computer.
Cfg_Hardware_RealTimeMachine
Field Name Description
RealTimeMachineId The ID number of the Real-Time Engine
computer—must be “1”, as e-Schedule does
not currently support multiple instances of
the Real-Time Engine application.
RealTimeMachineIPAddress The static IP Address of the Real-Time
Engine computer.
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.)
WebServer/
CNX Gateway
Real-Time
Engine
Programmer’s Guide e-Schedule – DOC. 5919 •9

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., Law School), referenced
by the Location ID, and displayed in the user interface.
Cfg_Area_Groups
Field Name Description
GroupId Each group must be assigned a unique identifier, starting
with 1 and proceeding sequentially—gaps are permitted.
GroupName The name of the group (i.e., First Year Classes), referenced
by the Group ID, and displayed in the user interface.
Cfg_Area_SubLocations
Field Name Description
SubLocationId Each sublocation (room) must be assigned a unique
identifier, starting with 1 and proceeding
sequentially—gaps are permitted.
SubLocationName The name of the room (i.e., Room 101), referenced
by the SubLocation ID, and displayed in the user
interface.
Cfg_Area_MapTable
Field Name Description
LocationId The Location ID taken from Cfg_Area_Locations.
GroupId The Group ID taken from Cfg_Area_Groups.
SubLocationId The SubLocation ID taken from Cfg_Area_Sublocations.
Enable Check box to enable or “remove” the mapping
configuration in the system.
Programmer’s Guide e-Schedule – DOC. 5919 •10

Crestron e-Schedule Programmer’s Guide
Programmer’s Guide e-Schedule – DOC. 5919 •11
Example 2 – Locations, groups and rooms, with corresponding tables mapping the
relationships between them.
Group 1
Cfg_Area_MapTable
Cfg_Area_Groups
Cfg_Area_Locations
Cfg_Area_SubLocations
Group 3
Room 6
Group 2
Business School
Law School
Room 7
Room 5Room 4
Room 3Room 2
Room 1

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.
RealTimeMachineID Taken from Cfg_Hardware_RealTimeMachine,
this ID number must be “1”.
IPAddress The static IPAddress of the control system for the
switcher.
IPID The decimal equivalent of the hexadecimal Cresnet
IP ID of the switcher.
Enable Check box to enable or “remove” the device in the
system.
Cfg_Source_FormatType
Field Name Description
FormatTypeId Each format type must be assigned a unique identifier,
starting with 1 and proceeding sequentially—gaps are
permitted.
Format The format of the source device (i.e., VHS or DVD)
displayed in the user interface when media is selected.
All media titles must have a corresponding format if they
are to be used in a source.
Controllable Check box that indicates whether a source device must
be controlled, either manually or remotely (i.e., a VCR is
controllable, whereas a television tuner is not.)
Load Required 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 e-Schedule – DOC. 5919 •12

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).
SwitcherInput In baseband systems only, this is the switcher input ID
number that is specified in SIMPL Windows. (Ignored
in broadband systems—enter 0.)
Valid Channel 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.
Example 3 – Configuration table for channels
Programmer’s Guide e-Schedule – DOC. 5919 •13

Crestron e-Schedule Programmer’s Guide
Cfg_Hardware_Source
Field Name 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.
RealTimeMachineID Taken from Cfg_Hardware_RealTimeMachine,
this ID number must be “1”.
IPAddress The static IP Address of the control system for this
device.
IPID The decimal equivalent of the Cresnet IP ID of the
device.
SwitcherID For baseband systems, this is the switcher used by
the device. This ID number is taken from the table
Cfg_Hardware_Switcher. (Ignored in broadband
systems.)
FormatTypeId The ID number taken from
Cfg_Hardware_Source_FormatType.
BasicWebPage This ID number must be taken from the
BasicPageID field of the table RealTimePages,
located in the read-only database,
Scheduler_RealTimeControl. (Currently the
choices are: 1 = VCR; 2 = DVD; 3 = Projector;
4 = Environment; and 5 = TV Tuner.)
Channel 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 e-Schedule – DOC. 5919 •14

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. The control system that controls both the VCR
and switcher is located at IP Address 192.168.2.173.
Database Table: Cfg_Hardware_Source
Database Table: Status_Src
SrcStatusId 3
SrcStatusDesc Ready
Database Table: RealTimeSrcStatus
SrcId 3
SrcStatus 0
Database Table: Cfg_Hardware_Switcher
SwitcherId 1
SwitcherName AutoPatch
IPAddress 192.168.2.173
IPID 8
Database Table: Cfg_Hardware_LegalChannels
ChannelId 1
ChannelNumber 11
ChannelName VCR-1
SwitcherInput 0 (ignored in broadband)
ValidChannel Yes
Database Table: RealTimePages
BasicPageId 1
Comment VCR
Database Table: Cfg_Hardware_Source_FormatType
FormatTypeId 1
Format VHS
Database Table: Cfg_Area_ Locations
LocationId 1
LocationName Law School
VCR1
SrcId 3
SrcName VCR-1
LocationId 1
IPAddress 192.168.2.173
IPID 6
SwitcherID 1
FormatTypeId 1
Basic Web Page 1
Channel 1
Programmer’s Guide e-Schedule – DOC. 5919 •15

Crestron e-Schedule Programmer’s Guide
Programmer’s Guide e-Schedule – DOC. 5919 •16
Example 4 (continued)

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.
Destination Devices
Cfg_Hardware_SetTopBox
Field Name Description
SetTopBoxId The ID number of the set-top box (room
controller)—must be the same as the
SubLocationId.
SubLocationId The ID number of the room where the set-top box
is located, taken from Cfg_Area_SubLocations.
RealTimeMachineID Taken from Cfg_Hardware_RealTimeMachine,
this ID number must be “1”.
IPAddress The static IPAddress of the set-top box or control
system, if set-top box does not have its own IP
Address.
IPID The decimal equivalent of the hexadecimal Cresnet
IP ID of the set-top box.
SetTopBoxType Type of controller, i.e., CEN-TVAV, taken from
Cfg_Hardware_SetTopBox_Variables.
SwitcherID In baseband systems only, this is the ID number of
the head end switcher, taken from
Cfg_Hardware_Switcher.
SwitcherOutput In baseband systems only, this is the switcher
output ID number that is specified in SIMPL
Windows.
SafeChannel Overrides the global (default) safe channel defined
in Cfg_System_Variables (–1 = Use Global Safe
Channel)—currently unused.
Enable Check box to enable or “remove” the device in the
system.
Programmer’s Guide e-Schedule – DOC. 5919 •17

Crestron e-Schedule Programmer’s Guide
RealTime_DstStatus (Scheduler_Events.mdb)
Field Name Description
SetTopBoxId 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).
OptionName 1 = RecurringEvents (not available); 2 = Groups;
3 = Multilocation.
Active Check box to enable or disable each option. Option 2
should be enabled if the system is to permit group
scheduling. 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.
Example 6 – Configuration table for conflict checking options
Programmer’s Guide e-Schedule – DOC. 5919 •18