ZEKTOR TM Z-SLOT RS-232 Serial Port Option Serial Option www.zektor.com 400-000006-08 (Rev 8) 4/19/05 Copyright © 2005 Zektor, LLC. All rights reserved. 2 An RS-232 Overview The RS-232 interface for Zektor products has been designed to be simple, straight forward and still allow the installer full access to the capabilities of the product being controlled. · The cable used to connect to a standard PC is a straight through RS-232 cable. The same type of cable used to connect to a standard serial modem. · All commands sent to the RS-232 interface consist of the command followed by a carriage return. · All commands follow the same format. · For easy parsing all strings returned from the RS-232 interface are identified by the first character of the string. · There are only 3 possible response codes coming from the interface. They are identified by the 3 following characters: `+' - The acknowledgement of a valid command. `!' `=' - The command caused an error (followed by the error code). - Indicates a status string (followed by the status string). · All status strings follow the same format. · All status strings are always terminated with a carriage return / line feed combination to allow for easy buffering of returned strings. Pinout Transmit: Receive: Signal GND: Pin 2 (Transmit from Serial Slot option to the PC) Pin 3 (Receive from the PC to the Serial Slot option) Pin 5 Serial Port Settings Baud Rate: Data Bits: Parity: Stop Bits: 9600 8 None 1 The Command String Format Where: = The RS-232 command. = The Carriage Return character used to terminate the command. = Optional parameters required by some commands. All commands will be acknowledged, with either a simple acknowledgment string, or an error code, depending upon the command's successful execution. The Acknowledgment String + 3 Where: + = The `+' character. = The Carriage Return and Line feed characters. Every command that does not cause an error will be responded to with the acknowledgement string. This includes commands that request status. Status commands are acknowledge with this string, and then followed by the status response string. The Error Response ! Where: ! = The `!' character. = An numeric ASCII value indicating the error encountered. Any command that causes an error will be acknowledge with the error response string instead of a `+' prefixed acknowledgement string. For simple parsing of strings, the installer can simply look for the `+' or `!' in response to a command. Or the `!' response can be more fully parsed to determine what caused the error. The Status Response String = Where: = = The `=' character. = The status command's command character. = The carriage return / line feed characters. = The command's status. Status commands returned from the RS-232 interface are easily parsed, for they all begin with the `=' character. Status string: = Where: = = The `=' character. = The status of the current command, usually a numeric ASCII value. = The Carriage Return and Line feed characters. 4 ZEKTOR TM The MAS3 Serial Option 5 The MAS3 Command Set Power Control P0 P1 P+ P? Turn off power Turn on power Toggle power Request power status Select Channel C1 C2 C3 C+ C- C? Select Channel 1 (Note 1) Select Channel 2 (Note 1) Select Channel 3 (Note 1) Select the next higher channel (Note 2) Select the next lower channel (Note 2) Request current channel status (Note 3) Note 1: If power is off, this command will turn on power and then select the specified channel. Note 2: If power is off, this command will be ignored. Note 3: Returns channel status, if power is off, returns channel to be selected when power is applied. Set Front Panel Lamp Intensities L0 L1 L2 L+ L? Set lamps to the dim setting Set lamps to the bright setting Set lamps to the auto-dim setting Cycle through intensity settings Request the current intensity status 6 Auto Status Control X0 X1 X? Turn off auto-status transmissions Turn on auto-status transmissions Request current auto status setting The MAS3 can be set to send a status message when any of the following occur (outside of an RS-232 command): · A new channel is selected. Sends a Channel Status string · The power state changes. Sends a Power Status string · The state of the lamp intensity changes. Sends a Lamp Status string The responses are identical to the responses you receive when you request the information using the "?" parameter for each of the above commands. When `X0' is issued, these above actions will not automatically be sent, but will be buffered. When `X1' is issued, any pending status messages will be sent, and from then on, any of the above actions will cause a status message to be immediately sent. Status changes made through the RS-232 will not cause the above status strings to be automatically sent. For instance, a button press will send a Channel Status string, an IR remote Channel change will send a Channel Status string, however the command `C+' will only be followed by the `+' acknowledgement string. See the section on MAS3 status strings for the syntax of the status strings. Query Command Status Q Request information on MAS3 command states If the command `X0' has been issued then command statuses will not be immediately sent but instead buffered. This command returns a bitmap that indicates what statuses are buffered and need to be read. See the section on MAS3 status strings for the syntax of the returned string. Save Current State As Power On Default S Save MAS3's current state as the power on default Request Version V Request the MAS3's version 7 The MAS3 Response Strings The section list the strings returned from the MAS3. All MAS3 strings are terminated with the characters . Strings will start with only one of three characters: `+' `!' `=' - Acknowledgement of a valid command. - Command caused an error (followed by the error code). - Start of a status string (followed by the status string). Acknowledgement String + Acknowledge an error free command. Acknowledge an error free command was received by the MAS3. All commands are acknowledged with either this string or the Error Code String if an error occurred processing the command. Error Code String ! Indicate an error in the previous command. The response to a command that caused an error. = A single digit ASCII value that indicates the error. 1 - Unknown command. 2 - Error in command's parameters (out of range, or invalid). Power Status String =P Return the current power state = A one digit ASCII value that indicates the power state of the MAS3 0 - MAS3 is OFF. 1 - MAS3 in ON. Channel Status String =C Return the current channel = A one digit ASCII value that indicate the current channel of the MAS3. 1 - MAS3 is set to channel 1. 2 - MAS3 is set to channel 2. 3 - MAS3 is set to channel 3. Lamp Intensity Setting =L Return the current lamp intensity state = A one digit ASCII value that indicates the current Lamp Intensity setting. 0 - Dim setting. 1 - Bright setting. 8 2 - Automatic bright to dim setting. Query Command Status String =Q Return buffered status state of the MAS3 = A one digit ASCII value that indicates the pending status commands. 0 - No commands pending. 1 - Power status string is pending. 2 - Channel status string is pending. 3 - Power & Channel status strings are pending. 4 - Lamp Intensity status string is pending. 5 - Power & Lamp status strings are pending. 6 - Channel & Lamp status strings are pending. 7 - Power, Channel & Lamp status strings are pending. If a `X1' command has been issued to the MAS3, then the results of the `Q?' command will always be 0. If a `X0' command has been issued and any of the above states change, the command will be buffered awaiting the proper status request to be issued. This command string returns a status of which MAS3 states have changed and need to be read by the controller. Version Status String =V Return the MAS3 version string. = A string of ASCII characters that identifies the MAS3 and its version. 9 10 ZEKTORTM The HDS4.2 Serial Option 11 The HDS4.2 Command Set Power Control P0 P1 P+ P? Turn off power Turn on power Toggle power Request power status Button Emulation B1 B2 B3 B4 B5 B? Same as pressing Select 1 Button Same as pressing Select 2 Button Same as pressing Select 3 Button Same as pressing Select 4 Button Same as pressing Power Button Request pending button status (Note 1) The `B' command is only available on firmware versions 1.1 or later. Note1: This returns the last button pressed on the HDS4.2 front panel, and not the last `Bx' command sent to the HDS4.2. A value of `B0' will be sent if no button on the HDS4.2 has been pressed since power was applied. Select Channel C1 C2 C3 C4 C+ C- C? Select Channel 1 (Note 1) Select Channel 2 (Note 1) Select Channel 3 (Note 1) Select Channel 4 (Note 1) Select the next higher channel (Note 2) Select the next lower channel (Note 2) Request current channel status (Note 3) Note 1: If power is off, this command will turn on power and then select the specified channel. Note 2: If power is off, this command will be ignored. Note 3: Returns channel status, if power is off, returns channel to be selected when power is applied. Set Front Panel Lamp Mode L0 L1 L2 L3 L+ L? Set lamps to the dim setting Set lamps to the bright setting Set lamps to the auto-dim setting Turn off front panel LEDs (Note 1). Cycle through intensity settings 0-2. Request the current intensity status Note 1: When Front Panel lights are turned off, the user has no way of knowing unit is powered on, or what channel is selected. This setting should only be used when the HDS4.2 is fully under serial control. The `L3' (turn off front panel LEDs) is only available on firmware versions 1.1 or later. 12 Set Front Panel Intensities I Where: = The minumum (dim) intensity level of the front panel LEDs (0-255). = The maximum (bright) intensity level of the front panel LEDs (1-255). Minimum intensity must be less than the maximum intensity. If is set to zero (LEDs blanked) the DIM Lamp Mode setting `L0' will no longer be available. When attempting to set the Lamp Mode to DIM, BRIGHT will be used instead. This keeps the user from inadvertantly turning off the front panel LEDs by setting the DIM mode using the IR remote. The proper way to turn off the front panel is by issuing the `L3' command. The `I' command is only available on firmware versions 1.1 or later. Set the minimum and maximum front panel intensities. Control Bits X0 Where: ControlBits = Status control bits. This is a bitmapped value, given in decimal. Bit 7 6 5 4 3 2 IR 1 KB 0 AS 0 0 IR KB AS X? 0 0 0 0 Reserved, always set to 0. 0=Normal IR (default), 1=IR control disabled. 0=Normal Keyboard (default), 1=Keyboard selection disabled. 0=Auto-status off (Polled Mode), 1=Auto-status transmissions enabled. Request current ControlBits setting The HDS4.2 can be set to send a status message when any of the following occur (outside of an RS-232 command): · A new channel is selected. Sends a Channel Status string · The power state changes. Sends a Power Status string · The state of the lamp intensity changes. Sends a Lamp Status string · A button is pressed on the front panel. Sends a Button Status string (Note 1) The responses are identical to the responses you receive when you request the information using the "?" parameter for each of the above commands. When `X0' is issued, these above actions will not automatically be sent, but will be buffered. When `X1' is issued, any pending status messages will be sent, and from then on, any of the above actions will cause a status message to be immediately sent. Status changes made through the RS-232 will not cause the above status strings to be automatically sent. For instance, a button press will send a Channel Status string, an IR remote Channel change will send a Channel Status string, however the command `C+' will only be followed by the `+' acknowledgement string. See the section on HDS4.2 status strings for the syntax of the status strings. Note 1: The Button Status string is only sent automatically when the HDS4.2 front panel is disabled and the 'AS' bit is set to `0'. Note 2: The `IR' and `KB' bits are only available in firmware version 1.1 or later. Query Command Status Q Request information on HDS4.2 command states If th ...