KONNEKTING Protocol Specification 0x00

From KONNEKTING Wiki
Jump to navigation Jump to search

Message Types for Protocol-Version 0x00

This is the first protocol version. Used until 1.0.0 beta4. With beta5, things will change.

0x00 Acknowledge

  • Message Name: Acknowledge
  • MsgID: 0 dec / 0x00 hex
  • Description: Acknowledge a previous received WRITE message
  • Requires Programming Mode: n/a
Byte no# Description
2 Acknowledge type:

0x00: ACK
0xFF: NACK

3 Error-Code (only NACK):

0x00: no error / no error code available
0x01: invalid index
0xFE: not implemented
0xFF: general error

4 Affected index (only NACK):

0x00..0xFE: errornous index
0xFF: no relevant index

5..13 0x00, unused


0x01 ReadDeviceInfo

  • Message Name: ReadDeviceInfo
  • MsgID: 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 0x00, unused


0x02 AnswerDeviceInfo

  • Message Name: AnswerDeviceInfo
  • MsgID: 2 dec / 0x02 hex
  • Description: Answers a ReadDeviceInfo 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

Flag masks:
0x80: Factory-Flag: 1 = factory sttings, 0 = stored settings

7 IndividualAddress HI
8 IndividualAddress LO
9..13 0x00, unused


0x09 Restart

  • Message Name: Restart
  • MsgID: 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 0x00, unused


0x0A WriteProgrammingMode

  • Message Name: WriteProgrammingMode
  • MsgID: 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
0x01 = ON

5..13 0x00, unused


0x0B ReadProgrammingMode

  • Message Name: ReadProgrammingMode
  • MsgID: 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 0x00, unused


0x0C AnswerProgrammingMode

  • Message Name: AnswerProgrammingMode
  • MsgID: 12 dec / 0x11 hex
  • Description: Answers a ReadDeviceInfo message with the device's individual address.
  • Requires Programming Mode: n/a
Byte no# Description
2 IndividualAddress HI
3 IndividualAddress LO
4..13 0x00, unused


0x14 WriteIndividualAddress

  • Message Name: WriteProgrammingMode
  • MsgID: 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 0x00, unused


0x15 ReadIndividualAddress

  • Message Name: ReadIndividualAddress
  • MsgID: 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 0x00, unused


0x16 AnswerIndividualAddress

  • Message Name: AnswerIndividualAddress
  • MsgID: 22 dec / 0x16 hex
  • Description: Answers a ReadIndividualAddress message with the device's individual address.
  • Requires Programming Mode: n/a
Byte no# Description
2 IndividualAddress HI
3 IndividualAddress LO
4..13 0x00, unused


0x1E WriteParameter

  • Message Name: WriteParameter
  • MsgID: 30 dec / 0x1E hex
  • Description: Writes a value for a specific parameter. Device will respond with a "Acknowledge" message.
  • Requires Programming Mode: yes
Byte no# Description
2 Parameter ID
3..13 parameter value, up to 11 bytes. Data depends on parameter type


0x1F ReadParameter

  • Message Name: ReadParameter
  • MsgID: 31 dec / 0x1F hex
  • Description: Reads a value for a specific parameter
  • Requires Programming Mode: yes
Byte no# Description
2 Parameter ID
3..13 0x00, unused


0x20 AnswerParameter

  • Message Name: AnswerParameter
  • MsgID: 32 dec / 0x20 hex
  • Description: Answers a ReadDeviceInfo message with the device's individual address.
  • Requires Programming Mode: n/a
Byte no# Description
2 Parameter ID
3..13 parameter value, up to 11 bytes. Data depends on parameter type


0x28 WriteCommObject

  • Message Name: WriteCommObject
  • MsgID: 40 dec / 0x28 hex
  • Description: Writes a GA for a specific CommObjects. Device will respond with a "Acknowledge" message.
  • Requires Programming Mode: yes
Byte no# Description
2 CommObject ID
3 GA HI
4 GA LO
5 Settings
6..13 unused

0x29 ReadCommObject

  • Message Name: ReadCommObject
  • MsgID: 41 dec / 0x29 hex
  • Description: Reads up to 3 GAs for a specific CommObjects.
  • Requires Programming Mode: no
Byte no# Description
2 CommObject ID
3..13 unused

0x2A AnswerCommObject

  • Message Name: AnswerCommObject
  • MsgID: 42 dec / 0x2A hex
  • Description: Answers read request for a specific CommObjects.
  • Requires Programming Mode: n/a
Byte no# Description
2 CommObject ID
3 GA HI
4 GA LO
5 Settings
6..13 0x00, unused