Difference between revisions of "KONNEKTING Protocol Specification 0x01"
Jump to navigation
Jump to search
Konnekting (talk | contribs) |
Konnekting (talk | contribs) |
||
| Line 97: | Line 97: | ||
=== Device Flags === | === Device Flags === | ||
| + | |||
| + | b7 ist the left most bit, b0 is the right most bit. | ||
{| class="wikitable" | {| class="wikitable" | ||
| + | !bit | ||
!hex mask | !hex mask | ||
!Description | !Description | ||
|- | |- | ||
| + | |b7 | ||
|0x80 | |0x80 | ||
|Factory Flag:<br> | |Factory Flag:<br> | ||
* 1 = factory settings | * 1 = factory settings | ||
* 0 = stored settings | * 0 = stored settings | ||
| + | |- | ||
| + | |b6..b0 | ||
| + | |n/a | ||
| + | |unused | ||
|} | |} | ||
Revision as of 09:01, 6 March 2018
Message Types for Protocol-Version 0x01
--- DRAFT ---
This is the second protocol version, starting witrh 1.0.0 beta5
--- DRAFT ---
0x00 Acknowledge
- Message Name: Acknowledge
- Message-Type-ID: 0 dec / 0x00 hex
- Description: Acknowledge a previous received WRITE message
- Requires Programming Mode: n/a
| Byte no# | Description |
|---|---|
| 2 | Acknowledge type: 0x00: ACK |
| 3 | Error-Code (only NACK): 0x00: no error / no error code available |
| 4..13 | 0xFF, unused |
0x01 DeviceInfoRead
- Message Name: DeviceInfoRead
- Message-Type-ID: 1 dec / 0x01 hex
- Description: Initiates reading general device information
- Requires Programming Mode: no
| Byte no# | Description |
|---|---|
| 2 | IndividualAddress HI |
| 3 | IndividualAddress LO |
| 4..13 | 0xFF, unused |
0x02 DeviceInfoResponse
- Message Name: DeviceInfoResponse
- Message-Type-ID: 2 dec / 0x02 hex
- Description: Response to a DeviceInfoRead message
- Requires Programming Mode: n/a
| Byte no# | Description |
|---|---|
| 2 | Manufacturer-ID HI |
| 3 | Manufacturer-ID LO |
| 4 | Device-ID |
| 5 | RevisionID |
| 6 | Device Flags, see below |
| 7 | IndividualAddress HI |
| 8 | IndividualAddress LO |
| 9 | System Type, see below |
| 10..13 | 0xFF, unused |
Device Flags
b7 ist the left most bit, b0 is the right most bit.
| bit | hex mask | Description |
|---|---|---|
| b7 | 0x80 | Factory Flag:
|
| b6..b0 | n/a | unused |
System Types
| hex | Name | Description |
|---|---|---|
| 0x00 | System 1 | Up to:
|
| 0x01 | System 2 | Up to:
|
| 0x02 | System 3 - DRAFT | Up to:
|
0x09 Restart
- Message Name: Restart
- Message-Type-ID: 9 dec / 0x09 hex
- Description: Restart device (device reboot, no memory reset)
- Requires Programming Mode: no
| Byte no# | Description |
|---|---|
| 2 | IndividualAddress HI |
| 3 | IndividualAddress LO |
| 4..13 | 0xFF, unused |
0x0A ProgrammingModeWrite
- Message Name: ProgrammingModeWrite
- Message-Type-ID: 10 dec / 0x0A hex
- Description: Sets/Unsets Programming-Mode for device with given individual address. Device will respond with a "Acknowledge" message.
- Requires Programming Mode: no
| Byte no# | Description |
|---|---|
| 2 | IndividualAddress HI |
| 3 | IndividualAddress LO |
| 4 | Mode: 0x00 = OFF |
| 5..13 | 0xFF, unused |
0x0B ProgrammingModeRead
- Message Name: ProgrammingModeRead
- Message-Type-ID: 11 dec / 0x10 hex
- Description: Reads current programming mode of all listening devices. If more than one device is in programming-mode, you will get more then one AnswerProgrammingMode messages.
- Requires Programming Mode: no
| Byte no# | Description |
|---|---|
| 2..13 | 0xFF, unused |
0x0C ProgrammingModeResponse
- Message Name: ProgrammingModeResponse
- Message-Type-ID: 12 dec / 0x11 hex
- Description: Response to ProgrammingModeRead message.
- Requires Programming Mode: n/a
| Byte no# | Description |
|---|---|
| 2 | IndividualAddress HI |
| 3 | IndividualAddress LO |
| 4..13 | 0xFF, unused |
0x14 IndividualAddressWrite
- Message Name: IndividualAddressWrite
- Message-Type-ID: 20 dec / 0x14 hex
- Description: Writes the individual address the device should use. Device will respond with a "Acknowledge" message.
- Requires Programming Mode: yes
| Byte no# | Description |
|---|---|
| 2 | IndividualAddress HI |
| 3 | IndividualAddress LO |
| 4..13 | 0xFF, unused |
0x15 IndividualAddressRead
- Message Name: IndividualAddressRead
- Message-Type-ID: 21 dec / 0x15 hex
- Description: Each device in programming mode will respond with its individual address
- Requires Programming Mode: yes
| Byte no# | Description |
|---|---|
| 2..13 | 0xFF, unused |
0x16 IndividualAddressResponse
- Message Name: IndividualAddressResponse
- Message-Type-ID: 22 dec / 0x16 hex
- Description: Response to a IndividualAddressRead message with the device's individual address.
- Requires Programming Mode: n/a
| Byte no# | Description |
|---|---|
| 2 | IndividualAddress HI |
| 3 | IndividualAddress LO |
| 4..13 | 0xFF, unused |
0x1E MemoryWrite
- Message Name: MemoryWrite
- Message-Type-ID: ?? dec / 0x?? hex
- Description: Write data to device memory
- Requires Programming Mode: yes
| Byte no# | Description |
|---|---|
| 2 | Count: Number of bytes to write to memory, starting at "Address" |
| 3 | Address HI |
| 4 | Address LO |
| 5..13 | 1..9 bytes of Data, depends on "Count". Remaining bytes: 0xFF |
0x1F MemoryRead
- Message Name: MemoryRead
- Message-Type-ID: ?? dec / 0x?? hex
- Description: Reads data from device memory
- Requires Programming Mode: yes
| Byte no# | Description |
|---|---|
| 2 | Count: Number of bytes to read from address |
| 3 | Address HI |
| 4 | Address LO |
| 5..13 | 0xFF, unused |
0x20 MemoryResponse
- Message Name: MemoryResponse
- Message-Type-ID: ?? dec / 0x?? hex
- Description: Response to MemoryRead
- Requires Programming Mode: yes
| Byte no# | Description |
|---|---|
| 2 | Count: Number of bytes that have been read from address |
| 3 | Address HI |
| 4 | Address LO |
| 5..13 | 1..9 bytes of Data, depends on "Count". Remaining bytes: 0xFF |