Proemion Byte Command Protocol Binary commands User Manual

Byte Command Manual

Byte Command Protocol Binary commands

The Byte Command Manual describes the commands and their structure of the Proemion Byte Command Protocol to used by a remote host and the CAN network for message transmissions.

General

The Byte Command Manual describes the structure and commands used by the Proemion Byte Command Protocol.
This protocol is supported by all CAN to PC gateways from Proemion GmbH for communication with a remote host via the interface supported by the device.
The following manual extends the device specific manuals.
In case of uncertainties please also refer to the device manuals of your specific gateway device.
The CAN to PC gateways connect a CAN network to a remote host using a specific interface like RS232, USB, Ethernet, Bluetooth or WLAN.
The Proemion Byte Command Protocol serves for bi-directional transparent CAN message transmission between the host and the CAN network as well as for the transfer of commands between host and gateway.
Since all Proemion CAN to PC gateways work on the same protocol, any application software can be easily extended to use different communication interfaces by just exchanging the basic communication routines.
Most of the commands are supported by all gateways, in some cases special commands are not supported by single devices.
The table in chapter Commands and Devices gives you an overview on the commands supported by each single gateway-type.

NOTE
Normally all commands which influence devices settings are only stored in the volatile RAM memory of the gateway, after a reset the settings stored in the devices non-volatile memory are used again.
You can change these settings with the device specific configurator software or – if supported by the device – via CANopen.
Exception: The command “CAN baud rate” is stored permanently.
For some gateways it is possible to change start-byte (default: 0x43) and stop-byte (default: 0x0D) in the configurator software.
All descriptions in this manual assume that the default values are used.
For further information and support fill out the support form, see Service and Support.
The latest versions of the drivers, software, firmware and documentations are available on our website: Download Center.

1.1. Service and Support
The latest versions of the drivers, software, firmware, and documentation are available in our Document Library.

Do you need help or want to report a bug?
Visit our website Proemion for more information, or raise a ticket at the Support.

Byte Mode Commands

2.1. Command Format (Byte Mode)

SOF
(Start of Frame)| 0x43| SOF marks the beginning of the command.
‘C’ (0x43) is the default setting. For some devices this  value can be changed. This manual always  shows the default setting.
Length| 0x00-0xFF| The  length byte includes the number of data bytes the number of command bytes following.
Command| 0x00-0xFF| Command byte, values 0x00 to 0xFE are direct commands, the value 0xFF means that the next  byte contains a command extension
Data| xx| Data content
Checksum| xx| Contains the XOR checksum of the SOF, Length, Command and the Data-bytes.
EOF
(End of Frame)| 0x0D| EOF byte marks the end of the command.
0x0D  (Carriage Return) is the default setting. For some devices this value can be changed. This  manual always shows the default setting

“–” means that this value is not of interest
“xx” means that the field contains the configuration / reply value
Each message which changes or requests the settings of the Proemion CAN device is replied by a message with the same command byte, containing the new settings.

NOTE
Request commands normally do not require additional parameters (no “Data” field).
Exceptions are mentioned in the command description.

2.1.1. Example

SOF
(Start of Frame)| 0x43| SOF marks the beginning of the command.
Length| 0x0B| The  length byte includes the number of data bytes the number of command bytes following.
Command| 0x00| 11-bit ID CAN message
Data| 0x07, 0x89, 0x11, 0x12,   0x13, 0x14,  0x15,  0x16, 0x17, 0x18| ID (0x789) (MSB first)
CAN-message Data content
Checksum| 0xCE| Contains the XOR checksum of the SOF, Length, Command and the Data-bytes.
EOF| 0x0D| EOF byte marks the end of the command.

2.2. Extended Command Format (Byte Mode)

SOF
(Start of Frame)| 0x43| SOF marks the beginning of the command.
‘C’ (0x43) is the default setting. For some devices this  value can be changed.
This manual always shows the default setting.
Length| 0x00-0xFF| The  length byte includes the number of data bytes the number of command bytes following.
Extended Command| 0xD0-0xDF| Command byte, values 0xD0  to 0xDF are extended commands
Data| xx| Byte 0: CAN-Channel (starting at 0 for CAN 1) / 128 … 255 reserved for module (WLAN /  GSM / GPS…)
Byte 1: Command
Byte 2: Data content
Checksum| 0xCE| Contains the XOR checksum of the SOF, Length, Command and the Data-bytes.
EOF| 0x0D| EOF byte marks the end of the command.

“–” means that this value is not of interest
“xx” means that the field contains the configuration / reply value

2.2.1. Example – Extended Command

SOF
(Start of Frame)| 0x43| SOF marks the beginning of the command.
Length| 0x0D| The  length byte includes the number of data bytes the number of command bytes following.
Command| 0xD0| Extended Command
Data| 0x01
0x00
0x07, 0x89, 0x11, 0x12,   0x13, 0x14,  0x15,  0x16, 0x17, 0x18,| CAN-Channel: 2
Command: 11-bit ID CAN message  ID (0x789) (MSB first)
CAN-message Data content
Checksum| 0x19| Contains the XOR checksum of the SOF, Length, Command and the Data-bytes.
EOF
(End of Frame)| 0x0D| EOF byte marks the end of the command.

2.3. Process Data Messages
These messages are used to transmit received CAN messages to the host or to send CAN messages from the host to the CAN network.

2.3.1. CAN data frame reception
CAN data frame messages received by the gateway from the CAN bus are transferred to the host interface in the following format.

SOF
(Start of Frame)| 0x43| SOF marks the beginning of the command.
Length| xx| The  length byte contains the number of data bytes the number of command bytes following.
Command| 0x00| 11-bit ID CAN message received
0x01| 11-bit ID CAN message received, message contains an additional 32- bit timestamp value.
0x02| 29-bit ID CAN message received
0x03| 29-bit ID CAN message received, message contains an additional 32- bit timestamp value.
Data| For 11-bit ID messages:
0x00-0xFF| Byte 0-1: 11-bit CAN ID (MSB first)
additional data bytes:
Up to 8 CAN data bytes an additional 32-bit timestamp value (only if timestamp option is  enabled, see below)
For 29-bit ID messages:
0x00-0xFF| Byte 0-3: 29-bit CAN ID (MSB first)
additional data bytes:
Up to 8 CAN data bytes an additional 32-bit timestamp value
(only if timestamp option is enabled, see below)
Checksum| xx| Contains the XOR checksum of the SOF, Length, Command and the Data-bytes.
EOF
(End of Frame)| 0x0D| EOF byte marks the end of the command.

NOTE
If a timestamp is desired, this option must be enabled with the corresponding command message (see Reset Device).
The usage as extended command is possible (see Extended Command Format (Byte Mode)).

2.3.2. Transmit CAN data frame
In order to transmit CAN data frame messages to the CAN bus, the host interface sends data to the gateway in the following format.

SOF
(Start of Frame)| 0x43| SOF marks the beginning of the command.
Length| xx| The  length byte contains the number of data bytes the number of command bytes following.
Command| 0x00| Transmit 11-bit ID CAN data frame
0x02| Transmit 29-bit ID CAN data frame
Data| For 11-bit ID messages:
0x00-0xFF| Byte 0-1:
11-bit CAN ID (MSB first)
additional data bytes:
Up to 8 CAN data bytes
For 29-bit ID messages:
0x00-0xFF| Byte 0-3:
29-bit CAN ID (MSB first)
additional data bytes:
Up to 8 CAN data bytes
Checksum| xx| Contains the XOR checksum of the SOF, Length, Command and the Data-bytes.
EOF
(End of Frame)| 0x0D| EOF byte marks the end of the command.

NOTE
The usage as extended command is possible (see Extended Command Format (Byte Mode)).

2.3.3. CAN remote frame reception
CAN remote frame messages received by the gateway from the CAN bus are transferred to the host interface in the following format.

SOF
(Start of Frame)| 0x43| SOF marks the beginning of the command.
Length| xx| The  length byte contains the number of data bytes the number of command bytes following.
Command| 0x04| 11-bit ID CAN remote frame received
0x05| 11-bit ID CAN remote frame received, message contains an additional 32-bit timestamp value.
0x06| 29-bit ID CAN remote frame received
0x07| 29-bit ID CAN remote frame received, message contains an additional 32-bit timestamp value.
Data| For 11-bit ID remote frames:
0x00-0xFF| Byte 0-1:
11-bit CAN ID (MSB first)
additional data bytes:
DLC (CAN remote frame Data Length Code) an additional 32-bit timestamp value (only if  timestamp option is enabled, see below)
For 29-bit ID remote frames:
0x00-0xFF| Byte 0-3:
29-bit CAN ID (MSB first)
additional data bytes:
DLC (CAN remote frame Data Length Code) an additional 32-bit timestamp value (only if  timestamp option is enabled, see below)
Checksum| xx| Contains the XOR checksum of the SOF, Length, Command and the Data-bytes.
EOF
(End of Frame)| 0x0D| EOF byte marks the end of the command.

NOTE
If a timestamp is desired, this option must be enabled with the corresponding command message (see Reset Device).
The usage as extended command is possible (see Extended Command Format (Byte Mode)).

2.3.4. Transmit CAN remote frame
In order to transmit CAN remote frame messages to the CAN bus, the host interface sends data to the gateway in the following format.

SOF
(Start of Frame)| 0x43| SOF marks the beginning of the command.
Length| xx| The  length byte contains the number of data bytes the number of command bytes following.
Command| 0x04| Transmit 11-bit ID CAN remote frame
0x06| Transmit 29-bit ID CAN remote frame
Data| For 11-bit ID remote frames:
0x00-0xFF| Byte 0-1:
11-bit CAN ID (MSB first)
additional data byte:
DLC (CAN remote frame Data Length Code)
For 29-bit ID remote frames:
0x00-0xFF| Byte 0-3:
29-bit CAN ID (MSB first)
additional data byte:
DLC (CAN remote frame Data Length Code)
Checksum| xx| Contains the XOR checksum of the SOF, Length, Command and the Data-bytes.
EOF
(End of Frame)| 0x0D| EOF byte marks the end of the command.

NOTE
The usage as extended command is possible (see Extended Command Format (Byte Mode)).

2.3.5. RS232 data frame transmit and reception

SOF
(Start of Frame)| 0x43| SOF marks the beginning of the command.
Length| xx| The  length byte contains the number of data bytes the number of command bytes following.
Command| 0x09| RS232 data frame
Data| xx| RS232 data
Checksum| xx| Contains the XOR checksum of the SOF, Length, Command and the Data-bytes.
EOF
(End of Frame)| 0x0D| EOF byte marks the end of the command.

2.3.6. Receive Optimization Block

SOF
(Start of Frame)| 0x43| SOF marks the beginning of the command.
Length| xx| The  length byte contains the number of data bytes the number of command bytes following.
Command| 0x08| Receive Optimization Block
Data| xx| Receive Optimization data
Checksum| xx| Contains the XOR checksum of the SOF, Length, Command and the Data-bytes.
EOF
(End of Frame)| 0x0D| EOF byte marks the end of the command.

2.4. Feedback messages
These messages contain feedback data which allows the user to check the correct transmission of CAN messages.

2.4.1. CAN message transmission feedback

SOF
(Start of Frame)| 0x43| SOF marks the beginning of the command.
Length| xx| The  length byte contains the number of data bytes the number of command bytes following.
Command| 0x20| 11-bit ID CAN message transmitted
0x21| 11-bit ID CAN message transmitted, feedback contains an additional timestamp of the transmission time
0x22| 29-bit ID CAN message transmitted
0x23| 29-bit ID CAN message transmitted, feedback contains an additional timestamp of the transmission time
0x24| 11-bit ID CAN remote frame transmitted
0x25| 11-bit ID CAN remote frame transmitted, feedback contains an additional timestamp of the transmission time
0x26| 29-bit ID CAN remote frame transmitted
0x27| 29-bit ID CAN remote frame transmitted, feedback contains an additional timestamp of the transmission time
0x28| 11-bit ID Transmit Server message transmitted
0x29| 11-bit ID Transmit Server message transmitted, feedback contains an additional timestamp of the transmission time
0x2A| 29-bit ID Transmit Server message transmitted
0x2B| 29-bit ID Transmit Server message transmitted, feedback contains an additional timestamp of the transmission time
Data| For 11-bit ID messages / remote frames:
0x00-0xFF| Byte 0-1:
11-bit CAN ID (MSB first)
0x00-0xFF| additional data bytes (not on remote frame feedback):
Up to 8 CAN Data bytes an additional 32-bit timestamp value (only if timestamp option is enabled, see below)
For 29-bit ID messages / remote frames:
0x00-0xFF| Byte 0-3:
29-bit CAN ID (MSB first)
0x00-0xFF| additional data bytes (not on remote frame feedback):
Up to 8 CAN Data bytes an additional 32-bit timestamp value (only if timestamp option is enabled,  see below)
Checksum| xx| Contains the XOR checksum of the SOF, Length, Command and the Data-bytes.
EOF
(End of Frame)| 0x0D| EOF byte marks the end of the command.

NOTE
If feedback messages are desired, the feedback option has to be enabled by the corresponding command (see Switch server objects on / off).
If a timestamp is favored, this option must be enabled by the corresponding message (see Reset Device).
The usage as extended command is possible (see Extended Command Format (Byte Mode)).

2.5. Diagnosis data messages
2.5.1. Device ID

SOF
(Start of Frame)| 0x43| SOF marks the beginning of the command.
Length| xx| The  length byte contains the number of data bytes the number of command bytes following.
Command| 0x40| Device ID string (request: no additional data bytes)
Data
(only on reply)| 0x00-0xFF| ID string (only on response)
Checksum| xx| Contains the XOR checksum of the SOF, Length, Command and the Data-bytes.
EOF
(End of Frame)| 0x0D| EOF byte marks the end of the command.

2.5.2. Hardware / Software version

SOF
(Start of Frame)| 0x43| SOF marks the beginning of the command.
Length| xx| The  length byte contains the number of data bytes the number of command bytes following.
Command| 0x41| Hardware / Software version (request: no additional data bytes)
Data
(only on reply)| 0x00-0xFF| Byte 0-1: Hardware version of the device
Byte 2-3: Software version of the firmware
Byte 4-5: Software version of the bootloader
Checksum| xx| Contains the XOR checksum of the SOF, Length, Command and the Data-bytes.
EOF
(End of Frame)| 0x0D| EOF byte marks the end of the command.

2.5.3. Error status

SOF
(Start of Frame)| 0x43| SOF marks the beginning of the command.
Length| xx| The  length byte contains the number of data bytes the number of command bytes following.
Command| 0x42| Error  status (request: no additional data bytes)
0x43| Error  status message which contains an additional timestamp value
(no request command, only response message)
Data
(only on reply)| 0x00-0xFF| Byte 0:
bit 0: CAN receive buffer overflow
bit 1: CAN transmit timeout
bit 2: CAN error counter overflow
bit 3: CAN bus-off error
bit 4: Host interface syntax error
bit 5: Host interface format error
bit 6: Host interface transmit buffer overflow
bit 7: not  used
Byte 1 (Last error code of the CAN controller):
‘0’: No Error
‘1’: More  than 5 equal bits  in a sequence have occurred
‘2’: Received message does not  have the right format
‘3’: Transmitted Message was not  acknowledged
‘4’: Not possible to set recessive level  during transmission
‘5’: Not possible to set dominant level  during transmission
‘6’: received CRC check sum  was incorrect
Checksum| xx| Contains the XOR checksum of the SOF, Length, Command and the Data-bytes.
EOF
(End of Frame)| 0x0D| EOF byte marks the end of the command.

NOTE
If a timestamp is favored, this option must be enabled by the corresponding message (see Reset Device).
Each time the error status changes, an error status message is generated automatically.
The usage as extended command is possible (see Extended Command Format (Byte Mode)).

2.5.4. Interfaces version

SOF
(Start of Frame)| 0x43| SOF marks the beginning of the command.
Length| xx| The  length byte contains the number of data bytes the number of command bytes following.
Command| 0x44| Interfaces version (e.g. Bluetooth module, WLAN-module, …) (request: no additional data bytes)
Data
(only on reply)| 0x00-0xFF| ASCII coded version string
Checksum| xx| Contains the XOR checksum of the SOF, Length, Command and the Data-bytes.
EOF
(End of Frame)| 0x0D| EOF byte marks the end of the command.

NOTE
The usage as extended command is possible (see Extended Command Format (Byte Mode)).
Modul is selectable.

2.5.5. Current CAN-busload

SOF
(Start of Frame)| 0x43| SOF marks the beginning of the command.
Length| xx| The  length byte contains the number of data bytes the number of command bytes following.
Command| 0x47| Current busload in messages per  second (request: no additional data bytes)
Data
(only on reply)| 0x00-0xFF| Byte 0-1:
unsigned Integer value size:16 bit (MSB first)
Checksum| xx| Contains the XOR checksum of the SOF, Length, Command and the Data-bytes.
EOF
(End of Frame)| 0x0D| EOF byte marks the end of the command.

NOTE
The usage as extended command is possible (see Extended Command Format (Byte Mode)).

2.5.6. Device busy / command not supported

SOF
(Start of Frame)| 0x43| SOF marks the beginning of the command.
Length| xx| The  length byte contains the number of data bytes the number of command bytes following.
Command| 0x48| Device cannot execute command (only response on other commands)
Data| 0x00-0xFF| Reserved for future use
Checksum| xx| Contains the XOR checksum of the SOF, Length, Command and the Data-bytes.
EOF
(End of Frame)| 0x0D| EOF byte marks the end of the command.

NOTE
The usage as extended command is possible (see Extended Command Format (Byte Mode)).

2.5.7. Set CAN transmit delay time

SOF
(Start of Frame)| 0x43| SOF marks the beginning of the command.
Length| xx| The  length byte contains the number of data bytes the number of command bytes following.
Command| 0x49| Set CAN transmit delay time
Data| 0x00-0xFF| Unsigned integer value size:16 bit (MSB first)
(RAM-parameter is set back to 0 after device reset)
Delay  time  until the next command is evaluated in 10 ms,  this  value only applies once!
Checksum| xx| Contains the XOR checksum of the SOF, Length, Command and the Data-bytes.
EOF
(End of Frame)| 0x0D| EOF byte marks the end of the command.

NOTE
The usage as extended command is possible (see Extended Command Format (Byte Mode)).

2.6. CAN Controller setup messages
2.6.1. Change / request receive channel ID settings

SOF
(Start of Frame)| 0x43| SOF marks the beginning of the command.
Length| xx| The  length byte contains the number of data bytes the number of command bytes following.
Command| 0x50| Request receive channel ID settings
(needs one additional data byte = channel number)
0x51| Change receive channel ID settings
(needs at least two  additional data bytes, the channel number and the channel settings)
Data| 0x00-0xFF| Byte 0:
Receive object number (range depends on gateway device) CANview  USB / RS232: 0…8
CANview  Ethernet: 0…7
CANlink Bluetooth / WLAN: 0…15
0x00-0x07| Byte 1:
bit 0: 0 = channel disable, 1 = channel enable bit 1: 0 = receive 11-bit ID, 1 = receive 29-bit ID bit  2: 0 = change 11-bit ID, 1 = change 29-bit ID
Byte 2-3: 11-bit ID if byte1, bit 2 = 0
Byte 2-5: 29-bit ID if byte1, bit 2 = 1
Checksum| xx| Contains the XOR checksum of the SOF, Length, Command and the Data-bytes.
EOF
(End of Frame)| 0x0D| EOF byte marks the end of the command.

NOTE
If the change message contains no ID information (length byte < 4) the last ID setting remains.
In this case byte 1, bit 2 is ignored.
The usage as extended command is possible (see Extended Command Format (Byte Mode)).

2.6.2. Change / request receive channel mask settings

SOF
(Start of Frame)| 0x43| SOF marks the beginning of the command.
Length| xx| The  length byte contains the number of data bytes the number of command bytes following.
Command| 0x52| Request receive channel mask settings
(needs one additional data byte = channel number)
0x53| Change receive channel mask settings
(needs at least two  additional data bytes, the channel number and the channel settings)
Data| 0x00-0xFF| Byte 0:
Receive object number (range depends on gateway device) CANview  USB / RS232: 0…8
CANview  Ethernet: 0…7
CANlink Bluetooth / WLAN: 0…15
0x00-0x07| Byte 1:
bit 0: 0 = channel disable, 1 = channel enable
bit 1: 0 = receive 11-bit mask, 1 = receive 29-bit mask
bit 2: 0 = change 11-bit mask, 1 = change 29-bit mask
Byte 2-3: 11-bit mask if byte1, bit 2 = 0
Byte 2-5: 29-bit mask if byte1, bit 2 = 1
Checksum| xx| Contains the XOR checksum of the SOF, Length, Command and the Data-bytes.
EOF
(End of Frame)| 0x0D| EOF byte marks the end of the command.

NOTE
If the change message contains no mask information (length byte < 4), the last mask setting remains.
In this case byte 1, bit 2 is ignored.
If the device does not support individual masks for each channel (CANview RS232), the mask settings for channel 1 to 7 are ignored and replied with the setting of channel 0.
The usage as extended command is possible (see Extended Command Format (Byte Mode)).

2.6.3. CAN baud rate

SOF

(Start of Frame)

| 0x43| SOF marks the beginning of the command.
Length| xx| The  length byte contains the number of data bytes the number of command bytes following.
Command| 0x56| Request CAN baud rate parameters (no additional data bytes)
0x57| Set CAN baud rate Parameters
Data| 0x00-0xFF| Byte 0: 0xFF if no CIA conform standard baud rate, else:
0x00: 10 kBit / sec
0x01: 20  kBit / sec
0x02: 50  kBit / sec
0xFE: 100 kBit / sec
0x03: 125 kBit / sec
0x04: 250 kBit / sec
0x05: 500 kBit / sec
0x06: 800 kBit / sec
0x07: 1 MBit / sec
0xFF: BTR values are used
Byte 1: BTR0 Value  (device dependent, only if Byte  0 = 0xFF) Byte 2: BTR1 Value  (device dependent, only if Byte  0 = 0xFF) Byte 3: BTR2 Value  (device dependent, only if Byte  0 = 0xFF)  Byte 4: BTR3 Value (device dependent, only if Byte  0 = 0xFF)
Checksum| xx| Contains the XOR checksum of the SOF, Length, Command and the Data-bytes.
EOF
(End of Frame)| 0x0D| EOF byte marks the end of the command.

NOTE
If data byte 0 is set to 0xFF, the BTR values are used to set nonstandard baud rates.
If a standard baud rate is used, the BTR values are not necessary, if they are used anyway, they are ignored!
If you need to set a baud rate that is not supported by the standard settings of the device, please contact our support for further information, see Service and Support.
The usage as extended command is possible (see Extended Command Format (Byte Mode)).

2.6.4. CAN controller reset

SOF
(Start of Frame)| 0x43| SOF marks the beginning of the command.
Length| xx| The  length byte contains the number of data bytes the number of command bytes following.
Command| 0x58| CAN controller reset (no additional data bytes)
Checksum| xx| Contains the XOR checksum of the SOF, Length, Command and the Data-bytes.
EOF
(End of Frame)| 0x0D| EOF byte marks the end of the command.

NOTE
The “CAN Controller Reset” command performs a complete reset of the CAN controller, including the timestamp value, receive and transmit buffers.
The CAN controller reset also resets the error status of the device.
For this reason, after the CAN controller reset, an error status message is generated, to update the error status.
The usage as extended command is possible (see Extended Command Format (Byte Mode)).

2.6.5. Set CAN interface Auto Baud Mode

SOF
(Start of Frame)| 0x43| SOF marks the beginning of the command.
Length| xx| The  length byte contains the number of data bytes the number of command bytes following.
Command| 0x59| Set auto baud mode (no additional data bytes)
Checksum| xx| Contains the XOR checksum of the SOF, Length, Command and the Data-bytes.
EOF
(End of Frame)| 0x0D| EOF byte marks the end of the command.

NOTE
Auto Baud Mode is only possible with the standard baud rates the device supports.
For auto baud detection it is necessary to have a working communication on the bus.
While baud rate detection is active, the Proemion CAN devices are in passive mode and have no influence on the traffic on the CAN bus.
The usage as extended command is possible (see Extended Command Format (Byte Mode)).

The auto baud command sets the gateway device to “Auto Baud Mode”.
The device listens to the traffic on the CAN and configures the baud rate automatically (only standard baud rates supported by the device are detectable).
After getting the right baud rate setting, the device generates a reply, containing the detected baud rate.
The format of this message is identical to the CAN baud rate request message, except the command byte is 0x59.
When no baud rate is detected, the device uses the last configured baud rate for operation.
In this case, the baud rate reply is the same as if a nonstandard baud rate is requested.

2.6.6. Set / request active / passive mode

SOF
(Start of Frame)| 0x43| SOF marks the beginning of the command.
Length| xx| The  length byte contains the number of data bytes the number of command bytes following.
Command| 0x5A| Request active / passive mode (no additional data bytes)
0x5B| Set active / passive mode
Data| 0x00-0x01| 0x00 device = active mode
0x01 device = passive mode
Checksum| xx| Contains the XOR checksum of the SOF, Length, Command and the Data-bytes.
EOF
(End of Frame)| 0x0D| EOF byte marks the end of the command.

NOTE
The usage as extended command is possible (see Extended Command Format (Byte Mode)).

2.6.7. Change / request receive channel cycle time

SOF
(Start of Frame)| 0x43| SOF marks the beginning of the command.
Length| xx| The  length byte contains the number of data bytes the number of command bytes following.
Command| 0x5C| Request receive channel cycle time
(needs one additional data byte = channel number)
0x5D| Change receive channel cycle time
(needs at least two  additional data bytes, the channel number and the channel settings)
Data| 0x00-0xFF| Byte 0:
Receive object number (range depends on gateway device) CANview  Ethernet: 0…7
CANlink Bluetooth / WLAN: 0…15
0x00-0xFF| Byte 1:
Cycle Time in 10 ms
Checksum| xx| Contains the XOR checksum of the SOF, Length, Command and the Data-bytes.
EOF
(End of Frame)| 0x0D| EOF byte marks the end of the command.

NOTE
The usage as extended command is possible (see Extended Command Format (Byte Mode)).

2.7. Host interface configuration messages
2.7.1. Feedback / output settings

SOF
(Start of Frame)| 0x43| SOF marks the beginning of the command.
Length| xx| The  length byte contains the number of data bytes the number of command bytes following.
Byte(s)| Value| Description
---|---|---
Command| 0x60| Request feedback settings (no additional data bytes)
0x61| Set feedback settings
Data| 0x00-0x07| Byte 0:
bit 0: 1 = CAN output on / 0 = CAN output off
bit 1: 1 = Transmit CAN message feedback on / 0 = feedback off
bit 2: 1 = Server feedback on / 0 = server feedback off
bit 3: 1 = RS232 interface on / 0 = RS232 interface off
Checksum| xx| Contains the XOR checksum of the SOF, Length, Command and the Data-bytes.
EOF
(End of Frame)| 0x0D| EOF byte marks the end of the command.

NOTE
If the serial output is disabled, the received CAN messages are stored in the RAM of the Proemion CAN device. If this buffer is full, a buffer overflow error is indicated.
If the output is enabled, all stored messages are transmitted immediately to the host interface.
The usage as extended command is possible (see Extended Command Format (Byte Mode)).

2.8. Transmit server interface commands
2.8.1. Switch server objects on / off

SOF
(Start of Frame)| 0x43| SOF marks the beginning of the command.
Length| xx| The  length byte contains the number of data bytes the number of command bytes following.
Command| 0x80| Request server object on / off (no additional data bytes)
0x81| Set server object on / off
Data| 0x00-0xFF| Byte 0:
Each  bit which is set switches on the corresponding server object / shows that the server object is  on.
A reset bit marks disabled server objects.
Checksum| xx| Contains the XOR checksum of the SOF, Length, Command and the Data-bytes.
EOF
(End of Frame)| 0x0D| EOF byte marks the end of the command.

NOTE
This command is deprecated and is no longer used by our devices.

2.8.2. Change / request server object configuration

SOF
(Start of Frame)| 0x43| SOF marks the beginning of the command.
Length| xx| The  length byte contains the number of data bytes the number of command bytes following.
Command| 0x82| Request server object configuration (needs one additional data byte which contains the server object number)
0x83| Set server object on / off
Data| 0x01-0x08| Byte 0 (object number):
Contains the number of one of the eight possible server objects which should be changed.
0x00-0x01| Byte 1 (IDE):
0x00 = 11-bit ID Object
0x01 = 29-bit ID Object
Byte 2 and higher byte numbers contain the following information in the displayed order:
0x00-0xFF| ID (11 or 29 bit)
0x01-0x08| DLC (number of data bytes of the CAN message)
0x00-0xFF| up to 8 data bytes of the can message
0x00-0xFF| cycle time of the server object in 10 ms
Checksum| xx| Contains the XOR checksum of the SOF, Length, Command and the Data-bytes.
EOF
(End of Frame)| 0x0D| EOF byte marks the end of the command.

NOTE
The content of the DLC byte has to agree with the number of transmitted data bytes, otherwise the transmit server may behave unpredictably.
This command is deprecated and is no longer used by our devices.

2.8.3. Change / request transmit channel ID settings
The CAN transmit channel filters work identical like the CAN receive filters described in chapter CAN Controller setup messages. Messages received from the host are checked with this filter conditions. If the conditions are met, the message is sent to the CAN  bus.

SOF
(Start of Frame)| 0x43| SOF marks the beginning of the command.
Length| xx| The  length byte contains the number of data bytes the number of command bytes following.
Command| 0x84| Request transmit channel ID settings
(needs one additional data byte = channel number)
0x85| Change transmit channel ID settings
(needs at least two  additional data bytes, the channel number and the channel settings)
Data| 0x00-0x07| Byte 0:
Transmit object number
0x00-0x07| Byte 1:
bit 0: 0 = channel disable, 1 = channel enable
bit 1: 0 = transmit 11-bit ID, 1 = transmit 29-bit ID
bit 2: 0 = change 11-bit ID, 1 = change 29-bit ID
0x00-0xFF| Byte 2-3: 11-bit ID if byte1, bit 2 = 0
0x00-0xFF| Byte 2-5: 29-bit ID if byte1, bit 2 = 1
Checksum| xx| Contains the XOR checksum of the SOF, Length, Command and the Data-bytes.
EOF
(End of Frame)| 0x0D| EOF byte marks the end of the command.

NOTE
This command is deprecated and is no longer used by our devices.

2.8.4. Change / request transmit channel mask settings

SOF
(Start of Frame)| 0x43| SOF marks the beginning of the command.
Length| xx| The  length byte contains the number of data bytes the number of command bytes following.
Command| 0x86| Request transmit channel mask settings
(needs one additional data byte = channel number)
0x87| Change transmit channel mask settings
(needs at least two  additional data bytes, the channel number and the channel settings)
Data| 0x00-0x07| Byte 0:
Transmit object number
0x00-0x07| Byte 1:
bit 0: 0 = channel disable, 1 = channel enable
bit 1: 0 = transmit 11-bit mask, 1 = transmit 29-bit mask
bit 2: 0 = change 11-bit mask, 1 = change 29-bit mask
0x00-0xFF| Byte 2-3: 11-bit mask if byte1, bit 2 = 0
0x00-0xFF| Byte 2-5: 29-bit mask if byte1, bit 2 = 1
Checksum| xx| Contains the XOR checksum of the SOF, Length, Command and the Data-bytes.
EOF
(End of Frame)| 0x0D| EOF byte marks the end of the command.

NOTE
This command is deprecated and is no longer used by our devices.

2.8.5. Change / request transmit channel cycle time settings

SOF
(Start of Frame)| 0x43| SOF marks the beginning of the command.
Length| xx| The  length byte contains the number of data bytes the number of command bytes following.
Command| 0x88| Request transmit channel cycle time  settings
(needs one additional data byte = channel number)
0x89| Change transmit channel cycle time  settings
(needs at least two  additional data bytes, the channel number and the channel settings)
Data| 0x00-0x07| Byte 0:
Transmit object number
0x00-0x07| Byte 1: +
bit 0: 0 = channel disable, 1 = channel enable
bit 1: 0 = transmit 11-bit cycle time, 1 = transmit 29-bit cycle time
bit 2: 0 = change 11-bit cycle time, 1 = change 29-bit cycle time
0x00-0xFF| Byte 2-3: 11-bit cycle time  if byte1, bit 2 = 0
0x00-0xFF| Byte 2-5: 29-bit cycle time  if byte1, bit 2 = 1
Checksum| xx| Contains the XOR checksum of the SOF, Length, Command and the Data-bytes.
EOF
(End of Frame)| 0x0D| EOF byte marks the end of the command.

2.9. Device parameter settings
2.9.1. Change / request Timestamp settings

SOF
(Start of Frame)| 0x43| SOF marks the beginning of the command.
Length| xx| The  length byte contains the number of data bytes the number of command bytes following.
Command| 0xA0| Request timestamp settings (request: no additional data bytes)
0xA1| Set timestamp settings
Data| 0x00-0x13| Byte 0:
bit 0: 1 = Timestamp on, 0 = Timestamp off
bit 1: 1 = Relative timestamp, 0 = Absolute timestamp
bit 4: 1 = Error  and Echo  Feedback timestamp on 0 = Error  and Echo Feedback timestamp off
Checksum| xx| Contains the XOR checksum of the SOF, Length, Command and the Data-bytes.
EOF
(End of Frame)| 0x0D| EOF byte marks the end of the command.

If the “Timestamp-Mode” is selected, a 32-bit counter (100 µs resolution) value is inserted after the last data byte of each received CAN message.
All messages on the host interface side which contain a timestamp are in the correct chronological order.
If a timestamp should be inserted after the echoed messages (“Transmit Server Feedback” or “Send CAN Message Feedback”) and the error messages, the ‘Error and Echo Feedback timestamp’ has to be activated additionally.
The difference between “relative” and “absolute-mode” is that the counter value is reset after each received message in “relative-mode”.

NOTE
The “Error and Echo Feedback” timestamp is only transmitted if the timestamp mode is enabled.
The usage as extended command is possible (see Extended Command Format (Byte Mode)).

2.9.2. Change CAN transmit Delay time

SOF
(Start of Frame)| 0x43| SOF marks the beginning of the command.
Length| xx| The  length byte contains the number of data bytes the number of command bytes
Command| 0xA2| Set CAN transmit delay time
Data
(only on reply)| 0x00-0xFF| Unsigned integer value size: 16 bit
(RAM-parameter is set back to 0 after device reset)
Checksum| xx| Contains the XOR checksum of the SOF, Length, Command and the Data-bytes.
EOF
(End of Frame)| 0x0D| EOF byte marks the end of the command.

NOTE
This delay time is inserted before each CAN message, so that the CAN transmission gets slower.

2.9.3. Set IP-block wait time

SOF
(Start of Frame)| 0x43| SOF marks the beginning of the command.
Length| xx| The  length byte contains the number of data bytes the number of command bytes following.
Command| 0xA3| Set IP-block wait  time  (for better use of bandwidth)
Data| 0x00-0xFF| Interval in 10 milliseconds
Checksum| xx| Contains the XOR checksum of the SOF, Length, Command and the Data-bytes.
EOF
(End of Frame)| 0x0D| EOF byte marks the end of the command.

2.9.4. Set baud rate calculation interval

SOF
(Start of Frame)| 0x43| SOF marks the beginning of the command.
Length| xx| The  length byte contains the number of data bytes the number of command bytes following.
Command| 0xA4| Set CAN baud rate calculation interval
Data| 0x00-0xFF| Interval in milliseconds
Unsigned integer value size: 16 bit (MSB first)
Checksum| xx| Contains the XOR checksum of the SOF, Length, Command and the Data-bytes.
EOF
(End of Frame)| 0x0D| EOF byte marks the end of the command.

NOTE
The usage as extended command is possible (see Extended Command Format (Byte Mode)).

2.9.5. CANopen object dictionary access

SOF
(Start of Frame)| 0x43| SOF marks the beginning of the command.
Length| xx| The  length byte contains the number of data bytes the number of command bytes following.
Command| 0xA5| Read / Write  in the object dictionary
Data| 0x00-0xFF| Request: Byte 0:
Command: 0x01 write, 0x00 read (no additional data bytes)
Byte 1-2:
Index  (LSB first)
Byte 3:
Sub-index
additional data bytes:
Data (LSB first)
Response: Byte 0:
Result: 0x40 read success
0x80 read failure (no additional data bytes)
0x41  write success (no additional data bytes)
0x81 write failure (no additional data bytes)
Byte 1-2:
Index  (LSB first)
Byte 3:
Sub-index
additional data bytes:
Data (LSB first)
Checksum| xx| Contains the XOR checksum of the SOF, Length, Command and the Data-bytes.
EOF
(End of Frame)| 0x0D| EOF byte marks the end of the command.

2.10. Hardware access commands
2.10.1. Reset Device

SOF
(Start of Frame)| 0x43| SOF marks the beginning of the command.
Length| xx| The  length byte contains the number of data bytes the number of command bytes following.
Command| 0xC0| Set reset device
Data|  —|
Checksum| xx| Contains the XOR checksum of the SOF, Length, Command and the Data-bytes.
EOF
(End of Frame)| 0x0D| EOF byte marks the end of the command.

NOTE
The devices respond to this command with the command “Device ID”.
For some devices this command does not lead to a hardware reset since the communication to the host would be lost otherwise.

• CANview Ethernet
• CANlink Bluetooth / WLAN

2.10.2. Request analog channel value

SOF
(Start of Frame)| 0x43| SOF marks the beginning of the command.
Length| xx| The  length byte contains the number of data bytes the number of command bytes following.
Command| 0xC2| Request analog channel value (needs 1 additional data byte containing the channel number)
Data| 0x00-0x03| Byte 0 (channel number):
0x00: Supply voltage
0x01: CAN Low line
0x02: CAN High line
0x03: Analog Inputs 1 and 2
0x00-0xFF| Byte 1: analog value (for channel 0…2, see description below)
Byte 1-4: (for channel 3) Analog input 1 voltage IEEE 754 coded, LSB first
Byte 5-8: (for channel 3) Analog input 2 voltage IEEE 754 coded, LSB first
Checksum| xx| Contains the XOR checksum of the SOF, Length, Command and the Data-bytes.
EOF
(End of Frame)| 0x0D| EOF byte marks the end of the command.
VCC
CANH / CANL| 0x00| 0V
0V
VCC
CANH / CANL| 0xFF| 39V
5V

NOTE
Only the CANview RS232 can measure the CAN line voltage levels.
This measurement is only possible for CAN baud rates of 125 kBit/s and slower.

Set / request digital channel value

SOF
(Start of Frame)| 0x43| SOF marks the beginning of the command.
Length| xx| The  length byte contains the number of data bytes the number of command bytes following.
Command| 0xC4| Request digital channel value (needs 1 additional data byte containing the channel number)
0xC5| Set digital channel value (needs 2 additional data byte containing the channel number and the value)
Data| 0x00-0xFF| Byte 0 (channel number): 0x00: bus termination resistor
0x00-0x01| Byte 1: digital value (1 = on, 0 = off)
Checksum| xx| Contains the XOR checksum of the SOF, Length, Command and the Data-bytes.
EOF
(End of Frame)| 0x0D| EOF byte marks the end of the command.

NOTE
Each set command is replied with the actual values.

2.10.3. Set Communication password

SOF
(Start of Frame)| 0x43| SOF marks the beginning of the command.
Length| xx| The  length byte contains the number of data bytes the number of command bytes following.
Command| 0xC6| Request communication password check
Data| xx| Command
Byte 0…n:
Password string (default: “GSMONLIN”) Response
Byte 0:
0 = password checked and OK
If password check failed, there is no response from  the device
Checksum| xx| Contains the XOR checksum of the SOF, Length, Command and the Data-bytes.
EOF
(End of Frame)| 0x0D| EOF byte marks the end of the command.

NOTE
This message is very important to unlock the whole functionality of byte mode interface at CANlink GSM/UMTS.
A session is only possible with a check of the correct communication password!

2.10.4. Reset Communication password

SOF
(Start of Frame)| 0x43| SOF marks the beginning of the command.
Length| xx| The  length byte contains the number of data bytes the number of command bytes following.
Command| 0xC7| Reset communication password check
Checksum| xx| Contains the XOR checksum of the SOF, Length, Command and the Data-bytes.
EOF
(End of Frame)| 0x0D| EOF byte marks the end of the command.

NOTE
This message locks the byte mode interface.
This command should be sent at the end of a communication session.

Commands and Devices

The table below provides a summary of all existing commands and indicates which Proemion device supports them.
The usability of a command for a Proemion device is marked with a “S”, “E” or “S / E”.

These acronyms stand for:

• “S” The Proemion device supports this command only in the standard command format (see Command Format (Byte Mode)).
• “E” The Proemion device supports this command only in the extended command format (see Extended Command Format (Byte Mode)).
• “S / E” The Proemion device supports this command in the standard command format and in the extended command format.

Message| Command| Device| | | | | | | |
---|---|---|---|---|---|---|---|---|---|---
Type| | CANview USB| CANlink
Bluetooth
2000| CANlink
WLAN
2000| CANlink
wireless
3000| CANlink
wireless 4000| CANview
Ethernet| CANlink
mobile
5000| CANlink
mobile
3000| CANview
RS232
Process Data Messages| 0x00| S / E| S / E| S / E| S / E| S / E| S / E| S / E| S / | S / E
| 0x01| S / E| S / E| S / E| S / E| S / E| S / E| S / E| S / E| S / E
| 0x02| S / E| S / E| S / E| S / E| S / E| S / E| S / E| S / E| S / E
| 0x03| S / E| S / E| S / E| S / E| S / E| S / E| S / E| S / E| S / E
| 0x04| S / E| S / E| S / E| S / E| S / E| S / E| S / E| S / E| S / E
| 0x05| S / E| S / E| S / E| S / E| S / E| S / E| S / E| S / E|
| 0x06| S / E| S / E| S / E| S / E| S / E| S / E| S / E| S / E|
| 0x07| S / E| S / E| S / E| S / E| S / E| S / E| S / E| S / E|
| 0x08| | | | | | | S / E| S / E|
| 0x09| | | | | | | S| |
Feedback Messages| 0x20| S / E| S / E| S / E| S / E| S / E| S / E| S / E| S / E| S / E
| 0x21| S / E| S / E| S / E| S / E| S / E| S / E| S / E| S / E| S / E
| 0x22| S / E| S / E| S / E| S / E| S / E| S / E| S / E| S / E| S / E
| 0x23| S / E| S / E| S / E| S / E| S / E| S / E| S / E| S / E| S / E
| 0x24| S / E| S / E| S / E| S / E| S / E| S / E| S / E| S / E| S / E
| 0x25| S / E| S / E| S / E| S / E| S / E| S / E| S / E| S / E| S / E
| 0x26| S / E| S / E| S / E| S / E| S / E| S / E| S / E| S / E|
| 0x27| S / E| S / E| S / E| S / E| S / E| S / E| S / E| S / E|
| 0x28| S / E| | | | | | | | S / E
| 0x29| S / E| | | | | | | | S / E
| 0x2A| S / E| | | | | | | | S / E
| 0x2B| S / E| | | | | | | | S / E

*Following command data options are not implemented for the CLM3000 and CLM3600:
– bit 2: 1 = Server feedback on / 0 = server feedback off
– bit 3: 1 = RS232 interface on / 0 = RS232 interface off

Message| Command| Device| | | | | | | |
---|---|---|---|---|---|---|---|---|---|---
Type| | CANview USB| CANlink
Bluetooth
2000| CANlink
WLAN
2000| CANlink
wireless  3000| CANlink
wireless 4000| CANview
Ethernet| CANlink
mobile
5000| CANlink
mobile
3000| CANview
RS232
Diagnosis Data Messages| 0x40| S| S| S| S| S| S| S| S| S
| 0x41| S| S| S| S| S| S| S| S| S
| 0x42| S / E| S / E| S / E| S / E| S / E| S / E| S / E| S / E| S / E
| 0x43| S / E| S / E| S / E| | | S / E| | | S / E
| 0x44| | S / E| S / E| S / E| S / E| S / E| S / E| S / E|
| 0x47| | S / E| S / E| | | S / E| | |
| 0x48| | | | S / E| S / E| | S / E| S / E|
| 0x49| | S / E| S / E| | S / E| | | S / E|
CAN Controller Setup Messages| 0x50| S / E| S / E| S / E| S / E| S / E| S / E| S / E| S / E| S / E
| 0x51| S / E| S / E| S / E| S / E| S / E| S / E| S / E| S / E| S / E
| 0x52| S / E| S / E| S / E| S / E| S / E| S / E| S / E| S / E| S / E
| 0x53| S / E| S / E| S / E| S / E| S / E| S / E| S / E| S / E| S / E
| 0x56| S / E| S / E| S / E| S / E| S / E| S / E| S / E| S / E| S / E
| 0x57| S / E| S / E| S / E| S / E| S / E| S / E| S / E| S / E| S / E
| 0x58| S / E| S / E| S / E| S / E| | S / E| S / E| S / E| S / E
| 0x59| S / E| | | | | | | | S / E
| 0x5A| S / E| | | S / E| | | S / E| S / E| S / E
| 0x5B| S / E| | | S / E| | | S / E| S / E| S / E
| 0x5C| | S / E| S / E| S / E| S / E| S / E| S / E| S / E|
| 0x5D| | S / E| S / E| S / E| S / E| S / E| S / E| S / E|
Host Interface Configuration Messages| 0x60| S / E| S / E| S / E| S / E| S / E| S / E| S / E| S / E| S / E
| 0x61| S / E| S / E| S / E| S / E| S / E| S / E| S / E| S / E| S / E
Transmit Server Interface Commands| 0x80| S| | | | | | | | S
| 0x81| S| | | | | | | | S
| 0x82| S| | | | | | | | S
| 0x83| S| | | | | | | | S
| 0x84| | | | | | S| | |
| 0x85| | | | | | S| | |
| 0x86| | | | | | S| | |
| 0x87| | | | | | S| | |
| 0x88| | | | | | S| | |
| 0x89| | | | | | S| | |
Type| | CANview   USB| CANlink Bluetooth
2000| CANlink WLAN
2000| CANlink wireless 3000| CANlink wireless  4000| CANview Ethernet| CANlink mobile
5000| CANlink mobile
3000| CANview
RS232
Device Parameter Settings| 0xA0| S / E| S / E| S / E| S / E| S / E| S /E| S / E| S / E| S / E
| 0xA1| S / E| S / E| S / E| S / E| S / E| S / E| S / E| S / E| S / E
| 0xA2| S| | | | | | | |
| 0xA3| | | | | | S| | |
| 0xA4| | S / E| S / E| | | S / E| | |
| 0xA5| | S| S| S| S| | | |
Hardware Access Commands| 0xC0| S| S| S| S| S| S| S| S| S
| 0xC2| | S| S| S| | | | | S
| 0xC4| | | | | | | | | S
| 0xC5| | | | | | | | | S
| 0xC6| | | | S| | | S| S|
| 0xC7| | | | S| | | S| S|

Version: 11.0.549

References

• Support Center - Customer Help - Resources - Proemion
• Sharing Link Validation
• Telematics solutions for OEM machine connectivity - Proemion

Read User Manual Online (PDF format)

Read User Manual Online (PDF format)  >>

Download This Manual (PDF format)

Download this manual  >>