The Lauer SCOM Protocol is designed for controlling different Beijer Electronics
devices remotely over different kind of interfaces. It is based on the SCOM Protocol,
allowing easy replacement of existing units. Besides the standard command set, the
Lauer SCOM Protocol includes a rich set of special purpose commands for extended
remote controlling options. The SCOM Protocol is extended with these special features, without affecting the compatibility.
Some of the major extensions are:
• Special purpose command set available with the new SCOM command “LAU”.
• Extended address field functionality, which enables device grouping, allowing a total count of 240 devices in a network (15 groups, 16 devices in each group).
All examples in the manual are intended solely to increase understanding of the software’s functionality and
use. Beijer Electronics AB bears no responsibility if these examples are used in actual applications.
Because of the large number of application areas for this software, users must acquire the appropriate knowledge to use the software properly for their specific applications. Persons responsible for the application must
themselves ensure that each application is in compliance with all relevant requirements, standards and legislation in respect to configuration and safety.
Beijer Electronics AB assumes no responsibility for damages that may occur during installation or use of the
software.
Beijer Electronics AB hereby forbids all modification of the software.
A command can be sent either using the serial interface (RS232 or RS485) or the
USB interface.
This is the default configuration for the two interfaces:
Interface typeDefault configuration
Serial (RS232 or RS485) 9600 bits/second, 8 data bits, 1 start bit, 1 stop bit, no parity
USBFull speed
Beijer Electronics, MAEN9935
Message Format and Description
2Message Format and Description
An SCOM message is a stream of bytes, containing the destination, type of message
and the corresponding data, if available. The complete stream is protected by two
checksums. Data transfer is initiated by sending a command message. Depending on
the command, a response message may be sent back. Some commands may contain
sub-commands and data, which are sent in the data field of the message.
SCOM Message Basic Format
Byte
Field
012345 6 7...7 + [LEN]
ATNADRCMDLENICHKHDATAICHKD
Each field of the message is described in the following table:
ByteFieldValueSizeDescription
0ATN
1ADR
2
34CMD
0x07 (BELL):
Command
0x06 (ACK):
Acknowledge
0x15 (NAK):
Negative
Acknowledge
0x00 to 0xEF:
Device group/
address
0xFF:
Broadcast address
0xF0 to 0xFE:
Unused address
range
0x42 0x52 0x54:
“BRT”
0x4D 0x41 0x4E:
“MAN”
0x56 0x45 0x52:
“VER”
0x50 0x4F 0x54:
“POT”
0x4D 0x43 0x43:
“MCC”
0x54 0x59 0x50:
“TYP”
0x45 0x54 0x43:
“ETC”
0x4C 0x41 0x55:
“LAU”
1 byte
1 byte
3 bytes
Identifies the start of a new message. T he
type of message is given by its value. Data
transfer is always initiated by using the
Command message type. Depending on
the command, a response message of type
Acknowledge or Negative Acknowledge
may be sent back by the destination.
Defines the destination of a command
message or the source of the response
message. A unique device group/address
can be assigned to each device in a
network, and then individually address ed
using this field. By default, all devices
also support the Broadcast address and
can be controlled simultaneously. In this
case, no response messages are sent.
Contains the main command supported in
the current firmware version.
Please refer to section Command
Reference for a description of commands
and sub-commands.
6Beijer El ectr onics, MAEN99 3
Message Format and Description
ByteFieldValueSizeDescription
5LEN
6ICHKH...1 byte
7
...
7 + [LEN] ICHKD ...1 byte
0 to 74
(0x00 to 0x4A)
DATA...
1 byte
0 to 74
bytes
82 bytes
The size of the DATA-field in bytes.
To protect the message header
(bytes 0 to 5), a simple 8-bit checksum is
calculated as follows:
Calculate the sum of bytes 0 to 5.
1.
Reduce the sum width to 8 bits
2.
(AND 0xFF).
3.
Invert all bits. The result is ICHKH.
The checksum is verified as follows:
Calculate the sum of bytes 0 to 6.
1.
Reduce the sum width to 8 bits (AND
2.
0xFF).
3.
The result should be 0xFF.
Optional field.
If the LEN-field is not 0, this field contains
sub-commands and/or data for the
specified command. If the LEN -f ie l d is 0,
no data is avail a bl e .
Optional field. Only sent if data is
available (LEN ≠ 0).
T o protect the data (bytes 7 to 7+(LEN-1)),
a simple 8-bit checksum is calculated as
follows:
1.
Calculate the sum of bytes 7 to
7+(LEN-1)
2.
Reduce the sum width to 8 bits (AND
0xFF)
3.
Invert all bits. The result is ICHKD.
The checksum is verified as follows:
1.
Calculate the sum of bytes 7 to 7+LEN
2.
Reduce the sum width to 8 bits (AND
0xFF)
3.
The result should be 0xFF
As shown in the table, the DATA field is optional. If the message does not require
any data, the value of LEN is 0 and the field ICHKD is not used and not sent. In
this case the message has the minimum SCOM size of 7 bytes (bytes 0 to 6).
If a command requires data to be sent, the maximum size of an SCOM message is 82 bytes. This means, that the last field ICHKD is located at the offset of the first data
byte plus the value of the LEN field.
The maximum value of the LEN field is 74, which is calculated as:
By default, a Beijer Electronics RBC supports the standard SCOM addressing
scheme, which allows a total count of 16 devices within a network. The address of a
device is set with four DIP switches. If an SCOM command is sent to a device, the
ADR field must contain either the broadcast address 0xFF, or the address of the destination device set by the DIP switches. To eliminate this limit, a new addressing
scheme is supported by the Beijer Electronics RBC.
According to the previous chapter, the width of the ADR field is 1 byte (or 8 bits).
The standard SCOM addressing scheme uses only the lower 4 bits of this field (only
in case of the broadcast address, all bits are used), allowing a maximum of 16 addresses.
Related information
Message Format and Description
The new addressing scheme, implemented in Beijer Electronics RBC, uses also the 4
upper bits. To distinguish between the standard and new addressing scheme, these
bits are called “group bits” or simply “group”. Based on this definition, the following
table shows field ADR in more detail:
ADR bits 15...8ADR bits 7...0
Group
(0 … 14)
Address
(0 … 15)
As shown in the table, a group between 0 and 14 can be specified. Group 15 is not
supported, to avoid address collision with the broadcast address. Thus, together with
the address field, a total count of 15 x 16 = 240 devices can be connected to one network.
Grouping of devices is activated only, if the devices are set up to use the software configured address, instead of the hardware address specified by the DIP switches. If the
device uses the hardware address, the group address is automatically set to 0, regardless of the group configuration.
Beijer Electronics RBC addresses are always given in a dotted notation as “group.address”. This means, if a device belongs to group 7 and its address is 3, the resulting
address will be 7.3, which is 115 (0x73). In the standard mode (i.e. DIP switch address is used), the device address will be 0.3 (or simply 3) for the given example, because the group bits are set to 0.
If a Beijer Electronics RBC is configured as remote controller (default), it addresses
all reachable devices by sending a broadcast command.
8Beijer El ectr onics, MAEN99 3
Protocol Description and Timings
4Protocol Description and Timings
The protocol used for transferring SCOM messages and receiving response messages
is optimized for easy software implementation. Regardless of the type of interface, a
connected device is always passive and listening for a command to be received by any
available communication interface. A Beijer Electronics RBC never sends SCOM
messages by itself, unless it is configured as a remote controller.
If a device receives an SCOM message from any interface, it verifies the message and
checks the address field ADR. In case of an address match between the received address and the device address, the command is processed.
If the broadcast address 0xFF is received, a command is always processed by any device in the network. Depending on the received address and the type of the interface,
a response message (ACK or NAK) might be sent back to the interface, from which
the command was received.
If a device is individually addressed and a serial port (RS232 or RS485) is used, the
next command shall not be sent until a delay time called Inter-message gap. The
Inter-message gap depends on the baud rate and is calculated as shown below:
5 x 10
Ti =
b
Ti: Inter-message ga p [s]
b: Baud rate [bits/second]
Example
Inter-message gap at 9600 baud: Ti = 5 x 10 / 9600 ≈ 0.0052 s = 5.2 ms
Beijer Electronics, MAEN9939
Protocol Description and Timings
Conditions for Response Message
The conditions for a response message generated by the Beijer Electronics RBC are
described below:
InterfaceAddr ess conditionCommand statusResponse
RS232Address does not match
device address
Address matches device
address
Address is Broadcast
address (0xFF )
RS485Address does not match
device address
Address matches device
address
Address is Broadcast
address (0xFF )
USBAddress does not match
device address
Address matches device
address
Address is Broadcast
address (0xFF )
Delayed Response
not EXECUTEDNo response
not EXECUTEDNo response
if COMPLETEDACK
if FAILEDNAK
if COMPLETEDACK
if FAILEDNAK
not EXECUTEDNo response
not EXECUTEDNo response
if COMPLETEDACK
if FAILEDNAK
if COMPLETEDDelayed ACK
if FAILEDNo response
not EXECUTEDNo response
not EXECUTEDNo response
if COMPLETEDACK
if FAILEDNAK
if COMPLETEDACK
if FAILEDNAK
If a Beijer Electronics RBC receives an SCOM message with a broadcast address from
the RS485 interface and the command is completed, the generated response message
is sent after a delay time. This is required, because many devices can be attached to
the RS485 bus, but only one device can claim the line for its communication. The
delay guarantees that each response message is sent one after one, even if all devices
have received the broadcast message and processed it at the same time, avoiding a collision on the RS485 bus.
The length of the delay time depends on the device address and maximum length of
a response message, and is calculated according to the following formula:
(2.5 + Lr) x 10 x N
Te =
b
Te: Bro ad cast command response [s]
Lr: Maximum length of response message
N: Device address + 1
b: Baud rate [bits/second]
10Beijer Electronics, MAEN993
Protocol Description and Timings
The Lr value depends on the command, for which the response message is generated.
Detailed information and the “Maximum Lr value” for each response message can be
found in Command Reference chapter.
Note:
The given “Maximum Lr value” is specified for a valid command. If an invalid command
with a data field exceeding the specifica tion is sent, the Lr value will grow accordingly.
Related information
Command Reference
Example
Broadcast command response for command BRT, sent by device with address 7 at
9600 baud: Te = (2.5 + 9) x 10 x 8 / 9600 ≈ 0.0958 s = 95.8 ms
The delay time Te is inserted by the device automatically, only if the RS485 interface
is selected for the communication. If the RS232 or USB interface is used, the response message is generated and sent as fast as possible.
The RS232 communication does not require a delay time due to the point-to-point
communication, where only two devices can be attached to the line (i.e. host and
Beijer Electronics RBC or Beijer Electronics RBC and Beijer Electronics RBC). USB
communication is similar to the RS485 communication, where many devices can be
attached to the same line. However, in contrast to the RS485 interface, a collision is
handled by the USB architecture and software, so there is no need for anti-collision
support within the device.
Beijer Electronics, MAEN99311
Protocol Description and Timings
12Beijer Electronics, MAEN993
Command Reference
5Command Reference
The Lauer SCOM protocol exposes many commands for remote control of a Beijer
Electronics RBC by a dedicated software. It supports all standard SCOM commands,
as well as the new Lauer command set for special purpose functions.
This chapter describes each SCOM command and sub-commands for the currently
available device, Beijer Electronics RBC.
Although each Beijer Electronics RBC is based on the same base firmware and uses
the same communication, some commands/sub-commands are hardware dependant
and not supported for each device of the series, due to the differences within the device hardware. These differences and required firmware versions are indicated in detail for each command description.
Note:
Response messages may be generated and sent back, even if the commands/sub commands are not supported within a particular firmware version or if they are invalid.
Beijer Electronics, MAEN99313
Command Reference
5.1BRT
Backlight Brightness
Sets the backlight level to the given value. This command affects only the brightness
of the backlight lamp or LED array, not the brightness value of the video controller.
Value:0: dark … 255: bright
Type:Byte
Length:1
Descript i on:New backlight level
Response Message (Ack n o wledge)
012345678
0x06ADR
Backlight level
0x420x520x540x01ICHKH Backlight level ICHKD
Value:0: dark … 255: bright
Type:Byte
Length:1
Descript i on:Current backlight l evel
Response Message (Negati v e Ack n owl ed g e)
012345678
0x15ADR
Backlight level
0x420x520x540x01ICHKH Backlight level ICHKD
Value:0: dark … 255: bright
Type:Byte
Length:1
Description: Last backlight level
Maximum Lr for this Command
9
14Beijer Electronics, MAEN993
Command Reference
Example 1
Set the backlight level of device at address 0.7 (group 0, address 7) to 130 (0x82):
012345678
0x070x070x420x520x540x010x080x820x7D
Device at address 0.7 (group 0, address 7) has acknowledged the new backlight level
130 (0x82):
012345678
0x060x070x420x520x540x010x090x820x7D
Example 2
Send an invalid “BRT” command to the device at address 0.7 (group 0, address 7).
The command has two data bytes, but “BRT” accepts only one byte:
01234567...89
0x070x070x420x520x540x020x070xFF0xFF0x01
Device at address 0.7 (group 0, address 7) has not accepted the command. Instead,
it sent a negative acknowledge with the current backlight level 128 (0x80). The
length of the response message exceeds the specified value 9, because of the invalid
data field length:
01234567...89
0x150x070x420x520x540x020xF90x820xFF0x80
Beijer Electronics, MAEN99315
Command Reference
5.2MAN
Manufacturer ID
Requests the manufacturer ID from the device. The manufacturer ID is a short, max.
7 character ASCII-string containing the manufacturer specific code.
For devices manufactured by Beijer Electronics, the returned code is always “LAU”.
Supported since Firmware Version
LAUER RBC: 0.0.0.1
Command Stream
0123456
0x07ADR
0x4D0x410x4E0x00ICHKH
(This command has no data)
Response Message (Ack n o wledge)
01234567...7+[LEN]-17+[LEN]
0x06ADR
Manufacturer ID
0x4D0x410x4ELENICHKHManufacturer IDICHKD
Value:ASCII characters
Type:String
Length:0...7
Description: ASCII-string containing the manufacturer ID
Response Message (Negati v e Ack n owl ed g e)
Under normal operation conditions, a device never sends a negative acknowledge in
response to this command.
Maximum Lr for this Command
15
Example
Query the manufacturer ID of the device at address 0.7 (group 0, address 7):
0123456
0x070x070x4D0x410x4E0x000x15
The device at address 0.7 (group 0, address 7) has returned “0x4C 0x41 0x55”, which
represents the ASCII-string “LAU”, indicating that the device is manufactured by
Beijer Electronics:
01234567...910
0x060x07
16Beijer Electronics, MAEN993
0x4D0x410x4E0x030x130x4C0x410x550x1D
Command Reference
5.3VER
Unit ID and Model / Version Number
Requests the preassigned unit ID and model code, and the version of the serial
communications interface software. For compatibility reasons, this code is always
static and does not return information specific to Beijer Electronics RBC. To get device informations specific to Beijer Electronics RBC, such as firmware version etc.,
use the Lauer Extension command “LAU”.
Supported since Firmware Version
LAUER RBC: 0.0.0.1
Command Stream
0123456
0x07ADR0x560x450x520x00ICHKH
(This command has no data)
Response Message (Acknowledge)
01234567...910
0x06ADR
Unit ID / Version
0x560x450x520x03ICHKH Unit ID / VersionICHKD
Value:0…255 each byte
Type:Byte array
Length:3
Description: Static unit ID, model and version number
Response Message (Negative Acknowledge)
Under normal operation conditions, a device never sends a negative acknowledge in
response to this command.
Maximum Lr for this Command
11
Example
Query the unit ID, model and version number of the device at address 0.7 (group 0,
address 7):
0123456
0x070x070x560x450x520x000x04
The device at address 0.7 (group 0, address 7) has returned “0x01 0x01 0x00”, which
indicates model 1, version 1.0:
01234567...910
0x060x070x560x450x520x030x020x010x010x000xFD
Beijer Electronics, MAEN99317
Command Reference
5.4POT
Local Control
Enables or disables the local backlight level control. If the local backlight control is
enabled, the backlight level can be changed using the front panel buttons and by remote control (RS232, RS485 or USB interface). If the local backlight control is disabled, the backlight level cannot be changed using the front panel buttons. It can still
be changed by any remote control message.
Supported since Firmware Version
LAUER RBC: 0.0.0.1
Command Stream
012345678
0x07ADR0x500x4F0x540x01ICHKH Local controlICHKD
Local control
Value:0x00: Disable local backlight control
0xFF: Enable local backlight control
Type:Byte
Length:1
Description: New local control configuration
Response Message (Ack n o wledge)
012345678
0x06ADR0x500x4F0x540x01ICHKH Local controlICHKD
Local control
Value:0x00: Local backlight control disabled
0xFF: Local backlight control enabled
Type:Byte
Length:1
Description: Current local control configuration
Response Message (Negati v e Ack n owl ed g e)
012345678
0x15ADR0x500x4F0x540x01ICHKH Local controlICHKD
Local control
Value:0x00: Local backlight control disabled
0xFF: Local backlight control enabled
Type:Byte
Length:1
Description: Last local backlight control configuration
18Beijer Electronics, MAEN993
Command Reference
Maximum Lr for this Command
9
Example 1
Disable the local control of device at address 0.7 (group 0, address 7):
012345678
0x070x07
0x500x4F0x540x010xFD0x000xFF
Device at address 0.7 (group 0, address 7) has acknowledged, that the local control
is disabled:
012345678
0x060x07
0x500x4F0x540x010xFE0x000xFF
Example 2
Send an invalid “POT” command to the device at address 0.7 (group 0, address 7).
The command uses an invalid value 0x90 for “Local control”:
012345678
0x070x07
0x500x4F0x540x010xFD0x900x6F
Device at address 0.7 (group 0, address 7) has not accepted the command. Instead,
it sent a negative acknowledge with the current local control mode 255 (0xFF):
012345678
0x150x07
0x500x4F0x540x010xEF0xFF0x00
Beijer Electronics, MAEN99319
Command Reference
5.5TYP
Unit Type and Model Number
Queries the device type and model.
Supported since Firmware Version
LAUER RBC: 0.0.0.1
Command Stream
0123456
0x07ADR
0x540x590x500x01ICHKH
(This command has no data)
Response Message (Ack n o wledge)
01234567...7+[LEN]-1 7+[LEN]
0x06ADR0x540x590x50LENICHKH Type/ModelICHKD
Type/Model
Value:ASCII characters
Type:String
Length:1...15
Descript i on: Devic e type and mode l
Response Message (Negati v e Ack n owl ed g e)
0123456
0x15ADR
0x540x590x500x00ICHKH
(No data is returned, in case of a negative acknowledge)
Maximum Lr for this Command
23
Example
Query the unit type and model of the device at address 0.7 (group 0, address 7):
0123456
0x070x070x540x590x500x000xF4
According to the data returned by the device (“Lauer RBC”) at address 0.7 (group 0,
address 7), this is a device of the Beijer Electronics RBC series:
01234567-15
0x060x070x540x590x500x090xEC0x4C0x610x750x65
7-1516
0x720x200x520x420x430xB9
20Beijer Electronics, MAEN993
Loading...
+ 44 hidden pages
You need points to download manuals.
1 point = 1 manual.
You can buy points or you can get point for every manual you upload.