API | CoLa Telegrams¶
This reference lists the CoLa telegrams supported by the picoScan100. Use the command details to build or troubleshoot PLC and other low-level integrations without guessing the telegram structure.
Examples are grouped by protocol, with each telegram representation in a separate code block and its own copy button.
Categories follow the picoScan150 REST API reference where corresponding CoLa telegrams are available. Select a telegram to expand its structure and examples. A direct link to a telegram opens it automatically. The categories organize the reference; they do not imply that every telegram is supported by every picoScan variant.
General¶
METHOD Log In [sMN SetAccessMode]¶
The password hashes of the default passwords are documented in the operating instructions (PDF) of your device. Do not pass them on, and change the passwords during commissioning.
A log in to the device is necessary to change parameters. In most cases, the user level 'Authorized client' is needed. Changed parameters will be reset to the previous state via a reboot unless they are saved. To save parameter changes the command "sMN mEEwriteall" must be sent before log out.
Telegram structure: sMN SetAccessMode
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Method | String | 3 | sMN |
73 4D 4E |
|
| Command | User level | String | 13 | SetAccessMode |
53 65 74 41 63 63 65 73 73 4D 6F 64 65 |
|
| User level | Select user level | Int_8 | 1 | Maintenance: Authorized client: Service: |
2 |
02 |
| Password | Hash value for the selected user level | Uint_32 | 4 | Maintenance: Authorized client: Service: |
<password hash> |
<password hash> |
Example: sMN SetAccessMode - Log in as “Authorized client”
CoLa A (ASCII)
Telegram structure: sAN SetAccessMode
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Answer | String | 3 | sAN |
73 41 4E |
|
| Command | User level | String | 13 | SetAccessMode |
53 65 74 41 63 63 65 73 73 4D 6F 64 65 |
|
| Change user level | Changed level | Bool_1 | 1 | Error: Success: |
0 |
00 |
Example: sAN SetAccessMode
CoLa A (ASCII)
CoLa B (binary)
METHOD Enable/ Disable CoLa User Levels [sMN EnableLegacyUserLevel]¶
This command enables and disables a specific CoLa user level (Maintenance, Authorized Client).
Telegram structure: sMN EnableLegacyUserLevel
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Method | String | 3 | sMN |
73 4D 4E |
|
| Command | Enable/ disable CoLa user level | String | 21 | EnableLegacyUserLevel |
45 6E 61 62 6C 65 4C 65 67 61 63 79 55 73 65 72 4C 65 76 65 6C |
|
| User level | - | Uint_8 | 1 | Maintenance: Authorized Client: |
2 |
02 |
| Status | Enable/ disable | Bool_1 | 1 | Disable: Enable: |
0 |
00 |
Example: sMN EnableLegacyUserLevel - Enable User Level Authorized Client
CoLa A (ASCII)
CoLa B (binary)
02 02 02 02 00 00 00 1D 73 4D 4E 20 45 6E 61 62 6C 65 4C 65 67 61 63 79 55 73 65 72 4C 65 76 65 6C 20 03 20 01 21
Telegram structure: sAN EnableLegacyUserLevel
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Answer | String | 3 | sAN |
73 41 4E |
|
| Command | Enable/ disable CoLa user level | String | 21 | EnableLegacyUserLevel |
45 6E 61 62 6C 65 4C 65 67 61 63 79 55 73 65 72 4C 65 76 65 6C |
|
| Status code | Confirmation | Bool_1 | 1 | unsuccessful: successful: |
0 |
00 |
Example: sAN EnableLegacyUserLevel - Enabling/ disabling of the CoLa User Level was successful
CoLa A (ASCII)
CoLa B (binary)
METHOD Load Factory Defaults [sMN mSCloadfacdef]¶
The Factory-Reset (Load factory defaults) deletes the entire parametrization of the device. All parameters, settings and system applications will be set to default.
Telegram structure: sMN mSCloadfacdef
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Method | String | 3 | sMN |
73 4D 4E |
|
| Command | Load factory defaults | String | 13 | mSCloadfacdef |
6D 53 43 6C 6F 61 64 66 61 63 64 65 66 |
Example: sMN mSCloadfacdef
CoLa A (ASCII)
CoLa B (binary)
Telegram structure: sAN mSCloadfacdef
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Answer | String | 3 | sAN |
73 41 4E |
|
| Command | Load factory defaults | String | 13 | mSCloadfacdef |
6D 53 43 6C 6F 61 64 66 61 63 64 65 66 |
Example: sAN mSCloadfacdef
CoLa A (ASCII)
CoLa B (binary)
METHOD Load Application Defaults [sMN mSCloadappdef]¶
The Application-Reset (Load application defaults) deletes only the user parametrization of the Fields, Evaluation cases (EVC) and parameters under the header “Application”. Other parameters like Interface settings, Echo Filter, etc. remain unaffected.
Telegram structure: sMN mSCloadappdef
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Method | String | 3 | sMN |
73 4D 4E |
|
| Command | Load application defaults | String | 13 | mSCloadappdef |
6D 53 43 6C 6F 61 64 61 70 70 64 65 66 |
Example: sMN mSCloadappdef
CoLa A (ASCII)
CoLa B (binary)
Telegram structure: sAN mSCloadappdef
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Answer | String | 3 | sAN |
73 41 4E |
|
| Command | Load application defaults | String | 13 | mSCloadappdef |
6D 53 43 6C 6F 61 64 61 70 70 64 65 66 |
Example: sAN mSCloadappdef
CoLa A (ASCII)
CoLa B (binary)
READ Read Checksum [sRN LFTchecksum]¶
This command includes the MD5 checksum of multiple software parts to verify their integrity. The checksums help to ensure files have not been corrupted or altered. They are also important for cybersecurity because they detect unauthorized modifications.
Telegram structure: sRN LFTchecksum
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Read | String | 3 | sRN |
73 52 4E |
|
| Command | MD5 checksum | String | 11 | LFTchecksum |
4C 46 54 63 68 65 63 6B 73 75 6D |
Example: sRN LFTchecksum
CoLa A (ASCII)
CoLa B (binary)
Telegram structure: sRA LFTchecksum
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Answer | String | 3 | sRA |
73 52 41 |
|
| Command | MD5 checksum | String | 11 | LFTchecksum |
4C 46 54 63 68 65 63 6B 73 75 6D |
|
| Variable Data 1 | Checksum validity | Bool_1 | 1 | False: True: |
0 |
00 |
| Variable Data 2 | Length | Uint_16 | 2 | 20 |
32 20 |
|
| Variable Data 2 | Checksum Linux part | FlexString | <hash> |
<hash> |
||
| Variable Data 3 | Length | Uint_16 | 2 | 20 |
32 20 |
|
| Variable Data 3 | Checksum app part | FlexString | <hash> |
<hash> |
||
| Variable Data 4 | Length | Uint_16 | 2 | 20 |
32 20 |
|
| Variable Data 4 | Checksum calibration part | FlexString | <hash> |
<hash> |
||
| Variable Data 5 | Length | Uint_16 | 2 | 20 |
32 20 |
|
| Variable Data 5 | Checksum parameters part | FlexString | <hash> |
<hash> |
Example: sRA LFTchecksum
CoLa A (ASCII)
<STX>sRA{SPC}LFTchecksum{SPC}1{SPC}20{SPC}92b7b9720c40e8b99268229283617dd5{SPC}20{SPC}e002a1c8022b30589ce0e357c87f5a1c{SPC}20{SPC}901736df3fbc807121c46f9eaed8ff28{SPC}20{SPC}588e8386c7cd011d1a8369c4377e2a4c<ETX>
02 73 52 41 20 4C 46 54 63 68 65 63 6B 73 75 6D 20 31 20 32 30 20 39 32 62 37 62 39 37 32 30 63 34 30 65 38 62 39 39 32 36 38 32 32 39 32 38 33 36 31 37 64 64 35 20 32 30 20 65 30 30 32 61 31 63 38 30 32 32 62 33 30 35 38 39 63 65 30 65 33 35 37 63 38 37 66 35 61 31 63 20 32 30 20 39 30 31 37 33 36 64 66 33 66 62 63 38 30 37 31 32 31 63 34 36 66 39 65 61 65 64 38 66 66 32 38 20 32 30 20 35 38 38 65 38 33 38 36 63 37 63 64 30 31 31 64 31 61 38 33 36 39 63 34 33 37 37 65 32 61 34 63 03
CoLa B (binary)
02 02 02 02 00 00 00 99 73 52 41 20 4C 46 54 63 68 65 63 6B 73 75 6D 20 01 00 20 39 32 62 37 62 39 37 32 30 63 34 30 65 38 62 39 39 32 36 38 32 32 39 32 38 33 36 31 37 64 64 35 00 20 65 30 30 32 61 31 63 38 30 32 32 62 33 30 35 38 39 63 65 30 65 33 35 37 63 38 37 66 35 61 31 63 00 20 39 30 31 37 33 36 64 66 33 66 62 63 38 30 37 31 32 31 63 34 36 66 39 65 61 65 64 38 66 66 32 38 00 20 35 38 38 65 38 33 38 36 63 37 63 64 30 31 31 64 31 61 38 33 36 39 63 34 33 37 37 65 32 61 34 63 6F
METHOD Change Password [sMN SetPassword]¶
Changing the log in password for a specific user level.
If logged in with a higher user level you may set the password for lower user levels as well.
Telegram structure: sMN SetPassword
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Method | String | 3 | sMN |
73 4D 4E |
|
| Command | Set password request | String | 13 | SetPassword |
53 65 74 50 61 73 73 77 6F 72 64 |
|
| User level | User level that the password will be applied to | Int_8 | 1 | Maintenance: Authorized client: Service: |
2 |
02 |
| Password | Hash value of the new password | Uint_32 | 4 | <Hash value> |
Set password for 'Authorized client' to “testtest” (hash value = 1920E4C9).
Example: sMN SetPassword
CoLa A (ASCII)
CoLa B (binary)
Calculating the hash value of the password
Telegram structure: sAN SetPassword
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Answer | String | 3 | sAN |
73 41 4E |
|
| Command | Set password requested | String | 13 | SetPassword |
53 65 74 50 61 73 73 77 6F 72 64 |
|
| Success | Confirmation | Int_8 | 1 | Failed: Success: |
0 |
00 |
Example: sAN SetPassword
CoLa A (ASCII)
CoLa B (binary)
METHOD Check Password [sMN CheckPassword]¶
Check the password for a specific user level, e.g. to verify if it has been changed correctly.
Telegram structure: sMN CheckPassword
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Method | String | 3 | sMN |
73 4D 4E |
|
| Command | Check password request | String | 13 | CheckPassword |
43 68 65 63 6B 50 61 73 73 77 6F 72 64 |
|
| User level | User level to check the password for | Int_8 | 1 | Maintenance: Authorized client: Service: |
2 |
02 |
| Password | Hash value of the password to be checked | Uint_32 | 4 | <Hash value> |
Check password “testtest” for 'Authorized client'.
Example: sMN CheckPassword
CoLa A (ASCII)
CoLa B (binary)
Telegram structure: sAN CheckPassword
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Answer | String | 3 | sAN |
73 41 4E |
|
| Command | Check password request | String | 13 | CheckPassword |
43 68 65 63 6B 50 61 73 73 77 6F 72 64 |
|
| Success | Confirmation | Int_8 | 1 | Failed: Success: |
0 |
00 |
Example: sAN CheckPassword
CoLa A (ASCII)
CoLa B (binary)
METHOD Save Parameters Permanently [sMN mEEwriteall]¶
Save all parameter changes of the device. Must be sent before logging off and/ or hardware rebooting of the device. Else all changes will be lost.
Telegram structure: sMN mEEwriteall
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Method | String | 3 | sMN |
73 4D 4E |
|
| Command | Store parameters permanently | String | 11 | mEEwriteall |
6D 45 45 77 72 69 74 65 61 6C 6C |
Example: sMN mEEwriteall
CoLa A (ASCII)
CoLa B (binary)
Telegram structure: sAN mEEwriteall
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Answer | String | 3 | sAN |
73 41 4E |
|
| Command | Store parameters permanently | String | 11 | mEEwriteall |
6D 45 45 77 72 69 74 65 61 6C 6C |
|
| Status code | Accepted when value is 1 | Bool_1 | 1 | Error: Success: |
0 |
00 |
Example: sAN mEEwriteall
CoLa A (ASCII)
CoLa B (binary)
METHOD Set to Run [sMN Run]¶
Log out from device and activate all parameter changes.
Telegram structure: sMN Run
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Method | String | 3 | sMN |
73 4D 4E |
|
| Command | Start the device | String | 3 | Run |
52 75 6E |
Example: sMN Run
CoLa A (ASCII)
CoLa B (binary)
Telegram structure: sAN Run
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Answer | String | 3 | sAN |
73 41 4E |
|
| Command | Start the device | String | 3 | Run |
52 75 6E |
|
| Status code | Accepted when value is 1 | Bool_1 | 1 | Error: Success: |
0 |
00 |
Example: sAN Run
CoLa A (ASCII)
CoLa B (binary)
METHOD Reboot Device [sMN mSCreboot]¶
This command includes saving all parameters.
Telegram structure: sMN mSCreboot
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Method | String | 3 | sMN |
73 4D 4E |
|
| Command | Reboot device | String | 9 | mSCreboot |
6D 53 43 72 65 62 6F 6F 74 |
Example: sMN mSCreboot
CoLa A (ASCII)
CoLa B (binary)
Telegram structure: sAN mSCreboot
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Answer | String | 3 | sAN |
73 41 4E |
|
| Command | Reboot device | String | 9 | mSCreboot |
6D 53 43 72 65 62 6F 6F 74 |
Example: sAN mSCreboot
CoLa A (ASCII)
CoLa B (binary)
Status¶
READ Read the Device State [sRN DevSta]¶
This telegram reads the device state.
Telegram structure: sRN DevSta
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Read | String | 3 | sRN |
73 52 4E |
|
| Command | Read the current device state | String | 13 | DevSta |
44 65 76 53 74 61 |
Example: sRN DevSta
CoLa A (ASCII)
CoLa B (binary)
Telegram structure: sRA DevSta
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Answer | String | 3 | sRA |
73 52 41 |
|
| Command | Read the current device state | String | 13 | DevSta |
44 65 76 53 74 61 |
|
| Status code | Code number | Enum_8 | 1 | Reserved: Startup: Service mode: Normal operation: Suspended operation: Service recommended: Service required: Recoverable error: Fatal error: |
0 |
00 |
Example: sRA DevSta
CoLa A (ASCII)
CoLa B (binary)
EVENT Receive the Device State by Event [sEN DevSta]¶
This telegram reads the device state.
Telegram structure: sEN DevSta
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Event | String | 3 | sEN |
73 45 4E |
|
| Command | Read the current device state | String | 13 | DevSta |
44 65 76 53 74 61 |
|
| Data | Start/ Stop | Bool_1 | 1 | Stop: Start: |
0 |
00 |
Example: sEN DevSta
CoLa A (ASCII)
CoLa B (binary)
Telegram structure: sSN DevSta
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Answer | String | 3 | sSN |
73 53 4E |
|
| Command | Read the current device state | String | 13 | DevSta |
44 65 76 53 74 61 |
|
| Status code | Code number | Enum_8 | 1 | Reserved: Startup: Service mode: Normal operation: Suspended operation: Service recommended: Service required: Recoverable error: Fatal error: |
0 |
00 |
Example: sSN DevSta
CoLa A (ASCII)
CoLa B (binary)
READ Read the Device State [sRN SCdevicestate]¶
This telegram reads the general device state.
Telegram structure: sRN SCdevicestate
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Read | String | 3 | sRN |
73 52 4E |
|
| Command | Read the device state | String | 13 | SCdevicestate |
53 43 64 65 76 69 63 65 73 74 61 74 65 |
Example: sRN SCdevicestate
CoLa A (ASCII)
CoLa B (binary)
Telegram structure: sRA SCdevicestate
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Answer | String | 3 | sRA |
73 52 41 |
|
| Command | Read the device state | String | 13 | SCdevicestate |
53 43 64 65 76 69 63 65 73 74 61 74 65 |
|
| Status code | Code number | Enum_8 | 1 | Busy / logged-in: Ready: Error: |
0 |
00 |
Example: sRA SCdevicestate
CoLa A (ASCII)
CoLa B (binary)
EVENT Receive the Device State by Event [sEN SCdevicestate]¶
This telegram reads the general device state continuously.
Telegram structure: sEN SCdevicestate
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Event | String | 3 | sEN |
73 45 4E |
|
| Command | Read the device state | String | 13 | SCdevicestate |
53 43 64 65 76 69 63 65 73 74 61 74 65 |
|
| Data | Start/ Stop | Bool_1 | 1 | Stop: Start: |
0 |
00 |
Example: sEN SCdevicestate
CoLa A (ASCII)
CoLa B (binary)
Telegram structure: sRA SCdevicestate
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Answer | String | 3 | sSN |
73 53 4E |
|
| Command | Read the device state | String | 13 | SCdevicestate |
53 43 64 65 76 69 63 65 73 74 61 74 65 |
|
| Status code | Code number | Enum_8 | 1 | Busy / logged-in: Ready: Error: |
0 |
00 |
Example: sSN SCdevicestate
CoLa A (ASCII)
CoLa B (binary)
Device Information¶
READ Read Firmware Version [sRN DeviceIdent]¶
Telegram structure: sRN DeviceIdent
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Read | String | 3 | sRN |
73 52 4E |
|
| Command | Read firmware version | String | 11 | DeviceIdent |
44 65 76 69 63 65 49 64 65 6E 74 |
Example: sRN DeviceIdent
CoLa A (ASCII)
CoLa B (binary)
Telegram structure: sRA DeviceIdent
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Answer | String | 3 | sRA |
73 52 41 |
|
| Command | String | 11 | DeviceIdent |
44 65 76 69 63 65 49 64 65 6E 74 |
||
| Value | Length of firmware designation | Enum_16 | 2 | 0 ... 22h |
0 ... 22h |
|
| Value | Firmware designation for device family | String | (See example) |
(See example) |
||
| Value | Length of firmware version | Enum_16 | 2 | 0 ... 22h |
0 ... 22h |
|
| Value | Firmware version | String | (See example) |
(See example) |
Example: sRA DeviceIdent
CoLa A (ASCII)
02 73 52 41 20 44 65 76 69 63 65 49 64 65 6E 74 20 38 20 70 69 63 6F 53 63 61 6E 20 38 20 31 2E 32 2E 30 2E 30 42 03
CoLa B (binary)
READ Read Version of the Application Software [sRN FirmwareVersion]¶
Telegram structure: sRN FirmwareVersion
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Read | String | 3 | sRN |
73 52 4E |
|
| Command | Read version of the application software | String | 15 | FirmwareVersion |
46 69 72 6D 77 61 72 65 56 65 72 73 69 6F 6E |
Example: sRN FirmwareVersion
CoLa A (ASCII)
CoLa B (binary)
Telegram structure: sRA FirmwareVersion
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Answer | String | 3 | sRA |
73 52 41 |
|
| Command | Read version of the application software | String | 15 | FirmwareVersion |
46 69 72 6D 77 61 72 65 56 65 72 73 69 6F 6E |
|
| Value | Length of version | Uint_16 | 2 | 0 ... 28h |
0 ... 28h |
|
| Value | Version | String | 16 | (See example) |
(See example) |
Example: sRA FirmwareVersion
CoLa A (ASCII)
02 73 52 41 20 46 69 72 6D 77 61 72 65 56 65 72 73 69 6F 6E 20 31 34 20 31 2E 32 2E 30 2D 62 2E 30 2B 31 32 32 35 2E 35 32 33 65 66 03
CoLa B (binary)
READ Read Device Order Number [sRN OrdNum]¶
This telegram reads the device order number which corresponds to the SICK part number of the device.
Telegram structure: sRN OrdNum
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Read | String | 3 | sRN |
73 52 4E |
|
| Command | Read device order number | String | 6 | OrdNum |
4F 72 64 4E 75 6D |
Example: sRN OrdNum
CoLa A (ASCII)
CoLa B (binary)
Telegram structure: sRA OrdNum
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Answer | String | 3 | sRA |
73 52 41 |
|
| Command | Read device order number | String | 6 | OrdNum |
4F 72 64 4E 75 6D |
|
| Length | Number of characters of the following order number | Uint_16 | 2 | 0h ... 20h |
00 00 ... 00 20 |
|
| Order number | Order number in 7 digits | String | 7 | 0000000 … 9999999 |
00 00 00 00 00 00 00 … FF FF FF FF FF FF FF |
Example: sRA OrdNum 1134610 (Order Number for picoScan150 Pro-1)
Example for picoScan150 Pro-1: sRA OrdNum
CoLa A (ASCII)
CoLa B (binary)
READ Read Serial Number [sRN SerialNumber]¶
Read the serial number of the device.
Telegram structure: sRN SerialNumber
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Read | String | 3 | sRN |
73 52 4E |
|
| Command | Read serial number of the device | String | 12 | SerialNumber |
53 65 72 69 61 6C 4E 75 6D 62 65 72 |
Example: sRN SerialNumber
CoLa A (ASCII)
CoLa B (binary)
Telegram structure: sRA SerialNumber
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Answer | String | 3 | sRA |
73 52 41 |
|
| Command | Read serial number of the device | String | 12 | SerialNumber |
53 65 72 69 61 6C 4E 75 6D 62 65 72 |
|
| Length of serial number | Number of characters of the serial number | Uint_16 | 2 | 0 ... 8h |
00 00 ... 00 08h |
|
| Serial number | Production period (year, calendar week, number): YYWWxxxx | String | 8 | (See example) |
(See example) |
Example: sRA SerialNumber
CoLa A (ASCII)
CoLa B (binary)
READ Read Device Type [sRN DItype]¶
This telegram asks for the device type of the product family.
Telegram structure: sRN DItype
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Read | String | 3 | sRN |
73 52 4E |
|
| Command | Ask state | String | 6 | DItype |
44 49 74 79 70 65 |
Example: sRN DItype
CoLa A (ASCII)
CoLa B (binary)
Telegram structure: sRA DItype
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Answer | String | 3 | sRA |
73 52 41 |
|
| Command | Ask state | String | 6 | DItype |
44 49 74 79 70 65 |
|
| Length of type key | Number of characters of the following type code | Uint_16 | 2 | 0d … 65535d (0h … FFFFh) |
00 00 … FF FF |
|
| Device type | Type code of the device | String | (var.) | (Device type) |
(Device type) |
Example: sRA DItype (picoScan150)
CoLa A (ASCII)
CoLa B (binary)
WRITE Set Device Name [sWN LocationName]¶
Give the device a specific description name such as its location.
Telegram structure: sWN LocationName
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Write | String | 3 | sWN |
73 57 4E |
|
| Command | Set device name | String | 12 | LocationName |
4C 6F 63 61 74 69 6F 6E 4E 61 6D 65 |
|
| Value | Number of characters of the following device name | Uint_16 | 2 | 0d … +16d (0h … 10h ) |
00 00 … 00 10 |
|
| Value | Device name | String | 32 | [Device name] |
[Device name] |
Example: sWN LocationName +9 LongRange
CoLa A (ASCII)
CoLa B (binary)
02 02 02 02 00 00 00 1C 73 57 4E 20 4C 6F 63 61 74 69 6F 6E 4E 61 6D 65 20 00 09 4C 6F 6E 67 52 61 6E 67 65 0C
Telegram structure: sWA LocationName
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Answer | String | 3 | sWA |
73 57 41 |
|
| Command | Set device name | String | 12 | LocationName |
4C 6F 63 61 74 69 6F 6E 4E 61 6D 65 |
Example: sWA LocationName
CoLa A (ASCII)
CoLa B (binary)
READ Read Device Name [sRN LocationName]¶
Read the given name of the device (Default is the serial number of the device).
Telegram structure: sRN LocationName
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Read | String | 3 | sRN |
73 52 4E |
|
| Command | Read device name | String | 12 | LocationName |
4C 6F 63 61 74 69 6F 6E 4E 61 6D 65 |
Example: sRN LocationName
CoLa A (ASCII)
CoLa B (binary)
Telegram structure: sRA LocationName
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Find complete telegram structure of the answer in |
METHOD Initiate an Acoustic or Visual Signal for a Defined Period of Time [sMN FindMe]¶
This command can be used to make the device easier to find.
Telegram structure: sMN FindMe
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Method | String | 3 | sMN |
73 4D 4E |
|
| Command | Initiate an acoustic or visual signal | String | 11 | FindMe |
46 69 6E 64 4D 65 |
|
| Period of time | Duration in seconds | Uint_16 | 2 | 0d … 65535d (0h .. FF FF) |
00 ... FF FF |
Example: sMN FindMe
CoLa A (ASCII)
CoLa B (binary)
Telegram structure: sAN FindMe
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Answer | String | 3 | sAN |
73 41 4E |
|
| Command | Initiate an acoustic or visual signal | String | 11 | FindMe |
46 69 6E 64 4D 65 |
Example: sAN FindMe
CoLa A (ASCII)
CoLa B (binary)
Basic Settings¶
READ Read for Frequency and Angular Resolution [sRN LMPscancfg]¶
Read the scanning frequency, angular resolution and aperture angle of the device. Values show the information of the values before any filters are applied. Therefore aperture angle is always showing the maximum, scanning frequency and angular resolution may also be static depending on device family.
Telegram structure: sRN LMPscancfg
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Read | String | 3 | sRN |
73 52 4E |
|
| Command | Info of scan frequency and angular resolution | String | 10 | LMPscancfg |
4C 4D 50 73 63 61 6E 63 66 67 |
Example: sRN LMPscancfg
CoLa A (ASCII)
CoLa B (binary)
Telegram structure: sRA LMPscancfg
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Answer | String | 3 | sRA |
73 52 41 |
|
| Command | Info of scan frequency and angular resolution | String | 10 | LMPscancfg |
4C 4D 50 73 63 61 6E 63 66 67 |
|
| Scan frequency | [1/100 Hz] | Uint_32 | 4 | 15 Hz ... 50 Hz: (depends on Dynamic Sensing Profile ) |
5DCh ... 1388h |
05 DC ... 13 88 |
| Reserved | - | Int_16 | 2 | Always: | 1 |
00 01 |
| Angular resolution | [1/10000°] | Uint_32 | 4 | 0.1° ... 1°: (depends on Dynamic Sensing Profile ) |
3E8h … 2710h |
03 E8 ... 27 10 |
| Start angle | [1/10000°] | Int_32 | 4 | -48° ... 228° | FFF8AD00h … 22CA40h |
FF F8 AD 00h … 00 22 CA 40h |
| Stop angle | [1/10000°] | Int_32 | 4 | -48° ... 228° | FFF8AD00h … 22CA40h |
FF F8 AD 00h … 00 22 CA 40h |
Example: sRA LMPscancfg - 30 Hz scan frequency, 0.1° angular resolution, -138° start angle, +138° stop angle
CoLa A (ASCII)
02 73 52 41 20 4C 4D 50 73 63 61 6E 63 66 67 20 42 42 38 20 31 20 33 45 38 20 46 46 45 41 46 31 36 30 20 31 35 30 45 41 30 03
CoLa B (binary)
METHOD Activate Standby Mode [sMN LMCstandby]¶
Shut off the laser in order to extend the lifetime of laser diode and reduce motor speed to 25 Hz.
Telegram structure: sMN LMCstandby
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Method | String | 3 | sMN |
73 4D 4E |
|
| Command | Set device to standby | String | 10 | LMCstandby |
4C 4D 43 73 74 61 6E 64 62 79 |
Example: sMN LMCstandby
CoLa A (ASCII)
CoLa B (binary)
Telegram structure: sAN LMCstandby
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Answer | String | 3 | sAN |
73 41 4E |
|
| Command | Set device to standby | String | 10 | LMCstandby |
4C 4D 43 73 74 61 6E 64 62 79 |
|
| Status code | Accepted when value is 0 | Enum_8 | 1 | Success: Not allowed: |
0 |
00 |
Example: sAN LMCstandby
CoLa A (ASCII)
CoLa B (binary)
METHOD Start Measurement [sMN LMCstartmeas]¶
Start the laser and (unless in Standby mode) the motor of the device
Telegram structure: sMN LMCstartmeas
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Method | String | 3 | sMN |
73 4D 4E |
|
| Command | Start measurement | String | 12 | LMCstartmeas |
4C 4D 43 73 74 61 72 74 6D 65 61 73 |
Example: sMN LMCstartmeas
CoLa A (ASCII)
CoLa B (binary)
Telegram structure: sAN LMCstartmeas
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Answer | String | 3 | sAN |
73 41 4E |
|
| Command | Start measurement | String | 12 | LMCstartmeas |
4C 4D 43 73 74 61 72 74 6D 65 61 73 |
|
| Status code | Accepted when value is 0 | Enum_8 | 1 | Success: Not allowed: |
0 |
00 |
Example: sAN LMCstartmeas
CoLa A (ASCII)
CoLa B (binary)
METHOD Stop Measurement [sMN LMCstopmeas]¶
Shut off the laser and the motor is running at the set up frequency.
Telegram structure: sMN LMCstopmeas
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Method | String | 3 | sMN |
73 4D 4E |
|
| Command | Stop measurement | String | 11 | LMCstopmeas |
4C 4D 43 73 74 6F 70 6D 65 61 73 |
Example: sMN LMCstopmeas
CoLa A (ASCII)
CoLa B (binary)
Telegram structure: sAN LMCstopmeas
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Answer | String | 3 | sAN |
73 41 4E |
|
| Command | Stop measurement | String | 11 | LMCstopmeas |
4C 4D 43 73 74 6F 70 6D 65 61 73 |
|
| Status code | Accepted when value is 0 | Enum_8 | 1 | No error: Not allowed: |
0 |
00 |
Example: sAN LMCstopmeas
CoLa A (ASCII)
CoLa B (binary)
WRITE Autostart Measurement [sWN LMPautostartmeas]¶
This parameter defines whether the scanner will start to rotate directly and measure when powering up or remain in idle mode. The changed setting (saved with the command sMN mEEWriteall, ) will be then be active with the next power-up cycle.
In case autostart is deactivated, the sensor will remain in idle mode with the laser switched off and a motor speed depending on the Dynamic Sensing Profile .
Telegram structure: sWN LMPautostartmeas
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Write | String | 3 | sWN |
73 57 4E |
|
| Command | Autostart measurement | String | 16 | LMPautostartmeas |
4C 4D 50 61 75 74 6F 73 74 61 72 74 6D 65 61 73 |
|
| Status code | Activate / Deactivate Autostart | Bool_1 | 1 | Autostart off: Autostart on: |
0 |
00 |
Example: sWN LMPautostartmeas 1
CoLa A (ASCII)
CoLa B (binary)
Telegram structure: sWA LMDautostartmeas
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Answer | String | 3 | sWA |
73 57 41 |
|
| Command | Autostart measurement | String | 16 | LMPautostartmeas |
4C 4D 50 61 75 74 6F 73 74 61 72 74 6D 65 61 73 |
Example: sWA LMPautostartmeas
CoLa A (ASCII)
CoLa B (binary)
WRITE Set Sensitivity Mode [sWN SensitivityMode]¶
Define a sensitivity mode for the detection of reflectors .
Telegram structure: sWN SensitivityMode
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Write | String | 3 | sWN |
73 57 4E |
|
| Command | Sensitivity Mode | String | 15 | SensitivityMode |
53 65 6E 73 69 74 69 76 69 74 79 4D 6F 64 65 |
|
| Sensitivity | Choose Sensitivity Mode | Enum_8 | 1 | Maximum robustness: Standard (recommended): Maximum detectivity: |
0 |
00 |
Example: sWN SensitivityMode
CoLa A (ASCII)
CoLa B (binary)
Telegram structure: sWA SensitivityMode
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Answer | String | 3 | sWA |
73 57 41 |
|
| Command | Sensitivity Mode | String | 15 | SensitivityMode |
53 65 6E 73 69 74 69 76 69 74 79 4D 6F 64 65 |
Example: sWA SensitivityMode
CoLa A (ASCII)
CoLa B (binary)
WRITE Set Performance Profile [sWN PerformanceProfileNumber]¶
Define which Dynamic Sensing Profile shall be used, .
Telegram structure: sWN PerformanceProfileNumber
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Write | String | 3 | sWN |
73 57 4E |
|
| Command | Set Dynamic Sensing Profile | String | 24 | PerformanceProfileNumber |
50 65 72 66 6F 72 6D 61 6E 63 65 50 72 6F 66 69 6C 65 4E 75 6D 62 65 72 |
|
| Performance Profile | Selection of Dynamic Sensing Profile | Enum_8 | 1 | Profile 1: Profile 2: Profile 3: Profile 4: Profile 5: Profile 6: Profile 7: Profile 8: Profile 9: Profile 10: Profile 11: |
1 |
01 |
Example: sWN PerformanceProfileNumber
CoLa A (ASCII)
CoLa B (binary)
02 02 02 02 00 00 00 1E 73 57 4E 20 50 65 72 66 6F 72 6D 61 6E 63 65 50 72 6F 66 69 6C 65 4E 75 6D 62 65 72 20 02 58
Telegram structure: sWA PerformanceProfileNumber
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Answer | String | 3 | sWA |
73 57 41 |
|
| Command | Set Performance Profile | String | 24 | PerformanceProfileNumber |
50 65 72 66 6F 72 6D 61 6E 63 65 50 72 6F 66 69 6C 65 4E 75 6D 62 65 72 |
Example: sWA PerformanceProfileNumber
CoLa A (ASCII)
CoLa B (binary)
WRITE Activate Extended Range Mode [sWN EnableLongRangeMode]¶
Extends the maximum scanning distance .
Telegram structure: sWN EnableLongRangeMode
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Write | String | 3 | sWN |
73 57 4E |
|
| Command | Enable extended range mode | String | 19 | EnableLongRangeMode |
45 6E 61 62 6C 65 4C 6F 6E 67 52 61 6E 67 65 4D 6F 64 65 |
|
| Status code | Activate / deactivate extended range mode | Bool_1 | 1 | Inactive: Active: |
0 |
00 |
Example: sWN EnableLongRangeMode 1
CoLa A (ASCII)
CoLa B (binary)
02 02 02 02 00 00 00 19 73 57 4E 20 45 6E 61 62 6C 65 4C 6F 6E 67 52 61 6E 67 65 4D 6F 64 65 20 01 1C
Telegram structure: sWA EnableLongeRangeModer
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Answer | String | 3 | sWA |
73 57 41 |
|
| Command | Enable extended range mode | String | 19 | EnableLongRangeMode |
45 6E 61 62 6C 65 4C 6F 6E 67 52 61 6E 67 65 4D 6F 64 65 |
Example: sWA EnableLongeRangeMode
CoLa A (ASCII)
CoLa B (binary)
READ Read Status of Extended Range Mode [sRN EnableLongRangeMode]¶
Read if the extended range mode is currently active.
Telegram structure: sRN EnableLongRangeMode
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Read | String | 3 | sRN |
73 52 4E |
|
| Command | Read status of extended range mode | String | 19 | EnableLongRangeMode |
45 6E 61 62 6C 65 4C 6F 6E 67 52 61 6E 67 65 4D 6F 64 65 |
Example: sRN EnableLongRangeMode
CoLa A (ASCII)
CoLa B (binary)
Telegram structure: sRA EnableLongRangeMode
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Answer | String | 3 | sRA |
73 52 41 |
|
| Command | Read status of extended range mode | String | 19 | EnableLongRangeMode |
45 6E 61 62 6C 65 4C 6F 6E 67 52 61 6E 67 65 4D 6F 64 65 |
|
| Status code | Status of extended range mode | Bool_1 | 1 | Inactive: Active: |
0 |
00 |
Example: sRA EnableLongRangeMode
CoLa A (ASCII)
CoLa B (binary)
WRITE Enable/ Disable LEDs [sWN LEDEnable]¶
This command enables/ disables the LEDs of the device.
Telegram structure: sWN LEDEnable
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Method | String | 3 | sWN |
73 57 4E |
|
| Command | Set LEDs | String | 9 | LEDEnable |
4C 45 44 45 6E 61 62 6C 65 |
|
| Status | Enable/ disable | Bool_1 | 1 | Off: On: |
0 |
00 |
Example: sWN LEDEnable
CoLa A (ASCII)
CoLa B (binary)
Telegram structure: sWA LEDEnable
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Answer | String | 3 | sWA |
73 57 41 |
|
| Command | Set LEDs | String | 9 | LEDEnable |
4C 45 44 45 6E 61 62 6C 65 |
Example: sWA LEDEnable
CoLa A (ASCII)
CoLa B (binary)
READ Read State of LEDs [sRN LEDState]¶
Read the current state of the LEDs.
Telegram structure: sRN LEDState
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Method | String | 3 | sRN |
73 52 4E |
|
| Command | Read state of LEDs | String | 8 | LEDState |
4C 45 44 53 74 61 74 65 |
Example: sRN LEDState
CoLa A (ASCII)
CoLa B (binary)
Telegram structure: sRA LEDState
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Answer | String | 3 | sRA |
73 52 41 |
|
| Command | State of LEDs | String | 8 | LEDState |
4C 45 44 53 74 61 74 65 |
|
| LED Color | - | Enum_8 | 1 | Green: Yellow: Red: |
0 |
00 |
| LED behavior | - | Enum_8 | 1 | On: Off: Blinking: Blinking fast: Blinking delayed: Find me active: |
0 |
00 |
| LED ID | Name of the LED | String | 8 | LED1 |
4C 45 44 31 |
Example: sRA LEDState
CoLa A (ASCII)
<STX>sRA{SPC}LEDState{SPC}2{SPC}0{SPC}0{SPC}LED2{SPC}0{SPC}0{SPC}0{SPC}0{SPC}1{SPC}0{SPC}LED1{SPC}0{SPC}0{SPC}0{SPC}0<ETX>
02 73 52 41 20 4C 45 44 53 74 61 74 65 20 32 20 30 20 30 20 4C 45 44 32 00 00 00 00 20 31 20 30 20 4C 45 44 31 00 00 00 00 03
CoLa B (binary)
Date and System Time¶
WRITE Set Time Synchronization [sWN TSCRole]¶
Set the device synchronization mode.
Telegram structure: sWN TSCRole
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Write | String | 3 | sWN |
73 57 4E |
|
| Command | Set timestamp role | String | 7 | TSCRole |
54 53 43 52 6F 6C 65 |
|
| Status | Timestamp role | Uint_8 | 1 | Off: NTP: PTP: |
0 |
00 |
Example: sWN TSCRole
CoLa A (ASCII)
CoLa B (binary)
Telegram structure: sWA TSCRole
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Answer | String | 3 | sWA |
73 57 41 |
|
| Command | Set timestamp role | String | 7 | TSCRole |
54 53 43 52 6F 6C 65 |
Example: sWA TSCRole
CoLa A (ASCII)
CoLa B (binary)
METHOD Set Time Stamp [sMN LSPsetdatetime]¶
The data format in the telegram is: +2009{SPC}+7{SPC}+22{SPC}+12{SPC}+0{SPC}+0{SPC}+0.The numbers represent year, month, day, hour, minute, second, microsecond.
If plus is used up-front the data it is interpreted as an integer decimal number, without the plus it's the scanner reads the data as hex format.
The answer is always in ASCII format.
Does only work if NTP- respectively PTP-Client is not active.
There is no real time clock inside the device. When the scanner is switched off and after a reboot, the time has to be set again. Therefore, it is recommended to use a NTP or a PTP setting.
Telegram structure: sMN LSPsetdatetime
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Method | String | 3 | sMN |
73 4D 4E |
|
| Command | Set time stamp | String | 14 | LSPsetdatetime |
4C 53 50 73 65 74 64 61 74 65 74 69 6D 65 |
|
| Year | Uint_16 | 2 | +1970d … +2099d (07B2h … 0833h) |
07 B2 … 08 33 |
||
| Month | Uint_8 | 1 | +1d … +12d(01h … 0Ch) |
01 … 0C |
||
| Day | Uint_8 | 1 | +1d … +31d(01h … 1Fh) |
00 … 1F |
||
| Hour | Uint_8 | 1 | +0d … +23d(00h … 17h) |
00 … 17 |
||
| Minute | Uint_8 | 1 | +0d … +59d(00h … 3Bh) |
00 … 3B |
||
| Second | Uint_8 | 1 | +0d … +59d(00h … 3Bh) |
00 … 3B |
||
| Microsecond | Uint_32 | 4 | +0d … +999999d(00000000h … 000F423Fh) |
00 00 00 00 … 00 0F 42 3F |
Example 1: sMN LSPsetdatetime Date: 17.02.2009; Time: 16:34
CoLa A (ASCII)
02 73 4D 4E 20 4C 53 50 73 65 74 64 61 74 65 74 69 6D 65 20 37 44 39 20 32 20 31 31 20 31 30 20 32 32 20 30 20 30 03
CoLa B (binary)
02 02 02 02 00 00 00 1E 73 4D 4E 20 4C 53 50 73 65 74 64 61 74 65 74 69 6D 65 20 07 D9 02 11 10 22 00 00 00 00 00 A3
Example 2: sMN LSPsetdatetime Date: 26.01.2010; Time: 10:35
CoLa A (ASCII)
02 73 4D 4E 20 4C 53 50 73 65 74 64 61 74 65 74 69 6D 65 20 2B 32 30 31 30 20 2B 30 31 20 2B 32 36 20 2B 31 30 20 2B 33 35 20 2B 30 30 20 2B 30 30 30 30 03
CoLa B (binary)
02 02 02 02 00 00 00 1E 73 4D 4E 20 4C 53 50 73 65 74 64 61 74 65 74 69 6D 65 20 07 DA 01 1A 0A 23 00 00 00 00 00 B3
Telegram structure: sAN LSPsetdatetime
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Answer | String | 3 | sAN |
73 41 4E |
|
| Command | Set time stamp | String | 14 | LSPsetdatetime |
4C 53 50 73 65 74 64 61 74 65 74 69 6D 65 |
|
| Status code | Code number | Enum_8 | 1 | Success: | 0 |
00 |
Example 1, 2: sAN LSPsetdatetime
CoLa A (ASCII)
CoLa B (binary)
Activate time stamp in the output string format or on SOPAS page “data processing”.
Set NTP (Network Time Protocol) Parameters
WRITE Set Time Server IP Address [sWN TSCTCSrvAddr]¶
Define the IP address from which the device will receive the time synchronization.
Telegram structure: sWN TSCTCSrvAddr
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Write | String | 3 | sWN |
73 57 4E |
|
| Command | Set time server IP address | String | 12 | TSCTCSrvAddr |
54 53 43 54 43 53 72 76 41 64 64 72 |
|
| IP address data | Set values | Uint_8 | 1 | First part of IP address | 0 …+255d (00…FF) |
00 … FF |
| IP address data | Set values | Uint_8 | 1 | Second part of IP address | 0 …+255d (00…FF) |
00 … FF |
| IP address data | Set values | Uint_8 | 1 | Third part of IP address | 0 …+255d (00…FF) |
00 … FF |
| IP address data | Set values | Uint_8 | 1 | Fourth part of IP address | 0 …+255d (00…FF) |
00 … FF |
Example: sWN TSCTCSrvAddr 192.168.0.11
CoLa A (ASCII)
CoLa B (binary)
Telegram structure: sWA TSCTCSrvAddr
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Answer | String | 3 | sWA |
73 57 41 |
|
| Command | Set time server IP address | String | 12 | TSCTCSrvAddr |
54 53 43 54 43 53 72 76 41 64 64 72 |
Example: sWA TSCTCSrvAddr
CoLa A (ASCII)
CoLa B (binary)
WRITE Set Time Zone [sWN TSCTCtimezone]¶
Telegram structure: sWN TSCTCtimezone
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Write | String | 3 | sWN |
73 57 4E |
|
| Command | Set time zone | String | 13 | TSCTCtimezone |
54 53 43 54 43 74 69 6D 65 7A 6F 6E 65 |
|
| Time zone data | Select the time zone of the client | Enum_8 | 1 | List of time zones | +0d … +104d (00h … 68h) |
00 … 68 |
Time zone data Values CoLa (ASCII)
| Value | Time zone | Value | Time zone | Value | Time zone |
|---|---|---|---|---|---|
| 0 | DATE_LINE_STANDARD | 35 | MONROVIA_REYKJAVIK | 70 | MUMBAI_NEUDELHI |
| 1 | COORD_WORLD_TIME_11 | 36 | AMSTERDAM_BERLIN_ROM | 71 | SRI_JAYAWARDENEPURA |
| 2 | HAWAII | 37 | BELGRAD_BUDAPEST_PRAG | 72 | KATMANDU |
| 3 | ALASKA | 38 | BRUESSEL_MADRID_PARIS | 73 | ASTANA |
| 4 | CALIFORNIA | 39 | SARAJEVO_WARSCHAU | 74 | DAKKA |
| 5 | USA_CANADA | 40 | WEST_CENTRAL_AFRICA | 75 | NOWOSIBIRSK |
| 6 | ARIZONA | 41 | WINDHUK | 76 | YANGON |
| 7 | LA_PAZ | 42 | AMMAN | 77 | BANGKOK_HANOI_JAKARTA |
| 8 | MOUNTAIN_TIME_USA | 43 | ATHEN_BUKAREST | 78 | KRASNOJARSK |
| 9 | CENTRAL_TIME_USA | 44 | BEIRUT | 79 | IRKUTSK |
| 10 | MEXICO_CITY | 45 | DAMASCUS | 80 | KUALA_LUMPUR_SINGAPUR |
| 11 | MIDDLE_AMERICA | 46 | HARARE_PRETORIA | 81 | PEKING_HONGKONG |
| 12 | SASKATCHEWAN | 47 | HELSINKI_KIEW_RIGA | 82 | PERTH |
| 13 | BOGOTA_LIMA | 48 | ISTANBUL | 83 | TAIPEH |
| 14 | EASTERN_TIME_USA | 49 | JERUSALEM | 84 | ULAN_BATOR |
| 15 | INDIANA | 50 | KAIRO | 85 | JAKUTSK |
| 16 | CARACAS | 51 | KALININGRAD | 86 | OSAKA_TOKIO |
| 17 | ASUNCION | 52 | EASTERN_EUROPE | 87 | SEOUL |
| 18 | ATLANTIC_KANADA | 53 | TRIPOLIS | 88 | ADELAIDE |
| 19 | CUIABA | 54 | BAGDAD | 89 | DARWIN |
| 20 | LAPAZ_SANJUAN | 55 | KUWAIT_RIAD | 90 | BRISBANE |
| 21 | SANTIAGO | 56 | MINSK | 91 | CANBERRA_SYDNEY |
| 22 | NEUFUNDLAND | 57 | MOSKAU_PETERSBURG | 92 | GUAM_PORT_MORESBY |
| 23 | BRASILIA | 58 | NAIROBI | 93 | HOBART |
| 24 | BUENOS_AIRES | 59 | TEHERAN | 94 | MAGADAN |
| 25 | CAYENNE_FORTALEZA | 60 | ABU_DHABI | 95 | WLADIWOSTOK |
| 26 | GROENLAND | 61 | BAKU | 96 | SALOMONEN_KALEDONIEN |
| 27 | MONTEVIDEO | 62 | ERIWAN | 97 | TSCHOKURDACH |
| 28 | SALVADOR | 63 | ISCHEWSK_SAMARA | 98 | ANADYR |
| 29 | COORD_WORLD_TIME_02 | 64 | PORT_LOUIS | 99 | AUCKLAND_WELLINGTON |
| 30 | AZOREN | 65 | TIFLIS | 100 | FIDSCHI |
| 31 | KAP_VERDE | 66 | KABUL | 101 | COORD_WORLD_TIME_12 |
| 32 | CASABLANCA | 67 | ASCHGABET_TASCHKENT | 102 | NAKUALOFA |
| 33 | DUBLIN_LISSABON_LONDON | 68 | ISLAMABAD_KARATSCHI | 103 | SAMOA |
| 34 | COORD_WORLD_TIME | 69 | JEKATERINBURG | 104 | KIRITIMATI |
Example: sWN TSCTCtimezone Amsterdam, Berlin, Rom
CoLa A (ASCII)
CoLa B (binary)
Telegram structure: sWA TSCTCtimezone
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Answer | String | 3 | sWA |
73 57 41 |
|
| Command | Set time zone | String | 13 | TSCTCtimezone |
54 53 43 54 43 74 69 6D 65 7A 6F 6E 65 |
Example: sWA TSCTCtimezone
CoLa A (ASCII)
CoLa B (binary)
WRITE Set Update Time [sWN TSCTCupdatetime]¶
Define the time period after which the sensor will attempt to get the current system time for the TSC server.
Telegram structure: sWN TSCTCupdatetime
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Write | String | 3 | sWN |
73 57 4E |
|
| Command | Set update time of synchronization | String | 15 | TSCTCupdatetime |
54 53 43 54 43 75 70 64 61 74 65 74 69 6D 65 |
|
| Update time of synchronization | Set values in seconds | Uint_32 | 4 | +1d … +3600d(01h … 0E10h) |
00 00 00 00 … 00 00 0E 10 |
Example: sWN TSCTCupdatetime 600 s
CoLa A (ASCII)
CoLa B (binary)
Telegram structure: sWA TSCTCupdatetime
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Answer | String | 3 | sWA |
73 57 41 |
|
| Command | Set update time of synchronization | String | 15 | TSCTCupdatetime |
54 53 43 54 43 75 70 64 61 74 65 74 69 6D 65 |
Example: sWA TSCTCupdatetime
CoLa A (ASCII)
CoLa B (binary)
Filter¶
WRITE Set Particle Filter [sWN LFPparticle]¶
Filter out disturbances in the meausurement data caused by particles such as dust, snow flakes or similar .
Telegram structure: sWN LFPparticle
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Write | String | 3 | sWN |
73 57 4E |
|
| Command | Set particle filter | String | 11 | LFPparticle |
4C 46 50 70 61 72 74 69 63 6C 65 |
|
| Status code | Code number | Bool_1 | 1 | Inactive: Active: |
0 |
00 |
| Threshold1) | Particle threshold in mm | Uint_16 | 2 | (must be taken) | +500d (1F4h) |
01 F4 |
Never change the threshold here, it is taken by the device to handle the particles.
Example: sWN LFPparticle
CoLa A (ASCII)
CoLa B (binary)
Telegram structure: sWA LFPparticle
| Telegram part | Description | Variable | Length | Sensor | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Answer | String | 3 | sWA |
73 57 41 |
|
| Command | Set particle filter | String | 11 | LFPparticle |
4C 46 50 70 61 72 74 69 63 6C 65 |
Example: sWA LFPparticle
CoLa A (ASCII)
CoLa B (binary)
WRITE Set Echo Filter [sWN FREchoFilter]¶
Only available with firmware versions > V1.10.
Select which measurement value(s) shall be sent via LMDscandata if the measurement of one angular position returns several distance values
Telegram structure: sWN FREchoFilter
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Write | String | 3 | sWN |
73 57 4E |
|
| Command | Set echo filter | String | 12 | FREchoFilter |
46 52 45 63 68 6F 46 69 6C 74 65 72 |
|
| Status code | Code number | Enum_8 | 1 | First echo: All echos: Last echo: |
0 |
00 |
Example: sWN FREchoFilter
CoLa A (ASCII)
CoLa B (binary)
Telegram structure: sWA FREchoFilter
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Answer | String | 3 | sWA |
73 57 41 |
|
| Command | Set echo filter | String | 12 | FREchoFilter |
46 52 45 63 68 6F 46 69 6C 74 65 72 |
Example: sWa FREchoFilter
CoLa A (ASCII)
CoLa B (binary)
WRITE Set Sensitivity Fog Filter [sWN MCSenseLevel]¶
Filter out disturbances in the meausurement data caused by fog or steam.
Telegram structure: sWN MCSenseLevel
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Write | String | 3 | sWN |
73 57 4E |
|
| Command | Sense level | String | 12 | MCSenseLevel |
4D 43 53 65 6E 73 65 4C 65 76 65 6C |
|
| Sensitivity level | Enable or disable fog filter and Sense Level | Uint_8 | 1 | Fog Filter off Fog Filter on |
0 |
00 |
Example: sWN MCSenseLevel
CoLa A (ASCII)
CoLa B (binary)
Telegram structure: sWA MCSenseLevel
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Answer | String | 3 | sWA |
73 57 41 |
|
| Command | Sense level | String | 12 | MCSenseLevel |
4D 43 53 65 6E 73 65 4C 65 76 65 6C |
Example: sWA MCSenseLevel
CoLa A (ASCII)
CoLa B (binary)
WRITE Set Moving Averaging Filter [sWN LFPmovingAveragingFilter]¶
Enables the moving average filter
Telegram structure: sWN LFPmovingAveragingFilter
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Write | String | 3 | sWN |
73 57 4E |
|
| Command | String | String | 24 | LFPmovingAveragingFilter |
4C 46 50 6D 6F 76 69 6E 67 41 76 65 72 61 67 69 6E 67 46 69 6C 74 65 72 |
|
| Variable Data 1 | Moving averaging is enabled | Bool | 1 | Off: On: |
0d (00h) |
00 |
| Variable Data 2 | averaging depth | UInt | 2 | Minimum: Maximum: |
+2d (02h) |
00 02 |
Disable the moving average filter and set averaging depth to 3
Example: sWN LFPmovingAveragingFilter +0 +3
CoLa A (ASCII)
02 73 57 4E 20 4C 46 50 6D 6F 76 69 6E 67 41 76 65 72 61 67 69 6E 67 46 69 6C 74 65 72 20 2B 30 20 2B 33 03
CoLa B (binary)
02 02 02 02 00 00 00 20 73 57 4E 20 4C 46 50 6D 6F 76 69 6E 67 41 76 65 72 61 67 69 6E 67 46 69 6C 74 65 72 20 00 00 03 41
Telegram structure: sWA LFPmovingAveragingFilter
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Answer | String | 3 | sWA |
73 57 41 |
|
| Command | String | String | 24 | LFPmovingAveragingFilter |
4C 46 50 6D 6F 76 69 6E 67 41 76 65 72 61 67 69 6E 67 46 69 6C 74 65 72 |
Example: sWA LFPmovingAveragingFilter
CoLa A (ASCII)
CoLa B (binary)
Contamination Indication¶
WRITE Set Contamination Indication Settings [sWN ContaminationConfig]¶
Define how and under which conditions the device shall indicate a potential contamination of the optics cover to enable preventive cleaning.
Telegram structure: sWN ContaminationConfig
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Write | String | 3 | sWN |
73 57 4E |
|
| Command | String | 19 | ContaminationConfig |
43 6F 6E 74 61 6D 69 6E 61 74 69 6F 6E 43 6F 6E 66 69 67 |
||
| Strategy | Strategy code | Enum_8 | 1 | No output: All sectors contaminated: One sector contaminated: |
0 |
00 |
| Response time | How fast (in seconds) the sensor reacts after a contamination | Uint_16 | 2 | Value range 3 ... 60 Default: 3 |
+3d … +60d (03h … 3Ch) |
00 03 … 00 3C |
| Threshold warning | Sensitivity | Enum_8 | 1 | High: Medium: Low: |
0 |
00 |
| Sector preselection | Selection of either custom sectors or used weather protection hood | Enum_8 | 1 | All sectors: Weather protection hood: Custom sectors: |
0 |
00 |
| Length | UInt_16 | 2 | Always: | 7 |
00 07 |
|
| Custom sectors | Enable/ disable individual sectors when custom sectors got selected in Sector preselection | Array | 7 | Active: 1 Inactive: 0 Default value of all sectors is active |
0 ... 1 |
00 ... 01 |
| Enable Warning | Warning monitoring | Bool_1 | 1 | Off (False): On (True): |
0 |
00 |
| Enable Error | Error monitoring | Bool_1 | 1 | Off (False): On (True): |
0 |
00 |
Example: sWN ContaminationConfig One sector contaminated, response time 60 seconds, sensitivity low, weather protection hood, enable warning, enable error
CoLa A (ASCII)
<STX>sWN{SPC}ContaminationConfig{SPC}2{SPC}3C{SPC}2{SPC}6{SPC}7{SPC}1{SPC}1{SPC}1{SPC}1{SPC}1{SPC}1{SPC}1{SPC}1{SPC}1<ETX>
02 73 57 4E 20 43 6F 6E 74 61 6D 69 6E 61 74 69 6F 6E 43 6F 6E 66 69 67 20 32 20 33 43 20 32 20 36 20 37 20 31 20 31 20 31 20 31 20 31 20 31 20 31 20 31 20 31 03
CoLa B (binary)
02 02 02 02 00 00 00 28 73 57 4E 20 43 6F 6E 74 61 6D 69 6E 61 74 69 6F 6E 43 6F 6E 66 69 67 20 02 00 3C 02 06 00 07 01 01 01 01 01 01 01 01 01 3C
73 57 4E 20 43 6F 6E 74 61 6D 69 6E 61 74 69 6F 6E 43 6F 6E 66 69 67 20 02 00 3C 02 06 00 07 01 01 01 01 01 01 01 01 01
Telegram structure: sWA ContaminationConfig
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Answer | String | 3 | sWA |
73 57 41 |
|
| Command | String | 19 | ContaminationConfig |
43 6F 6E 74 61 6D 69 6E 61 74 69 6F 6E 43 6F 6E 66 69 67 |
Example: sWA ContaminationConfig
CoLa A (ASCII)
CoLa B (binary)
READ Read Contamination Indication Settings [sRN ContaminationConfig]¶
Reads the current contamination settings that define how and under which conditions the device indicates a potential contamination of the optics cover to enable preventive cleaning.
Telegram structure: sRN ContaminationConfig
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Read | String | 3 | sRN |
73 52 4E |
|
| Command | String | 19 | ContaminationConfig |
43 6F 6E 74 61 6D 69 6E 61 74 69 6F 6E 43 6F 6E 66 69 67 |
Example: sRN ContaminationConfig
CoLa A (ASCII)
CoLa B (binary)
Telegram structure: sRA ContaminationConfig
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Answer | String | 3 | sRA |
73 52 41 |
|
| Command | String | 19 | ContaminationConfig |
43 6F 6E 74 61 6D 69 6E 61 74 69 6F 6E 43 6F 6E 66 69 67 |
||
| Strategy | Strategy code | Enum_8 | 1 | No output: All sectors contaminated: One sector contaminated: |
0 |
00 |
| Response time | How fast (in seconds) the sensor reacts after a contamination | Uint_16 | 2 | Value range 3 ... 60 Default: 3 |
03h … 3Ch |
00 03 … 00 3C |
| Threshold warning | Sensitivity | Enum_8 | 1 | High: Medium: Low: |
0 |
00 |
| Sector preselection | Selection of either custom sectors or used weather protection hood | Enum_8 | 1 | All sectors: Weather protection hood: Custom sectors: |
0 |
00 |
| Length | UInt_16 | 2 | Always: | 7 |
00 07 |
|
| Custom sectors | Enable/ disable individual sectors when custom sectors got selected in Sector preselection | Array | 7 | Active: 1 Inactive: 0 Default value of all sectors is active |
0 ... 1 |
00 ... 01 |
| Enable Warning | Warning monitoring | Bool_1 | 1 | Off (False): On (True): |
0 |
00 |
| Enable Error | Error monitoring | Bool_1 | 1 | Off (False): On (True): |
0 |
00 |
Example: sRA ContaminationConfig No output, response time 3 sec, All sectors active, warning enabled, error enabled
CoLa A (ASCII)
<STX>sRA{SPC}ContaminationConfig{SPC}0{SPC}3{SPC}0{SPC}0{SPC}7{SPC}1{SPC}1{SPC}1{SPC}1{SPC}1{SPC}1{SPC}1{SPC}1{SPC}1<ETX>
02 73 52 41 20 43 6F 6E 74 61 6D 69 6E 61 74 69 6F 6E 43 6F 6E 66 69 67 20 30 20 33 20 30 20 30 20 37 20 31 20 31 20 31 20 31 20 31 20 31 20 31 20 31 20 31 03
CoLa B (binary)
READ Read Contamination Indication Data [sRN ContaminationData]¶
Get the current contamination indication data.
Telegram structure: sRN ContaminationData
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Read | String | 3 | sRN |
73 52 4E |
|
| Command | Reading status of all contamination sectors | String | 17 | ContaminationData |
43 6F 6E 74 61 6D 69 6E 61 74 69 6F 6E 44 61 74 61 |
Example: sRN ContaminationData
CoLa A (ASCII)
CoLa B (binary)
Telegram structure: sRA ContaminationData
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Answer | String | 3 | sRA |
73 52 41 |
|
| Command | Reading status of all contamination sectors | String | 17 | ContaminationData |
43 6F 6E 74 61 6D 69 6E 61 74 69 6F 6E 44 61 74 61 |
|
| Number of contamination sectors | Uint_16 | 2 | Always: | 7 |
00 07 |
|
| Contamination data | Status of contamination of each sector | Array of Enum_8 | 7 | Blocked: Clean: Warning: Error: |
0 |
00 |
Example: sRA ContaminationData
CoLa A (ASCII)
02 73 52 41 20 43 6F 6E 74 61 6D 69 6E 61 74 69 6F 6E 44 61 74 61 20 37 20 32 20 31 20 32 20 33 20 32 20 31 20 32 03
CoLa B (binary)
EVENT Send Contamination Indication Data Permanently [sEN ContaminationData]¶
Provides continuous contamination indication data for the individual sectors of the optical cover. When a change in contamination is detected in any sector, the current contamination status of all sectors will be transmitted
Telegram structure: sEN ContaminationData
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Read | String | 3 | sEN |
73 45 4E |
|
| Command | Get the contamination indication data continuously | String | 17 | ContaminationData |
43 6F 6E 74 61 6D 69 6E 61 74 69 6F 6E 44 61 74 61 |
|
| Data | Start/ Stop | Bool_1 | 1 | Stop: Start: |
0 |
00 |
Example: sEN ContaminationData
CoLa A (ASCII)
CoLa B (binary)
Telegram structure: sSN ContaminationData
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Answer | String | 3 | sSN |
73 53 4E |
|
| Command | Get the contamination indication data continuously | String | 17 | ContaminationData |
43 6F 6E 74 61 6D 69 6E 61 74 69 6F 6E 44 61 74 61 |
|
| Number of contamination sectors | Uint_16 | 2 | Always: | 7 |
00 07 |
|
| Contamination data | Status of contamination of each sector | Array of Enum_8 | 7 | Blocked: Clean: Warning: Error: |
0 |
00 |
Example: sSN ContaminationData
CoLa A (ASCII)
02 73 53 4E 20 43 6F 6E 74 61 6D 69 6E 61 74 69 6F 6E 44 61 74 61 20 37 20 30 20 30 20 30 20 32 20 32 20 31 20 31 03
CoLa B (binary)
READ Read Contamination Indication Result [sRN ContaminationResult]¶
This telegram is intended to read the contamination result. The telegram returns two Boolean. One for warning and one for error. Depending on the strategy of the contamination indication the state changes if one or all sectors are in the specific status (warning or error).
Telegram structure: sRN ContaminationResult
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Read | String | 3 | sRN |
73 52 4E |
|
| Command | String | 19 | ContaminationResult |
43 6F 6E 74 61 6D 69 6E 61 74 69 6F 6E 52 65 73 75 6C 74 |
Example: sRN ContaminationResult
CoLa A (ASCII)
CoLa B (binary)
Telegram structure: sRA ContaminationResult
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Answer | String | 3 | sRA |
73 52 41 |
|
| Command | String | 19 | ContaminationResult |
43 6F 6E 74 61 6D 69 6E 61 74 69 6F 6E 52 65 73 75 6C 74 |
||
| Contamination Result | Warning | Bool_1 | 1 | Not active: Active: |
0 |
00 |
| Contamination Result | Error | Bool_1 | 1 | Not active: Active: |
0 |
00 |
Example: sRA ContaminationResult warning inactive error inactive
CoLa A (ASCII)
CoLa B (binary)
EVENT Send Contamination Indication Result Permanently [sEN ContaminationResult]¶
This telegram is intended to activate the event for read the contamination result permanently. The telegram returns two Boolean. One for warning and one for error. Depending on the strategy of the contamination indication the state changes if one or all sectors are in the specific status (warning or error).
Telegram structure: sEN ContaminationResult
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Read | String | 3 | sEN |
73 52 4E |
|
| Command | String | 19 | ContaminationResult |
43 6F 6E 74 61 6D 69 6E 61 74 69 6F 6E 52 65 73 75 6C 74 |
||
| Data | Start/ Stop | Bool_1 | 1 | Stop: Start: |
0 |
00 |
Example: sEN ContaminationResult
CoLa A (ASCII)
CoLa B (binary)
02 02 02 02 00 00 00 19 73 45 4E 20 43 6F 6E 74 61 6D 69 6E 61 74 69 6F 6E 52 65 73 75 6C 74 20 01 10
Telegram structure: sSN ContaminationResult
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Answer | String | 3 | sSN |
73 53 4E |
|
| Contamination Result | Warning | Bool_1 | 1 | Not active: Active: |
0 |
00 |
| Contamination Result | Error | Bool_1 | 1 | Not active: Active: |
0 |
00 |
Example: sSN ContaminationResult warning active error inactive
CoLa A (ASCII)
CoLa B (binary)
WRITE Set Treat Blocked Sectors as Error Sectors [sWN treatBlockedSectorsAsErrorSectors]¶
If enabled, blocked sectors get interpreted as error sectors for contamination strategy evaluation.
Telegram structure: sWN treatBlockedSectorsAsErrorSectors
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Write request | String | 3 | sWN |
73 57 4E |
|
| Variable name | treatBlockedSectorsAsErrorSectors | String | 33 | treatBlockedSectorsAsErrorSectors |
74 72 65 61 74 42 6C 6F 63 6B 65 64 53 65 63 74 6F 72 73 41 73 45 72 72 6F 72 53 65 63 74 6F 72 73 |
|
| Value | Enable/ disable Treat Blocked Sectors As Error Sectors | Bool_1 | 1 | Disable: Enable: |
0 |
00 |
Example: sWN treatBlockedSectorsAsErrorSectors
CoLa A (ASCII)
02 73 57 4E 20 74 72 65 61 74 42 6C 6F 63 6B 65 64 53 65 63 74 6F 72 73 41 73 45 72 72 6F 72 53 65 63 74 6F 72 73 20 31 03
CoLa B (binary)
02 02 02 02 00 00 00 27 73 57 4E 20 74 72 65 61 74 42 6C 6F 63 6B 65 64 53 65 63 74 6F 72 73 41 73 45 72 72 6F 72 53 65 63 74 6F 72 73 20 01 3F
73 57 4E 20 74 72 65 61 74 42 6C 6F 63 6B 65 64 53 65 63 74 6F 72 73 41 73 45 72 72 6F 72 53 65 63 74 6F 72 73 20 01
Telegram structure: sWA treatBlockedSectorsAsErrorSectors
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Write answer | String | 3 | sWA |
73 57 41 |
|
| Variable name | Echo of variable name | String | 33 | treatBlockedSectorsAsErrorSectors |
74 72 65 61 74 42 6C 6F 63 6B 65 64 53 65 63 74 6F 72 73 41 73 45 72 72 6F 72 53 65 63 74 6F 72 73 |
Example: sWA treatBlockedSectorsAsErrorSectors
CoLa A (ASCII)
02 73 57 41 20 74 72 65 61 74 42 6C 6F 63 6B 65 64 53 65 63 74 6F 72 73 41 73 45 72 72 6F 72 53 65 63 74 6F 72 73 03
CoLa B (binary)
READ Read Treat Blocked Sectors as Error Sectors [sRN treatBlockedSectorsAsErrorSectors]¶
Returns the state if blocked sectors are treated as error sectors for contamination strategy evaluation.
Telegram structure: sRN treatBlockedSectorsAsErrorSectors
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Read request | String | 3 | sRN |
73 52 4E |
|
| Variable name | treatBlockedSectorsAsErrorSectors | String | 33 | treatBlockedSectorsAsErrorSectors |
74 72 65 61 74 42 6C 6F 63 6B 65 64 53 65 63 74 6F 72 73 41 73 45 72 72 6F 72 53 65 63 74 6F 72 73 |
Example: sRN treatBlockedSectorsAsErrorSectors
CoLa A (ASCII)
02 73 52 4E 20 74 72 65 61 74 42 6C 6F 63 6B 65 64 53 65 63 74 6F 72 73 41 73 45 72 72 6F 72 53 65 63 74 6F 72 73 03
CoLa B (binary)
02 02 02 02 00 00 00 25 73 52 4E 20 74 72 65 61 74 42 6C 6F 63 6B 65 64 53 65 63 74 6F 72 73 41 73 45 72 72 6F 72 53 65 63 74 6F 72 73 1B
73 52 4E 20 74 72 65 61 74 42 6C 6F 63 6B 65 64 53 65 63 74 6F 72 73 41 73 45 72 72 6F 72 53 65 63 74 6F 72 73
Telegram structure: sRA treatBlockedSectorsAsErrorSectors
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Read answer | String | 3 | sRA |
73 52 41 |
|
| Variable name | treatBlockedSectorsAsErrorSectors | String | 33 | treatBlockedSectorsAsErrorSectors |
74 72 65 61 74 42 6C 6F 63 6B 65 64 53 65 63 74 6F 72 73 41 73 45 72 72 6F 72 53 65 63 74 6F 72 73 |
|
| Value | State of Treat Blocked Sectors As Error Sectors (disabled/ enabled) | Bool_1 | 1 | Disabled: Enabled: |
0 |
00 |
Example: sRA treatBlockedSectorsAsErrorSectors
CoLa A (ASCII)
02 73 52 41 20 74 72 65 61 74 42 6C 6F 63 6B 65 64 53 65 63 74 6F 72 73 41 73 45 72 72 6F 72 53 65 63 74 6F 72 73 20 31 03
CoLa B (binary)
Ethernet¶
WRITE Set IP Address [sWN EIIpAddr]¶
Save permanently to set values. Changes will be active after rebooting the device. Settings must correspond with network in which scanner is used. Else device cannot be found any more.
Telegram structure: sWN EIIpAddr
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Write | String | 3 | sWN |
73 57 4E |
|
| Command | Set IP address | String | 8 | EIIpAddr |
45 49 49 50 41 64 64 72 |
|
| IP address | Set values | Uint_8 | 1 | First part of IP address | 0 …+255d (00 ... FF) |
00 … FF |
| IP address | Set values | Uint_8 | 1 | Second part of IP address | 0 …+255d (00 ... FF) |
00 … FF |
| IP address | Set values | Uint_8 | 1 | Third part of IP address | 0 …+255d (00 ... FF) |
00 … FF |
| IP address | Set values | Uint_8 | 1 | Fourth part of IP address | 0 …+255d (00 ... FF) |
00 … FF |
Example: sWN EIIpAddr 192.168.0.2
CoLa A (ASCII)
CoLa B (binary)
Telegram structure: sWA EIIpAddr
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Answer | String | 3 | sWA |
73 57 41 |
|
| Command | Set IP address | String | 8 | EIIpAddr |
45 49 49 50 41 64 64 72 |
Example: sWA EIIpAddr
CoLa A (ASCII)
CoLa B (binary)
READ Read IP Address [sRN EIIpAddr]¶
Read the IP address of the device.
Telegram structure: sRN EIIpAddr
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Read | String | 3 | sRN |
73 52 4E |
|
| Command | Read IP address | String | 8 | EIIpAddr |
45 49 49 50 41 64 64 72 |
Example: sRN EIIpAddr
CoLa A (ASCII)
CoLa B (binary)
Telegram structure: sRA EIIpAddr
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Answer | String | 3 | sRA |
73 52 41 |
|
| Command | Read IP address | String | 8 | EIIpAddr |
45 49 49 50 41 64 64 72 |
|
| IP address | Default: 192.168.0.1 | Uint_8 | 1 | First part of IP address | 0 …+255d (00 … FF) |
00 … FF |
| IP address | Default: 192.168.0.1 | Uint_8 | 1 | Second part of IP address | 0 …+255d (00 … FF) |
00 … FF |
| IP address | Default: 192.168.0.1 | Uint_8 | 1 | Third part of IP address | 0 …+255d (00 … FF) |
00 … FF |
| IP address | Default: 192.168.0.1 | Uint_8 | 1 | Fourth part of IP address | 0 …+255d (00 … FF) |
00 … FF |
Example: sRA EIIpAddr 192.168.0.2
CoLa A (ASCII)
CoLa B (binary)
READ Read IP Address Assigned by DHCP [sRN EIIpAddrDHCP]¶
DHCP needs to be set as mode for ethernet assignment.
Telegram structure: sRN EIIpAddrDHCP
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Read | String | 3 | sRN |
73 52 4E |
|
| Command | Read IP address assigned by DHCP | String | 12 | EIIpAddrDHCP |
45 49 49 70 41 64 64 72 44 48 43 50 |
Example: sRN EIIpAddrDHCP
CoLa A (ASCII)
CoLa B (binary)
Telegram structure: sRA EIIpAddrDHCP
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Answer | String | 3 | sRA |
73 52 41 |
|
| Command | Read IP address assigned by DHCP | String | 12 | EIIpAddrDHCP |
45 49 49 70 41 64 64 72 44 48 43 50 |
|
| IP address | Default: 192.168.0.1 | Uint_8 | 1 | First part of IP address | 0 …+255d (00 … FF) |
00 … FF |
| IP address | Default: 192.168.0.1 | Uint_8 | 1 | Second part of IP address | 0 …+255d (00 … FF) |
00 … FF |
| IP address | Default: 192.168.0.1 | Uint_8 | 1 | Third part of IP address | 0 …+255d (00 … FF) |
00 … FF |
| IP address | Default: 192.168.0.1 | Uint_8 | 1 | Fourth part of IP address | 0 …+255d (00 … FF) |
00 … FF |
Example: sRA EIIpAddrDHCP 192.168.0.1
CoLa A (ASCII)
CoLa B (binary)
WRITE Set Mode for Ethernet Address Assignment [sWN EIAddrMode]¶
This Command determines the mode for the ethernet address assignment.
Telegram structure: sWN EIAddrMode
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Write | String | 3 | sWN |
73 57 4E |
|
| Command | Set mode for ethernet address assignment | String | 10 | EIAddrMode |
45 49 41 64 64 72 4D 6F 64 65 |
|
| Ethernet address assignment | Static IP address / DHCP | Enum_8 | 1 | Static: DHCP: |
0 |
00 |
Example: sWN EIAddrMode
CoLa A (ASCII)
CoLa B (binary)
Telegram structure: sWA EIAddrMode
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Answer | String | 3 | sWA |
73 57 41 |
|
| Command | Set mode for ethernet address assignment | String | 10 | EIAddrMode |
45 49 41 64 64 72 4D 6F 64 65 |
Example: sWA EIAddrMode
CoLa A (ASCII)
CoLa B (binary)
WRITE Set Fallback for DHCP [sWN EIDHCPFallback]¶
This Command determines the fallback when DHCP is not successful.
Telegram structure: sWN EIDHCPFallback
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Write | String | 3 | sWN |
73 57 4E |
|
| Command | Set fallback for DHCP | String | 14 | EIDHCPFallback |
45 49 44 48 43 50 46 61 6C 6C 62 61 63 6B |
|
| Fallback ethernet address assignment | Use Static IP address / Retry DHCP | Enum_8 | 1 | Static IP address: DHCP retry: |
0 |
00 |
Example: sWN EIDHCPFallback
CoLa A (ASCII)
CoLa B (binary)
Telegram structure: sWA EIDHCPFallback
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Answer | String | 3 | sWA |
73 57 41 |
|
| Command | Set fallback for DHCP | String | 14 | EIDHCPFallback |
45 49 44 48 43 50 46 61 6C 6C 62 61 63 6B |
Example: sWA EIDHCPFallback
CoLa A (ASCII)
CoLa B (binary)
WRITE Set Ethernet Gateway [sWN EIgate]¶
Change Ethernet gateway IP address (TCP/IP)
Save permanently to set values. Changes will be active after rebooting the device. Settings must correspond with network in which scanner is used. Else device cannot be found any more.
Telegram structure: sWN EIgate
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Write | String | 3 | sWN |
73 57 4E |
|
| Command | Set gateway address | String | 6 | EIgate |
45 49 67 61 74 65 |
|
| Gateway address | Set values | Uint_8 | 1 | First part of gateway address | 0 …+255d (00…FF) |
00 …FF |
| Gateway address | Set values | Uint_8 | 1 | Second part of gateway address | 0 …+255d (00…FF) |
00 …FF |
| Gateway address | Set values | Uint_8 | 1 | Third part of gateway address | 0 …+255d (00…FF) |
00 …FF |
| Gateway address | Set values | Uint_8 | 1 | Fourth part of gateway address | 0 …+255d (00…FF) |
00 …FF |
Example: sWN EIgate 192.168.0.1
CoLa A (ASCII)
CoLa B (binary)
Telegram structure: sWA EIgate
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Answer | String | 3 | sWA |
73 57 41 |
|
| Command | Set gateway address | String | 6 | EIgate |
45 49 67 61 74 65 |
Example: sWA EIgate
CoLa A (ASCII)
CoLa B (binary)
READ Read Ethernet Gateway [sRN EIgate]¶
Read for the Ethernet gateway (TCP/IP)
Telegram structure: sRN EIgate
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Read | String | 3 | sRN |
73 52 4E |
|
| Command | Read gateway address | String | 6 | EIgate |
45 49 67 61 74 65 |
Example: sRN EIgate
CoLa A (ASCII)
CoLa B (binary)
Telegram structure: sRA EIgate
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Answer | String | 3 | sRA |
73 52 41 |
|
| Command | Read gateway address | String | 6 | EIgate |
45 49 67 61 74 65 |
|
| Gateway address | Default: 0.0.0.0 | Uint_8 | 1 | First part of gateway address | 0 …+255d (00…FF) |
00 … FF |
| Gateway address | Default: 0.0.0.0 | Uint_8 | 1 | Second part of gateway address | 0 …+255d (00…FF) |
00 … FF |
| Gateway address | Default: 0.0.0.0 | Uint_8 | 1 | Third part of gateway address | 0 …+255d (00…FF) |
00 … FF |
| Gateway address | Default: 0.0.0.0 | Uint_8 | 1 | Fourth part of gateway address | 0 …+255d (00…FF) |
00 … FF |
Example: sRA EIgate 192.168.0.1
CoLa A (ASCII)
CoLa B (binary)
READ Read Ethernet Gateway IP Address Assigned by DHCP [sRN EIgateDHCP]¶
DHCP needs to be set as mode for ethernet assignment.
Read for the ethernet gateway IP address which was assigned by DHCP.
Telegram structure: sRN EIgateDHCP
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Read | String | 3 | sRN |
73 52 4E |
|
| Command | Read ethernet gateway IP address assigned by DHCP | String | 6 | EIgateDHCP |
45 49 67 61 74 65 44 48 43 50 |
Example: sRN EIgateDHCP
CoLa A (ASCII)
CoLa B (binary)
Telegram structure: sRA EIgateDHCP
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Answer | String | 3 | sRA |
73 52 41 |
|
| Command | Read ethernet gateway IP address assigned by DHCP | String | 6 | EIgateDHCP |
45 49 67 61 74 65 44 48 43 50 |
|
| Gateway IP address | Default: 0.0.0.0 | Uint_8 | 1 | First part of gateway IP address | 0 …+255d (00…FF) |
00 … FF |
| Gateway IP address | Default: 0.0.0.0 | Uint_8 | 1 | Second part of gateway IP address | 0 …+255d (00…FF) |
00 … FF |
| Gateway IP address | Default: 0.0.0.0 | Uint_8 | 1 | Third part of gateway IP address | 0 …+255d (00…FF) |
00 … FF |
| Gateway IP address | Default: 0.0.0.0 | Uint_8 | 1 | Fourth part of gateway IP address | 0 …+255d (00…FF) |
00 … FF |
Example: sRA EIgateDHCP 0.0.0.0
CoLa A (ASCII)
CoLa B (binary)
WRITE Set IP Mask [sWN EImask]¶
Define the subnet mask of the device.
Save permanently to set values. Changes will be active after rebooting the device. Settings must correspond with network in which scanner is used. Else device cannot be found any more.
Telegram structure: sWN EImask
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Write | String | 3 | sWN |
73 57 4E |
|
| Command | Set IP mask | String | 6 | EImask |
45 49 6D 61 73 6B |
|
| IP mask | Set values | Uint_8 | 1 | First part of IP mask | 0 …+255d (00…FF) |
00 …FF |
| IP mask | Set values | Uint_8 | 1 | Second part of IP mask | 0 …+255d (00…FF) |
00 …FF |
| IP mask | Set values | Uint_8 | 1 | Third part of IP mask | 0 …+255d (00…FF) |
00 …FF |
| IP mask | Set values | Uint_8 | 1 | Fourth part of IP mask | 0 …+255d (00…FF) |
00 …FF |
Example: sWN EImask 255.255.254.0
CoLa A (ASCII)
CoLa B (binary)
Telegram structure: sWA EImask
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Answer | String | 3 | sWA |
73 57 41 |
|
| Command | Set IP mask | String | 6 | EImask |
45 49 6D 61 73 6B |
Example: sWA EImask
CoLa A (ASCII)
CoLa B (binary)
READ Read IP Mask [sRN EImask]¶
Read the subnet mask of the device.
Telegram structure: sRN EImask
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Read | String | 3 | sRN |
73 52 4E |
|
| Command | Read IP mask | String | 6 | EImask |
45 49 6D 61 73 6B |
Example: sRN EImask
CoLa A (ASCII)
CoLa B (binary)
Telegram structure: sRA EImask
| Telegram part | Description | Variable | Length | Sensor | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Answer | String | 3 | sRA |
73 52 41 |
|
| Command | Read IP mask | String | 6 | EImask |
45 49 6D 61 73 6B |
|
| IP mask | Default: 255.255.255.0 | Uint_8 | 1 | First part of IP mask | 0 …+255d (00…FF) |
00 … FF |
| IP mask | Default: 255.255.255.0 | Uint_8 | 1 | Second part of IP mask | 0 …+255d (00…FF) |
00 … FF |
| IP mask | Default: 255.255.255.0 | Uint_8 | 1 | Third part of IP mask | 0 …+255d (00…FF) |
00 … FF |
| IP mask | Default: 255.255.255.0 | Uint_8 | 1 | Fourth part of IP mask | 0 …+255d (00…FF) |
00 … FF |
Example: sRA EImask 255.255.254.0
CoLa A (ASCII)
CoLa B (binary)
READ Read IP Mask Assigned by DHCP [sRN EImaskDHCP]¶
DHCP needs to be set as mode for ethernet assignment.
Read for the IP mask which was assigned by DHCP.
Telegram structure: sRN EImaskDHCP
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Read | String | 3 | sRN |
73 52 4E |
|
| Command | Read IP mask assigned by DHCP | String | 10 | EImaskDHCP |
45 49 6D 61 73 6B 44 48 43 50 |
Example: sRN EImaskDHCP
CoLa A (ASCII)
CoLa B (binary)
Telegram structure: sRA EImaskDHCP
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Answer | String | 3 | sRA |
73 52 41 |
|
| Command | Read IP mask assigned by DHCP | String | 10 | EImaskDHCP |
45 49 6D 61 73 6B 44 48 43 50 |
|
| IP mask | Default: 255.255.255.0 | Uint_8 | 1 | First part of IP mask | 0 …+255d (00…FF) |
00 … FF |
| IP mask | Default: 255.255.255.0 | Uint_8 | 1 | Second part of IP mask | 0 …+255d (00…FF) |
00 … FF |
| IP mask | Default: 255.255.255.0 | Uint_8 | 1 | Third part of IP mask | 0 …+255d (00…FF) |
00 … FF |
| IP mask | Default: 255.255.255.0 | Uint_8 | 1 | Fourth part of IP mask | 0 …+255d (00…FF) |
00 … FF |
Example: sRA EImaskDHCP 255.255.255.0
CoLa A (ASCII)
CoLa B (binary)
READ Read MAC Address [sRN EIMacAdr]¶
Read the MAC address of the device.
Telegram structure: sRN EIMacAdr
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Read | String | 3 | sRN |
73 52 4E |
|
| Command | Read MAC address of the device | String | 8 | EIMacAdr |
45 49 4D 61 63 41 64 72 |
Example: sRN EIMacAdr
CoLa A (ASCII)
CoLa B (binary)
Telegram structure: sRA EIMacAdr
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Answer | String | 3 | sRA |
73 52 41 |
|
| Command | Read MAC address of the device | String | 8 | EIMacAdr |
45 49 4D 61 63 41 64 72 |
|
| MAC address | Values | Uint_8 | 1 | First part of MAC address | 0 …+255d (00…FF) |
00 … FF |
| MAC address | Values | Uint_8 | 1 | Second part of MAC address | 0 …+255d (00…FF) |
00 … FF |
| MAC address | Values | Uint_8 | 1 | Third part of MAC address | 0 …+255d (00…FF) |
00 … FF |
| MAC address | Values | Uint_8 | 1 | Fourth part of MAC address | 0 …+255d (00…FF) |
00 … FF |
| MAC address | Values | Uint_8 | 1 | Fifth part of MAC address | 0 …+255d (00…FF) |
00 … FF |
| MAC address | Values | Uint_8 | 1 | Sixth part of MAC address | 0 …+255d (00…FF) |
00 … FF |
Example: sRA EIMacAdr 00:06:77:22:40:EA
CoLa A (ASCII)
CoLa B (binary)
METHOD Apply Configured Ethernet Settings [sMN mEthUpdt]¶
Apply the configured ethernet settings.
Telegram structure: sMN mEthUpdt
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Method | String | 3 | sMN |
73 4D 4E |
|
| Command | Apply ethernet settings | String | 8 | mEthUpdt |
6D 45 74 68 55 70 64 74 |
Example: sMN mEthUpdt
CoLa A (ASCII)
CoLa B (binary)
Telegram structure: sAN mEthUpdt
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Answer | String | 3 | sAN |
73 41 4E |
|
| Command | Apply ethernet settings | String | 8 | mEthUpdt |
6D 45 74 68 55 70 64 74 |
Example: sAN mEthUpdt
CoLa A (ASCII)
CoLa B (binary)
Inputs and Outputs¶
READ Read State of the Ports [sRN LIDportstate]¶
LIDportstate has to be available additionally or as successor of the LIDoutputstate telegram.
Valid for all sensors with Ethernet and ports (inputs / outputs).
Telegram structure: sRN LIDportstate
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Read | String | 3 | sRN |
73 52 4E |
|
| Command | Ask for port configuration | String | 12 | LIDportstate |
4C 49 44 70 6F 72 74 73 74 61 74 65 |
Example: sRN LIDportstate
CoLa A (ASCII)
CoLa B (binary)
Telegram structure: sRA LIDportstate
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Answer | String | 3 | sRA |
73 52 41 |
|
| Command | Port state | String | 12 | LIDportstate |
4C 49 44 70 6F 72 74 73 74 61 74 65 |
|
| Status code | Version number | Uint_16 | 2 | Current version: | 0 … FFFFh |
00 01 … FF FF |
| Status code | System counter (time in µs since power up max. 71min then starting from 0 again) | Uint_32 | 4 | 0 … FFFFFFFFh |
00 00 00 00 … FF FF FF FF |
|
| ARRAY which defines the number of internal ports* | 0...n | Uint_16 | 2 | Hex: Not available: Number of ports: |
0000 - FFFF |
00 00 - FF FF |
| State of the ports and count value in hex | Internal port state | Enum_8 | 1 | Output voltage low:(Relays open) Output voltage high:(Relays closed) Tri-state: Input voltage high (level):Input voltage from low to high (edge) Input voltage low (level):Input voltage high to low (edge) |
00 |
00 |
| State of the ports and count value in hex | Internal port counter | Uint_32 | 4 | 0 … FFFFFFFFh |
00 00 00 00 … FF FF FF FF |
|
| ….. | ||||||
| ARRAY which defines the number of external or virtual ports* | 0...n | Uint_16 | 1 | Hex: Not available: Number of ports: |
00 00 - FF FF |
00 00 - FF FF |
| State of the ports and count value in hex | External port state | Enum_8 | 1 | Output voltage low:(Relays open) Output voltage high:(Relays closed) Tri-state: Input voltage high (level):Input voltage from low to high (edge) Input voltage low (level):Input voltage high to low (edge) |
00 |
00 |
| State of the ports and count value in hex | External port counter | Uint_32 | 4 | 0 … FFFFFFFFh |
00 00 00 00 … FF FF FF FF |
|
| Time | States code | Enum_16 | 1 | No time data: Time data: |
00 00 |
00 00 |
| Time Block (sensor time from the last change of min. one of the outputs) | Year | Array | 2 | E.g. | 1970 |
07 B2 |
| Time Block (sensor time from the last change of min. one of the outputs) | Month | Array | 1 | 1 … 12 |
01 … 0C |
|
| Time Block (sensor time from the last change of min. one of the outputs) | Day | Array | 1 | 1 … 31 |
01 … 1F |
|
| Time Block (sensor time from the last change of min. one of the outputs) | Hour | Array | 1 | 0 … 23 |
00 … 17 |
|
| Time Block (sensor time from the last change of min. one of the outputs) | Minute | Array | 1 | 0 … 59 |
00 … 3B |
|
| Time Block (sensor time from the last change of min. one of the outputs) | Second | Array | 1 | 0 … 59 |
00 … 3B |
|
| Time Block (sensor time from the last change of min. one of the outputs) | Microsecond | Array | 4 | 0 … 999999 |
00 00 00 00 … 00 0F 42 3F |
Inputs/outputs: If the device has separate inputs and outputs (instead of general purpose ports) the ARRAY shall start with inputs followed by the outputs.
Virtual ports are ports that can be used to expand the number of ports but are not physically available. They just show up in the corresponding ethernet telegrams (like LIDportstate).
Tri-State: Port is neither input nor output; the port is set inactive in SOPAS
Example: sRA LIDportstate
CoLa A (ASCII)
<STX>sRA{SPC}LIDportstate{SPC}0{SPC}3340BBDA{SPC}1{SPC}0{SPC}1{SPC}0{SPC}4{SPC}0{SPC}2{SPC}0{SPC}2{SPC}0{SPC}2{SPC}0{SPC}2{SPC}0{SPC}2{SPC}0{SPC}2{SPC}0{SPC}2{SPC}0{SPC}2{SPC}0{SPC}2{SPC}0{SPC}2{SPC}0{SPC}2{SPC}0{SPC}2{SPC}0{SPC}2{SPC}0{SPC}1{SPC}7B2{SPC}1{SPC}1{SPC}2{SPC}25{SPC}1D{SPC}C6F98<ETX>
02 73 52 41 20 4C 49 44 70 6F 72 74 73 74 61 74 65 20 30 20 33 33 34 30 42 42 44 41 20 31 20 30 20 31 20 30 20 34 20 30 20 32 20 30 20 32 20 30 20 32 20 30 20 32 20 30 20 32 20 30 20 32 20 30 20 32 20 30 20 32 20 30 20 32 20 30 20 32 20 30 20 32 20 30 20 32 20 30 20 32 20 30 20 31 20 37 42 32 20 31 20 31 20 32 20 32 35 20 31 44 20 43 36 46 39 38 03
CoLa B (binary)
02 02 02 02 00 00 00 74 73 52 41 20 4C 49 44 70 6F 72 74 73 74 61 74 65 20 00 00 33 40 BB DA 01 00 00 00 00 01 00 00 00 00 04 00 00 00 00 02 00 00 00 00 02 00 00 00 00 02 00 00 00 00 02 00 00 00 00 02 00 00 00 00 02 00 00 00 00 02 00 00 00 00 02 00 00 00 00 02 00 00 00 00 02 00 00 00 00 02 00 00 00 00 02 00 00 00 00 02 00 00 00 00 00 01 07 B2 01 01 02 25 1D 00 0C 6F 98 2E
READ Read Port Configuration of All I/Os [sRN PortConfiguration]¶
Read the configuration of the digital inputs and outputs.
Telegram structure: sRN PortConfiguration
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Read | String | 3 | sRN |
73 52 4E |
|
| Command | Ask for port configuration | String | 12 | PortConfiguration |
50 6F 72 74 43 6F 6E 66 69 67 75 72 61 74 69 6F 6E |
Example: sRN PortConfiguration
CoLa A (ASCII)
CoLa B (binary)
Telegram structure: sRA PortConfiguration
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Answer | String | 3 | sRA |
73 52 41 |
|
| Command | Configuration of all I/Os | String | 12 | PortConfiguration |
50 6F 72 74 43 6F 6E 66 69 67 75 72 61 74 69 6F 6E |
|
| Start of loop, number of loops = amount of all current and future Inputs and Outputs of device family | ||||||
| Port Type | Input or Output | Enum_8 | 1 | Input: Output: |
0 |
00 |
| Port Name | Amount of characters of the following port name | Uint_16 | 2 | 0h … 20h |
00 00 … 00 20 |
|
| Port Name | Port name | String | 16 (depending on string length) |
[Port name] |
[Port name] |
|
| Input Settings | ||||||
| Logic | Logic of the input | Bool_1 | 1 | Active high: Active low: |
0 |
00 |
| Debouncing | Select debouncing time in ms | Uint_16 | 2 | (max. 10,000ms) | 0h … 2710h |
00 00 … 27 10 |
| Reserved | - | Enum_8 | 1 | Always: | 0 |
00 |
| Reserved | Reserved value 1 | Uint_16 | 2 | 0 |
00 00 |
|
| Reserved | Reserved value 2 | Uint_16 | 2 | 0 |
00 00 |
|
| Output Settings | ||||||
| Logic | Logic of the input | Bool_1 | 1 | Active high: Active low: |
0 |
00 |
| Output Mode | PNP, NPN or Push-Pull | Enum_8 | 1 | PNP: NPN: Push-Pull: |
0 |
00 |
| Restart type | Restart behavior of output after event: immediately or after specific time | Enum_8 | 1 | Immediately: Time: Input: |
0 |
00 |
| Restart time | [Only with restart type = Time], time in ms | Uint_32 | 4 | (20 ms … 600,000 ms) | 14h … 927C0h |
00 00 00 14 … 00 09 27 C0 |
| Restart input | [Only with restart type = Input], input for restart | Uint_16 | 2 | 1 ... 8 |
00 01 ... 00 08 |
|
| Combination | Combining multiple Events and/or Inputs | Enum_8 | 1 | AND: OR: XOR: |
0 |
00 |
| Reserved | Reserved value 3 | Uint_16 | 2 | 0 |
00 00 |
|
| Reserved | Reserved value 4 | Uint_16 | 2 | 0 |
00 00 |
|
| Sources | Amount (n) of combined sources | Uint_16 | 2 | 0h ... FFFFh |
00 00 ... FF FF |
|
| Sources | Start of source loop, number of loops = amount of combined sources | |||||
| Sources | Source name | String | 4 | Device Ready: Sopas Command:(xx = Number of output port) Indexsignal: SyncOutByClock: Input = Port Name:(INxx = Number of input port) |
[Source] |
[Source] |
| Sources | Source Inverted or not | Bool_1 | 1 | Not inverted: Inverted: |
0 |
00 |
| Sources | Reserved value 5 | Uint_8 | 1 | 0 |
00 |
|
| Sources | Reserved value 6 | Uint_8 | 1 | 0 |
00 |
|
| Sources | Stop of source loop | |||||
| Reserved | Reserved value 7 | Uint_16 | 2 | 0 |
00 00 |
|
| Reserved | Reserved value 8 | Uint_16 | 2 | 0 |
00 00 |
|
| Reserved | Reserved value 9 | Uint_16 | 2 | 0 |
00 00 |
|
| Reserved | Reserved value 10 | Uint_16 | 2 | 0 |
00 00 |
|
| Stop of loop |
Example: sRA PortConfiguration
CoLa A (ASCII)
<STX>sRA{SPC}PortConfiguration{SPC}1{SPC}6{SPC}InOut1{SPC}0{SPC}A{SPC}0{SPC}0{SPC}0{SPC}1{SPC}0{SPC}0{SPC}C8{SPC}1{SPC}1{SPC}0{SPC}0{SPC}1{SPC}DRDY{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}1{SPC}6{SPC}InOut2{SPC}0{SPC}A{SPC}1{SPC}0{SPC}0{SPC}1{SPC}0{SPC}0{SPC}C8{SPC}1{SPC}1{SPC}0{SPC}0{SPC}1{SPC}DRDY{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}6{SPC}InOut3{SPC}0{SPC}A{SPC}1{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}C8{SPC}1{SPC}1{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}6{SPC}InOut4{SPC}0{SPC}A{SPC}1{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}C8{SPC}1{SPC}1{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}6{SPC}InOut5{SPC}0{SPC}A{SPC}1{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}C8{SPC}1{SPC}1{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}6{SPC}InOut6{SPC}0{SPC}A{SPC}1{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}C8{SPC}1{SPC}1{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}1{SPC}6{SPC}InOut7{SPC}0{SPC}A{SPC}1{SPC}0{SPC}0{SPC}1{SPC}0{SPC}0{SPC}C8{SPC}1{SPC}1{SPC}0{SPC}0{SPC}1{SPC}DRDY{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}1{SPC}6{SPC}InOut8{SPC}0{SPC}A{SPC}1{SPC}0{SPC}0{SPC}1{SPC}0{SPC}0{SPC}C8{SPC}1{SPC}1{SPC}0{SPC}0{SPC}1{SPC}DRDY{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0<ETX>
<STX>sRA PortConfiguration 1 6 InOut1 0 A 0 0 0 1 0 0 C8 1 1 0 0 1 DRDY 0 0 0 0 0 0 0 1 6 InOut2 0 A 1 0 0 1 0 0 C8 1 1 0 0 1 DRDY 0 0 0 0 0 0 0 0 6 InOut3 0 A 1 0 0 0 0 0 C8 1 1 0 0 0 0 0 0 0 0 6 InOut4 0 A 1 0 0 0 0 0 C8 1 1 0 0 0 0 0 0 0 0 6 InOut5 0 A 1 0 0 0 0 0 C8 1 1 0 0 0 0 0 0 0 0 6 InOut6 0 A 1 0 0 0 0 0 C8 1 1 0 0 0 0 0 0 0 1 6 InOut7 0 A 1 0 0 1 0 0 C8 1 1 0 0 1 DRDY 0 0 0 0 0 0 0 1 6 InOut8 0 A 1 0 0 1 0 0 C8 1 1 0 0 1 DRDY 0 0 0 0 0 0 0<ETX>
sRA PortConfiguration 1 6 InOut1 0 A 0 0 0 1 0 0 C8 1 1 0 0 1 DRDY 0 0 0 0 0 0 0 1 6 InOut2 0 A 1 0 0 1 0 0 C8 1 1 0 0 1 DRDY 0 0 0 0 0 0 0 0 6 InOut3 0 A 1 0 0 0 0 0 C8 1 1 0 0 0 0 0 0 0 0 6 InOut4 0 A 1 0 0 0 0 0 C8 1 1 0 0 0 0 0 0 0 0 6 InOut5 0 A 1 0 0 0 0 0 C8 1 1 0 0 0 0 0 0 0 0 6 InOut6 0 A 1 0 0 0 0 0 C8 1 1 0 0 0 0 0 0 0 1 6 InOut7 0 A 1 0 0 1 0 0 C8 1 1 0 0 1 DRDY 0 0 0 0 0 0 0 1 6 InOut8 0 A 1 0 0 1 0 0 C8 1 1 0 0 1 DRDY 0 0 0 0 0 0 0
CoLa B (binary)
02 02 02 02 00 00 01 7A 73 52 41 20 50 6F 72 74 43 6F 6E 66 69 67 75 72 61 74 69 6F 6E 20 01 00 06 49 6E 4F 75 74 31 00 00 0A 00 00 00 00 00 01 00 00 00 00 00 C8 00 01 01 00 00 00 00 00 01 44 52 44 59 00 00 00 00 00 00 00 00 00 00 00 01 00 06 49 6E 4F 75 74 32 00 00 0A 01 00 00 00 00 01 00 00 00 00 00 C8 00 01 01 00 00 00 00 00 01 44 52 44 59 00 00 00 00 00 00 00 00 00 00 00 00 00 06 49 6E 4F 75 74 33 00 00 0A 01 00 00 00 00 00 00 00 00 00 00 C8 00 01 01 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 06 49 6E 4F 75 74 34 00 00 0A 01 00 00 00 00 00 00 00 00 00 00 C8 00 01 01 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 06 49 6E 4F 75 74 35 00 00 0A 01 00 00 00 00 00 00 00 00 00 00 C8 00 01 01 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 06 49 6E 4F 75 74 36 00 00 0A 01 00 00 00 00 00 00 00 00 00 00 C8 00 01 01 00 00 00 00 00 00 00 00 00 00 00 00 00 00 01 00 06 49 6E 4F 75 74 37 00 00 0A 01 00 00 00 00 01 00 00 00 00 00 C8 00 01 01 00 00 00 00 00 01 44 52 44 59 00 00 00 00 00 00 00 00 00 00 00 01 00 06 49 6E 4F 75 74 38 00 00 0A 01 00 00 00 00 01 00 00 00 00 00 C8 00 01 01 00 00 00 00 00 01 44 52 44 59 00 00 00 00 00 00 00 00 00 00 00 00
73 52 41 20 50 6F 72 74 43 6F 6E 66 69 67 75 72 61 74 69 6F 6E 20 01 00 06 49 6E 4F 75 74 31 00 00 0A 00 00 00 00 00 01 00 00 00 00 00 C8 00 01 01 00 00 00 00 00 01 44 52 44 59 00 00 00 00 00 00 00 00 00 00 00 01 00 06 49 6E 4F 75 74 32 00 00 0A 01 00 00 00 00 01 00 00 00 00 00 C8 00 01 01 00 00 00 00 00 01 44 52 44 59 00 00 00 00 00 00 00 00 00 00 00 00 00 06 49 6E 4F 75 74 33 00 00 0A 01 00 00 00 00 00 00 00 00 00 00 C8 00 01 01 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 06 49 6E 4F 75 74 34 00 00 0A 01 00 00 00 00 00 00 00 00 00 00 C8 00 01 01 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 06 49 6E 4F 75 74 35 00 00 0A 01 00 00 00 00 00 00 00 00 00 00 C8 00 01 01 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 06 49 6E 4F 75 74 36 00 00 0A 01 00 00 00 00 00 00 00 00 00 00 C8 00 01 01 00 00 00 00 00 00 00 00 00 00 00 00 00 00 01 00 06 49 6E 4F 75 74 37 00 00 0A 01 00 00 00 00 01 00 00 00 00 00 C8 00 01 01 00 00 00 00 00 01 44 52 44 59 00 00 00 00 00 00 00 00 00 00 00 01 00 06 49 6E 4F 75 74 38 00 00 0A 01 00 00 00 00 01 00 00 00 00 00 C8 00 01 01 00 00 00 00 00 01 44 52 44 59 00 00 00 00 00 00 00 00 00 00 00
WRITE Set Port Configuration [sWN PortConfiguration]¶
Configuration of the given ports. Telegram structure represents the configuration of 1 port.
If the device has multiple ports, use the same structure.
Telegram structure: sWN PortConfiguration
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Write | String | 3 | sWN |
73 57 4E |
|
| Command | Configuration of the given ports | String | 17 | PortConfiguration |
50 6F 72 74 43 6F 6E 66 69 67 75 72 61 74 69 6F 6E |
|
| Port Type | Input or Output | Enum_8 | 1 | Input: Output: |
+0d (0h) |
00 |
| Name | Name of the port | FlexString | 9 (0..32) |
Default: | InOut1 |
00 06 49 6E 4F 75 74 31 00 |
| Input Settings | ||||||
| Logic | Logic of the input | Enum_8 | 1 | Active high: Active low: |
+0d (0h) |
00 |
| Debounce | Select debouncing time in ms | Uint_8 | 1 | +0d ... +255d (0h … FFh) |
00 … FF |
|
| Reserved | - | Enum_8 | 1 | Always: | +0d (0h) |
00 |
| Reserved1 | Uint_16 | 2 | +0d (0h) |
00 00 |
||
| Reserved2 | Uint_16 | 2 | +0d (0h) |
00 00 |
||
| Output Settings | ||||||
| Logic | Definition of the output logic | Enum_8 | 1 | Active high: Active low: |
+0d (0h) |
00 |
| Output Mode | Set kind of mode for output pin | Enum_8 | 1 | PNP: NPN: Push-Pull: |
0 |
00 |
| Restart Type | Defines type of restart to be used | Enum_8 | 1 | Immediately: Time: |
+0d (0h) |
00 |
| Restart Time | [Only with restart type = Time], time in ms | Uint_32 | 4 | (20 ms … 600,000 ms) | +20d … +600000d (C8h ... 927C0h) |
00 00 00 00 … 00 09 27 C0 |
| Restart Input | [Only with restart type = Input], input for restart | Uint_16 | 2 | +1d ... +8d (1h ... 8h) |
00 00 … 00 08 |
|
| Combination | Combining multiple Events and/or Inputs | Enum_8 | 1 | AND: OR: XOR: |
+0d (0h) |
|
| Reserved | Reserved value 3 | Uint_16 | 2 | +0d (0h) |
00 00 |
|
| Reserved | Reserved value 4 | Uint_16 | 2 | +0d (0h) |
00 00 |
|
| Source | ||||||
| Source | The source parameter are only existing if the port is set to OUTPUT! | 2 | +1d (1h) |
00 01 |
||
| Source Name | Name of the source option | String | 4 | DeviceNotReady: Input1: Input2: SopasCommand: |
DRDY |
44 52 44 59 |
| Invert | Invert the source signal | Bool_1 | 1 | Not inverted: Inverted: |
+0d (0h) |
00 |
| Reserved | Reserved value 5 | Uint_8 | 1 | +0d (0h) |
00 |
|
| Reserved | Reserved value 6 | Uint_8 | 1 | +0d (0h) |
00 |
|
| Reserved | ||||||
| Reserved | Reserved value 7 | Uint_16 | 2 | +0d (0h) |
00 00 |
|
| Reserved | Reserved value 8 | Uint_16 | 2 | +0d (0h) |
00 00 |
|
| Reserved | Reserved value 9 | Uint_16 | 2 | +0d (0h) |
00 00 |
|
| Reserved | Reserved value 10 | Uint_16 | 2 | +0d (0h) |
00 00 |
Example: sWN PortConfiguration
CoLa A (ASCII)
<STX>sWN{SPC}PortConfiguration{SPC}1{SPC}6{SPC}InOut1{SPC}0{SPC}A{SPC}0{SPC}0{SPC}0{SPC}1{SPC}0{SPC}0{SPC}C8{SPC}1{SPC}1{SPC}0{SPC}0{SPC}1{SPC}DRDY{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}1{SPC}6{SPC}InOut2{SPC}0{SPC}A{SPC}1{SPC}0{SPC}0{SPC}1{SPC}0{SPC}0{SPC}C8{SPC}1{SPC}1{SPC}0{SPC}0{SPC}1{SPC}DRDY{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}6{SPC}InOut3{SPC}0{SPC}A{SPC}1{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}C8{SPC}1{SPC}1{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}6{SPC}InOut4{SPC}0{SPC}A{SPC}1{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}C8{SPC}1{SPC}1{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}6{SPC}InOut5{SPC}0{SPC}A{SPC}1{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}C8{SPC}1{SPC}1{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}6{SPC}InOut6{SPC}0{SPC}A{SPC}1{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}C8{SPC}1{SPC}1{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}1{SPC}6{SPC}InOut7{SPC}0{SPC}A{SPC}1{SPC}0{SPC}0{SPC}1{SPC}0{SPC}0{SPC}C8{SPC}1{SPC}1{SPC}0{SPC}0{SPC}1{SPC}DRDY{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}1{SPC}6{SPC}InOut8{SPC}0{SPC}A{SPC}1{SPC}0{SPC}0{SPC}1{SPC}0{SPC}0{SPC}C8{SPC}1{SPC}1{SPC}0{SPC}0{SPC}1{SPC}DRDY{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0<ETX>
<STX>sWN PortConfiguration 1 6 InOut1 0 A 0 0 0 1 0 0 C8 1 1 0 0 1 DRDY 0 0 0 0 0 0 0 1 6 InOut2 0 A 1 0 0 1 0 0 C8 1 1 0 0 1 DRDY 0 0 0 0 0 0 0 0 6 InOut3 0 A 1 0 0 0 0 0 C8 1 1 0 0 0 0 0 0 0 0 6 InOut4 0 A 1 0 0 0 0 0 C8 1 1 0 0 0 0 0 0 0 0 6 InOut5 0 A 1 0 0 0 0 0 C8 1 1 0 0 0 0 0 0 0 0 6 InOut6 0 A 1 0 0 0 0 0 C8 1 1 0 0 0 0 0 0 0 1 6 InOut7 0 A 1 0 0 1 0 0 C8 1 1 0 0 1 DRDY 0 0 0 0 0 0 0 1 6 InOut8 0 A 1 0 0 1 0 0 C8 1 1 0 0 1 DRDY 0 0 0 0 0 0 0<ETX>
sWN PortConfiguration 1 6 InOut1 0 A 0 0 0 1 0 0 C8 1 1 0 0 1 DRDY 0 0 0 0 0 0 0 1 6 InOut2 0 A 1 0 0 1 0 0 C8 1 1 0 0 1 DRDY 0 0 0 0 0 0 0 0 6 InOut3 0 A 1 0 0 0 0 0 C8 1 1 0 0 0 0 0 0 0 0 6 InOut4 0 A 1 0 0 0 0 0 C8 1 1 0 0 0 0 0 0 0 0 6 InOut5 0 A 1 0 0 0 0 0 C8 1 1 0 0 0 0 0 0 0 0 6 InOut6 0 A 1 0 0 0 0 0 C8 1 1 0 0 0 0 0 0 0 1 6 InOut7 0 A 1 0 0 1 0 0 C8 1 1 0 0 1 DRDY 0 0 0 0 0 0 0 1 6 InOut8 0 A 1 0 0 1 0 0 C8 1 1 0 0 1 DRDY 0 0 0 0 0 0 0
02 73 57 4E 20 50 6F 72 74 43 6F 6E 66 69 67 75 72 61 74 69 6F 6E 20 31 20 36 20 49 6E 4F 75 74 31 20 30 20 41 20 30 20 30 20 30 20 31 20 30 20 30 20 43 38 20 31 20 31 20 30 20 30 20 31 20 44 52 44 59 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 31 20 36 20 49 6E 4F 75 74 32 20 30 20 41 20 31 20 30 20 30 20 31 20 30 20 30 20 43 38 20 31 20 31 20 30 20 30 20 31 20 44 52 44 59 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 36 20 49 6E 4F 75 74 33 20 30 20 41 20 31 20 30 20 30 20 30 20 30 20 30 20 43 38 20 31 20 31 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 36 20 49 6E 4F 75 74 34 20 30 20 41 20 31 20 30 20 30 20 30 20 30 20 30 20 43 38 20 31 20 31 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 36 20 49 6E 4F 75 74 35 20 30 20 41 20 31 20 30 20 30 20 30 20 30 20 30 20 43 38 20 31 20 31 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 36 20 49 6E 4F 75 74 36 20 30 20 41 20 31 20 30 20 30 20 30 20 30 20 30 20 43 38 20 31 20 31 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 31 20 36 20 49 6E 4F 75 74 37 20 30 20 41 20 31 20 30 20 30 20 31 20 30 20 30 20 43 38 20 31 20 31 20 30 20 30 20 31 20 44 52 44 59 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 31 20 36 20 49 6E 4F 75 74 38 20 30 20 41 20 31 20 30 20 30 20 31 20 30 20 30 20 43 38 20 31 20 31 20 30 20 30 20 31 20 44 52 44 59 20 30 20 30 20 30 20 30 20 30 20 30 20 30 03
CoLa B (binary)
02 02 02 02 00 00 01 7A 73 57 4E 20 50 6F 72 74 43 6F 6E 66 69 67 75 72 61 74 69 6F 6E 20 01 00 06 49 6E 4F 75 74 31 00 00 0A 00 00 00 00 00 01 00 00 00 00 00 C8 00 01 01 00 00 00 00 00 01 44 52 44 59 00 00 00 00 00 00 00 00 00 00 00 01 00 06 49 6E 4F 75 74 32 00 00 0A 01 00 00 00 00 01 00 00 00 00 00 C8 00 01 01 00 00 00 00 00 01 44 52 44 59 00 00 00 00 00 00 00 00 00 00 00 00 00 06 49 6E 4F 75 74 33 00 00 0A 01 00 00 00 00 00 00 00 00 00 00 C8 00 01 01 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 06 49 6E 4F 75 74 34 00 00 0A 01 00 00 00 00 00 00 00 00 00 00 C8 00 01 01 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 06 49 6E 4F 75 74 35 00 00 0A 01 00 00 00 00 00 00 00 00 00 00 C8 00 01 01 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 06 49 6E 4F 75 74 36 00 00 0A 01 00 00 00 00 00 00 00 00 00 00 C8 00 01 01 00 00 00 00 00 00 00 00 00 00 00 00 00 00 01 00 06 49 6E 4F 75 74 37 00 00 0A 01 00 00 00 00 01 00 00 00 00 00 C8 00 01 01 00 00 00 00 00 01 44 52 44 59 00 00 00 00 00 00 00 00 00 00 00 01 00 06 49 6E 4F 75 74 38 00 00 0A 01 00 00 00 00 01 00 00 00 00 00 C8 00 01 01 00 00 00 00 00 01 44 52 44 59 00 00 00 00 00 00 00 00 00 00 00 0A
73 57 4E 20 50 6F 72 74 43 6F 6E 66 69 67 75 72 61 74 69 6F 6E 20 01 00 06 49 6E 4F 75 74 31 00 00 0A 00 00 00 00 00 01 00 00 00 00 00 C8 00 01 01 00 00 00 00 00 01 44 52 44 59 00 00 00 00 00 00 00 00 00 00 00 01 00 06 49 6E 4F 75 74 32 00 00 0A 01 00 00 00 00 01 00 00 00 00 00 C8 00 01 01 00 00 00 00 00 01 44 52 44 59 00 00 00 00 00 00 00 00 00 00 00 00 00 06 49 6E 4F 75 74 33 00 00 0A 01 00 00 00 00 00 00 00 00 00 00 C8 00 01 01 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 06 49 6E 4F 75 74 34 00 00 0A 01 00 00 00 00 00 00 00 00 00 00 C8 00 01 01 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 06 49 6E 4F 75 74 35 00 00 0A 01 00 00 00 00 00 00 00 00 00 00 C8 00 01 01 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 06 49 6E 4F 75 74 36 00 00 0A 01 00 00 00 00 00 00 00 00 00 00 C8 00 01 01 00 00 00 00 00 00 00 00 00 00 00 00 00 00 01 00 06 49 6E 4F 75 74 37 00 00 0A 01 00 00 00 00 01 00 00 00 00 00 C8 00 01 01 00 00 00 00 00 01 44 52 44 59 00 00 00 00 00 00 00 00 00 00 00 01 00 06 49 6E 4F 75 74 38 00 00 0A 01 00 00 00 00 01 00 00 00 00 00 C8 00 01 01 00 00 00 00 00 01 44 52 44 59 00 00 00 00 00 00 00 00 00 00 00
Telegram structure: sWA PortConfiguration
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Answer | String | 3 | sWA |
73 57 41 |
|
| Command | Configuration of the given ports | String | 17 | PortConfiguration |
50 6F 72 74 43 6F 6E 66 69 67 75 72 61 74 69 6F 6E |
Example: sWA PortConfiguration
CoLa A (ASCII)
CoLa B (binary)
READ Read State of the Inputs [sRN LIDinputstate]¶
Use sEN LIDinputstate 1 to receive a telegram each time an input signal (e.g. by trigger) changes.
Telegram structure: sRN LIDinputstate
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Read | String | 3 | sRN |
73 52 4E |
|
| Command | Input state | String | 14 | LIDinputstate |
4C 49 44 69 6E 70 75 74 73 74 61 74 65 |
Example: sRN LIDinputstate
CoLa A (ASCII)
CoLa B (binary)
Telegram structure: sRA LIDinputstate
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Answer | String | 3 | sRA |
73 52 41 |
|
| Command | Output state | String | 14 | LIDinputstate |
4C 49 44 69 6E 70 75 74 73 74 61 74 65 |
|
| Status code | Version number | Uint_16 | 2 | 0h … FFFFh |
00 00 … FF FF |
|
| Status code | System counter (time in µs since power up max. 71min then starting from 0 again) |
Uint_32 | 4 | 0 h … FFFFFFFFh |
00 00 00 00 … FF FF FF FF |
|
| State of the inputs 1 … n | Amount of inputs (n) depending of device family | Enum_8 | 1 | Not active: Active: Input not used: |
0 |
00 |
| Time | States code | Uint_16 | 2 | No time data: Time data: |
0 |
00 00 |
| Time Block (sensor-time from the last change of min. one of the outputs) |
Year | Array | 2 | E. g. | 1970 |
07 B2 |
| Time Block (sensor-time from the last change of min. one of the outputs) |
Month | Array | 1 | 1 … 12 |
01 … 0C |
|
| Time Block (sensor-time from the last change of min. one of the outputs) |
Day | Array | 1 | 1 … 31 |
01 … 1F |
|
| Time Block (sensor-time from the last change of min. one of the outputs) |
Hour | Array | 1 | 0 … 23 |
00 … 17 |
|
| Time Block (sensor-time from the last change of min. one of the outputs) |
Minute | Array | 1 | 0 … 59 |
00 … 3B |
|
| Time Block (sensor-time from the last change of min. one of the outputs) |
Second | Array | 1 | 0 … 59 |
00 … 3B |
|
| Time Block (sensor-time from the last change of min. one of the outputs) |
Microsecond | Array | 4 | 0 … 999999 |
00 00 00 00 … 00 0F 42 3F |
Example: sRA LIDinputstate In1 not used, In2 inactive, In3 inactive, In4 not used, In5 not used, In6 not used, In7 not used, In8 not used, time: 1970-01-01 0:13 58.443 sec
CoLa A (ASCII)
<STX>sRA{SPC}LIDinputstate{SPC}1{SPC}31F99C10{SPC}2{SPC}0{SPC}0{SPC}2{SPC}2{SPC}2{SPC}2{SPC}2{SPC}1{SPC}7B2{SPC}1{SPC}1{SPC}0{SPC}D{SPC}3A{SPC}6C278<ETX>
02 73 52 41 20 4C 49 44 69 6E 70 75 74 73 74 61 74 65 20 31 20 33 31 46 39 39 43 31 30 20 32 20 30 20 30 20 32 20 32 20 32 20 32 20 32 20 31 20 37 42 32 20 31 20 31 20 30 20 44 20 33 41 20 36 43 32 37 38 03
CoLa B (binary)
READ Read State of the Outputs [sRN LIDoutputstate]¶
Status of all outputs
Telegram structure: sRN LIDoutputstate
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Read | String | 3 | sRN |
73 52 4E |
|
| Command | Output state | String | 14 | LIDoutputstate |
4C 49 44 6F 75 74 70 75 74 73 74 61 74 65 |
Example: sRN LIDoutputstate
CoLa A (ASCII)
CoLa B (binary)
Telegram structure: sRA LIDoutputstate
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Complete telegram structure of the answer . |
EVENT Receive Outputstate by Event [sEN LIDoutputstate]¶
Output telegram is sent every time an output state changes.
Telegram structure: sEN LIDoutputstate
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Event | String | 3 | sEN |
73 45 4E |
|
| Command | Output state | String | 14 | LIDoutputstate |
4C 49 44 6F 75 74 70 75 74 73 74 61 74 65 |
|
| Start/stop | Enum_8 | 1 | Start: Stop: |
1 |
01 |
Example: sEN LIDoutputstate
CoLa A (ASCII)
CoLa B (binary)
Telegram structure: sRA/sSN LIDoutputstate
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Answer | String | 3 | sRA / sSN |
73 52 41 / 73 53 4E |
|
| Command | Output state | String | 14 | LIDoutputstate |
4C 49 44 6F 75 74 70 75 74 73 74 61 74 65 |
|
| Status code | Version number | Uint_16 | 2 | 0h … FFFFh |
00 00 … FF FF |
|
| Status code | System counter (time in µs since power up max. 71min then starting from 0 again) |
Uint_32 | 4 | 0h … FFFFFFFFh |
00 00 00 00 … FF FF FF FF |
|
| State of the outputs 1 ... n and count value in hex. (values of an example) Amount of outputs (n) depending of device family |
Output 1 ... n state | Enum_8 | 1 | Not active: Active: Output not used: |
0 |
00 |
| State of the outputs 1 ... n and count value in hex. (values of an example) Amount of outputs (n) depending of device family |
Output 1 ... n count | Uint_32 | 4 | 0h … FFFFFFFFh |
00 00 00 00 … FF FF FF FF |
|
| Time | States code | Uint_16 | 2 | No time data: Time data: |
0 |
00 00 |
| Time Block (sensor-time from the last change of min. one of the outputs) |
Year | Array | 2 | E. g. | 1970 |
07 B2 |
| Time Block (sensor-time from the last change of min. one of the outputs) |
Month | Array | 1 | 1 … 12 |
01 … 0C |
|
| Time Block (sensor-time from the last change of min. one of the outputs) |
Day | Array | 1 | 1 … 31 |
01 … 1F |
|
| Time Block (sensor-time from the last change of min. one of the outputs) |
Hour | Array | 1 | 0 … 23 |
00 … 17 |
|
| Time Block (sensor-time from the last change of min. one of the outputs) |
Minute | Array | 1 | 0 … 59 |
00 … 3B |
|
| Time Block (sensor-time from the last change of min. one of the outputs) |
Second | Array | 1 | 0 … 59 |
00 … 3B |
|
| Time Block (sensor-time from the last change of min. one of the outputs) |
Microsecond | Array | 4 | 0 … 999999 |
00 00 00 00 … 00 0F 42 3F |
Example: sRA LIDoutputstate Out1 active Count 0, Out2 active Count 0, all other Outputs not used, time: 1970-01-01 0:31 38.191 sec
CoLa A (ASCII)
<STX>sRA{SPC}LIDoutputstate{SPC}1{SPC}712414B0{SPC}1{SPC}0{SPC}1{SPC}0{SPC}2{SPC}0{SPC}2{SPC}0{SPC}2{SPC}0{SPC}2{SPC}0{SPC}2{SPC}0{SPC}2{SPC}0{SPC}1{SPC}7B2{SPC}1{SPC}1{SPC}0{SPC}1F{SPC}26{SPC}2EA18<ETX>
02 73 52 41 20 4C 49 44 6F 75 74 70 75 74 73 74 61 74 65 20 31 20 37 31 32 34 31 34 42 30 20 31 20 30 20 31 20 30 20 32 20 30 20 32 20 30 20 32 20 30 20 32 20 30 20 32 20 30 20 32 20 30 20 31 20 37 42 32 20 31 20 31 20 30 20 31 46 20 32 36 20 32 45 41 31 38 03
CoLa B (binary)
METHOD Set Output State [sMN mDOSetOutput]¶
Set a specific output to high or low via software command.
Output source needs to be set to "SOPAS command" and the port configured as Output (in case of I/O).
Telegram structure: sMN mDOSetOutput
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Method | String | 3 | sMN |
73 4D 4E |
|
| Command | Set output state | String | 12 | mDOSetOutput |
6D 44 4F 53 65 74 4F 75 74 70 75 74 |
|
| Output number | Uint_8 | 1 | Depends on system plug: | 1 … 3 |
01 … 03 |
|
| Output state | Enum_8 | 1 | Not active: Active: |
0 |
00 |
Example: sMN mDOSetOutput
CoLa A (ASCII)
CoLa B (binary)
Telegram structure: sAN mDOSetOutput
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Answer | String | 3 | sAN |
73 41 4E |
|
| Command | Set output state | String | 12 | mDOSetOutput |
6D 44 4F 53 65 74 4F 75 74 70 75 74 |
|
| Status Code | Status code | Bool_1 | 1 | Error: Success: |
0 |
00 |
Example: sAN mDOSetOutput
CoLa A (ASCII)
CoLa B (binary)
METHOD Reset Output Counter [sMN LIDrstoutpcnt]¶
Reset the counter which keeps track of how often an digital output has been active (and not active). Information from the counter is included in LIDoutputstate.
Telegram structure: sMN LIDrstoutpcnt
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Method | String | 3 | sMN |
73 4D 4E |
|
| Command | Reset output counter | String | 13 | LIDrstoutpcnt |
4C 49 44 72 73 74 6F 75 74 70 63 6E 74 |
Example: sMN LIDrstoutpcnt
CoLa A (ASCII)
CoLa B (binary)
Telegram structure: sAN LIDrstoutpcnt
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Answer | String | 3 | sAN |
73 41 4E |
|
| Command | Reset output counter | String | 13 | LIDrstoutpcnt |
4C 49 44 72 73 74 6F 75 74 70 63 6E 74 |
|
| Status code | Code number | Bool_1 | 1 | Success: Error: |
0 |
00 |
Example: sAN LIDrstoutpcnt
CoLa A (ASCII)
CoLa B (binary)
WRITE Enable Cloning Plug Functionality [sWN enableCloningPlug]¶
Enables or disables the cloning plug functionality.
Telegram structure: sWN enableCloningPlug
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Write request | String | 3 | sWN |
73 57 4E |
|
| Variable name | enableCloningPlug | String | 17 | enableCloningPlug |
65 6E 61 62 6C 65 43 6C 6F 6E 69 6E 67 50 6C 75 67 |
|
| Value | Enable/ disable cloning plug functionality | Bool_1 | 1 | Disable: Enable: |
0 |
00 |
Example: sWN enableCloningPlug
CoLa A (ASCII)
CoLa B (binary)
Telegram structure: sWA enableCloningPlug
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Write answer | String | 3 | sWA |
73 57 41 |
|
| Variable name | Echo of variable name | String | 17 | enableCloningPlug |
65 6E 61 62 6C 65 43 6C 6F 6E 69 6E 67 50 6C 75 67 |
Example: sWA enableCloningPlug
CoLa A (ASCII)
CoLa B (binary)
READ Read Cloning Plug Functionality [sRN enableCloningPlug]¶
Check if the cloning plug functionality is enabled.
Telegram structure: sRN enableCloningPlug
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Read request | String | 3 | sRN |
73 52 4E |
|
| Variable name | enableCloningPlug | String | 17 | enableCloningPlug |
65 6E 61 62 6C 65 43 6C 6F 6E 69 6E 67 50 6C 75 67 |
Example: sRN enableCloningPlug
CoLa A (ASCII)
CoLa B (binary)
Telegram structure: sRA enableCloningPlug
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Read answer | String | 3 | sRA |
73 52 41 |
|
| Variable name | enableCloningPlug | String | 17 | enableCloningPlug |
65 6E 61 62 6C 65 43 6C 6F 6E 69 6E 67 50 6C 75 67 |
|
| Value | Cloning plug functionality disabled / enabled | Bool_1 | 1 | Disabled: Enabled: |
0 |
00 |
Example: sRA enableCloningPlug
CoLa A (ASCII)
CoLa B (binary)
Measurement Data Output¶
WRITE Configure the Data Content for the Scan [sWN LMDscandatacfg]¶
Configuration of the channels (e.g. distance) and information that will be send by the device as measurement data (output data format).
Telegram structure: sWN LMDscandatacfg
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Write | String | 3 | sWN |
73 57 4E |
|
| Command | Configure scandata | String | 14 | LMDscandatacfg |
4C 4D 44 73 63 61 6E 64 61 74 61 63 66 67 |
|
| Reserved | - | Uint_8 | 2 | Always: | 0 0 |
00 00 |
| RSSI | Enable or disable the output of RSSI values | Uint_8 | 1 | RSSI disabled: RSSI enabled: |
0 |
00 |
| Reserved | - | Enum_8 | 1 | Always: | 0 |
00 |
| Reserved | - | Enum_8 | 1 | Always: | 0 |
00 |
| Encoder | Encoder data | Uint_8 | 2 | No encoder: Channel 1: |
0 0 |
00 00 |
| Reserved | - | Bool_1 | 1 | Always: | 0 |
00 |
| Device name | Sends the device name | Bool_1 | 1 | No: Yes: |
0 |
00 |
| Reserved | - | Bool_1 | 1 | Always: | 0 |
00 |
| Time | Sends time stamp information | Bool_1 | 1 | No: Yes: |
0 |
00 |
| Reserved | - | Uint_16 | 2 | Always: | +1d (1h) |
00 01 |
Example: RSSI enabled
Example: sWN LMDscandatacfg
CoLa A (ASCII)
<STX>sWN{SPC}LMDscandatacfg{SPC}0{SPC}0{SPC}1{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}+1<ETX>
02 73 57 4E 20 4C 4D 44 73 63 61 6E 64 61 74 61 63 66 67 20 30 20 30 20 31 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 2B 31 03
CoLa B (binary)
02 02 02 02 00 00 00 20 73 57 4E 20 4C 4D 44 73 63 61 6E 64 61 74 61 63 66 67 20 00 00 01 00 00 00 00 00 00 00 00 00 01 42
Telegram structure: sWA LMDscandatacfg
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Answer | String | 3 | sWA |
73 57 41 |
|
| Command | Configure scandata | String | 14 | LMDscandatacfg |
4C 4D 44 73 63 61 6E 64 61 74 61 63 66 67 |
Example: sWA LMDscandatacfg
CoLa A (ASCII)
CoLa B (binary)
READ Poll One Telegram [sRN LMDscandata]¶
Asking the device for the measurement values of the last valid scan. The device will respond, even if currently no measurement data is created (e.g. due to standby or log in).
Data is transmitted only via LMDscandata when LMDscandata is selected as data output format.
During the boot-up phase of the device, there will be no data telegram or answer from the device.
Telegram structure: sRN LMDscandata
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Read | String | 3 | sRN |
73 52 4E |
|
| Command | Only one telegram | String | 11 | LMDscandata |
4C 4D 44 73 63 61 6E 64 61 74 61 |
Example: sRN LMDscandata
CoLa A (ASCII)
CoLa B (binary)
Telegram structure: sRA LMDscandata
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Find complete telegram structure of the answer in . |
EVENT Send Data Permanently [sEN LMDscandata]¶
Start/ stop continuous retrievement of measurement data from device. Data will be transmitted as configured as soon as measurement data is generated by the device. No data is generated when there is an active log in, the laser is shut off (e.g. in Standby mode), the motor is stopped or in case of certain error modes (e.g. Device not ready).
Data is transmitted only via LMDscandata when LMDscandata is selected as data output format.
During the boot-up phase of the device, there will be no data telegram or answer from the device.
Telegram structure: sEN LMDscandata
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Event | String | 3 | sEN |
73 45 4E |
|
| Command | Data telegram | String | 11 | LMDscandata |
4C 4D 44 73 63 61 6E 64 61 74 61 |
|
| Measurement | Start/stop | Enum_8 | 1 | Stop: Start: |
0 |
00 |
Example: sEN LMDscandata
CoLa A (ASCII)
CoLa B (binary)
Telegram structure: sEA LMDscandata
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Answer | String | 3 | sEA |
73 45 41 |
|
| Command | Data telegram | String | 11 | LMDscandata |
4C 4D 44 73 63 61 6E 64 61 74 61 |
|
| Measurement | Start/stop | Enum_8 | 1 | Stop: Start: |
0 |
00 |
Example: Confirmation of sEA LMDscandata
CoLa A (ASCII)
CoLa B (binary)
The answer to the telegram will be followed by the scandata:
Telegram structure: Datastream of sRA LMDscandata/sSN LMDscandata
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Read | String | 3 | Answer to sRN LMDscandata: Answer to sEN LMDscandata: |
sRA |
73 52 41 |
| Command | Data telegram | String | 11 | LMDscandata |
4C 4D 44 73 63 61 6E 64 61 74 61 |
|
| Version number | For detecting format changes by the version. | Uint_16 | 2 | 1h … FFFFh |
00 01 … FF FF |
|
| Device | ||||||
| Device number | Defined with SOPAS | Uint_16 | 2 | 0h … FFFFh |
00 00 … FF FF |
|
| Serial number | Production period (year, calendar week, number): YYWWxxxx | Uint_32 | 4 | 0h … FFFFFFFFh |
00 00 00 00 … FF FF FF FF |
|
| Device status | (See values column) | Uint_8 | 2 x 1 | Ok: Error: |
0 0 |
00 00 |
| Status info | ||||||
| Telegram counter | Number of measurement telegrams finished in the scanner and given to the interface. Does not count how many telegrams were really given out; is relevant if not all scans are delivered from the scan core. | Uint_16 | 2 | 0h … FFFFh |
00 00 … FF FF |
|
| Scan counter | Number of scans which were created in the device; counts how many scans were really done. | Uint_16 | 2 | 0h … FFFFh |
00 00 … FF FF |
|
| Time since start up in µs | In the output telegram this is the time at the zero index before the measurement itself starts. Time base is the boot-up time in µs since power up, max. 71 min then starting from 0 again. | Uint_32 | 4 | 0h … FFFFFFFFh |
00 00 00 00 … FF FF FF FF |
|
| Time of transmission in µs | In the output telegram this is the time when the complete scan is transmitted to the buffer for data output. Time base is the boot-up time in µs since power up, max. 71 min then starting from 0 again. | Uint_32 | 4 | 0h … FFFFFFFFh |
00 00 00 00 … FF FF FF FF |
|
| Status of digital inputs | Low byte represents input 1. | Uint_8 | 2 x 1 | All inputs low: Input 1 high: Input 2 high: Input 1+2 high: All inputs high: (Depends on system plug and port configuration) |
0 0 |
00 00 |
| Status of digital outputs | Low byte represents output 1. | Uint_8 | 2 x 1 | All outputs low: All outputs high: |
0 0 |
00 00 |
| Reserved | - | Uint_16 | 2 | Always: | 0 |
00 00 00 00 |
| Frequencies | ||||||
| Scan frequency | [1/100 Hz] | Uint_32 | 4 | 15 Hz ... 50 Hz: (depends on Dynamic Sensing Profile ) |
5DCh ... 1388h |
05 DC ... 13 88 |
| Reserved | - | Uint_32 | 4 | Always: | 0 |
00 00 00 00 |
| Encoder | ||||||
| Amount of encoder | If 0, then next two telegram parts are missing. | Enum_16 | 2 | External encoder | 0 |
00 00 |
| Encoder position | Info in ticks | Uint_32 | 4 | Only filled if parameter is activated | 0h … FFFFFFFFh |
00 00 00 00 ... FF FF FF FF |
| Encoder speed | mm/sec or milligrad/sec |
Uint_16 | 2 | Only filled if parameter is activated | 0h ... FFFFh |
00 00 ... FF FF |
| 16 bit output channel (Distance) | ||||||
| Amount of 16 bit channels | Number of 16 bit channels that provide measured data | Enum_16 | 2 | Output channels | 1 or 3 |
01 or 03 |
| Content | Defines the content of the output channel | String | 5 | Distance values: Distance values: Distance values: |
DIST1 |
44 49 53 54 31 |
| Scale factor | Scale factor or factor of the measurement values | Real as float according to IEEE754 | 4 | Factor x 1: Factor x 2: Factor x 1 (REFL1) (alternative): |
3F800000h |
3F 80 00 00 |
| Reserved | - | Real as float according to IEEE754 | 4 | Always: | 00000000 |
00 00 00 00 |
| Start angle | [1/10000°] | Int_32 | 4 | -48° ... 228° (depends on Dynamic Sensing Profile ) |
FFF8AD00h … 22CA40h |
FF F8 AD 00h … 00 22 CA 40h |
| Size of single angular step | Output format in degree: 1/10000° | Uint_16 | 2 | 0.1° ... 1°: (depends on angular resolution of Dynamic Sensing Profile ) |
3E8h ... 2710h |
03 E8 ... 27 10 |
| Amount of data | Number of transmitted measurement points | Uint_16 | 2 | 0h … FFFFh |
00 00 … FF FF |
|
| Data_1 Data_n |
Data stream starting Data_1 to Data_n | Uint_16 | 2 | 0h … 61A8h |
00 00 00 00 … 00 00 61 A8 |
|
| 8 bit output channel (RSSI) | ||||||
| Amount of 8 bit channels | Number of 8 bit channels that provide measured data | Enum_16 | 2 | Output channels: | 1 or 3 |
01 or 03 |
| Content | Defines the content of the output channel (RSSI) | String | 5 | RSSI1 |
52 53 53 49 31 |
|
| Scale factor | Scale factor of the RSSI values | Real as float according to IEEE754 | 4 | Factor x 1: Factor x 2: |
3F800000h |
3F 80 00 00 |
| Reserved | - | Real as float according to IEEE754 | 4 | Always: | 00000000h |
00 00 00 00 |
| Start angle | Output format: [1/10000°] | Uint_32 | 4 | -48° ... 228° (depends on Dynamic Sensing Profile ) |
FFF8AD00h … 22CA40h |
FF F8 AD 00h … 00 22 CA 40h |
| Size of single angular step | Output format: 1/10000° | Uint_16 | 2 | 0.1° ... 1°: (depends on Dynamic Sensing Profile ) |
3E8h ... 2710h |
03 E8 ... 27 10 |
| Amount of data | Number of transmitted measurement points | Uint_16 | 2 | 0h … FFFFh |
00 00 … FF FF |
|
| Data_1 Data_n |
Data stream starting Data_1 to Data_n | Uint_8 | 1 | 00h ... FFh |
00 ... FF |
|
| Reserved | ||||||
| Reserved | - | Enum_16 | 2 | Always: | 0 |
00 00 |
| Reserved | ||||||
| Reserved | - | Enum_16 | 2 | Always: | 0 |
00 00 |
| Reserved | ||||||
| Reserved | - | Enum_16 | 2 | Always: | 0 |
00 00 |
| Reserved | ||||||
| Reserved | - | Enum_16 | 2 | Always: | 0 |
00 00 |
| Reserved | ||||||
| Reserved | - | Uint_16 | 2 | Always: | 0 |
00 00 |
LMDscandata - reserved values
Valid distance measurement values are values starting from 16d upwards; everything below has the following meaning:
| DIST | RSSI | Description |
|---|---|---|
| 0d | 0d | Invalid measurement value; caused by very low remission (extremely dark object), object distance not within measurement range (too close or too far away) or selected filter settings at device |
| 1d - 15d | 0d | Reserved, currently not in use |
| ≥16d | >0h | Valid measurement values |
| ≥16d | 254d | Reflector detected |
| ≥16d | 255d | Reserved |
Higher measurement values will be given out with a zero, that means no measurement value detected.
WRITE Set Scan Data Enable [sWN ScanDataEnable]¶
Enables/ Disables streaming data output
Telegram structure: sWN ScanDataEnable
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Write | String | 3 | sWN |
73 57 E4 |
|
| Command | Enables/ Disables streaming data output. | String | 14 | ScanDataEnable |
53 63 61 6E 44 61 74 61 45 6E 61 62 6C 65 |
|
| Data | Bool | 1 | Off: On: |
0d (00h) |
00 ... 01 |
Example: sWN ScanDataEnable 0 - Disable the streaming data output
CoLa A (ASCII)
CoLa B (binary)
Telegram structure: sWA ScanDataEnable
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Answer | String | 3 | sWA |
73 57 41 |
|
| Command | Enables/ Disables streaming data output. | String | 14 | ScanDataEnable |
53 63 61 6E 44 61 74 61 45 6E 61 62 6C 65 |
Example: sWA ScanDataEnable
CoLa A (ASCII)
CoLa B (binary)
WRITE Set Streaming Ethernet Settings [sWN ScanDataEthSettings]¶
Ethernet settings for the scan data streaming functionality of the device
Telegram structure: sWN ScanDataEthSettings
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Write | String | 3 | sWN |
73 57 4E |
|
| Command | String | String | 19 | ScanDataEthSettings |
53 63 61 6E 44 61 74 61 45 74 68 53 65 74 74 69 6E 67 73 |
|
| Protocol | Transport protocol for streaming data | Enum_8 | 1 | UDP (fix): | +1d (01h) |
01 |
| IPAddress | IP address of the destination for data receiver | Array | 4 | 0 …+255d (00…FF) |
00 … FF |
|
| Port | Port destination of the data reseiver | Uint_16 | 2 | 0 .. +65535d(00 00…FF FF) |
00 00 … FF FF |
Example: sWN ScanDataEthSettings +1 +192 +168 +0 +100 +2115
Protocol is set to UDP (1), IPAddress (192.168.0.100), Port (2115)
Example: sWN ScanDataEthSettings
CoLa A (ASCII)
02 73 57 4E 20 53 63 61 6E 44 61 74 61 45 74 68 53 65 74 74 69 6E 67 73 20 31 20 43 30 20 41 38 20 30 20 36 34 20 38 34 33 03
CoLa B (binary)
02 02 02 02 00 00 00 1F 73 57 4E 20 53 63 61 6E 44 61 74 61 45 74 68 53 65 74 74 69 6E 67 73 20 01 C0 A8 00 64 08 43 5F
Telegram structure: sWA ScanDataEthSettings
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Answer | String | 3 | sWA |
73 57 41 |
|
| Command | String | String | 19 | ScanDataEthSettings |
53 63 61 6E 44 61 74 61 45 74 68 53 65 74 74 69 6E 67 73 |
Example: sWA ScanDataEthSettings
CoLa A (ASCII)
CoLa B (binary)
READ Read Streaming Ethernet Settings [sRN ScanDataEthSettings]¶
Read ethernet settings for the scan data streaming functionality of the device.
Telegram structure: sRN ScanDataEthSettings
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Read | String | 3 | sRN |
73 52 4E |
|
| Command | String | String | 19 | ScanDataEthSettings |
53 63 61 6E 44 61 74 61 45 74 68 53 65 74 74 69 6E 67 73 |
Example: sRN ScanDataEthSettings
CoLa A (ASCII)
CoLa B (binary)
Telegram structure: sRA ScanDataEthSettings
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Answer | String | 3 | sRA |
73 52 41 |
|
| Command | String | String | 19 | ScanDataEthSettings |
53 63 61 6E 44 61 74 61 45 74 68 53 65 74 74 69 6E 67 73 |
|
| Protocol | Transport protocol for streaming data | Enum_8 | 1 | UDP: TCP: |
+1d (01h) |
01 |
| IPAddress | IP address of the destination for data receiver | Array | 4 | 0 …+255d (00…FF) |
00 … FF |
|
| Port | Port destination of the data receiver | Uint_16 | 2 | 0 .. +65535d(00 00…FF FF) |
00 00 … FF FF |
Example: sRA ScanDataEthSettings +1 +192 +168 +0 +100 +2115
Protocol is set to UDP (1), IPAddress (192.168.0.100), Port (2115)
Example: sRA ScanDataEthSettings
CoLa A (ASCII)
02 73 52 41 20 53 63 61 6E 44 61 74 61 45 74 68 53 65 74 74 69 6E 67 73 20 31 20 43 30 20 41 38 20 30 20 36 34 20 38 34 33 03
CoLa B (binary)
READ Read Scan Data Format [sRN ScanDataFormat]¶
Return of the scan data format
Telegram structure: sRN ScanDataFormat
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Read | String | 3 | sRN |
73 52 4E |
|
| Command | Data serialization format | String | 14 | ScanDataFormat |
53 63 61 6E 44 61 74 61 46 6F 72 6D 61 74 |
Example: sRN ScanDataFormat
Read of the data serialization format
Example: sRN ScanDataFormat
CoLa A (ASCII)
CoLa B (binary)
Telegram structure: sRA ScanDataFormat
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Answer | String | 3 | sRA |
73 52 41 |
|
| Command | Data serialization format | String | 14 | ScanDataFormat |
53 63 61 6E 44 61 74 61 46 6F 72 6D 61 74 |
|
| Data | Enum_8 | 1 | MSGPACK: Compact: LMDscandata: Native ROS2: |
1h |
01 |
Example: sRA ScanDataFormat
Scan data format is set to Compact = 2
Example: sRA ScanDataFormat
CoLa A (ASCII)
CoLa B (binary)
WRITE Set Scan Data Format [sWN ScanDataFormat]¶
Set the data serialization format
Telegram structure: sWN ScanDataFormat
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Write | String | 3 | sWN |
73 57 4E |
|
| Command | Data serialization format | String | 14 | ScanDataFormat |
53 63 61 6E 44 61 74 61 46 6F 72 6D 61 74 |
|
| Variable Data | Data | Enum_8 | 1 | MSGPACK: Compact (recommended): LMDscandata: Native ROS2: |
+1d (1h) |
01 |
Example: sWN ScanDataFormat
Scan data format set to Compact format
Example: sWN ScanDataFormat
CoLa A (ASCII)
CoLa B (binary)
Telegram structure: sWA ScanDataFormat
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Answer | String | 3 | sWA |
73 57 41 |
|
| Command | Data serialization format | String | 14 | ScanDataFormat |
53 63 61 6E 44 61 74 61 46 6F 72 6D 61 74 |
Example: sWA ScanDataFormat
CoLa A (ASCII)
CoLa B (binary)
WRITE Set the Session Timeout for TCP/IP Communication [sWN EtherSessionTimeout]¶
Set the session timeout for TCP/IP communication (e.g. LMDscandata communication). Be careful with low values as they might cause unexpected disconnections. Write access requires user level: Service.
Telegram structure: sWN EtherSessionTimeout
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Write request | String | 3 | sWN |
73 57 4E |
|
| Variable name | EtherSessionTimeout | String | 19 | EtherSessionTimeout |
45 74 68 65 72 53 65 73 73 69 6F 6E 54 69 6D 65 6F 75 74 |
|
| Value | Session timeout in ms | UInt_32 | 4 | +15000 |
00 00 3A 98 |
Example: sWN EtherSessionTimeout
CoLa A (ASCII)
CoLa B (binary)
02 02 02 02 00 00 00 1C 73 57 4E 20 45 74 68 65 72 53 65 73 73 69 6F 6E 54 69 6D 65 6F 75 74 20 00 00 3A 98 83
Telegram structure: sWA EtherSessionTimeout
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Write answer | String | 3 | sWA |
73 57 41 |
|
| Variable name | Echo of variable name | String | 19 | EtherSessionTimeout |
45 74 68 65 72 53 65 73 73 69 6F 6E 54 69 6D 65 6F 75 74 |
Example: sWA EtherSessionTimeout
CoLa A (ASCII)
CoLa B (binary)
READ Read the Session Timeout for TCP/IP Communication [sRN EtherSessionTimeout]¶
Returns the session timeout for TCP/IP communication (e.g. LMDscandata communication). Be careful with low values as they might cause unexpected disconnections.
Telegram structure: sRN EtherSessionTimeout
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Read request | String | 3 | sRN |
73 52 4E |
|
| Variable name | EtherSessionTimeout | String | 19 | EtherSessionTimeout |
45 74 68 65 72 53 65 73 73 69 6F 6E 54 69 6D 65 6F 75 74 |
Example: sRN EtherSessionTimeout
CoLa A (ASCII)
CoLa B (binary)
Telegram structure: sRA EtherSessionTimeout
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Read answer | String | 3 | sRA |
73 52 41 |
|
| Variable name | EtherSessionTimeout | String | 19 | EtherSessionTimeout |
45 74 68 65 72 53 65 73 73 69 6F 6E 54 69 6D 65 6F 75 74 |
|
| Value | Session timeout in ms | UInt_32 | 4 | +15000 |
00 00 3A 98 |
Example: sRA EtherSessionTimeout
CoLa A (ASCII)
CoLa B (binary)
WRITE Set the Content of the Compact Format Telegram Type 1 [sWN compactTelegramType1Content]¶
Sets the content of the Compact format telegram type 1 (e.g. whether to include the RSSI values).
Telegram structure: sWN compactTelegramType1Content
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Write request | String | 3 | sWN |
73 57 4E |
|
| Variable name | compactTelegramType1Content | String | 27 | compactTelegramType1Content |
63 6F 6D 70 61 63 74 54 65 6C 65 67 72 61 6D 54 79 70 65 31 43 6F 6E 74 65 6E 74 |
|
| includeRssi | If true, RSSIs are serialized | Bool_1 | 1 | Disable: Enable: |
0 |
00 |
| includeProperties | If true, properties are serialized | Bool_1 | 1 | Disable: Enable: |
0 |
00 |
Example: sWN compactTelegramType1Content
CoLa A (ASCII)
02 73 57 4E 20 63 6F 6D 70 61 63 74 54 65 6C 65 67 72 61 6D 54 79 70 65 31 43 6F 6E 74 65 6E 74 20 31 20 31 03
CoLa B (binary)
02 02 02 02 00 00 00 22 73 57 4E 20 63 6F 6D 70 61 63 74 54 65 6C 65 67 72 61 6D 54 79 70 65 31 43 6F 6E 74 65 6E 74 20 01 01 6C
73 57 4E 20 63 6F 6D 70 61 63 74 54 65 6C 65 67 72 61 6D 54 79 70 65 31 43 6F 6E 74 65 6E 74 20 01 01
Telegram structure: sWA compactTelegramType1Content
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Write answer | String | 3 | sWA |
73 57 41 |
|
| Variable name | Echo of variable name | String | 27 | compactTelegramType1Content |
63 6F 6D 70 61 63 74 54 65 6C 65 67 72 61 6D 54 79 70 65 31 43 6F 6E 74 65 6E 74 |
Example: sWA compactTelegramType1Content
CoLa A (ASCII)
CoLa B (binary)
READ Read compactTelegramType1Content [sRN compactTelegramType1Content]¶
Returns the content of the Compact format telegram type 1 (e.g. whether to include the RSSI values).
Telegram structure: sRN compactTelegramType1Content
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Read request | String | 3 | sRN |
73 52 4E |
|
| Variable name | compactTelegramType1Content | String | 27 | compactTelegramType1Content |
63 6F 6D 70 61 63 74 54 65 6C 65 67 72 61 6D 54 79 70 65 31 43 6F 6E 74 65 6E 74 |
Example: sRN compactTelegramType1Content
CoLa A (ASCII)
CoLa B (binary)
02 02 02 02 00 00 00 1F 73 52 4E 20 63 6F 6D 70 61 63 74 54 65 6C 65 67 72 61 6D 54 79 70 65 31 43 6F 6E 74 65 6E 74 49
Telegram structure: sRA compactTelegramType1Content
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Read answer | String | 3 | sRA |
73 52 41 |
|
| Variable name | compactTelegramType1Content | String | 27 | compactTelegramType1Content |
63 6F 6D 70 61 63 74 54 65 6C 65 67 72 61 6D 54 79 70 65 31 43 6F 6E 74 65 6E 74 |
|
| includeRssi | If true, RSSIs are serialized | Bool_1 | 1 | Disabled: Enabled: |
0 |
00 |
| includeProperties | If true, properties are serialized | Bool_1 | 1 | Disabled: Enabled: |
0 |
00 |
Example: sRA compactTelegramType1Content
CoLa A (ASCII)
02 73 52 41 20 63 6F 6D 70 61 63 74 54 65 6C 65 67 72 61 6D 54 79 70 65 31 43 6F 6E 74 65 6E 74 20 31 20 31 03
CoLa B (binary)
WRITE Write ROS Parent Frame ID [sWN rosParentFrameId]¶
Set the parent frame ID of the published topics.
Telegram structure: sWN rosParentFrameId
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Write | String | 3 | sWN |
73 57 4E |
|
| Command | Set parent frame ID of the published topics | String | 16 | rosParentFrameId |
72 6F 73 50 61 72 65 6E 74 46 72 61 6D 65 49 64 |
|
| Value | Number of characters of the parent frame id | Uint_16 | 1 | 0d ... +16d (0h ... 10h |
00 00 ... 00 10 |
|
| Value | Configured parent frame ID | FlexString | 64 | [Parent frame ID] |
[Parent frame ID] |
Example: sWN rosParentFrameId
CoLa A (ASCII)
CoLa B (binary)
02 02 02 02 00 00 00 1C 73 57 4E 20 72 6F 73 50 61 72 65 6E 74 46 72 61 6D 65 49 64 20 00 05 77 6F 72 6C 64 2F
Telegram structure: sWA rosParentFrameId
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Answer | String | 3 | sWA |
73 57 41 |
|
| Command | Set parent frame ID of the published topics | String | 16 | rosParentFrameId |
72 6F 73 50 61 72 65 6E 74 46 72 61 6D 65 49 64 |
Example: sWA rosParentFrameId
CoLa A (ASCII)
CoLa B (binary)
READ Read ROS Parent Frame ID [sRN rosParentFrameId]¶
Returns the parent frame ID of the published topics.
Telegram structure: sRN rosParentFrameId
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Read | String | 3 | sRN |
73 52 4E |
|
| Command | Read parent frame ID of the published topics | String | 16 | rosParentFrameId |
72 6F 73 50 61 72 65 6E 74 46 72 61 6D 65 49 64 |
Example: sRN rosParentFrameId
CoLa A (ASCII)
CoLa B (binary)
Telegram structure: sRA rosParentFrameId
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Answer | String | 3 | sRA |
73 52 41 |
|
| Command | Read parent frame ID of the published topics | String | 16 | rosParentFrameId |
72 6F 73 50 61 72 65 6E 74 46 72 61 6D 65 49 64 |
|
| Value | Number of characters of the parent frame id | Uint_16 | 2 | 0d ... +16d (0h ... 10h |
00 00 ... 00 10 |
|
| Value | Configured parent frame ID | FlexString | 64 | [Parent frame ID] |
[Parent frame ID] |
Example: sRA rosParentFrameId
CoLa A (ASCII)
CoLa B (binary)
WRITE Write ROS Frame ID [sWN rosFrameId]¶
Set the frame ID of the published topics.
Telegram structure: sWN rosFrameId
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Write | String | 3 | sWN |
73 57 4E |
|
| Command | ROS reference frame to use for data output | String | 10 | rosFrameId |
72 6F 73 46 72 61 6D 65 49 64 |
|
| Value | Number of characters of the frame id | Uint_16 | 1 | 0d ... +16d (0h ... 10h |
00 00 ... 00 10 |
|
| Value | Configured Frame ID of the device | FlexString | 64 | [Frame ID] |
[Frame ID] |
Example: sWN rosFrameId
CoLa A (ASCII)
CoLa B (binary)
Telegram structure: sWA rosFrameId
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Answer | String | 3 | sWA |
73 57 41 |
|
| Command | ROS reference frame to use for data output | String | 10 | rosFrameId |
72 6F 73 46 72 61 6D 65 49 64 |
Example: sWA rosFrameId
CoLa A (ASCII)
CoLa B (binary)
READ Read ROS Frame ID [sRN rosFrameId]¶
Returns the frame ID of the published topics.
Telegram structure: sRN rosFrameId
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Read | String | 3 | sRN |
73 52 4E |
|
| Command | ROS reference frame to use for data output | String | 10 | rosFrameId |
72 6F 73 46 72 61 6D 65 49 64 |
Example: sRN rosFrameId
CoLa A (ASCII)
CoLa B (binary)
Telegram structure: sRA rosFrameId
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Answer | String | 3 | sRA |
73 52 41 |
|
| Command | ROS reference frame to use for data output | String | 10 | rosFrameId |
73 57 4E 20 72 6F 73 46 72 61 6D 65 49 64 |
|
| Value | Number of characters of the frame id | Uint_16 | 1 | 0d ... +16d (0h ... 10h |
00 00 ... 00 10 |
|
| Value | Configured Frame ID of the device | FlexString | 64 | [Frame ID] |
[Frame ID] |
Example: sRA rosFrameId - Frame ID is "picoScan_"
CoLa A (ASCII)
CoLa B (binary)
WRITE Write ROS Namespace [sWN rosNamespace]¶
Adds a prefix to all ROS entities (topics, services, parameters).
Telegram structure: sWN rosNamespace
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Write | String | 3 | sWN |
73 57 4E |
|
| Command | Sets the namespace of the published topics | String | 12 | rosNamespace |
72 6F 73 4E 61 6D 65 73 70 61 63 65 |
|
| Value | Number of characters of the frame id | Uint_16 | 2 | 0d ... +16d (0h ... 10h) |
00 00 ... 00 10 |
|
| Value | Name | FlexString | 64 | [Namespace] |
[Namespace] |
Example: sWN rosNamespace - Namespace is "rear_lidar"
CoLa A (ASCII)
CoLa B (binary)
02 02 02 02 00 00 00 1D 73 57 4E 20 72 6F 73 4E 61 6D 65 73 70 61 63 65 20 00 0A 72 65 61 72 5F 6C 69 64 61 72 64
Telegram structure: sWA rosNamespace
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Answer | String | 3 | sWA |
73 57 41 |
|
| Command | Sets the namespace of the published topics | String | 12 | rosNamespace |
72 6F 73 4E 61 6D 65 73 70 61 63 65 |
Example: sWA rosNamespace
CoLa A (ASCII)
CoLa B (binary)
READ Read ROS Namespace [sRN rosNamespace]¶
Returns the namespace of the published topics.
Telegram structure: sRN rosNamespace
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Read | String | 3 | sRN |
73 52 4E |
|
| Command | Reads the namespace of the published topics | String | 12 | rosNamespace |
72 6F 73 4E 61 6D 65 73 70 61 63 65 |
Example: sRN rosNamespace
CoLa A (ASCII)
CoLa B (binary)
Telegram structure: sRA rosNamespace
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Answer | String | 3 | sRA |
73 52 41 |
|
| Command | Reads the namespace of the published topics | String | 12 | rosNamespace |
72 6F 73 4E 61 6D 65 73 70 61 63 65 |
|
| Value | Number of characters of the frame id | Uint_16 | 2 | 0d ... +16d (0h ... 10h) |
00 00 ... 00 10 |
|
| Value | Name | FlexString | 64 | [Namespace] |
[Namespace] |
Example: sRA rosNamespace - Namespace is "rear_lidar"
CoLa A (ASCII)
CoLa B (binary)
WRITE Configure the ROS Domain ID for Native ROS 2 [sWN rosDomainId]¶
Configure the ROS domain ID for Native ROS 2.
Telegram structure: sWN rosDomainId
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Write request | String | 3 | sWN |
73 57 4E |
|
| Variable name | rosDomainId | String | 11 | rosDomainId |
72 6F 73 44 6F 6D 61 69 6E 49 64 |
|
| Value | ROS domain ID | UInt_8 | 1 | 0 |
00 |
Example: sWN rosDomainId
CoLa A (ASCII)
CoLa B (binary)
Telegram structure: sWA rosDomainId
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Write answer | String | 3 | sWA |
73 57 41 |
|
| Variable name | Echo of variable name | String | 11 | rosDomainId |
72 6F 73 44 6F 6D 61 69 6E 49 64 |
Example: sWA rosDomainId
CoLa A (ASCII)
CoLa B (binary)
READ Read the Configured ROS Domain ID Set for Native ROS 2 [sRN rosDomainId]¶
Returns the configured ROS domain ID set for Native ROS 2.
Telegram structure: sRN rosDomainId
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Read request | String | 3 | sRN |
73 52 4E |
|
| Variable name | rosDomainId | String | 11 | rosDomainId |
72 6F 73 44 6F 6D 61 69 6E 49 64 |
Example: sRN rosDomainId
CoLa A (ASCII)
CoLa B (binary)
Telegram structure: sRA rosDomainId
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Read answer | String | 3 | sRA |
73 52 41 |
|
| Variable name | rosDomainId | String | 11 | rosDomainId |
72 6F 73 44 6F 6D 61 69 6E 49 64 |
|
| Value | ROS domain ID | UInt_8 | 1 | 0 |
00 |
Example: sRA rosDomainId
CoLa A (ASCII)
CoLa B (binary)
WRITE Set the Port Number for CoLa ASCII TCP/IP [sWN EIAuxPort]¶
Set the port number for CoLa ASCII TCP/IP (e.g. LMDscandata).
Telegram structure: sWN EIAuxPort
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Write request | String | 3 | sWN |
73 57 4E |
|
| Variable name | EIAuxPort | String | 9 | EIAuxPort |
45 49 41 75 78 50 6F 72 74 |
|
| Value | TCP port for CoLa ASCII communication | UInt_16 | 2 | +2111 |
08 3F |
Example: sWN EIAuxPort
CoLa A (ASCII)
CoLa B (binary)
Telegram structure: sWA EIAuxPort
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Write answer | String | 3 | sWA |
73 57 41 |
|
| Variable name | Echo of variable name | String | 9 | EIAuxPort |
45 49 41 75 78 50 6F 72 74 |
Example: sWA EIAuxPort
CoLa A (ASCII)
CoLa B (binary)
READ Read the Port Number for CoLa ASCII TCP/IP [sRN EIAuxPort]¶
Returns the port number for CoLa ASCII TCP/IP (e.g. LMDscandata).
Telegram structure: sRN EIAuxPort
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Read request | String | 3 | sRN |
73 52 4E |
|
| Variable name | EIAuxPort | String | 9 | EIAuxPort |
45 49 41 75 78 50 6F 72 74 |
Example: sRN EIAuxPort
CoLa A (ASCII)
CoLa B (binary)
Telegram structure: sRA EIAuxPort
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Read answer | String | 3 | sRA |
73 52 41 |
|
| Variable name | EIAuxPort | String | 9 | EIAuxPort |
45 49 41 75 78 50 6F 72 74 |
|
| Value | TCP port for CoLa ASCII communication | UInt_16 | 2 | +2111 |
08 3F |
Example: sRA EIAuxPort
CoLa A (ASCII)
CoLa B (binary)
WRITE Set the Port Number for CoLa Binary TCP/IP [sWN EIHstPort]¶
Set the port number for CoLa Binary TCP/IP (e.g. LMDscandata).
Telegram structure: sWN EIHstPort
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Write request | String | 3 | sWN |
73 57 4E |
|
| Variable name | EIHstPort | String | 9 | EIHstPort |
45 49 48 73 74 50 6F 72 74 |
|
| Value | TCP port for CoLa Binary communication | UInt_16 | 2 | +2112 |
08 40 |
Example: sWN EIHstPort
CoLa A (ASCII)
CoLa B (binary)
Telegram structure: sWA EIHstPort
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Write answer | String | 3 | sWA |
73 57 41 |
|
| Variable name | Echo of variable name | String | 9 | EIHstPort |
45 49 48 73 74 50 6F 72 74 |
Example: sWA EIHstPort
CoLa A (ASCII)
CoLa B (binary)
READ Read the Port Number for CoLa Binary TCP/IP [sRN EIHstPort]¶
Returns the port number for CoLa Binary TCP/IP (e.g. LMDscandata).
Telegram structure: sRN EIHstPort
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Read request | String | 3 | sRN |
73 52 4E |
|
| Variable name | EIHstPort | String | 9 | EIHstPort |
45 49 48 73 74 50 6F 72 74 |
Example: sRN EIHstPort
CoLa A (ASCII)
CoLa B (binary)
Telegram structure: sRA EIHstPort
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Read answer | String | 3 | sRA |
73 52 41 |
|
| Variable name | EIHstPort | String | 9 | EIHstPort |
45 49 48 73 74 50 6F 72 74 |
|
| Value | TCP port for CoLa Binary communication | UInt_16 | 2 | +2112 |
08 40 |
Example: sRA EIHstPort
CoLa A (ASCII)
CoLa B (binary)
IMU Data Output¶
WRITE Set IMU Data Enable [sWN ImuDataEnable]¶
Enables/ Disables streaming IMU data output.
Telegram structure: sWN ImuDataEnable
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Write | String | 3 | sWN |
73 57 4E |
|
| Command | Set streaming IMU data output. | String | 13 | ImuDataEnable |
49 6D 75 44 61 74 61 45 6E 61 62 6C 65 |
|
| IMU data stream | Enable/ disable | Bool | 1 | Disable: Enable: |
0d (00h) |
00 ... 01 |
Example: sWN ImuDataEnable 0 - Disable the streaming IMU data output
CoLa A (ASCII)
CoLa B (binary)
Telegram structure: sWA ImuDataEnable
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Answer | String | 3 | sWA |
73 57 41 |
|
| Command | Set streaming IMU data output. | String | 13 | ImuDataEnable |
49 6D 75 44 61 74 61 45 6E 61 62 6C 65 |
Example: sWA ImuDataEnable
CoLa A (ASCII)
CoLa B (binary)
WRITE Set IMU Data Streaming Ethernet Settings [sWN ImuDataEthSettings]¶
Ethernet settings for the IMU data streaming functionality of the device
Telegram structure: sWN ImuDataEthSettings
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Write | String | 3 | sWN |
73 57 4E |
|
| Command | Set IMU data streaming ethernet settings | String | 18 | ImuDataEthSettings |
49 6D 75 44 61 74 61 45 74 68 53 65 74 74 69 6E 67 73 |
|
| Protocol | Transport protocol for streaming IMU data | Enum_8 | 1 | UDP: | +1d (01h) |
01 |
| IP address | IP address of the destination for IMU data receiver | Array | 4 | 0 …+255d (00…FF) |
00 … FF |
|
| Port | Port destination of the IMU data reseiver | Uint_16 | 2 | 0 .. +65535d(00 00…FF FF) |
00 00 … FF FF |
Example: sWN ImuDataEthSettings +1 +192 +168 +0 +100 +7503
Protocol is set to UDP (1), IPAddress (192.168.0.100), Port (7503)
Example: sWN ImuDataEthSettings
CoLa A (ASCII)
02 73 57 4E 20 49 6D 75 44 61 74 61 45 74 68 53 65 74 74 69 6E 67 73 20 31 20 43 30 20 41 38 20 30 20 36 34 20 31 44 34 46 03
CoLa B (binary)
02 02 02 02 00 00 00 1E 73 57 4E 20 49 6D 75 44 61 74 61 45 74 68 53 65 74 74 69 6E 67 73 20 01 C0 A8 00 64 1D 4F 28
Telegram structure: sWA ImuDataEthSettings
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Answer | String | 3 | sWA |
73 57 41 |
|
| Command | Set IMU data streaming ethernet settings | String | 18 | ImuDataEthSettings |
49 6D 75 44 61 74 61 45 74 68 53 65 74 74 69 6E 67 73 |
Example: sWA ImuDataEthSettings
CoLa A (ASCII)
CoLa B (binary)
Encoder Data Output¶
WRITE Set Encoder Data Enable [sWN EncoderDataEnable]¶
Enables/ Disables streaming Encoder data output.
Telegram structure: sWN EncoderDataEnable
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Write | String | 3 | sWN |
73 57 4E |
|
| Command | Set streaming Encoder data output. | String | 17 | EncoderDataEnable |
45 6E 63 6F 64 65 72 44 61 74 61 45 6E 61 62 6C 65 |
|
| Encoder data stream | Enable/ disable | Bool | 1 | Disable: Enable: |
0d (00h) |
00 ... 01 |
Example: sWN EncoderDataEnable 0 - Disable the streaming Encoder data output
CoLa A (ASCII)
CoLa B (binary)
Telegram structure: sWA EncoderDataEnable
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Answer | String | 3 | sWA |
73 57 41 |
|
| Command | Set streaming Encoder data output. | String | 17 | EncoderDataEnable |
45 6E 63 6F 64 65 72 44 61 74 61 45 6E 61 62 6C 65 |
Example: sWA EncoderDataEnable
CoLa A (ASCII)
CoLa B (binary)
WRITE Set Encoder Data Streaming Ethernet Settings [sWN EncoderDataEthSettings]¶
Ethernet settings for the encoder data streaming functionality of the device
Telegram structure: sWN EncoderDataEthSettings
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Write | String | 3 | sWN |
73 57 4E |
|
| Command | Set Encoder data streaming ethernet settings | String | 22 | EncoderDataEthSettings |
45 6E 63 6F 64 65 72 44 61 74 61 45 74 68 53 65 74 74 69 6E 67 73 |
|
| Protocol | Transport protocol for streaming IMU data | Enum_8 | 1 | UDP: | +1d (01h) |
01 |
| IP address | IP address of the destination for IMU data receiver | Array | 4 | 0 …+255d (00…FF) |
00 … FF |
|
| Port | Port destination of the Encoder data reseiver | Uint_16 | 2 | 0 .. +65535d(00 00…FF FF) |
00 00 … FF FF |
Example: sWN EncoderDataEthSettings +1 +192 +168 +0 +100 +7503
Protocol is set to UDP (1), IPAddress (192.168.0.100), Port (7503)
Example: sWN EncoderDataEthSettings
CoLa A (ASCII)
02 73 57 4E 20 45 6E 63 6F 64 65 72 44 61 74 61 45 74 68 53 65 74 74 69 6E 67 73 20 31 20 43 30 20 41 38 20 30 20 36 34 20 31 44 34 46 03
CoLa B (binary)
02 02 02 02 00 00 00 22 73 57 4E 20 45 6E 63 6F 64 65 72 44 61 74 61 45 74 68 53 65 74 74 69 6E 67 73 20 01 C0 A8 00 64 1D 4F 2D
73 57 4E 20 45 6E 63 6F 64 65 72 44 61 74 61 45 74 68 53 65 74 74 69 6E 67 73 20 01 C0 A8 00 64 1D 4F
Telegram structure: sWA EncoderDataEthSettings
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Answer | String | 3 | sWA |
73 57 41 |
|
| Command | Set Encoder data streaming ethernet settings | String | 22 | EncoderDataEthSettings |
45 6E 63 6F 64 65 72 44 61 74 61 45 74 68 53 65 74 74 69 6E 67 73 |
Example: sWA EncoderDataEthSettings
CoLa A (ASCII)
CoLa B (binary)
WRITE Set Encoder Settings [sWN LICencset]¶
Define if and which type of encoder is connected to the device so that input signals are processed correctly.
Telegram structure: sWN LICencset
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Write | String | 3 | sWN |
73 57 4E |
|
| Command | Encoder settings | String | 9 | LICencset |
4C 49 43 65 6E 63 73 65 74 |
|
| Encoder setting | Enum_8 | 1 | Off: Single increment/INC1: Direction recognition (phase): Direction recognition (level): Fixed speed: |
0 |
00 |
Example: sWN LICencset
CoLa A (ASCII)
CoLa B (binary)
Telegram structure: sWA LICencset
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Answer | String | 3 | sWA |
73 57 41 |
|
| Command | Encoder settings | String | 9 | LICencset |
4C 49 43 65 6E 63 73 65 74 |
Example: sWA LICencset
CoLa A (ASCII)
CoLa B (binary)
WRITE Set Encoder Resolution [sWN LICencres]¶
Determine the encoder resolution in mm/increment.
Telegram structure: sWN LICencres
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Write | String | 3 | sWN |
73 57 4E |
|
| Command | Set encoder resolution | String | 9 | LICencres |
4C 49 43 65 6E 63 72 65 73 |
|
| Encoder resolution | Resolution value in mm/Inc as float according to IEEE754 | Real | 4 | +0.001d … +2000d |
3A 83 12 6F … 44 FA 00 00 |
Example: sWN LICencres
CoLa A (ASCII)
CoLa B (binary)
Telegram structure: sWA LICencres
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Answer | String | 3 | sWA |
73 57 41 |
|
| Command | Set encoder resolution | String | 9 | LICencres |
4C 49 43 65 6E 63 72 65 73 |
Example: sWA LICencres
CoLa A (ASCII)
CoLa B (binary)
METHOD Reset Encoder Values [sMN LIDrstencoderinc]¶
Reset current encoder tick value to 0.
Telegram structure: sMN LIDrstencoderinc
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Method | String | 3 | sMN |
73 4D 4E |
|
| Command | Reset Encoder values | String | 16 | LIDrstencoderinc |
4C 49 44 72 73 74 65 6E 63 6F 64 65 72 69 6E 63 |
Example: sMN LIDrstencoderinc
CoLa A (ASCII)
CoLa B (binary)
Telegram structure: sAN LIDrstencoderinc
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Answer | String | 3 | sAN |
73 41 4E |
|
| Command | Reset Encoder values | String | 16 | LIDrstencoderinc |
4C 49 44 72 73 74 65 6E 63 6F 64 65 72 69 6E 63 |
|
| Reset status | Bool_1 | 1 | Successful Failure/ Insufficient user level |
0 |
00 |
Example: sAN LIDrstencoderinc
CoLa A (ASCII)
CoLa B (binary)
WRITE Enable Encoder Reference Input 1 Signal [sWN LICpos1enable]¶
This command enables the encoder reference input signal.
Telegram structure: sWN LICpos1enable
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Write | String | 3 | sWN |
73 57 4E |
|
| Command | Enable encoder reference input signal | String | 13 | LICpos1enable |
4C 49 43 70 6F 73 31 65 6E 61 62 6C 65 |
|
| Variable Data | Disable/ enable | Bool_1 | 1 | Disable: Enable: |
0d (00h) |
00 |
Example: sWN LICpos1enable - Enable reference input signal
CoLa A (ASCII)
CoLa B (binary)
Telegram structure: sWA LICpos1enable
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Answer | String | 3 | sWA |
73 57 41 |
|
| Command | Enable encoder reference input signal | String | 13 | LICpos1enable |
4C 49 43 70 6F 73 31 65 6E 61 62 6C 65 |
Example: sWA LICpos1enable
CoLa A (ASCII)
CoLa B (binary)
READ Read Encoder Reference Input 1 Signal [sRN LICpos1enable]¶
This command reads the state (enabled/ disabled) of the encoder reference input signal.
Telegram structure: sRN LICpos1enable
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Read | String | 3 | sRN |
73 52 4E |
|
| Command | Enable encoder reference input signal | String | 13 | LICpos1enable |
4C 49 43 70 6F 73 31 65 6E 61 62 6C 65 |
Example: sRN LICpos1enable
CoLa A (ASCII)
CoLa B (binary)
Telegram structure: sRA LICpos1enable
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Answer | String | 3 | sRA |
73 52 41 |
|
| Command | Enable encoder reference input signal | String | 13 | LICpos1enable |
4C 49 43 70 6F 73 31 65 6E 61 62 6C 65 |
|
| Variable Data | Disabled/ enabled | Bool_1 | 1 | Disabled: Enabled: |
0d (00h) |
00 |
Example: sRA LICpos1enable - Encoder reference input signal is enabled
CoLa A (ASCII)
CoLa B (binary)
WRITE Enable Encoder Reference Input 2 Signal [sWN LICpos2enable]¶
This command enables the encoder reference input signal.
Telegram structure: sWN LICpos2enable
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Write | String | 3 | sWN |
73 57 4E |
|
| Command | Enable encoder reference input signal | String | 13 | LICpos2enable |
4C 49 43 70 6F 73 32 65 6E 61 62 6C 65 |
|
| Variable Data | Disable/ enable | Bool_1 | 1 | Disable: Enable: |
0d (00h) |
00 |
Example: sWN LICpos2enable - Enable reference input signal
CoLa A (ASCII)
CoLa B (binary)
Telegram structure: sWA LICpos2enable
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Answer | String | 3 | sWA |
73 57 41 |
|
| Command | Enable encoder reference input signal | String | 13 | LICpos2enable |
4C 49 43 70 6F 73 32 65 6E 61 62 6C 65 |
Example: sWA LICpos2enable
CoLa A (ASCII)
CoLa B (binary)
READ Read Encoder Reference Input 2 Signal [sRN LICpos2enable]¶
This command reads the state (enabled/ disabled) of the encoder reference input signal.
Telegram structure: sRN LICpos2enable
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Read | String | 3 | sRN |
73 52 4E |
|
| Command | Enable encoder reference input signal | String | 13 | LICpos2enable |
4C 49 43 70 6F 73 32 65 6E 61 62 6C 65 |
Example: sRN LICpos2enable
CoLa A (ASCII)
CoLa B (binary)
Telegram structure: sRA LICpos2enable
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Answer | String | 3 | sRA |
73 52 41 |
|
| Command | Enable encoder reference input signal | String | 13 | LICpos2enable |
4C 49 43 70 6F 73 32 65 6E 61 62 6C 65 |
|
| Variable Data | Disabled/ enabled | Bool_1 | 1 | Disabled: Enabled: |
0d (00h) |
00 |
Example: sRA LICpos2enable - Encoder reference input signal is enabled
CoLa A (ASCII)
CoLa B (binary)
Data Reduction¶
WRITE Set Angle Range Filter [sWN LFPangleRangeFilter]¶
The angle range filter set up the horizontal (theta) and vertical (phi) start- and stop angle in rad.
BeamIncrement = the 'beamIncrement' which is used to subsample the beams within the selected angle range. With a 'beamIncrement' of n only every nth beam from the selected angle range is copied to the output scan, i.e. the angle resolution is reduced by factor n. If the beamIncrement is zero it is set to one.
Telegram structure: sWN LFPangleRangeFilter
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Write | String | 3 | sWN |
73 57 4E |
|
| Command | filter set up the horizontal (theta) and vertical (phi) start- and stop angle in rad | String | 19 | LFPangleRangeFilter |
4C 46 50 61 6E 67 6C 65 52 61 6E 67 65 46 69 6C 74 65 72 |
|
| Variable Data 1 | Enables/Disables the filter | Bool_1 | 1 | Off: On: |
+0d |
00 |
| Variable Data 2 | ThetaStart | Real | 4 | No impact on sensor setting but needs to be filled (see example) | -1,800,000d ... +1,800,000d (FFE488C0 ... 001B7740h) |
FF E4 88 C0 … 00 1B 77 40 |
| Variable Data 3 | ThetaStop | Real | 4 | No impact on sensor setting but needs to be filled (see example) | -1,800,000d ... +1,800,000d (FFE488C0 ... 001B7740h) |
FF E4 88 C0 … 00 1B 77 40 |
| Variable Data 4 | PhiStart | Real | 4 | No impact on sensor setting but needs to be filled (see example) | -900,000d ... +900,000d (FFF24460 ... 000DBBA0h) |
FF F2 44 60 … 00 0D BB A0 |
| Variable Data 5 | PhiStop | Real | 4 | No impact on sensor setting but needs to be filled (see example) | -900,000d ... +900,000d (FFF24460 ... 000DBBA0h) |
FF F2 44 60 … 00 0D BB A0 |
| Variable Data 6 | BeamIncrement | UInt_16 | 2 | No impact on sensor setting but needs to be filled (see example) | 1d…+20d |
00 01 … 00 14 |
Explanation: Enable the angle range filter and set up theta (horizontal) start -90°, theta stop +90°, phi (vertical) start -90°, phi stop +90°, beam increment 1
Example: sWN LFPangleRangeFilter
CoLa A (ASCII)
02 73 57 4E 20 4C 46 50 61 6E 67 6C 65 52 61 6E 67 65 46 69 6C 74 65 72 20 31 20 2D 39 30 30 30 30 30 20 2B 39 30 30 30 30 30 20 2D 39 30 30 30 30 30 20 2B 39 30 30 30 30 30 20 31 03
CoLa B (binary)
02 02 02 02 00 00 00 2B 73 57 4E 20 4C 46 50 61 6E 67 6C 65 52 61 6E 67 65 46 69 6C 74 65 72 20 01 FF F2 44 60 00 0D BB A0 FF F2 44 60 00 0D BB A0 00 01 2E
73 57 4E 20 4C 46 50 61 6E 67 6C 65 52 61 6E 67 65 46 69 6C 74 65 72 20 01 FF F2 44 60 00 0D BB A0 FF F2 44 60 00 0D BB A0 00 01
Telegram structure: sWA LFP AngleRangeFilter
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Answer | String | 3 | sWA |
73 57 41 |
|
| Command | filter set up the horizontal (theta) and vertical (phi) start- and stop angle in rad | String | 19 | LFPangleRangeFilter |
4C 46 50 61 6E 67 6C 65 52 61 6E 67 65 46 69 6C 74 65 72 |
Example: sWA LFPangleRangeFilter
CoLa A (ASCII)
CoLa B (binary)
READ Read Angle Range Filter [sRN LFPangleRangeFilter]¶
The angle range filter set up the horizontal (theta) and vertical (phi) start- and stop angle in rad.
BeamIncrement = the 'beamIncrement' which is used to subsample the beams within the selected angle range. With a 'beamIncrement' of n only every nth beam from the selected angle range is copied to the output scan, i.e. the angle resolution is reduced by factor n. If the beamIncrement is zero it is set to one.
Telegram structure: sRN LFPangleRangeFilter
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Read | String | 3 | sRN |
73 52 4E |
|
| Command | filter set up the horizontal (theta) and vertical (phi) start- and stop angle in rad | String | 19 | LFPangleRangeFilter |
4C 46 50 61 6E 67 6C 65 52 61 6E 67 65 46 69 6C 74 65 72 |
Example: sRN LFPangleRangeFilter
CoLa A (ASCII)
CoLa B (binary)
Telegram structure: sRA LFP AngleRangeFilter
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Answer | String | 3 | sRA |
73 52 41 |
|
| Command | filter set up the horizontal (theta) and vertical (phi) start- and stop angle in rad | String | 19 | LFPangleRangeFilter |
4C 46 50 61 6E 67 6C 65 52 61 6E 67 65 46 69 6C 74 65 72 |
|
| Variable Data 1 | Enables/Disables the filter | Bool_1 | 1 | Off: On: |
+0d |
00 |
| Variable Data 2 | ThetaStart | Real | 4 | No impact on sensor setting | -1,800,000d ... +1,800,000d (FFE488C0 ... 001B7740h) |
FF E4 88 C0 … 00 1B 77 40 |
| Variable Data 3 | ThetaStop | Real | 4 | No impact on sensor setting | -1,800,000d ... +1,800,000d (FFE488C0 ... 001B7740h) |
FF E4 88 C0 … 00 1B 77 40 |
| Variable Data 4 | PhiStart | Real | 4 | No impact on sensor setting | -900,000d ... +900,000d (FFF24460 ... 000DBBA0h) |
FF F2 44 60 … 00 0D BB A0 |
| Variable Data 5 | PhiStop | Real | 4 | No impact on sensor setting | -900,000d ... +900,000d (FFF24460 ... 000DBBA0h) |
FF F2 44 60 … 00 0D BB A0 |
| Variable Data 6 | BeamIncrement | UInt_16 | 2 | No impact on sensor setting | 1d…+20d |
00 01 … 00 14 |
Explanation: Angle range filter enabled and set up theta (horizontal) start -90°, theta stop +90°, phi (vertical) start -90°, phi stop +90°, beam increment 1
Example: sRA LFPangleRangeFilter
CoLa A (ASCII)
02 73 52 41 20 4C 46 50 61 6E 67 6C 65 52 61 6E 67 65 46 69 6C 74 65 72 20 31 20 46 46 46 32 34 34 36 30 20 44 42 42 41 30 20 46 46 46 32 34 34 36 30 20 44 42 42 41 30 20 31 03
CoLa B (binary)
WRITE Set Interval Filter [sWN LFPintervalFilter]¶
Enables and set up the interval filter. The interval filter reduce the scan output rate by a given factor.
Telegram structure: sWN LFPintervalFilter
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Write | String | 3 | sWN |
73 57 4E |
|
| Command | Reduce the scan output rate by a given factor | String | 17 | LFPintervalFilter |
4C 46 50 69 6E 74 65 72 76 61 6C 46 69 6C 74 65 72 |
|
| Variable data 1 | Enables/Disables the filter. | Bool | 1 | Off: On: |
0d (00h) |
00 |
| Variable Data 2 | Only every nth scan is output where n is given by the value of uiReductionFactor. |
Uint_32 | 4 | 1d…+50d |
00 00 00 01 … 00 00 00 32 |
Enables the interval filter an set up to the 3rd scan
Example: sWN LFPintervalFilter
CoLa A (ASCII)
CoLa B (binary)
02 02 02 02 00 00 00 1B 73 57 4E 20 4C 46 50 69 6E 74 65 72 76 61 6C 46 69 6C 74 65 72 20 01 00 00 00 03 0D
Telegram structure: sWA LFPintervalFilter
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Answer | String | 3 | sWA |
73 57 41 |
|
| Command | Reduce the scan output rate by a given factor | String | 17 | LFPintervalFilter |
4C 46 50 69 6E 74 65 72 76 61 6C 46 69 6C 74 65 72 |
Example: sWA LFPintervalFilter
CoLa A (ASCII)
CoLa B (binary)
Range Filter¶
WRITE Set Rectangular Filter [sWN LFPcubicareafilter]¶
Telegram structure: sWN LFPcubicareafilter
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Write | String | 3 | sWN |
73 57 4E |
|
| Command | CubicAreaFilter limits a polar scan to a axisparallel cube | String | 18 | LFPcubicareafilter |
4C 46 50 63 75 62 69 63 61 72 65 61 66 69 6C 74 65 72 |
|
| Variable data 1 | Enables/Disables the filter. | Bool | 1 | Off: On: |
0d |
00 |
| Variable Data 2 | X min 1/10 mm |
Int_32 | 4 | -200000d…+200000d |
FF FF B1 E0 … 00 00 4E 20 |
|
| Variable Data 3 | X max 1/10 mm |
Int_32 | 4 | -200000d…+200000d |
FF FF B1 E0 … 00 00 4E 20 |
|
| Variable Data 4 | Y min 1/10 mm |
Int_32 | 4 | -200000d…+200000d |
FF FF B1 E0 … 00 00 4E 20 |
|
| Variable Data 5 | Y max 1/10 mm |
Int_32 | 4 | -200000d…+200000d |
FF FF B1 E0 … 00 00 4E 20 |
|
| Variable Data 6 | Z min 1/10 mm |
Int_32 | 4 | Other values than 0 will be ignored | 0 |
00 00 00 00 |
| Variable Data 7 | Z max 1/10 mm |
Int_32 | 4 | Other values than 0 will be ignored | 0 |
00 00 00 00 |
Example: sWN LFPcubicAreafilter
CoLa A (ASCII)
<STX>sWN{SPC}LFPcubicareafilter{SPC}0{SPC}FFFFB1E0{SPC}4E20{SPC}FFFFB1E0{SPC}4E20{SPC}FFFFB1E0{SPC}4E20<ETX>
02 73 57 4E 20 4C 46 50 63 75 62 69 63 61 72 65 61 66 69 6C 74 65 72 20 30 20 46 46 46 46 42 31 45 30 20 34 45 32 30 20 46 46 46 46 42 31 45 30 20 34 45 32 30 20 46 46 46 46 42 31 45 30 20 34 45 32 30 03
CoLa B (binary)
02 02 02 02 00 00 00 30 73 57 4E 20 4C 46 50 63 75 62 69 63 61 72 65 61 66 69 6C 74 65 72 20 00 FF FF B1 E0 00 00 4E 20 FF FF B1 E0 00 00 4E 20 FF FF B1 E0 00 00 4E 20 66
73 57 4E 20 4C 46 50 63 75 62 69 63 61 72 65 61 66 69 6C 74 65 72 20 00 FF FF B1 E0 00 00 4E 20 FF FF B1 E0 00 00 4E 20 FF FF B1 E0 00 00 4E 20
Telegram structure: sWA LFPcubicareafilter
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Answer | String | 3 | sWA |
73 57 41 |
|
| Command | CubicAreaFilter limits a polar scan to a axisparallel cube | String | 18 | LFPcubicareafilter |
4C 46 50 63 75 62 69 63 61 72 65 61 66 69 6C 74 65 72 |
Example: sWA LFPcubicareafilter
CoLa A (ASCII)
CoLa B (binary)
WRITE Set Radial Distance Range Filter [sWN LFPradialDistanceRangeFilter]¶
Restriction of the scan(s) to a specified distance range.
Telegram structure: sWN LFPradialDistanceRangeFilter
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Write | String | 3 | sWN |
73 57 4E |
|
| Command | Restriction of the scan(s) to a specified distance range. | String | 28 | LFPradialDistanceRangeFilter |
4C 46 50 72 61 64 69 61 6C 44 69 73 74 61 6E 63 65 52 61 6E 67 65 46 69 6C 74 65 72 |
|
| Variable Data 1 | Enables/Disables the filter. | Bool_1 | 1 | Off: On: |
0d (0h) |
00 |
| DistMin | Lower boundary of the distance range. | Int_32 | 4 | Minimum: Maximum: |
+0d (0h) |
00 00 00 00 |
| DistMax | Upper boundary of the distance range. | Int_32 | 4 | Minimum: Maximum: |
+0d (0h) |
00 00 00 00 |
Disable the radial distance range filter and set up the boundaries to min 0mm and max 200000mm.
Example: sWN LFPradialDistanceRangeFilter
CoLa A (ASCII)
02 73 57 4E 20 4C 46 50 72 61 64 69 61 6C 44 69 73 74 61 6E 63 65 52 61 6E 67 65 46 69 6C 74 65 72 20 30 20 30 20 33 30 44 34 30 03
CoLa B (binary)
02 02 02 02 00 00 00 2A 73 57 4E 20 4C 46 50 72 61 64 69 61 6C 44 69 73 74 61 6E 63 65 52 61 6E 67 65 46 69 6C 74 65 72 20 00 00 00 00 00 00 03 0D 40 31
73 57 4E 20 4C 46 50 72 61 64 69 61 6C 44 69 73 74 61 6E 63 65 52 61 6E 67 65 46 69 6C 74 65 72 20 00 00 00 00 00 00 03 0D 40
Telegram structure: sWA LFPradialDistanceRangeFilter
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Answer | String | 3 | sWA |
73 57 41 |
|
| Command | Restriction of the scan(s) to a specified distance range. | String | 28 | LFPradialDistanceRangeFilter |
4C 46 50 72 61 64 69 61 6C 44 69 73 74 61 6E 63 65 52 61 6E 67 65 46 69 6C 74 65 72 |
Example: sWA LFPradialDistanceRangeFilter
CoLa A (ASCII)
02 73 57 41 20 4C 46 50 72 61 64 69 61 6C 44 69 73 74 61 6E 63 65 52 61 6E 67 65 46 69 6C 74 65 72 03
CoLa B (binary)
Field Evaluation¶
METHOD Set Activation of Evaluation Group [sMN ActivateEvaluationGroup]¶
The telegram is intended to activate or deactivate groups via telegram. The group activation needs to be changed from always to telegram in advance.
Telegram structure: sMN ActivateEvaluationGroup
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Method | String | 3 | sMN |
73 4D 4E |
|
| Command | Activate / deactivate evaluation group | String | 23 | ActivateEvaluationGroup |
41 63 74 69 76 61 74 65 45 76 61 6C 75 61 74 69 6F 6E 47 72 6F 75 70 |
|
| Amount of evaluation groups to activate/ deactivate | Array | Uint_16 | 2 | Each array element contains two parameters:Evaluation group numberDeactivation / activation of evaluation group | 1d ... 48d (1 ... 30h) |
00 01 … 00 30 |
| Evaluation group number | Evaluation group 1 | UInt_16 | 2 | 1 |
00 01 |
|
| Deactivation / activation of evaluation group | Activate / deactivate evaluation group 1 | Bool_1 | 1 | Deactivate: Activate: |
0 |
00 |
| Evaluation group number | Evaluation group 2 | UInt_16 | 2 | 2 |
00 02 |
|
| Activate/ deactivate evaluation group | Activate / deactivate evaluation group 2 | Bool_1 | 1 | Deactivate: Activate: |
0 |
00 |
| ... | ||||||
| Evaluation group number | Evaluation group 48 | UInt_16 | 2 | 48d (30h) |
00 30 |
|
| Activate/ deactivate evaluation group | Activate / deactivate evaluation group 48 | Bool_1 | 1 | Deactivate: Activate: |
0 |
00 |
Example1: sMN ActivateEvaluationGroup - Deactivate evaluation group 1 and 10
CoLa A (ASCII)
02 73 4D 4E 20 41 63 74 69 76 61 74 65 45 76 61 6C 75 61 74 69 6F 6E 47 72 6F 75 70 20 32 20 31 20 30 20 2B 31 30 20 30 03
CoLa B (binary)
02 02 02 02 00 00 00 24 73 4D 4E 20 41 63 74 69 76 61 74 65 45 76 61 6C 75 61 74 69 6F 6E 47 72 6F 75 70 20 00 02 00 01 00 00 0A 00 29
73 4D 4E 20 41 63 74 69 76 61 74 65 45 76 61 6C 75 61 74 69 6F 6E 47 72 6F 75 70 20 00 02 00 01 00 00 0A 00
Example2: sMN ActivateEvaluationGroup - Deactivate evaluation group 1 and 10, activate evaluation group 2 and 3
CoLa A (ASCII)
02 73 4D 4E 20 41 63 74 69 76 61 74 65 45 76 61 6C 75 61 74 69 6F 6E 47 72 6F 75 70 20 34 20 31 20 30 20 2B 31 30 20 30 20 32 20 31 20 33 20 31 03
CoLa B (binary)
02 02 02 02 00 00 00 2A 73 4D 4E 20 41 63 74 69 76 61 74 65 45 76 61 6C 75 61 74 69 6F 6E 47 72 6F 75 70 20 00 04 00 01 00 00 0A 00 00 02 01 00 03 01 2E
73 4D 4E 20 41 63 74 69 76 61 74 65 45 76 61 6C 75 61 74 69 6F 6E 47 72 6F 75 70 20 00 04 00 01 00 00 0A 00 00 02 01 00 03 01
Telegram structure: sAN ActivateEvaluationGroup
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Answer | String | 3 | sAN |
73 52 41 |
|
| Command | Activate / deactivate evaluation group | String | 23 | ActivateEvaluationGroup |
41 63 74 69 76 61 74 65 45 76 61 6C 75 61 74 69 6F 6E 47 72 6F 75 70 |
|
| Amount of activated/deactivated evaluation groups | - | UInt_16 | 2 | 1h... 30h |
00 01 … 00 30 |
|
| State of activation / deactivation | - | Bool_1 | 1 | Activation/Deactivation failed: Successfully activated/deactivated: |
0 |
00 |
Example 1: sAN ActivateEvaluationGroup - Successfully deactivated evaluation group 1
CoLa A (ASCII)
CoLa B (binary)
02 02 02 02 00 00 00 1F 73 41 4E 20 41 63 74 69 76 61 74 65 45 76 61 6C 75 61 74 69 6F 6E 47 72 6F 75 70 20 00 01 01 2C
Example 2: sAN ActivateEvaluationGroup - Successfully deactivated evaluation group 1, successfully activated evaluation group 2, failed activation of evaluation group 3
CoLa A (ASCII)
02 73 41 4E 20 41 63 74 69 76 61 74 65 45 76 61 6C 75 61 74 69 6F 6E 47 72 6F 75 70 20 33 20 31 20 31 20 30 03
CoLa B (binary)
READ Read Evaluation Group Type [sRN EvaluationGroupType]¶
Array with the type of each group, either perpendicular distance or field evaluation.
Telegram structure: sRN EvaluationGroupType
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Read | String | 3 | sRN |
73 52 4E |
|
| Command | String | 19 | EvaluationGroupType |
45 76 61 6C 75 61 74 69 6F 6E 47 72 6F 75 70 54 79 70 65 |
Example: sRN EvaluationGroupType
CoLa A (ASCII)
CoLa B (binary)
Telegram structure: sRA EvaluationGroupType
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Answer | String | 3 | sRA |
73 52 41 |
|
| Command | String | 19 | EvaluationGroupType |
45 76 61 6C 75 61 74 69 6F 6E 47 72 6F 75 70 54 79 70 65 |
||
| Data | Type of evaluation group | Array | 48 | Field evaluation: Perpendicular distance: |
0d (00h) |
00 |
Example: sRA EvaluationGroupType - 3rd group is set as perpendicular distance
CoLa A (ASCII)
<STX>sRA{SPC}EvaluationGroupType{SPC}0{SPC}0{SPC}1{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0<ETX>
02 73 52 41 20 45 76 61 6C 75 61 74 69 6F 6E 47 72 6F 75 70 54 79 70 65 20 30 20 30 20 31 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 30 03
CoLa B (binary)
METHOD Set Field Evaluation Contour [sMN SetFieldEvaluationContour]¶
This telegram can be used to change or reshape the contour/ polygon of an already defined field. It´s possible to add additional points.
Telegram structure: sMN SetFieldEvaluationContour
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Method | String | 3 | sMN |
73 4D 4E |
|
| Command | Set the region of interest of an object detection evaluation | String | 25 | SetFieldEvaluationContour |
53 65 74 46 69 65 6C 64 45 76 61 6C 75 61 74 69 6F 6E 43 6F 6E 74 6F 75 72 |
|
| Evaluation ID | Specific ID of the evaluation that is to be changed | UInt_16 | 2 | +1d ... +48d (1h ... 30h) |
00 01 … 00 30 |
|
| Amount of polygon vertices | E. g. triangle = 3, square = 4 | Array | 3 ... 100 | +3d ... +800d (3h ... 320h) |
00 03... 03 20 |
|
| Polygon vertex | Coordinates of first polygon vertex in mm | Dint_32 | 4 | X coordinate: | -120,000d ... +120,000d (FFFE2B40h … 1D4C0h) |
FF FE 2B 40 … 00 01 D4 C0 |
| Polygon vertex | Coordinates of first polygon vertex in mm | Dint_32 | 4 | Y coordinate: | -120,000d ... +120,000d (FFFE2B40h … 1D4C0h) |
FF FE 2B 40 … 00 01 D4 C0 |
| Polygon vertex | Coordinates of second polygon vertex in mm | Dint_32 | 4 | X coordinate: | -120,000d ... +120,000d (FFFE2B40h … 1D4C0h) |
FF FE 2B 40 … 00 01 D4 C0 |
| Polygon vertex | Coordinates of second polygon vertex in mm | Dint_32 | 4 | Y coordinate: | -120,000d ... +120,000d (FFFE2B40h … 1D4C0h) |
FF FE 2B 40 … 00 01 D4 C0 |
| ... | ||||||
| Polygon vertex | Coordinates of last polygon vertex in mm | Dint_32 | 4 | X coordinate: | -120,000d ... +120,000d (FFFE2B40h … 1D4C0h) |
FF FE 2B 40 … 00 01 D4 C0 |
| Polygon vertex | Coordinates of last polygon vertex in mm | Dint_32 | 4 | Y coordinate: | -120,000d ... +120,000d (FFFE2B40h … 1D4C0h) |
FF FE 2B 40 … 00 01 D4 C0 |
| Lower Z limit | Lower bound of extrusion in Z direction | Dint_32 | 4 | Must be: (Other values than 0 will lead to an error) |
0 |
00 00 00 00 |
| Upper Z limit | Upper bound of extrusion in Z direction | Dint_32 | 4 | Must be: (Other values than 0 will lead to an error) |
0 |
00 00 00 00 |
Example: sMN SetFieldEvaluationContour
CoLa A (ASCII)
<STX>sMN{SPC}SetFieldEvaluationContour{SPC}1{SPC}4{SPC}+2000{SPC}+1000{SPC}+0{SPC}+1000{SPC}+0{SPC}+0{SPC}+2000{SPC}+0{SPC}+0{SPC}+0<ETX>
02 73 4D 4E 20 53 65 74 46 69 65 6C 64 45 76 61 6C 75 61 74 69 6F 6E 43 6F 6E 74 6F 75 72 20 31 20 34 20 2B 32 30 30 30 20 2B 31 30 30 30 20 2B 30 20 2B 31 30 30 30 20 2B 30 20 2B 30 20 2B 32 30 30 30 20 2B 30 20 2B 30 20 2B 30 03
CoLa B (binary)
02 02 02 02 00 00 00 4A 73 4D 4E 20 53 65 74 46 69 65 6C 64 45 76 61 6C 75 61 74 69 6F 6E 43 6F 6E 74 6F 75 72 20 00 01 00 04 00 00 07 D0 00 00 03 E8 00 00 00 00 00 00 03 E8 00 00 00 00 00 00 00 00 00 00 07 D0 00 00 00 00 00 00 00 00 00 00 00 00 1D
73 4D 4E 20 53 65 74 46 69 65 6C 64 45 76 61 6C 75 61 74 69 6F 6E 43 6F 6E 74 6F 75 72 20 00 01 00 04 00 00 07 D0 00 00 03 E8 00 00 00 00 00 00 03 E8 00 00 00 00 00 00 00 00 00 00 07 D0 00 00 00 00 00 00 00 00 00 00 00 00
Telegram structure: sAN SetFieldEvaluationContour
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Answer | String | 3 | sAN |
73 52 41 |
|
| Command | Set the region of interest of an object detection evaluation | String | 25 | SetFieldEvaluationContour |
53 65 74 46 69 65 6C 64 45 76 61 6C 75 61 74 69 6F 6E 43 6F 6E 74 6F 75 72 |
|
| State of evaluation conversion | - | Enum_8 | 1 | Conversion successful: Invalid Evaluation: Invalid Polygon: Invalid Z limit: |
0 |
00 |
Example: sAN SetFieldEvaluationContour - Evaluation conversion successful
CoLa A (ASCII)
CoLa B (binary)
METHOD Get Field Evaluation Contour [sMN GetFieldEvaluationContour]¶
This telegram can be used to read the contour/ polygon of an already defined field.
Telegram structure: sMN GetFieldEvaluationContour
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Method | String | 3 | sMN |
73 4D 4E |
|
| Command | Get the region of interest of an object detection evaluation | String | 25 | GetFieldEvaluationContour |
47 65 74 46 69 65 6C 64 45 76 61 6C 75 61 74 69 6F 6E 43 6F 6E 74 6F 75 72 |
|
| Evaluation ID | Specific ID of the evaluation that is to be changed | UInt_16 | 2 | +1d ... +48d (1h ... 30h) |
00 01 … 00 30 |
Example: sMN GetFieldEvaluationContour
CoLa A (ASCII)
CoLa B (binary)
02 02 02 02 00 00 00 20 73 4D 4E 20 47 65 74 46 69 65 6C 64 45 76 61 6C 75 61 74 69 6F 6E 43 6F 6E 74 6F 75 72 20 00 01 0D
Telegram structure: sAN GetFieldEvaluationContour
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Answer | String | 3 | sAN |
73 52 41 |
|
| Command | Get the region of interest of an object detection evaluation | String | 25 | GetFieldEvaluationContour |
47 65 74 46 69 65 6C 64 45 76 61 6C 75 61 74 69 6F 6E 43 6F 6E 74 6F 75 72 |
|
| Length of array | Uint_8 | 1 | Always: | 1 |
00 01 |
|
| Evaluation ID | Specific ID of the evaluation that is to be changed | UInt_16 | 2 | 1h ... 30h |
00 01 … 00 30 |
|
| Amount of polygon vertices | E. g. triangle = 3, square = 4 | Array | 3 ... 100 | 3h ... 320h |
00 03... 03 20 |
|
| Polygon vertex | Coordinates of first polygon vertex in mm | Dint_32 | 4 | X coordinate: | FFFE2B40h ... 1D4C0h |
FF FE 2B 40 … 00 01 D4 C0 |
| Polygon vertex | Coordinates of first polygon vertex in mm | Dint_32 | 4 | Y coordinate: | FFFE2B40h ... 1D4C0h |
FF FE 2B 40 … 00 01 D4 C0 |
| Polygon vertex | Coordinates of second polygon vertex in mm | Dint_32 | 4 | X coordinate: | FFFE2B40h ... 1D4C0h |
FF FE 2B 40 … 00 01 D4 C0 |
| Polygon vertex | Coordinates of second polygon vertex in mm | Dint_32 | 4 | Y coordinate: | FFFE2B40h ... 1D4C0h |
FF FE 2B 40 … 00 01 D4 C0 |
| ... | ||||||
| Polygon vertex | Coordinates of last polygon vertex in mm | Dint_32 | 4 | X coordinate: | FFFE2B40h ... 1D4C0h |
FF FE 2B 40 … 00 01 D4 C0 |
| Polygon vertex | Coordinates of last polygon vertex in mm | Dint_32 | 4 | Y coordinate: | FFFE2B40h ... 1D4C0h |
FF FE 2B 40 … 00 01 D4 C0 |
| Lower Z limit | Lower bound of extrusion in Z direction | Dint_32 | 4 | Always: | 0 |
00 00 00 00 |
| Upper Z limit | Upper bound of extrusion in Z direction | Dint_32 | 4 | Always: | 0 |
00 00 00 00 |
Example: sAN GetFieldEvaluationContour
CoLa A (ASCII)
<STX>sAN{SPC}GetFieldEvaluationContour{SPC}1{SPC}1{SPC}4{SPC}7D0{SPC}3E8{SPC}0{SPC}3E8{SPC}0{SPC}0{SPC}7D0{SPC}0{SPC}0{SPC}0<ETX>
02 73 41 4E 20 47 65 74 46 69 65 6C 64 45 76 61 6C 75 61 74 69 6F 6E 43 6F 6E 74 6F 75 72 20 31 20 31 20 34 20 37 44 30 20 33 45 38 20 30 20 33 45 38 20 30 20 30 20 37 44 30 20 30 20 30 20 30 03
CoLa B (binary)
READ Read Field Evaluation Result [sRN FieldEvaluationResult]¶
This telegram returns the status information of all evaluations.
Telegram structure: sRN FieldEvaluationResult
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Read | String | 3 | sRN |
73 52 4E |
|
| Command | Info on field evaluation result | String | 21 | FieldEvaluationResult |
46 69 65 6C 64 45 76 61 6C 75 61 74 69 6F 6E 52 65 73 75 6C 74 |
Example: sRN FieldEvaluationResult
CoLa A (ASCII)
CoLa B (binary)
02 02 02 02 00 00 00 19 73 52 4E 20 46 69 65 6C 64 45 76 61 6C 75 61 74 69 6F 6E 52 65 73 75 6C 74 12
Telegram structure: sRA FieldEvaluationResult
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Answer | String | 3 | sRA |
73 52 41 |
|
| Command | Info on field evaluation result | String | 21 | FieldEvaluationResult |
46 69 65 6C 64 45 76 61 6C 75 61 74 69 6F 6E 52 65 73 75 6C 74 |
|
| Version | Version number | Uint_16 | 2 | 0 ... FFFFh |
00 ... FF FF |
|
| Timestamp | Time of the last field infringement. Time base is the sensor system time in milliseconds since January 1, 1970, 00:00 (UTC). If a time server is being used, the configured system time is used. | ULInt_64 | 8 | 0 ... FFFFFFFFFFFFFFFFh |
00 00 00 00 00 00 00 00 ... FF FF FF FF FF FF FF FF |
|
| Evaluation Result | Evaluation state of the first field. | Enum_8 | 1 | Not configured: Inactive: Free: Detecting infringed: Infringed: Detecting free: |
0 |
00 |
| Reserved | - | Enum_8 | 1 | Always: | 0 |
00 |
| Evaluation Result | Evaluation state of the second field. | Enum_8 | 1 | Not configured: Inactive: Free: Detecting infringed: Infringed: Detecting free: |
0 |
00 |
| Reserved | - | Enum_8 | 1 | Always: | 0 |
00 |
| ... | ||||||
| Evaluation Result | Evaluation state of the last field. (maximum amount of evaluations = 48) | Enum_8 | 1 | Not configured: Inactive: Free: Detecting infringed: Infringed: Detecting free: |
0 |
00 |
| Reserved | - | Enum_8 | 1 | Always: | 0 |
00 |
Example: sRA FieldEvaluationResult - field 1 is infringed, field 2 is free
CoLa A (ASCII)
<STX>sRA{SPC}FieldEvaluationResult{SPC}1{SPC}1D869664{SPC}4{SPC}0{SPC}2{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0<ETX>
02 73 52 41 20 46 69 65 6C 64 45 76 61 6C 75 61 74 69 6F 6E 52 65 73 75 6C 74 20 31 20 31 44 38 36 39 36 36 34 20 34 20 30 20 32 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 30 03
CoLa B (binary)
02 02 02 02 00 00 00 B4 73 52 41 20 46 69 65 6C 64 45 76 61 6C 75 61 74 69 6F 6E 52 65 73 75 6C 74 20 00 01 00 00 00 00 1D 86 96 64 04 00 00 02 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 53
EVENT Receive Field Evaluation Result by Event [sEN FieldEvaluationResult]¶
This telegram returns the status information of all evaluations.
Telegram structure: sEN FieldEvaluationResult
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Event | String | 3 | sEN |
73 45 4E |
|
| Command | Info on field evaluation result | String | 21 | FieldEvaluationResult |
46 69 65 6C 64 45 76 61 6C 75 61 74 69 6F 6E 52 65 73 75 6C 74 |
|
| Reporting | Start/ stop | Enum_8 | 1 | Stop: Start: |
0 |
00 |
Example: sEN FieldEvaluationResult
CoLa A (ASCII)
CoLa B (binary)
02 02 02 02 00 00 00 1B 73 45 4E 20 46 69 65 6C 64 45 76 61 6C 75 61 74 69 6F 6E 52 65 73 75 6C 74 20 01 24
Telegram structure: sSN FieldEvaluationResult
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Answer | String | 3 | sSN |
73 53 4E |
|
| Command | Info on field evaluation result | String | 21 | FieldEvaluationResult |
46 69 65 6C 64 45 76 61 6C 75 61 74 69 6F 6E 52 65 73 75 6C 74 |
|
| Version | Version number | Uint_16 | 2 | 0 ... FFFFh |
00 ... FF FF |
|
| Timestamp | Time of the latest field infringement. Time base is the sensor system time in milliseconds since January 1, 1970, 00:00 (UTC). If a time server is being used, the configured system time is used. | ULInt_64 | 8 | 0 ... FFFFFFFFFFFFFFFFh |
00 00 00 00 00 00 00 00 ... FF FF FF FF FF FF FF FF |
|
| Evaluation Result | Evaluation state of the first field. | Enum_8 | 1 | Not configured: Inactive: Free: Detecting infringed: Infringed: Detecting free: |
0 |
00 |
| Reserved | - | Enum_8 | 1 | Always: | 0 |
00 |
| Evaluation Result | Evaluation state of the second field. | Enum_8 | 1 | Not configured: Inactive: Free: Detecting infringed: Infringed: Detecting free: |
0 |
00 |
| Reserved | - | Enum_8 | 1 | Always: | 0 |
00 |
| ... | ||||||
| Evaluation Result | Evaluation state of the last field. (maximum amount of evaluations = 48) |
Enum_8 | 1 | Not configured: Inactive: Free: Detecting infringed: Infringed: Detecting free: |
0 |
00 |
| Reserved | - | Enum_8 | 1 | Always: | 0 |
00 |
Example: sSN FieldEvaluationResult - field 1 is infringed, field 2 is free
CoLa A (ASCII)
<STX>sSN{SPC}FieldEvaluationResult{SPC}1{SPC}1D869664{SPC}4{SPC}0{SPC}2{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0{SPC}0<ETX>
02 73 53 4E 20 46 69 65 6C 64 45 76 61 6C 75 61 74 69 6F 6E 52 65 73 75 6C 74 20 31 20 31 44 38 36 39 36 36 34 20 34 20 30 20 32 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 30 20 30 03
CoLa B (binary)
02 02 02 02 00 00 00 B4 73 53 4E 20 46 69 65 6C 64 45 76 61 6C 75 61 74 69 6F 6E 52 65 73 75 6C 74 20 00 01 00 00 00 00 1D 86 96 64 04 00 00 02 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 5D
METHOD Start Teach-In [sMN StartTeachIn]¶
Start teach-in of the environment.
Telegram structure: sMN StartTeachIn
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Method invocation | String | 3 | sMN |
73 4D 4E |
|
| Method name | StartTeachIn | String | 12 | StartTeachIn |
53 74 61 72 74 54 65 61 63 68 49 6E |
Example: sMN StartTeachIn
CoLa A (ASCII)
CoLa B (binary)
Telegram structure: sAN StartTeachIn
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Method answer | String | 3 | sAN |
73 41 4E |
|
| Method name | Echo of method name | String | 12 | StartTeachIn |
53 74 61 72 74 54 65 61 63 68 49 6E |
Example: sAN StartTeachIn
CoLa A (ASCII)
CoLa B (binary)
METHOD Stop Teach-In [sMN StopTeachIn]¶
Stop teach-in of the environment.
Telegram structure: sMN StopTeachIn
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Method invocation | String | 3 | sMN |
73 4D 4E |
|
| Method name | StopTeachIn | String | 11 | StopTeachIn |
53 74 6F 70 54 65 61 63 68 49 6E |
Example: sMN StopTeachIn
CoLa A (ASCII)
CoLa B (binary)
Telegram structure: sAN StopTeachIn
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Method answer | String | 3 | sAN |
73 41 4E |
|
| Method name | Echo of method name | String | 11 | StopTeachIn |
53 74 6F 70 54 65 61 63 68 49 6E |
Example: sAN StopTeachIn
CoLa A (ASCII)
CoLa B (binary)
Perpendicular Distance¶
READ Request Perpendicular Distance Once [sRN perpendicularDistanceResult]¶
This telegram can be used to request the perpendicular distance. The shortest and furthest measuring point in a range to a reference plane will be transmitted. A field and a reference plane must be defined in the user interface under Application > Perpendicular distance measurement.
Telegram structure: sRN perpendicularDistanceResult
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Read | String | 3 | sRN |
73 52 4E |
|
| Command | Perpendicular distance values | String | 27 | perpendicularDistanceResult |
70 65 72 70 65 6E 64 69 63 75 6C 61 72 44 69 73 74 61 6E 63 65 52 65 73 75 6C 74 |
Example: sRN perpendicularDistanceResult
CoLa A (ASCII)
CoLa B (binary)
02 02 02 02 00 00 00 1F 73 52 4E 20 70 65 72 70 65 6E 64 69 63 75 6C 61 72 44 69 73 74 61 6E 63 65 52 65 73 75 6C 74 3D
Telegram structure: sRA perpendicularDistanceResult
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Answer | String | 3 | sRA |
73 52 41 |
|
| Command | Perpendicular distance values | String | 27 | perpendicularDistanceResult |
70 65 72 70 65 6E 64 69 63 75 6C 61 72 44 69 73 74 61 6E 63 65 52 65 73 75 6C 74 |
|
| Timestamp | Time of the latest object detection in the defined fields. Time base is the sensor system time in milliseconds since January 1, 1970, 00:00 (UTC). If a time server is being used, the configured system time is used. | Uint_32 | 8 | 0 ... FFFFFFFFh |
00 00 00 00 00 00 00 00... FF FF FF FF FF FF FF FF |
|
| Amount of channels | Amount of perpendicular distance evaluation channels/fields | Enum_8 | 2 | 1 ... 20d (1 ... 14h) |
00 01 ... 00 14 |
|
| Evaluation ID X | ID of perpendicular distance field | Enum_8 | 2 | 1 ... 20d (1 ... 14h) |
00 01 ... 00 14 |
|
| Evaluation ID X | Minimum distance [mm] | Int_32 | 4 | -120000d … +120000d (FFFE2B3F … 1D4C0h) |
FF FE 2B 3F … 00 01 D4 C0 |
|
| Evaluation ID X | Maximum distance [mm] | Int_32 | 4 | -120000d … +120000d (FFFE2B3F … 1D4C0h) |
FF FE 2B 3F … 00 01 D4 C0 |
|
| Evaluation ID X | X minimum distance [mm] | Int_32 | 4 | -120000d … +120000d (FFFE2B3F … 1D4C0h) |
FF FE 2B 3F … 00 01 D4 C0 |
|
| Evaluation ID X | Y minimum distance [mm] | Int_32 | 4 | -120000d … +120000d (FFFE2B3F … 1D4C0h) |
FF FE 2B 3F … 00 01 D4 C0 |
|
| Evaluation ID X | Reserved | Int_32 | 4 | Always: | 0 |
00 00 00 00 |
| Evaluation ID X | X maximum distance [mm] | Int_32 | 4 | -120000d … +120000d (FFFE2B3F … 1D4C0h) |
FF FE 2B 3F … 00 01 D4 C0 |
|
| Evaluation ID X | Y maximum distance [mm] | Int_32 | 4 | -120000d … +120000d (FFFE2B3F … 1D4C0h) |
FF FE 2B 3F … 00 01 D4 C0 |
|
| Evaluation ID X | Reserved | Int_32 | 4 | Always: | 0 |
00 00 00 00 |
| Evaluation ID ... | ... | ... | ... | ... | ... |
... |
Example: sRA perpendicularDistanceResult - 1 configured field
CoLa A (ASCII)
<STX>sRA{SPC}perpendicularDistanceResult{SPC}138D305E8{SPC}1{SPC}1{SPC}9D{SPC}7EA{SPC}9D{SPC}FFFFFC67{SPC}0{SPC}7EA{SPC}FFFFFD70{SPC}0<ETX>
02 73 52 41 20 70 65 72 70 65 6E 64 69 63 75 6C 61 72 44 69 73 74 61 6E 63 65 52 65 73 75 6C 74 20 31 33 38 44 33 30 35 45 38 20 31 20 31 20 39 44 20 37 45 41 20 39 44 20 46 46 46 46 46 43 36 37 20 30 20 37 45 41 20 46 46 46 46 46 44 37 30 20 30 03
CoLa B (binary)
EVENT Request Perpendicular Distance Continuously on Event [sEN perpendicularDistanceResult]¶
This telegram can be used to request the perpendicular distance continuously on event. The shortest and furthest measuring point in a range to a reference plane will be transmitted. A field and a reference plane must be defined in the user interface under Application > Perpendicular distance measurement.
Telegram structure: sEN perpendicularDistanceResult
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Event | String | 3 | sEN |
73 45 4E |
|
| Command | Perpendicular distance values | String | 27 | perpendicularDistanceResult |
70 65 72 70 65 6E 64 69 63 75 6C 61 72 44 69 73 74 61 6E 63 65 52 65 73 75 6C 74 |
|
| Start/ Stop | - | Enum_8 | 1 | Stop: Start: |
0 |
00 |
Example: sEN perpendicularDistanceResult
CoLa A (ASCII)
02 73 45 4E 20 70 65 72 70 65 6E 64 69 63 75 6C 61 72 44 69 73 74 61 6E 63 65 52 65 73 75 6C 74 20 31 03
CoLa B (binary)
02 02 02 02 00 00 00 21 73 45 4E 20 70 65 72 70 65 6E 64 69 63 75 6C 61 72 44 69 73 74 61 6E 63 65 52 65 73 75 6C 74 20 01 0B
Telegram structure: sSN perpendicularDistanceResult
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Answer | String | 3 | sSN |
73 53 4E |
|
| Command | Perpendicular distance values | String | 27 | perpendicularDistanceResult |
70 65 72 70 65 6E 64 69 63 75 6C 61 72 44 69 73 74 61 6E 63 65 52 65 73 75 6C 74 |
|
| Timestamp | Time of the latest object detection in the defined fields. Time base is the sensor system time in milliseconds since January 1, 1970, 00:00 (UTC). If a time server is being used, the configured system time is used. | Uint_32 | 8 | 0 ... FFFFFFFFh |
00 00 00 00 00 00 00 00... FF FF FF FF FF FF FF FF |
|
| Amount of channels | Amount of perpendicular distance evaluation channels/fields | Enum_8 | 2 | 1 ... 20d (1 ... 14h) |
00 01 ... 00 14 |
|
| Evaluation ID X | ID of perpendicular distance field | Enum_8 | 2 | 1 ... 20d (1 ... 14h) |
00 01 ... 00 14 |
|
| Evaluation ID X | Minimum distance [mm] | Int_32 | 4 | -120000d … +120000d (FFFE2B3F … 1D4C0h) |
FF FE 2B 3F … 00 01 D4 C0 |
|
| Evaluation ID X | Maximum distance [mm] | Int_32 | 4 | -120000d … +120000d (FFFE2B3F … 1D4C0h) |
FF FE 2B 3F … 00 01 D4 C0 |
|
| Evaluation ID X | X minimum distance [mm] | Int_32 | 4 | -120000d … +120000d (FFFE2B3F … 1D4C0h) |
FF FE 2B 3F … 00 01 D4 C0 |
|
| Evaluation ID X | Y minimum distance [mm] | Int_32 | 4 | -120000d … +120000d (FFFE2B3F … 1D4C0h) |
FF FE 2B 3F … 00 01 D4 C0 |
|
| Evaluation ID X | Reserved | Int_32 | 4 | Always: | 0 |
00 00 00 00 |
| Evaluation ID X | X maximum distance [mm] | Int_32 | 4 | -120000d … +120000d (FFFE2B3F … 1D4C0h) |
FF FE 2B 3F … 00 01 D4 C0 |
|
| Evaluation ID X | Y maximum distance [mm] | Int_32 | 4 | -120000d … +120000d (FFFE2B3F … 1D4C0h) |
FF FE 2B 3F … 00 01 D4 C0 |
|
| Evaluation ID X | Reserved | Int_32 | 4 | Always: | 0 |
00 00 00 00 |
| Evaluation ID ... | ... | ... | ... | ... | ... |
... |
Example: sSN perpendicularDistanceResult - 1 configured field
CoLa A (ASCII)
<STX>sSN{SPC}perpendicularDistanceResult{SPC}D5BD2DA8{SPC}1{SPC}1{SPC}174{SPC}7CE{SPC}174{SPC}FFFFFFFC{SPC}0{SPC}7CE{SPC}FFFFFD13{SPC}0<ETX>
02 73 53 4E 20 70 65 72 70 65 6E 64 69 63 75 6C 61 72 44 69 73 74 61 6E 63 65 52 65 73 75 6C 74 20 44 35 42 44 32 44 41 38 20 31 20 31 20 31 37 34 20 37 43 45 20 31 37 34 20 46 46 46 46 46 46 46 43 20 30 20 37 43 45 20 46 46 46 46 46 44 31 33 20 30 03
CoLa B (binary)
Operating Data¶
READ Read Operating Hours [sRN ODoprh]¶
Views the total number of operating hours during the lifetime of the device.
Telegram structure: sRN ODoprh
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Read | String | 3 | sRN |
73 52 4E |
|
| Command | Read operating hours | String | 6 | ODoprh |
4F 44 6F 70 72 68 |
Example: sRN ODoprh
CoLa A (ASCII)
CoLa B (binary)
Telegram structure: sRA ODoprh
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Answer | String | 3 | sRA |
73 52 41 |
|
| Command | Read operating hours | String | 6 | ODoprh |
4F 44 6F 70 72 68 |
|
| Value | Operating hours in 1/10 h | Uint_32 | 4 | 0h … FFFFFFFFh |
00 00 00 00 …FF FF FF FF |
Example: sRA ODoprh
CoLa A (ASCII)
CoLa B (binary)
Calculation of the value: 1B50B (hex) 111883 (dez) × 1/10 h = 11188.3 h
READ Read Operating Hours Since Last Power On [sRN ODopdaily]¶
Shows the runtime duration since the last power on of the device.
Telegram structure: sRN ODopdaily
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Read | String | 3 | sRN |
73 52 4E |
|
| Command | Read operating hours | String | 9 | ODopdaily |
4F 44 6F 70 64 61 69 6C 79 |
Example: sRN ODopdaily
CoLa A (ASCII)
CoLa B (binary)
Telegram structure: sRA ODopdaily
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Answer | String | 3 | sRA |
73 52 41 |
|
| Command | Read operating hours since last power on | String | 9 | ODopdaily |
4F 44 6F 70 64 61 69 6C 79 |
|
| Value | Operating hours in 1/10 h | Real as float according to IEEE754 | 4 | 0h … FFFFFFFFh |
00 00 00 00 …FF FF FF FF |
Example: sRA ODopdaily
CoLa A (ASCII)
CoLa B (binary)
READ Read Power on Counter [sRN ODpwrc]¶
Shows the number of power on cycles.
Telegram structure: sRN ODpwrc
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Read | String | 3 | sRN |
73 52 4E |
|
| Command | Read power on counter | String | 6 | ODpwrc |
4F 44 70 77 72 63 |
Example: sRN ODpwrc
CoLa A (ASCII)
CoLa B (binary)
Telegram structure: sRA ODpwrc
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Answer | String | 3 | sRA |
73 52 41 |
|
| Command | Read power on counter | String | 6 | ODpwrc |
4F 44 70 77 72 63 |
|
| Value | Power on counter | Uint_32 | 4 | 0h … FFFFFFFFh |
00 00 00 00 …FF FF FF FF |
Example: sRA ODpwrc
CoLa A (ASCII)
CoLa B (binary)
READ Read Temperature [sRN OPcurtmpdev]¶
With this command the internal temperature of the device can be identified. Please note that it does not give an indication of the current ambient temperature.
Telegram structure: sRN OPcurtmpdev
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Read | String | 3 | sRN |
73 52 4E |
|
| Command | Read temperature of the device | String | 11 | OPcurtmpdev |
4F 50 63 75 72 74 6D 70 64 65 76 |
Example: sRN OPcurtmpdev
CoLa A (ASCII)
CoLa B (binary)
Telegram structure: sRA OPcurtmpdev
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Answer | String | 3 | sRA |
73 52 41 |
|
| Command | Read temperature of the device | String | 11 | OPcurtmpdev |
4F 50 63 75 72 74 6D 70 64 65 76 |
|
| Temperature data | [°C] | Real as float according to IEEE754 | 4 | (-50°C … +100°C) | C2480000h … 42C80000h |
C2 48 00 00 … 42 C8 00 00 |
Example: sRA OPcurtmpdev (35°C)
Example: sRA OPcurtmpdev
CoLa A (ASCII)
CoLa B (binary)
READ Read Date of Last Permanent Save [sRN DIpara]¶
This command reads the date at which the last permanent save was executed.
Telegram structure: sRN DIpara
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Read | String | 3 | sRN |
73 52 4E |
|
| Command | Read date of last permanent save | String | 6 | DIpara |
44 49 70 61 72 61 |
Example: sRN DIpara
CoLa A (ASCII)
CoLa B (binary)
Telegram structure: sRA DIpara
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Answer | String | 3 | sRA |
73 52 41 |
|
| Command | Read date of last permanent save | String | 6 | DIpara |
44 49 70 61 72 61 |
|
| Reserved | - | Uint_8 | 1 | Always: | Ah |
0A |
| Date of last permanent save | DD.MM.YYYY | FlexString | 10 | (see example) |
(see example) |
Example: sRA DIpara
CoLa A (ASCII)
CoLa B (binary)
READ Read Time of Last Permanent Save [sRN DIparatm]¶
This command reads the time at which the last permanent save was executed.
Telegram structure: sRN DIparatm
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Read | String | 3 | sRN |
73 52 4E |
|
| Command | Read time of last permanent save | String | 8 | DIparatm |
44 49 70 61 72 61 74 6D |
Example: sRN DIparatm
CoLa A (ASCII)
CoLa B (binary)
Telegram structure: sRA DIparatm
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Answer | String | 3 | sRA |
73 52 41 |
|
| Command | Read time of last permanent save | String | 8 | DIparatm |
44 49 70 61 72 61 74 6D |
|
| Reserved | - | Uint_16 | 2 | Always: | 5h |
00 05 |
| Time of last permanent save | HH:MM | String | 5 | (see example) |
(see example) |
Example: sRA DIparatm
CoLa A (ASCII)
CoLa B (binary)
READ Read the Current Device Temperature Alarm Status [sRN temperatureAlarmStatus]¶
Current device temperature alarm status. If true, the configured temperature alarm is active.
Telegram structure: sRN temperatureAlarmStatus
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Read | String | 3 | sRN |
73 52 4E |
|
| Command | Device temperature alarm status | String | 22 | temperatureAlarmStatus |
74 65 6D 70 65 72 61 74 75 72 65 41 6C 61 72 6D 53 74 61 74 75 73 |
Example: sRN temperatureAlarmStatus
CoLa A (ASCII)
CoLa B (binary)
02 02 02 02 00 00 00 1A 73 52 4E 20 74 65 6D 70 65 72 61 74 75 72 65 41 6C 61 72 6D 53 74 61 74 75 73 44
Telegram structure: sRA temperatureAlarmStatus
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Answer | String | 3 | sRA |
73 52 41 |
|
| Command | Device temperature alarm status | String | 22 | temperatureAlarmStatus |
74 65 6D 70 65 72 61 74 75 72 65 41 6C 61 72 6D 53 74 61 74 75 73 |
|
| Data | Alarm state | Bool_1 | 1 | Disabled: Enabled: |
0d (00h) |
00 ... 01 |
Example: sRA temperatureAlarmStatus - Temperature alarm status is off. The device runs in the defined temperature range
CoLa A (ASCII)
CoLa B (binary)
WRITE Set Device Temperature Alarm Configuration [sWN temperatureAlarmConfiguration]¶
Sets the upper and lower threshold for the temperature alarm status.
Telegram structure: sWN temperatureAlarmConfiguration
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Write | String | 3 | sWN |
73 57 4E |
|
| Command | Device temperature alarm configuration | String | 29 | temperatureAlarmConfiguration |
74 65 6D 70 65 72 61 74 75 72 65 41 6C 61 72 6D 43 6F 6E 66 69 67 75 72 61 74 69 6F 6E |
|
| Data 1 | Upper threshold [°C] | Int_8 | 1 | Default: 55 | -128d ... +127d (80h ... 7Fh) |
80 ... 7F |
| Data 2 | Lower threshold [°C] | Int_8 | 1 | Default: 50 | -128d ... +127d (80h ... 7Fh) |
80 ... 7F |
Example: sWN temperatureAlarmConfiguration - Set the upper threshold to 55 °C and the lower threshold to 50 °C
CoLa A (ASCII)
02 73 57 4E 20 74 65 6D 70 65 72 61 74 75 72 65 41 6C 61 72 6D 43 6F 6E 66 69 67 75 72 61 74 69 6F 6E 20 33 37 20 33 32 03
CoLa B (binary)
02 02 02 02 00 00 00 24 73 57 4E 20 74 65 6D 70 65 72 61 74 75 72 65 41 6C 61 72 6D 43 6F 6E 66 69 67 75 72 61 74 69 6F 6E 20 37 32 00
73 57 4E 20 74 65 6D 70 65 72 61 74 75 72 65 41 6C 61 72 6D 43 6F 6E 66 69 67 75 72 61 74 69 6F 6E 20 37 32
Telegram structure: sWA temperatureAlarmConfiguration
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Answer | String | 3 | sWA |
73 57 41 |
|
| Command | Device temperature alarm configuration | String | 29 | temperatureAlarmConfiguration |
74 65 6D 70 65 72 61 74 75 72 65 41 6C 61 72 6D 43 6F 6E 66 69 67 75 72 61 74 69 6F 6E |
Example: sWA temperatureAlarmConfiguration
CoLa A (ASCII)
02 73 57 41 20 74 65 6D 70 65 72 61 74 75 72 65 41 6C 61 72 6D 43 6F 6E 66 69 67 75 72 61 74 69 6F 6E 03
CoLa B (binary)
READ Read Device Temperature Alarm Configuration [sRN temperatureAlarmConfiguration]¶
Returns the upper and lower threshold for the temperature alarm status.
Telegram structure: sRN temperatureAlarmConfiguration
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Read | String | 3 | sRN |
73 52 4E |
|
| Command | Device temperature alarm configuration | String | 29 | temperatureAlarmConfiguration |
74 65 6D 70 65 72 61 74 75 72 65 41 6C 61 72 6D 43 6F 6E 66 69 67 75 72 61 74 69 6F 6E |
Example: sRN temperatureAlarmConfiguration
CoLa A (ASCII)
02 73 52 4E 20 74 65 6D 70 65 72 61 74 75 72 65 41 6C 61 72 6D 43 6F 6E 66 69 67 75 72 61 74 69 6F 6E 03
CoLa B (binary)
02 02 02 02 00 00 00 21 73 52 4E 20 74 65 6D 70 65 72 61 74 75 72 65 41 6C 61 72 6D 43 6F 6E 66 69 67 75 72 61 74 69 6F 6E 20
Telegram structure: sRA temperatureAlarmConfiguration
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Answer | String | 3 | sRA |
73 52 41 |
|
| Command | Device temperature alarm configuration | String | 29 | temperatureAlarmConfiguration |
74 65 6D 70 65 72 61 74 75 72 65 41 6C 61 72 6D 43 6F 6E 66 69 67 75 72 61 74 69 6F 6E |
|
| Data 1 | Upper threshold [°C] | Int_8 | 1 | Default: 55 | -128d ... +127d (80h ... 7Fh) |
80 ... 7F |
| Data 2 | Lower threshold [°C] | Int_8 | 1 | Default: 50 | -128d ... +127d (80h ... 7Fh) |
80 ... 7F |
Example: sRA temperatureAlarmConfiguration - 55 °C upper threshold and 50 °C lower threshold
CoLa A (ASCII)
02 73 52 41 20 74 65 6D 70 65 72 61 74 75 72 65 41 6C 61 72 6D 43 6F 6E 66 69 67 75 72 61 74 69 6F 6E 20 33 37 20 33 32 03
CoLa B (binary)
Cybersecurity¶
WRITE Set Device Search Mode [sWN EtherCoLaScanMode]¶
This command configures the Auto IP functionalities (Device search by SICK Enginnering Tools) and the changeability of the IP address. The functionality can reduces the number of open ports to a minimum.
Telegram structure: sWN EtherCoLaScanMode
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Write | String | 3 | sWN |
73 57 4E |
|
| Command | Set CoLa Scan / AutoIP search settings | String | 17 | EtherCoLaScanMode |
45 74 68 65 72 43 6F 4C 61 53 63 61 6E 4D 6F 64 65 |
|
| CoLa Scan / AutoIP search settings | Choose setting | Uint_8 | 1 | IP address can be found/changed without login: IP address can be found/ changed with login: Disable the Auto IP search/ IP change: IP address can be found/changed for 1 min: |
0 |
00 |
Example: sWN EtherCoLaScanMode 2 - Disable the Auto IP search/ IP change
CoLa A (ASCII)
CoLa B (binary)
Telegram structure: sWA EtherCoLaScanMode
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Answer | String | 3 | sWA |
73 57 41 |
|
| Command | Set CoLa Scan / AutoIP search settings | String | 17 | EtherCoLaScanMode |
45 74 68 65 72 43 6F 4C 61 53 63 61 6E 4D 6F 64 65 |
Example: sWA EtherCoLaScanMode
CoLa A (ASCII)
CoLa B (binary)
READ Read Device Search Mode [sRN EtherCoLaScanMode]¶
This command polls the Auto IP functionalities (Device search by SICK Enginnering Tools) and the IP address changeability settings.
Telegram structure: sRN EtherCoLaScanMode
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Write | String | 3 | sRN |
73 52 4E |
|
| Command | Read CoLa Scan / AutoIP search settings | String | 17 | EtherCoLaScanMode |
45 74 68 65 72 43 6F 4C 61 53 63 61 6E 4D 6F 64 65 |
Example: sRN EtherCoLaScanMode
CoLa A (ASCII)
CoLa B (binary)
Telegram structure: sRA EtherCoLaScanMode
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Answer | String | 3 | sRA |
73 52 41 |
|
| Command | Read CoLa Scan / AutoIP search settings | String | 17 | EtherCoLaScanMode |
45 74 68 65 72 43 6F 4C 61 53 63 61 6E 4D 6F 64 65 |
|
| CoLa Scan / AutoIP search settings | Poll setting | Uint_8 | 1 | IP address can be found/changed without login: IP address can be found/ changed with login: Auto IP search/ IP change is disabled: IP address can be found/changed for 1 min: |
0 |
00 |
Example: sRA EtherCoLaScanMode 3 - IP address can be found/changed for 1 min
CoLa A (ASCII)
CoLa B (binary)
WRITE Enable/ Disable CoLa1 Interface [sWN EIAuxEnable]¶
After enabling the CoLa1 interface, use port 2111 for CoLa A and port 2112 for CoLa B.
Telegram structure: sWN EIAuxEnable
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Write | String | 3 | sWN |
73 57 4E |
|
| Command | Set CoLa1 interface | String | 11 | EIAuxEnable |
45 49 41 75 78 45 6E 61 62 6C 65 |
|
| CoLa1 interface | Enable/ disable | Bool_1 | 1 | Disable: Enable: |
0 |
00 |
Example: sWN EIAuxEnable
CoLa A (ASCII)
CoLa B (binary)
Telegram structure: sWA EIAuxEnable
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Answer | String | 3 | sWA |
73 57 41 |
|
| Command | Set CoLa1 interface | String | 11 | EIAuxEnable |
45 49 41 75 78 45 6E 61 62 6C 65 |
Example: sWA EIAuxEnable
CoLa A (ASCII)
CoLa B (binary)
METHOD Set Webserver State [sMN SetWebserverEnabled]¶
This command enables/ disables the Webserver. Port 80 will not be opened after a reboot.
Telegram structure: sMN SetWebserverEnabled
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Method | String | 3 | sMN |
73 4D 4E |
|
| Command | Set Webserver state | String | 19 | SetWebserverEnabled |
53 65 74 57 65 62 73 65 72 76 65 72 45 6E 61 62 6C 65 64 |
|
| State | Enable/ disable | Bool_1 | 1 | Disable: Enable: |
0 |
00 |
Example: sMN SetWebserverEnabled
CoLa A (ASCII)
CoLa B (binary)
02 02 02 02 00 00 00 19 73 4D 4E 20 53 65 74 57 65 62 73 65 72 76 65 72 45 6E 61 62 6C 65 64 20 01 23
Telegram structure: sAN SetWebserverEnabled
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Answer | String | 3 | sAN |
73 41 4E |
|
| Command | Set Webserver state | String | 19 | SetWebserverEnabled |
53 65 74 57 65 62 73 65 72 76 65 72 45 6E 61 62 6C 65 64 |
Example: sAN SetWebserverEnabled
CoLa A (ASCII)
CoLa B (binary)
METHOD Read Webserver State [sMN GetWebserverEnabled]¶
Returns state if Webserver is enabled.
Telegram structure: sMN GetWebserverEnabled
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Method | String | 3 | sMN |
73 4D 4E |
|
| Command | Webserver state | String | 19 | GetWebserverEnabled |
47 65 74 57 65 62 73 65 72 76 65 72 45 6E 61 62 6C 65 64 |
Example: sMN GetWebserverEnabled
CoLa A (ASCII)
CoLa B (binary)
Telegram structure: sAN GetWebserverEnabled
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Answer | String | 3 | sAN |
73 41 4E |
|
| Command | Webserver state | String | 19 | GetWebserverEnabled |
47 65 74 57 65 62 73 65 72 76 65 72 45 6E 61 62 6C 65 64 |
|
| State | Status of the webserver | Bool_1 | 1 | Disabled: Enabled: |
0 |
00 |
Example: sAN GetWebserverEnabled
CoLa A (ASCII)
CoLa B (binary)
Detection History¶
WRITE Enable Detection History Logging [sWN EnableDetectionHistory]¶
Enables or disables the detection history logging.
Telegram structure: sWN EnableDetectionHistory
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | String | 3 | sWN |
73 57 4E |
||
| Command | EnableDetectionHistory | String | 22 | EnableDetectionHistory |
45 6E 61 62 6C 65 44 65 74 65 63 74 69 6F 6E 48 69 73 74 6F 72 79 |
|
| Detection history logging | Enable/ Disable | Bool_1 | 1 | Disable: Enable: |
0 |
00 |
Example: sWN EnableDetectionHistory
CoLa A (ASCII)
CoLa B (binary)
02 02 02 02 00 00 00 1C 73 57 4E 20 45 6E 61 62 6C 65 44 65 74 65 63 74 69 6F 6E 48 69 73 74 6F 72 79 20 01 47
Telegram structure: sWA EnableDetectionHistory
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Answer | String | 3 | sWA |
73 57 41 |
|
| Command | EnableDetectionHistory | String | 22 | EnableDetectionHistory |
45 6E 61 62 6C 65 44 65 74 65 63 74 69 6F 6E 48 69 73 74 6F 72 79 |
Example: sWA EnableDetectionHistory
CoLa A (ASCII)
CoLa B (binary)
READ Read Detection History Logging State [sRN EnableDetectionHistory]¶
Reads whether the detection history logging is enabled or disabled.
Telegram structure: sRN EnableDetectionHistory
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | String | 3 | sRN |
73 52 4E |
||
| Command | EnableDetectionHistory | String | 22 | EnableDetectionHistory |
45 6E 61 62 6C 65 44 65 74 65 63 74 69 6F 6E 48 69 73 74 6F 72 79 |
Example: sRN EnableDetectionHistory
CoLa A (ASCII)
CoLa B (binary)
02 02 02 02 00 00 00 1A 73 52 4E 20 45 6E 61 62 6C 65 44 65 74 65 63 74 69 6F 6E 48 69 73 74 6F 72 79 63
Telegram structure: sRA EnableDetectionHistory
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Answer | String | 3 | sRA |
73 52 41 |
|
| Command | EnableDetectionHistory | String | 22 | EnableDetectionHistory |
45 6E 61 62 6C 65 44 65 74 65 63 74 69 6F 6E 48 69 73 74 6F 72 79 |
|
| Detection history logging | Enabled/ Disabled | Bool_1 | 1 | Disabled: Enabled: |
0 |
00 |
Example: sRA EnableDetectionHistory
CoLa A (ASCII)
CoLa B (binary)
METHOD Reset Detection History Logging [sMN ResetDetectionHistory]¶
Deletes all entries in the field evaluation logging list.
Telegram structure: sMN ResetDetectionHistory
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Method invocation | String | 3 | sMN |
73 4D 4E |
|
| Method name | ResetDetectionHistory | String | 21 | ResetDetectionHistory |
52 65 73 65 74 44 65 74 65 63 74 69 6F 6E 48 69 73 74 6F 72 79 |
Example: sMN ResetDetectionHistory
CoLa A (ASCII)
CoLa B (binary)
02 02 02 02 00 00 00 19 73 4D 4E 20 52 65 73 65 74 44 65 74 65 63 74 69 6F 6E 48 69 73 74 6F 72 79 08
Telegram structure: sAN ResetDetectionHistory
| Telegram part | Description | Variable | Length | Additional details | Values CoLa A (ASCII) | Values CoLa B (Binary) |
|---|---|---|---|---|---|---|
| Command type | Method answer | String | 3 | sAN |
73 41 4E |
|
| Method name | Echo of method name | String | 21 | ResetDetectionHistory |
52 65 73 65 74 44 65 74 65 63 74 69 6F 6E 48 69 73 74 6F 72 79 |
Example: sAN ResetDetectionHistory
CoLa A (ASCII)
CoLa B (binary)