Zektor SERIALOPTION User Manual

0 (0)
Zektor SERIALOPTION User Manual

ZEKTORTM 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: Pin 2 (Transmit from Serial Slot option to the PC)

Receive: Pin 3 (Receive from the PC to the Serial Slot option)

Signal GND: Pin 5

Serial Port Settings

Baud Rate:

9600

Data Bits:

8

Parity:

None

Stop Bits:

1

The Command String Format

<cmd><parameters><CR>

Where:

<cmd>

= The RS-232 command.

<parameters>= Optional parameters required by some commands.

<CR>

= The Carriage Return character used to terminate the command.

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

+<CR><LF>

3

Where:

+

= The ‘+’ character.

<CR><LF>

= 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

!<error code>

Where:

! = The ‘!’ character.

<error code>= 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

=<cmd><parameter><CR><LF>

Where:

=

= The ‘=’ character.

<cmd>

= The status command’s command character.

<parameter> = The command’s status.

<CR><LF> = The carriage return / line feed characters.

Status commands returned from the RS-232 interface are easily parsed, for they all begin with the ‘=’ character. Status string:

=<cmd><status><CR><LF>

Where:

=

= The ‘=’ character.

<status>

= The status of the current command, usually a numeric ASCII value.

<CR><LF>

= The Carriage Return and Line feed characters.

4

ZEKTORTM

The MAS3

Serial Option

5

 

The MAS3 Command Set

 

 

 

 

Power Control

 

P0<CR>

Turn off power

P1<CR>

Turn on power

P+<CR>

Toggle power

P?<CR>

Request power status

Select Channel

 

C1<CR>

Select Channel 1 (Note 1)

C2<CR>

Select Channel 2 (Note 1)

C3<CR>

Select Channel 3 (Note 1)

C+<CR>

Select the next higher channel (Note 2)

C-<CR>

Select the next lower channel (Note 2)

C?<CR>

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<CR>

Set lamps to the dim setting

L1<CR>

Set lamps to the bright setting

L2<CR>

Set lamps to the auto-dim setting

L+<CR>

Cycle through intensity settings

L?<CR>

Request the current intensity status

6

Auto Status Control

X0<CR>

Turn off auto-status transmissions

X1<CR>

Turn on auto-status transmissions

X?<CR>

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<CR>’ is issued, these above actions will not automatically be sent, but will be buffered.

When ‘X1<CR>’ 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+<CR>’ will only be followed by the ‘+<CR><LF>’ acknowledgement string.

See the section on MAS3 status strings for the syntax of the status strings.

Query Command Status

Q<CR> Request information on MAS3 command states

If the command ‘X0<CR>’ 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<CR>

Save MAS3’s current state as the power on default

Request Version

V<CR> 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 <CR><LF>. 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

+<CR><LF> 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

!<error><CR><LF> Indicate an error in the previous command.

The response to a command that caused an error.

<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<power><CR><LF> Return the current power state

<power> = 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<chan><CR><LF> Return the current channel

<chan> = 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<setting><CR><LF> Return the current lamp intensity state

<setting> = A one digit ASCII value that indicates the current Lamp Intensity setting. 0 - Dim setting.

1 - Bright setting.

8

Loading...
+ 16 hidden pages