How it Works
Xantech
Loading...
CRM-WIC
Reference Manual
99 pgs2.64 Mb0

Xantech CRM-WIC Reference Manual

Reference Manual & Programming Guide
Room Monitor – Web Intelligent Controller Model: CRM-WIC
Contents
CONTENTS ......................................................................................................................................................... 2
INTRODUCTION ................................................................................................................................................ 6
BOX CONTENTS ................................................................................................................................................7
HARDWARE USER INTERFACE .....................................................................................................................8
FACTORY DEFAULT CONFIGURATIONS .................................................................................................. 11
QUICK START.................................................................................................................................................. 12
USING THE CRM-WIC.................................................................................................................................... 15
BOOT MENU REFERENCE.............................................................................................................................17
ADMIN WEB PAGES........................................................................................................................................20
2
THE EVENT MANAGER ................................................................................................................................. 30
REMOTE PROCEDURE CALLS..................................................................................................................... 46
3
4
INDEX ................................................................................................................................................................ 98
LIMITED WARRANTY.................................................................................................................................... 99
5
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”.
6
Box Contents
Box Contents for the CRM-WIC
Web Intelligent Controller Model:CRMWIC Power Adapter
7
Hardware User Interface
Hardware User Interface for the CRM-WIC
8
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
3 Dipswitch
Settings for Serial Ports 1 & 2
4 Green LED
Indicator for Power
5 Power Adapter
Port
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.
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]
The green LED indicates that the CRM-WIC is powered.
The CRM-WIC is powered using the included Power Adapter. The smaller end of the Power Adapter is plugged into this port.
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]
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
7 LAN Port The CRM-WIC may be connected to a network
8 Reset Pin The Reset Pin is a recessed button used in the
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.
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.
administration and maintenance of the CRM­WIC.
Jump to LED Indicators
Jump to Network Access
Reset Function
9
Specifications
Size
Weight
Power Adapter
Processor
Memory
Ports
Monitoring
Network Access
CRM-WIC Input Voltage
Network Adapter
RS-232/RS-422/485
5.4" H x 4.4" W x 0.95" D √
0.6 lbs. √
12V DC 500mA 32-Bit √
Total RAM 32M
Total Flash 8M
Available Flash* 2.5M
10/100 LAN (RJ-45 / Ethernet) 1
RS-232/422/485 (Male DB9) 2 32-Bit Internal Clock/Calendar √ Web & FTP √
Min +8V, Typ +12V, Max +18V
10/100Mbits
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
9 NC NC
15 KΩ to
GND
10
Factory Default Configurations
Network Settings
DHCP Enabled No
IP Address 10.10.10.10
Subnet Mask 255.255.255.0
Gateway 10.10.10.1
Subnet Mask CRM-WIC
Gateway admin
Serial / Dipswitch Settings
Note: Serial Settings are configurable by default in the Serial Diagnostic Web Setup Page (Jump to
Diagnostics)
Positions 1-4: Baud Rate (bps)
1 2 3 4
300 Off Off Off Off
600 Off Off Off 1200 Off Off 2400 Off Off 4800 Off 9600 Off
19200 Off 38000 Off 57600
115000
ON ON
ON ON ON
ON
Off Off
ON
Off
ON ON ON ON ON
Off Off Off Off Off
Position 5: Number Bits
5
8 Bits Off 7 Bits
ON
ON
Off
ON
Off
ON
Position 6-7: Parity
6 7
None Off Off
ON
ON
Off
Odd Off
Even
Position 8: Stop Bits
8
1 Bits Off 2 Bits
ON
Position 9: Serial Port
9
RS-232 Off
RS-422-485
ON
Position 10-11: Handshaking
10 11
None Off Off
ON
ON
Off
Hardware Off
Software
11
Quick Start
This section describes how to power up your CRM-WIC and access the configuration options.
STEP 1: Powering Up
Locate the power adapter which came with your CRM-WIC. Plug the small end into the power supply port on the upper right side of the CRM-WIC, and the large plug into a wall socket or compatible power supply.
You should observe the following behavior in this order:
• The green Power LED will immediately light. It will remain lighted while the CRM-WIC is plugged in.
• After approximately 5 seconds, ALL the LEDs will flash on.
• Almost immediately, all the LEDs will then flash off, EXCEPT the green Power LED and the
blue Status LED, which will remain lighted.
• About 10 seconds later, the RTS and DTR Serial LEDs for both serial ports will light on. In addition, the LEDs for the four Digital I/O ports will also light on. The green Power LED and the blue Status LED will still be steadily lighted at this point.
• After another 10 seconds or so, the blue Status LED should start blinking slowly.
A slow, steady blink on the blue Status LED indicates that the CRM-WIC is ready to connect to an IP­based LAN network and serve web and FTP requests.
Repeating multiples of fast flashes on the blue Status LED indicate errors.
STEP 2: Determine CRM-WIC Connection
Decide how you would like to connect to your CRM-WIC to configure it:
Connection Type Why use this connection type? What do I do next to connect this
way?
Connect the CRM-WIC to a LAN Network and configure it using a
PC on the Network.
Connect the CRM-WIC directly to
a PC using a crossover Ethernet
cable.
Connect the CRM-WIC directly to
a PC using a serial data transfer
cable (AKA null modem cable
This is the typical set up for
general CRM-WIC use.
You do not have a LAN network,
and you need to access all
Admin Web Pages for
configuration.
You do not have a LAN network,
and you only need to access to
the basic setup configuration
found in the Boot Menu.
or
You need to set up the manual IP
address for a static LAN network
If you have a network
12
If your network is configured to support the default network (IP) settings (see Network Settings, page 11), you may immediately connect to the CRM-WIC using an Ethernet cable with an RJ-45 connector.
Similarly, if a computer supports the default settings, you may directly connect to the CRM-WIC using a crossover cable. A typical configuration is to manually set the Local Connection on the computer to:
IP Address 10.10.10.11
Subnet Mask 255.255.255.0
Gateway 10.10.10.1
Enabling / Disabling DHCP by Reset
If you have a DHCP server on your network, you may enable or disable the DHCP setting on the CRM­WIC by pressing and holding the reset button for about 30 seconds. Look for ONE (1) or TWO (2) flashes on the blue “Status” LED before ALL the LEDs flash once.
If the blue LED flashes ONCE before ALL the LEDs flash once, DHCP is DISABLED, and the settings revert to the factory default settings.
If the blue LED flashes TWICE before ALL the LEDs flash once, DHCP is ENABLED, and the Network settings are now configured to:
DHCP Enabled Yes
IP Address Automatic
Subnet Mask Automatic
Gateway Automatic
After all the LEDs flash once, wait for the blue LED to start blinking slowly. The CRM-WIC will then be ready to accept connections.
13
Accessing the CRM-WIC through the Network
Once the CRM-WIC is physically connected to the network, and the blue light is blinking slowly, you may access the CRM-WIC through your web browser, ftp client, and other network clients.
Upload User-Defined Web pages to:
ftp://[IP Address or Host Name]/wwwpub/
View User-Defined Web Pages:
http://[IP Address or Host Name]/
Admin Web Pages (Setup, Diagnostics, etc):
http://[IP Address or Host Name]/setup/
Configuring through the Admin Web Pages
Once the CRM-WIC is connected to the network, you may configure the device through the admin web pages at:
http://[IP Address or Host Name]/setup/
Username: (leave this blank) Password: Admin
Click "Setup" icon for network and other basic settings. Details describing these options can be found in the section {Admin Web Pages, starting on page 20}.
Configuring through the Boot Menu
You may also configure CRM-WIC directly from your computer with a serial connection. {See the Boot Menu Reference on page 17 for more details.}
14
Using the CRM-WIC
This section summarizes common administrative tasks for running your CRM-WIC and refers you to appropriate sections of this manual for further details.
Testing Hardware
From the Boot Menu, you may:
• Test your LEDs {6: Lamp Test, page 19}.
• Check your RAM {7: Hardware Test, page 19}.
From the Setup & Diagnostic web pages, you may check your total memory and all of your ports {Admin Web Pages , page 20}
Uploading Firmware Upgrades
Firmware upgrade files may be uploaded, one file at a time, to the CRM-WIC after the CRM-WIC is set to firmware upgrade mode. The CRM-WIC may be set to firmware upgrade mode through the serial Boot Menu or the Admin Web Pages. The CRM-WIC cannot be used for any other purpose while in this mode.
Firmware upgrade files will have extension .AFW (operating system upgrades) or .ABT (bootstrap loader upgrades).
Viewing Server Logs
Logs for the RPC (Remote Procedure Calls), Web, and FTP servers may be monitored through the Admin Web Pages {Admin Web Pages, page 20}.
Uploading Custom Web Pages
Your custom web pages may be uploaded with any ftp client at:
ftp://[IP Address or Host Name]/wwwpub/
These custom web pages may be viewed with a web browser at:
http://[IP Address or Host Name]/
Managing Custom Events
The CRM-WIC has a powerful event manager that will allow you to automate many tasks.
For full details, see {The Event Manager, page30} later in this manual.
Using Remote Procedure Calls (RPCs)
The CRM-WIC supports many programmable functions through remote procedure calls (RPCs).
15
For full details, see the RPC section at the end of this manual.
16
Boot Menu Reference
Accessing the Boot Menu with a Serial Connection
Connect the Serial 1 Port of the CRM-WIC to your computer with an RS-232 Data Transfer Cable (also known as a Null Modem Cable). Using Hyper Terminal (or similar software), connect to the CRM-WIC with the default Serial Settings: Baud Rate: 9600, Data bits: 8, Parity: None, Stop bits: 1, and Flow control: None. When connected, the CTS 1 and DSR 1 LEDs will light.
Press & hold the reset button for 5 seconds. The CRM-WIC Boot Menu will appear on the terminal screen:
CRM-WIC Boot Menu
------------------------------
0 : Display Current Settings 1 : Restore Factory Defaults 2 : Configure IP Settings 3 : Set Password 4 : Set Host Name 5 : Download New Firmware 6 : Lamp Test 7 : Hardware Test 8 : Erase All Files 9 : OEM Functions x : Exit menu and boot
Selection:
The boot menu will prompt you through setup and diagnostics.
Details about the options follow in this section.
17
0: Display Current Settings
Selecting "0" will display your CRM-WIC's:
• MAC Address
• DHCP Enabled / Disabled State
• IP Address Setting
• Subnet Mask Setting
• Gateway IP Address Setting
• Host Name - You May access your CRM-WIC at the URL <http://[Host Name]/>
• Password
• OS Loaded / Not Loaded State
• OS Filename
1: Restore Factory Defaults
This option restores the CRM-WIC’s network settings to the factory defaults. {see Factory Default Configurations on page 11}.
2: Configure IP Settings
You may enable DHCP or manually set an IP address, subnet mask, and gateway IP address.
3: Set Password
The maximum length is 8 characters, numbers and letters only. (If you are prompted for a user name as well as a password, you may use any name or leave it blank.
4: Set Host Name
The maximum length is 16 characters, numbers and letters only. Once set, you will be able to access your CRM-WIC at the URL <http://[Host Name]/>.
18
5: Download New Firmware
Select "5" to upgrade the OS (*.AFW) or bootstrap loader (*.ABT) file.
The Boot Menu display will first indicate some network initialization, and then the CRM-WIC will prompt you to use a tftp (trivial ftp) client to upload your upgrade file to the CRM-WIC at a specific IP address.
At this point, the blue LED will be OFF, and all the Serial LEDs for both ports will be on. You will now need to upload the OS or boot file using a tfpt client. To use the default Windows tftp client, open a Command Prompt (or DOS shell) window and execute:
tftp -i [IP Address] put [/File Path/Upgrade File]
Example:
tftp –i 10.10.10.10 put c:\temp\CRM-WICplus20.afw
You may only upgrade one file at a time, and you may not do anything else with the CRM-WIC in this mode.
During the file transfer, the serial LEDs will blink one at a time, and you will see the status on the boot menu screen.
The CRM-WIC will reset on completion. Continue to use CRM-WIC as normal, or press & hold the reset button 5 seconds to re-enter boot menu.
6: Lamp Test
Turns all LEDs on, so you can verify that they are working correctly.
7: Hardware Test
Performs a memory scan to validate the integrity of the system RAM.
8: Erase All Files
Deletes all files downloaded to the CRM-WIC. These are normally the files that have been downloaded using an FTP client to <ftp://[Host Name]/>.
9: OEM Functions
These are factory options that are configured by the manufacturer, and are not applicable for the end-user.
19
Admin Web Pages
Admin web pages include setup and diagnostic options, and may be accessed at:
http://[IP Address or Host Name]/setup/
From this web page, you may click on:
• SETUP - for firmware version, date/time setting, network settings, and network security settings.
• DIAGNOSTIC – serial port configuration settings, firmware upgrade instructions, logs, options, and other diagnostic tools for using and/or monitoring CRM-WIC hardware.
• EVENT MANAGER {see separate section, The Event Manager, page 30} - powerful non- programming tool to automate CRM-WIC tasks.
• FILES - opens an ftp connection to the CRM-WIC.
20
Setup
This web page allows you to set several administrative options. Many of these options are also available from the Boot Menu.
Firmware Version
The firmware version installed on the CRM-WIC is displayed.
Date / Time
The current date and time is displayed. You may also set the date and time using the pulldown menus.
21
Network Settings
If DHCP is enabled for the CRM-WIC, the IP Address, Subnet Mask, and Default Gateway are automatically assigned, and the values will be grey and uneditable.
If the DHCP is disabled, the values for IP Address, Subnet Mask, and Default Gateway will be black and editable.
Host Name
By setting the host name, your CRM-WIC 's web server may be accessed at
http://[Host Name]/
Similarly, the FTP server may be reached at
ftp://[Host Name]/
System Password
The password allows you to access the Admin Web Pages and FTP servers.
IP Access Table
When specified, your CRM-WIC will only accept network requests from computers with these IP addresses.
22
Diagnostics
Four of the Diagnostics described in this section (Serial, Memory, Log, and F/W) are available for the CRM-WIC:
23
SERIAL: Serial Port Diagnostics
The serial port diagnostics are available for the CRM-WIC From this web page, you may access three diagnostics for the serial ports.
Serial Send & Receive Histories
First, you may monitor the send and receive histories from either serial port.
The serial send and receive histories logs the bytes being output or input through the ports. First, select which port to log (1 or 2), and then specify the display. The bytes passing through the port may be displayed as printable ASCII characters, hex values, or decimal values.
If you select ASCII characters, you must also choose how you wish to view non-printable characters. The non-printable characters are denoted by boldface type and "<" and ">" parentheses. For example, an ASCII "space" character, which is non-printable, may be displayed as decimal value <32> or hex value <20>.
24
Send String
The second diagnostic allows you to send a byte stream through the port specified at the top of the page. The byte stream you wish to send must be a URL-encoded send string:
To send a URL-encoded string, follow these three rules for encoding:
1. Enter your byte values as a string of printable ASCII characters and hex values. Spaces and returns, for example, are non-printable characters and MUST be converted to hex.
2. Any hex value in the send string must be preceded by a "%" symbol.
3. The URL-encoded string does NOT accept decimal values, so if you only know the decimal value of a byte, you MUST either convert it to a printable ASCII characters or the hex equivalents.
For example, the decimal byte stream "103 111 111 100 32 100 111 103" is equivalent to the hex byte stream "67 6F 6F 64 20 64 6F 67". It is also equivalent to the ASCII string "good dog". However, to send the string to the serial port, you must use a combination of printable ASCII characters and hex values only. Therefore, you may send the string as "good%20dog" or "good%20%64%6F%67", but not "good dog" (contains a space, which is a non-printable character) or "good%32dog" (where "32" is a decimal value). (You do not need to use quotes in the Send String text box.)
For your convenience, if you forget URL-encoding rules 2 and 3 above, you may add hex or decimal values using the hex and decimal fields just below the Send String text box. Adding a hex number to your Send String with the tool simply places the "%" prefix in front of the value you enter, with no conversions. Adding a decimal number first converts the decimal number to the hex equivalent and correctly places the "%" prefix in front of it within the send string.
If the Send History log has been started, the send string should appear in that display once the "Send" button is pressed.
25
Serial Settings - Dipswitch Override
The final Serial diagnostic allows you to override the dipswitch settings for the port specified at the top of the page:
These are standard settings for serial applications: Baud, Parity, Data Bits, Stop Bits, and Handshaking. You may also choose whether to use RS-232 or RS-422/285 signal levels.
MEMORY: System Memory Information
System memory information is available for the CRM-WIC.
File space reflects the hard disk space available for custom web pages.
RAM reflects the status of the system memory. 26
LOG: Log Files
Log files for the CRM-WIC servers are available for the CRM-WIC. An admin may review or clear (reset) the logs from this page:
RPC Server Info
Displays the build date and version number of the RPC server. Also displays all tokens and methods available from the server.
RPC Server Commands
Logs all HTTP Post calls to the server. Active X calls are not logged.
FTP Server Connections & Commands
Logs the FTP activity on the CRM-WIC.
Web Server
Logs the HTTP activity on the CRM-WIC's web server.
27
F/W: Firmware
The Firmware page on the CRM-WIC will walk you through a CRM-WIC firmware update:
First, you will be prompted for the firmware files. Firmware upgrade files will have either the extension .AFW for operating system upgrades, or .ABT for bootstrap loader upgrades.
Once your upgrade file has been located, the web page will tell you the tftp command line you will need to execute to upload the file into your CRM-WIC. It will look something like:
tftp -i [IP Address] put [Filename with Full Path]
If ActiveX is enabled for your web browser, you may also request that the CRM-WIC create a batch file CRM-WICload.bat that will execute this command. The batch file will be placed at the root of your local drive.
To actually upload the file, click the "Ready to Download Firmware" button. The blue Status LED will turn OFF, and all the Serial LEDs for both ports will be on. You will now need to upload the OS or boot file using a tfpt client.
To use the default Windows tftp client, open a Command Line (or DOS Shell) window and execute the tftp command shown on your web page OR simply execute the batch file. Alternatively, you may double­click on the batch file.
While the file is uploading, the serial LEDs will blink one at a time. Once the file is uploaded, the CRM­WIC will reset, and you will be able to access the CRM-WIC’s web pages again.
Two important notes:
• You will not be able use the CRM-WIC for anything else while it is in the firmware upgrade mode.
• You may only update one firmware file at a time. If you wish to update both the boot-strap loader and firmware, you will need to completely upload one first, then repeat the entire process for the other.
28
Events (See section: The Event Manager)
Details of the Event Manager are described in the section, The Event Manager.
Files
This link will simply take you to the CRM-WIC's ftp server:
ftp://[IP Address or Host Name]/
Any custom web pages uploaded to the /wwwpub directory may be viewed at:
http://[IP Address or Host Name]/
29
The Event Manager
The Event Manager is a feature of the CRM-WIC that allows you to program the CRM-WIC to perform operations autonomously. With the Event Manager, you can associate different hardware or software events with actions to be performed directly on the CRM-WIC. There is then no need to continuously control the CRM-WIC using some client side software. Client side software can then be used to simply check the CRM-WIC’s status.
Overview of Events, Actions, & Variables
In the simplest terms, when certain conditions in hardware or variables are met, the CRM-WIC may be programmed to automatically perform specified tasks. To put this into the context of EVENTS, ACTIONS, and VARIABLES:
• An EVENT is triggered when conditions in hardware reaches a user-defined state, or when a value of a user-defined VARIABLE matches a user-defined constant.
• Once triggered, the EVENT can fire one or more ACTIONS.
• The conditions in hardware are typically read from one of the ports or the internal clock.
• Under many circumstances, user-defined states and constants can be written as expressions.
30
Loading...
+ 69 hidden pages
Buy Points How it Works FAQ Contact Us Questions and Suggestions Privacy Policy Cookie Policy Terms of Use