...
| Size | Description |
|---|---|
| B | Frame Size (n+2 bytes) - CRC not included |
| B | Register Address |
| B | Response Status (see response code table) |
| B | Register Address |
| nB | Frame Data |
| 2B | CRC |
Sensor Board Register Map
...
| Value | Size | Description |
|---|---|---|
| 0x03 | B | Size |
| Status0x00 | B | Response statusAddress0x00 |
| Status | B | AddressResponse status |
| Version | B | Interface version implemented |
| CRC | S | CRC |
...
| Value | Size | Description |
|---|---|---|
| 0x19 | B | Size |
| Status0x01 | B | Response statusAddress |
| 0x01Status | BAddress | Response status |
| Model | 8B | Eight bytes describing the model name. This field may be filled with (0x00) |
| Manufacturer | 8B | Eight bytes describing the manufacture name. This field may be filled with (0x00) |
| ID | L | Sensor board ID |
| Revision | B | Hardware revision |
| Points | B | Number of points (maximum is 32 |
| Capabilities | B | Sensor capabilities (see capabilities table) |
| CRC | S | CRC |
...
| Value | Size | Description |
|---|---|---|
| 0x03 | B | Size |
| Status0x02 | B | Response statusAddress |
| 0x02Status | BAddress | Response status |
| Status | B | Sensor Status Code |
| CRC | S | CRC |
...
| Value | Size | Description |
|---|---|---|
| 0x03 | B | Size |
| Status0x03 | B | Response statusAddress |
| 0x03Status | BAddress | Response status |
| Status | B | Command execution result |
| CRC | S | CRC |
...
| Value | Size | Description |
|---|---|---|
| 0x03 | B | Size |
| Status0x04 | B | Response statusAddress |
| 0x04Status | BAddress | Response status |
| Status | B | Battery status |
| CRC | S | CRC |
...
| Value | Size | Description |
|---|---|---|
| 0x02 | B | Size |
| Status0x05 | B | Response statusAddress |
| 0x05Status | BAddress | Response status |
| CRC | 2B | CRC |
Read Battery charge (0x06)
...
| Value | Size | Description |
|---|---|---|
| 0x03 | B | Size |
| Status0x06 | B | Response statusAddress |
| 0x06Status | BAddress | Response status |
| Charge | B | Battery charge (0 to 100%) |
| CRC | S | CRC |
...
| Value | Size | Description |
|---|---|---|
| 0x02 | B | Size |
| Status0x07 | B | Response statusAddress |
| 0x07Status | BAddress | Response status |
| CRC | 2B | CRC |
Wireless network status (0x08)
...
| Value | Size | Description |
|---|---|---|
| 0x02 | B | Size |
| Status0x08 | B | Response statusAddress |
| 0x08Status | BAddress | Response status |
| CRC | 2B | CRC |
Wireless network strength (0x09)
...
| Value | Size | Description |
|---|---|---|
| 0x02 | B | Size |
| Status0x09 | B | Response statusAddress |
| 0x09Status | BAddress | Response status |
| CRC | 2B | CRC |
Display register (0x0A)
...
| Value | Size | Description |
|---|---|---|
| 0x02 | B | Size |
| Status0x0A | B | Response statusAddress |
| 0x0AStatus | BAddress | Response status |
| CRC | 2B | CRC |
Main server address (0x0B)
...
This register holds the server address to which the sensor data should be reported.
Request
|--------+------+--------------|
| Value | Size | Description |
|--------+------+--------------|
| 0x02 | B | Size |
| 0x0B | B | Address |
| Server | 16B | IPv6 address |
| CRC | S | CRC |
|--------+------+--------------|
Response
|--------+------+-----------------|
| Value | Size | Description |
|--------+------+-----------------|
| Size | B | Response size |
| Status | B | Response status |
| CRC | S | CRC |
|--------+------+-----------------|
Secondary server address (0x0C)
When the main server is not available (register 0x09), this register holds the secondary server address to which the sensor data should be reported.
Request
|--------+------+--------------|
| Value | Size | Description |
|--------+------+--------------|
| 0x02 | B | Size |
| 0x0C | B | Address |
| Server | 16B | IPv6 address |
| CRC | S | CRC |
|--------+------+--------------|
Response
|--------+------+-----------------|
| Value | Size | Description |
|--------+------+-----------------|
| Size | B | Response size |
| Status | B | Response status |
| CRC | S | CRC |
|--------+------+-----------------|
Sensor Point Description (0x10 to 0x2F)
This range of registers is used to provided information about a specific point like point name, access rights, data type, unit and sampling time. It is possible to use the interrupt line and status register to indicate that a reading is pending for this point. The sampling time is specified as a multiple of 250ms and points with sampling time equal to 0 should not be read in the cyclic readings.
Request
|-------+------+------------------------------|
| Value | Size | Description |
|-------+------+------------------------------|
| 0x01 | B | Size |
| Point | B | Point Address (0x10 to 0x2F) |
| CRC | S | CRC |
|-------+------+------------------------------|
Response
|----------+------+--------------------------------------|
| Value | Size | Description |
|----------+------+--------------------------------------|
| Size | B | Response size |
| Status | B | Response status |
| Name | 8B | Point name |
| | | This field may be filled with (0x00) |
| Type | B | Point type |
| Unit | B | Point unit |
| Rights | B | Access rights |
| Sampling | L | Sampling time (x 250ms) |
| CRC | S | CRC |
|----------+------+--------------------------------------|
Read Sensor Point (0x30 to 0x4F)
Read the current value for some sensor point. Point description is used to determine the access rights to the point.
Request
|-------+------+------------------------------|
| Value | Size | Description |
|-------+------+------------------------------|
| 0x01 | B | Size |
| Point | B | Point Address (0x30 to 0x4F) |
| CRC | S | CRC |
|-------+------+------------------------------|
Response
|--------+------+------------------------------------------|
| Value | Size | Description |
|--------+------+------------------------------------------|
| Size | B | Response size |
| Status | B | Response status |
| Value | - | Point value (size depends on point type) |
| CRC | S | CRC |
|--------+------+------------------------------------------|
Read/Write Sensor Point (0x50 to 0x6F)
Write the current value for some sensor point. Point description is used to determine the access rights to the point.
Request
|-------+------+------------------------------------------|
| Value | Size | Description |
|-------+------+------------------------------------------|
| 0x01 | B | Size |
| Point | B | Point Address (0x50 to 0x6F) |
| Value | - | Point value (size depends on point type) |
| CRC | S | CRC |
|-------+------+------------------------------------------|
Response
...
| Value | Size | Description |
|---|---|---|
| 0x11 | B | Size |
| 0x0B | B | Address |
| IPv6 | 16B | IPv6 server address |
| CRC | 2B | CRC |
Response
| Value | Size | Description |
|---|---|---|
| 0x02 | B | Size |
| 0x0B | B | Address |
| Status | B | Response status |
| CRC | 2B | CRC |
Secondary server address (0x0C)
When the main server is not available (register 0x09), this register holds the secondary server address to which the sensor data should be reported.
Request
| Value | Size | Description |
|---|---|---|
| 0x11 | B | Size |
| 0x0C | B | Address |
| IPv6 | 16B | IPv6 server address |
| CRC | 2B | CRC |
Response
| Value | Size | Description |
|---|---|---|
| 0x02 | B | Size |
| 0x0C | B | Address |
| Status | B | Response status |
| CRC | 2B | CRC |
Sensor Point Description (0x10 to 0x2F)
This range of registers is used to provided information about a specific point like point name, access rights, data type, unit and sampling time. It is possible to use the interrupt line and status register to indicate that a reading is pending for this point. The sampling time is specified as a multiple of 250ms and points with sampling time equal to 0 should not be read in the cyclic readings.
Request
| Value | Size | Description |
|---|---|---|
| 0x01 | B | Size |
| Point | B | Point address (0x10 to 0x2F) |
| CRC | S | CRC |
Response
| Value | Size | Description |
|---|---|---|
| 0x02 | B | Size |
| Point | B | Point address (0x10 to 0x2F) |
| Status | B | Response status |
| Name | 8B | Point name. This field may be filled with (0x00) |
| Type | B | Point type |
| Unit | B | Point unit |
| Rights | B | Access rights |
| Sampling | L | Sampling time (x 250ms) |
| CRC | 2B | CRC |
Read Sensor Point (0x30 to 0x4F)
Read the current value for some sensor point. Point description is used to determine the access rights to the point.
Request
| Value | Size | Description |
|---|---|---|
| 0x01 | B | Size |
| Point | B | Point address (0x30 to 0x4F) |
| CRC | S | CRC |
Response
| Value | Size | Description |
|---|---|---|
| Size | B | Size |
| Point | B | Point address (0x30 to 0x4F) |
| Status | B | Response status |
| Value | - | Point value (size depends on point type) |
| CRC | 2B | CRC |
Read/Write Sensor Point (0x50 to 0x6F)
Write the current value for some sensor point. Point description is used to determine the access rights to the point.
Request
| Value | Size | Description |
|---|---|---|
| 0x02 | B | Size |
| Point | B | Point address (0x50 to 0x6F) |
| Value | - | Point value (size depends on point type) |
| CRC | 2B | CRC |
Response
| Value | Size | Description |
|---|---|---|
| 0x02 | B | Size |
| Point | B | Point address (0x50 to 0x6F) |
| Status | B | Response status |
| CRC | 2B | CRC |
Appendix: Tables
Data Types
...