Xantech CRM-WIC User manual

Reference Manual &
Programming Guide
Room Monitor – Web Intelligent Controller Model: CRM-WIC

2
Contents
CONTENTS ......................................................................................................................................................... 2
INTRODUCTION................................................................................................................................................ 6
BOX CONTENTS ................................................................................................................................................ 7
BOX CONTENTS FOR THE CRM-WIC...............................................................................................................7
HARDWARE USER INTERFACE ..................................................................................................................... 8
HARDWARE USER INTERFACE FOR THE CRM-WIC..........................................................................................8
SPECIFICATIONS ........................................................................................................................................... 10
PIN-OUTS..................................................................................................................................................... 10
FACTORY DEFAULT CONFIGURATIONS .................................................................................................. 11
NETWORK SETTINGS..................................................................................................................................... 11
SERIAL /DIPSWITCH SETTINGS...................................................................................................................... 11
QUICK START.................................................................................................................................................. 12
POWERING UP.............................................................................................................................................. 12
DETERMINE CRM-WIC CONNECTION ........................................................................................................... 12
ENABLING /DISABLING DHCP BY RESET ...................................................................................................... 13
ACCESSING THE CRM-WIC THROUGH THE NETWORK ................................................................................... 14
CONFIGURING THROUGH THE ADMIN WEB PAGES.......................................................................................... 14
CONFIGURING THROUGH THE BOOT MENU .................................................................................................... 14
USING THE CRM-WIC.................................................................................................................................... 15
TESTING HARDWARE.................................................................................................................................... 15
UPLOADING FIRMWARE UPGRADES............................................................................................................... 15
VIEWING SERVER LOGS ................................................................................................................................15
UPLOADING CUSTOM WEB PAGES................................................................................................................. 15
MANAGING CUSTOM EVENTS........................................................................................................................ 15
USING REMOTE PROCEDURE CALLS (RPCS) .................................................................................................. 15
BOOT MENU REFERENCE............................................................................................................................. 17
ACCESSING THE BOOT MENU WITH A SERIAL CONNECTION ........................................................................... 17
0: DISPLAY CURRENT SETTINGS .................................................................................................................... 18
1: RESTORE FACTORY DEFAULTS .................................................................................................................. 18
2: CONFIGURE IP SETTINGS........................................................................................................................... 18
3: SET PASSWORD......................................................................................................................................... 18
4: SET HOST NAME....................................................................................................................................... 18
5: DOWNLOAD NEW FIRMWARE .................................................................................................................... 19
6: LAMP TEST............................................................................................................................................... 19
7: HARDWARE TEST...................................................................................................................................... 19
8: ERASE ALL FILES...................................................................................................................................... 19
9: OEM FUNCTIONS ..................................................................................................................................... 19
ADMIN WEB PAGES........................................................................................................................................ 20
SETUP .......................................................................................................................................................... 21
Firmware Version........................................................................................................................................ 21
Date / Time.................................................................................................................................................. 21
Network Settings ......................................................................................................................................... 22
Host Name................................................................................................................................................... 22
System Password......................................................................................................................................... 22
IP Access Table........................................................................................................................................... 22
DIAGNOSTICS ............................................................................................................................................... 23

3
SERIAL: Serial Port Diagnostics.................................................................................................................. 24
MEMORY: System Memory Information..................................................................................................... 26
LOG: Log Files............................................................................................................................................ 27
F/W: Firmware ............................................................................................................................................ 28
EVENTS (SEE SECTION:THE EVENT MANAGER)............................................................................................. 29
FILES ........................................................................................................................................................... 29
THE EVENT MANAGER ................................................................................................................................. 30
OVERVIEW OF EVENTS,ACTIONS,&VARIABLES ........................................................................................... 30
THE EVENT MANAGER WEB PAGE ................................................................................................................ 31
EVENTS........................................................................................................................................................ 32
Creating and Editing Events......................................................................................................................... 32
Types of Events........................................................................................................................................... 32
Other Event Options .................................................................................................................................... 33
ACTIONS ...................................................................................................................................................... 34
Creating and Editing Actions ....................................................................................................................... 34
Types of Actions.......................................................................................................................................... 34
Action Timing Options ................................................................................................................................ 35
VARIABLES .................................................................................................................................................. 35
Creating and Editing Variables..................................................................................................................... 36
Types of Variables....................................................................................................................................... 37
EXPRESSIONS ............................................................................................................................................... 38
Interpreting Values as Expressions............................................................................................................... 38
Evaluation of Expressions............................................................................................................................ 38
Operators..................................................................................................................................................... 39
Escaping Special Characters......................................................................................................................... 45
REMOTE PROCEDURE CALLS..................................................................................................................... 46
RPC SERVER LOGS....................................................................................................................................... 46
SYNTAX FOR HTTP POST.............................................................................................................................. 46
Call Tokens ................................................................................................................................................. 46
Response Tokens......................................................................................................................................... 47
EXAMPLE #1: Serial_GetSettings............................................................................................................... 47
EXAMPLE #2: Net_GetSubnetMask ........................................................................................................... 47
FAULT CODES .............................................................................................................................................. 48
USING MACROMEDIA FLASH......................................................................................................................... 48
STEP 1: Pass CRM-WIC IP Address to Flash............................................................................................... 48
Step 2: Call RPC with HTTP Post ................................................................................................................ 49
Step 3: Response Tokens.............................................................................................................................. 50
VISUAL BASIC SCRIPTING ............................................................................................................................. 50
NOTE ON ERROR CHECKING.......................................................................................................................... 51
ERROR INFORMATION METHODS ................................................................................................................... 51
GetLastErrorCode ( ) ................................................................................................................................... 51
GetLastErrorString ( ).................................................................................................................................. 51
GetLastExtendedErrorString ( ).................................................................................................................... 52
GENERAL INFORMATION METHODS............................................................................................................... 52
AllState_Get ( )............................................................................................................................................ 52
Time_GetDate ( )......................................................................................................................................... 53
Time_Sleep ( Milliseconds ) ........................................................................................................................ 53
Net_GetIPAddress ( )................................................................................................................................... 53
Net_GetSubnetMask ( )................................................................................................................................ 54
SERIAL METHODS......................................................................................................................................... 55
Serial_GetSettings ( Port )............................................................................................................................ 55
Serial_Send ( Port, Msg, MaxWaitMS ) ....................................................................................................... 55
Serial_Read ( Port )...................................................................................................................................... 56
Serial_ClearReadBuffer ( Port ) ................................................................................................................... 56
Serial_ReadBufferCount ( Port ) .................................................................................................................. 56
EVENT METHODS ......................................................................................................................................... 57

4
GetEventByIdx ( Idx ).................................................................................................................................. 57
GetEventByName ( Name ).......................................................................................................................... 57
GetEventIdxById ( EventId ) ....................................................................................................................... 58
GetEventName ( EventId )........................................................................................................................... 58
GetEventType ( EventId ) ............................................................................................................................ 58
GetEventOption ( EventId, OptionType ) ..................................................................................................... 59
GetEventConcurrent ( EventId )................................................................................................................... 60
GetEventSource ( EventId ).......................................................................................................................... 60
GetEventMatch ( EventId ) .......................................................................................................................... 61
GetEventSchClockType ( EventId ).............................................................................................................. 61
GetEventSchRecurType ( EventId ).............................................................................................................. 62
GetEventSchMaskOrDay ( EventId )............................................................................................................ 62
GetEventSchMonth ( EventId ) .................................................................................................................... 63
GetEventSchYear ( EventId )....................................................................................................................... 64
GetEventSchRecurEveryN ( EventId ).......................................................................................................... 64
GetEventSchHour ( EventId )....................................................................................................................... 64
GetEventSchMinute ( EventId ) ................................................................................................................... 65
GetEventSchSecond ( EventId ) ................................................................................................................... 65
SetEventById ( EventId, Name, Type, Concurrent, Source, Match ).............................................................. 66
SetEventByName ( Name, Type, Concurrent, Source, Match )...................................................................... 66
SetEventOption ( EventId, OptionType, OptionVal ) .................................................................................... 67
SetEventSchedule ( EventId, Recur, MaskOrDay, Month, Year, RecurEveryN, Hour, Minute, Second )........ 69
CloneEventById ( EventId, CloneActions, NewName )................................................................................ 70
AddEvent ( Name, Type, Concurrent, Source, Match ) ................................................................................. 70
DeleteEventById ( EventId )........................................................................................................................ 71
DeleteEventByName ( Name )..................................................................................................................... 71
SortEvents ( SortType, Direction ) ............................................................................................................... 72
GetEventCount ( )........................................................................................................................................ 72
ACTION METHODS........................................................................................................................................ 73
GetActionByIdx ( EventId, Idx ) .................................................................................................................. 73
GetActionByName ( EventId, Name ) .......................................................................................................... 73
MoveActionByIdx ( EventId, Idx, Where )................................................................................................... 74
GetActionName ( ActionId )........................................................................................................................ 74
GetActionType ( ActionId ) ......................................................................................................................... 74
GetActionOption ( ActionId, OptionType ) .................................................................................................. 75
GetActionDelay ( ActionId )........................................................................................................................ 76
GetActionDutyCycle ( ActionId )................................................................................................................. 76
GetActionStopAfter ( ActionId ) .................................................................................................................. 76
GetActionPort ( ActionId )........................................................................................................................... 77
GetActionOutput ( ActionId )....................................................................................................................... 77
SetActionById ( ActionId, Name, Type, Delay, DutyCycle, StopAfter, Port, Output )................................... 78
SetActionByIdx ( EventId, Idx, Name, Type, Delay, DutyCycle, StopAfter, Port, Output ) ........................... 80
SetActionByName ( EventId, Name, Type, Delay, DutyCycle, StopAfter, Port, Output ) .............................. 81
SetActionOption ( ActionId, OptionType, OptionVal ) ................................................................................. 82
AddActionByEvId ( EventId, Name, Type, Delay, DutyCycle, StopAfter, Port, Output ) .............................. 83
AddActionByEvName ( EventName, Name, Type, Delay, DutyCycle, StopAfter, Port, Output )................... 84
DeleteActionById ( ActionId )..................................................................................................................... 86
DeleteActionByIdx ( EventId, Idx ).............................................................................................................. 87
DeleteActionByName ( EventId, Name )...................................................................................................... 87
SortActions ( SortType, Direction ).............................................................................................................. 87
GetActionCount ( EventId ) ......................................................................................................................... 88
VARIABLE METHODS.................................................................................................................................... 88
GetVariableByIdx ( Idx ) ............................................................................................................................. 88
GetVariableByName ( Name ) ..................................................................................................................... 89
GetVariableName ( VarId ).......................................................................................................................... 89
GetVariablePersist ( VarId )......................................................................................................................... 89
GetVariableType ( VarId ) ........................................................................................................................... 90
GetVariableDefault ( VarId )........................................................................................................................ 90

5
GetVariableValue ( VarId ).......................................................................................................................... 90
SetVariableById ( VarId, Name, Type, Default, Value, Persist ) ................................................................... 91
SetVariableByName ( Name, Type, Default, Value, Persist )........................................................................ 93
AddVariable ( Name, Type, Default, Value, Persist ).................................................................................... 94
DeleteVariableById ( VarId )....................................................................................................................... 95
DeleteVariableByName ( Name )................................................................................................................. 96
SortVariables ( SortType, Direction ) ........................................................................................................... 96
GetVariableCount ( ).................................................................................................................................... 97
INDEX ................................................................................................................................................................ 98
LIMITED WARRANTY.................................................................................................................................... 99

6
Introduction
Xantech’s Commercial Room Monitor – Web Intelligent Controller is a stand-alone room controller and
also the long awaited ‘glue’ piece providing dynamic RS232 feedback module from any RS232 device for
the Commercial CSPLCD TouchPanel displays.
On it’s own, the Web Intelligent Controller is an Event driven component with two RS232 ports
(configurable for RS422 and RS485) and a single IP port. The Event Manager is capable of Timed
Events, Calendar Events, Telnet and Serial Events as well as a full FTP site, Web Server and Email
Server.
Used as a Room Controller for a presentation system, the Web-Intelligent Controller can automatically,
every night at 12AM, turn the projector OFF if left on, check Bulb Life and if low email the IT or AV
specialist responsible!
When interfaced with the CSPLCD Commercial TouchPanel Display, the Web-Intelligent Controller can
send messages back to the TouchPanel allowing for Text Display, Numeric Display, Volume and
Indicator bars, ON/OFF indicators etc….. for full real-time data display. The IP port allows each room to
be accessible on the facilities IP network for Status display, remote centralized control as well as remote
diagnostics.
The following Manual, is an in-depth coverage of all features contained within the CRMWIC. For
Application specific examples, please refer to the “Web Intelligent Controller: Application & Quick-Start
Guide”.

7
Box Contents
Box Contents for the CRM-WIC
Web Intelligent Controller Model:CRMWIC Power Adapter

8
Hardware User Interface
Hardware User Interface for the CRM-WIC

9
Hardware
User Interface
Notes See Also
1 Serial Ports 1 &
2
The serial ports enable RS-232 and RS-422/485
communications, supporting a wide range of
compatible electronics.
The actual connectors on the CRM-WIC are
DB-9 male ports. Your device or cable should
have a DB-9 female to connect.
2 LED Indicators
for Serial Ports
1 & 2
There are two (2) sets of LEDs, one set for each
serial port. Each set consists of six (6) red
LEDs that indicate activity on the pins.
When using RS-232 communications, the six
LEDs indicate activity on the (from top down)
TX, RX, CTS, RTS, DTR, and DSR pins.
When using RS-422/485 communications, the
LEDs indicate activity on the corresponding TX-
A, RX-A, TX-B, and RX-B pins. For RS-422/485,
there is no activity on the CTS and RTS pins.
3 Dipswitch
Settings for
Serial Ports 1 &
2
These dipswitches physically set the Baud Rate,
Number Bit, Parity, Stop Bits, RS-232 or RS-
422/485, and Handshaking for Serial Ports 1
and 2.
It is possible to override the dipswitch settings
by using the Admin Web Pages [Admin]
Pin-Outs, page 10: DB-9 pin-
out diagram and labels.
Serial / Dipswitch Settings,
page 11: Setting options and
factory default settings.
Serial Settings - Dipswitch
Override, page 26: Settings
override from Admin Web
Pages., page 32: Tools on
Admin Web Pages.
Jump To [Events]
Jump to [Actions]
Jump to [Methods]
4 Green LED
Indicator for
Power
The green LED indicates that the CRM-WIC is
powered.
5 Power Adapter
Port
The CRM-WIC is powered using the included
Power Adapter. The smaller end of the Power
Adapter is plugged into this port.
This section describes how to
power up your CRM-WIC
and access the configuration
options.
STEP 1: Powering Up, page
12: Quick start to powering
up the CRM-WIC.
6 Blue LED
Indicator for
Status
A slow blink generally indicates that the CRM-
WIC is ready to serve web and ftp requests.
[Indicators]
A repeating sequence of flashes indicates an
error.
The blue LED will also light when the reset pin
is pressed.
Jump to LED Indicators
7 LAN Port The CRM-WIC may be connected to a network
using a standard Ethernet cable in this port.
The green LED on the LAN port indicates that a
network has been detected.
The yellow LED on the LAN port indicates that
data is being transmitted through the port.
Jump to Network Access
8 Reset Pin The Reset Pin is a recessed button used in the
administration and maintenance of the CRM-
WIC.
Reset Function

10
Specifications
Size 5.4" H x 4.4" W x 0.95" D √
Weight 0.6 lbs. √
Power Adapter 12V DC 500mA
Processor 32-Bit √
Memory Total RAM 32M
Total Flash 8M
Available Flash* 2.5M
Ports 10/100 LAN (RJ-45 / Ethernet) 1
RS-232/422/485 (Male DB9) 2
Monitoring 32-Bit Internal Clock/Calendar √
Network Access Web & FTP √
CRM-WIC Input
Voltage
Min +8V, Typ +12V, Max +18V
Network Adapter 10/100Mbits
RS-232/RS-422/485 15KB Protection 115KB Max
* Available Flash Memory may vary based on firmware version.
Pin-Outs
Port RS-232 RS-422/485
1 NC NC
2 RX RX -
3 TX TX -
4 DTR TX +
5 GND GND
6 DSR RX +
7 RTS Active Low
(0.5v)
8 CTS 15 KΩto
GND
9 NC NC