Difference between revisions of "KONNEKTING Protocol Specification 0x01"

From KONNEKTING Wiki
Jump to navigation Jump to search
Line 8: Line 8:
  
 
* '''Message Name:''' Acknowledge   
 
* '''Message Name:''' Acknowledge   
−
* '''MsgID:''' 0 dec / 0x00 hex   
+
* '''Message-Type-ID:''' 0 dec / 0x00 hex   
 
* '''Description:''' Acknowledge a previous received WRITE message   
 
* '''Description:''' Acknowledge a previous received WRITE message   
 
* '''Requires Programming Mode:''' n/a  
 
* '''Requires Programming Mode:''' n/a  
Line 37: Line 37:
  
 
* '''Message Name:''' DeviceInfoRead
 
* '''Message Name:''' DeviceInfoRead
−
* '''MsgID:''' 1 dec / 0x01 hex   
+
* '''Message-Type-ID:''' 1 dec / 0x01 hex   
 
* '''Description:''' Initiates reading general device information     
 
* '''Description:''' Initiates reading general device information     
 
* '''Requires Programming Mode:''' no
 
* '''Requires Programming Mode:''' no
Line 60: Line 60:
  
 
* '''Message Name:''' DeviceInfoResponse   
 
* '''Message Name:''' DeviceInfoResponse   
−
* '''MsgID:''' 2 dec / 0x02 hex   
+
* '''Message-Type-ID:''' 2 dec / 0x02 hex   
 
* '''Description:''' Response to a DeviceInfoRead message   
 
* '''Description:''' Response to a DeviceInfoRead message   
 
* '''Requires Programming Mode:''' n/a
 
* '''Requires Programming Mode:''' n/a
Line 116: Line 116:
 
|-
 
|-
 
|0x00
 
|0x00
−
|System 1 - Normal
+
|System 1
 
| Up to:<br>
 
| Up to:<br>
 
* 256 GAs
 
* 256 GAs
Line 124: Line 124:
 
|-
 
|-
 
|0x01
 
|0x01
−
|System 2 - Light
+
|System 2
 
|Up to:<br>
 
|Up to:<br>
 
* 128 GAs
 
* 128 GAs
Line 132: Line 132:
 
|-
 
|-
 
|0x02
 
|0x02
−
|System 3 - Extended<br>''DRAFT''
+
|System 3 - DRAFT
 
| Up to:<br>
 
| Up to:<br>
 
* 65535 GAs (32*8*256)
 
* 65535 GAs (32*8*256)
Line 144: Line 144:
  
 
* '''Message Name:''' Restart   
 
* '''Message Name:''' Restart   
−
* '''MsgID:''' 9 dec / 0x09 hex   
+
* '''Message-Type-ID:''' 9 dec / 0x09 hex   
 
* '''Description:''' Restart device (device reboot, no memory reset)   
 
* '''Description:''' Restart device (device reboot, no memory reset)   
 
* '''Requires Programming Mode:''' no
 
* '''Requires Programming Mode:''' no
Line 167: Line 167:
  
 
* '''Message Name:''' ProgrammingModeWrite   
 
* '''Message Name:''' ProgrammingModeWrite   
−
* '''MsgID:''' 10 dec / 0x0A hex   
+
* '''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.   
 
* '''Description:''' Sets/Unsets Programming-Mode for device with given individual address. Device will respond with a "Acknowledge" message.   
 
* '''Requires Programming Mode:''' no
 
* '''Requires Programming Mode:''' no
Line 195: Line 195:
  
 
* '''Message Name:''' ProgrammingModeRead   
 
* '''Message Name:''' ProgrammingModeRead   
−
* '''MsgID:''' 11 dec / 0x10 hex   
+
* '''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.     
 
* '''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
 
* '''Requires Programming Mode:''' no
Line 212: Line 212:
  
 
* '''Message Name:''' ProgrammingModeResponse   
 
* '''Message Name:''' ProgrammingModeResponse   
−
* '''MsgID:''' 12 dec / 0x11 hex   
+
* '''Message-Type-ID:''' 12 dec / 0x11 hex   
 
* '''Description:''' Response to ProgrammingModeRead message.   
 
* '''Description:''' Response to ProgrammingModeRead message.   
 
* '''Requires Programming Mode:''' n/a
 
* '''Requires Programming Mode:''' n/a
Line 235: Line 235:
  
 
* '''Message Name:''' IndividualAddressWrite   
 
* '''Message Name:''' IndividualAddressWrite   
−
* '''MsgID:''' 20 dec / 0x14 hex   
+
* '''Message-Type-ID:''' 20 dec / 0x14 hex   
 
* '''Description:''' Writes the individual address the device should use. Device will respond with a "Acknowledge" message.    
 
* '''Description:''' Writes the individual address the device should use. Device will respond with a "Acknowledge" message.    
 
* '''Requires Programming Mode:''' yes
 
* '''Requires Programming Mode:''' yes
Line 258: Line 258:
  
 
* '''Message Name:''' IndividualAddressRead   
 
* '''Message Name:''' IndividualAddressRead   
−
* '''MsgID:''' 21 dec / 0x15 hex   
+
* '''Message-Type-ID:''' 21 dec / 0x15 hex   
 
* '''Description:''' Each device in programming mode will respond with its individual address      
 
* '''Description:''' Each device in programming mode will respond with its individual address      
 
* '''Requires Programming Mode:''' yes
 
* '''Requires Programming Mode:''' yes
Line 275: Line 275:
  
 
* '''Message Name:''' IndividualAddressResponse   
 
* '''Message Name:''' IndividualAddressResponse   
−
* '''MsgID:''' 22 dec / 0x16 hex   
+
* '''Message-Type-ID:''' 22 dec / 0x16 hex   
 
* '''Description:''' Response to a IndividualAddressRead message with the device's individual address.   
 
* '''Description:''' Response to a IndividualAddressRead message with the device's individual address.   
 
* '''Requires Programming Mode:''' n/a
 
* '''Requires Programming Mode:''' n/a
Line 298: Line 298:
  
 
* '''Message Name:''' MemoryWrite
 
* '''Message Name:''' MemoryWrite
−
* '''MsgID:''' ?? dec / 0x?? hex   
+
* '''Message-Type-ID:''' ?? dec / 0x?? hex   
 
* '''Description:''' Write data to device memory
 
* '''Description:''' Write data to device memory
 
* '''Requires Programming Mode:''' yes
 
* '''Requires Programming Mode:''' yes
Line 324: Line 324:
  
 
* '''Message Name:''' MemoryRead   
 
* '''Message Name:''' MemoryRead   
−
* '''MsgID:''' ?? dec / 0x?? hex   
+
* '''Message-Type-ID:''' ?? dec / 0x?? hex   
 
* '''Description:''' Reads data from device memory
 
* '''Description:''' Reads data from device memory
 
* '''Requires Programming Mode:''' yes
 
* '''Requires Programming Mode:''' yes
Line 350: Line 350:
  
 
* '''Message Name:''' MemoryResponse   
 
* '''Message Name:''' MemoryResponse   
−
* '''MsgID:''' ?? dec / 0x?? hex   
+
* '''Message-Type-ID:''' ?? dec / 0x?? hex   
 
* '''Description:''' Response to MemoryRead
 
* '''Description:''' Response to MemoryRead
 
* '''Requires Programming Mode:''' yes
 
* '''Requires Programming Mode:''' yes

Revision as of 20:54, 5 March 2018

Message Types for Protocol-Version 0x01

--- DRAFT ---
This is the second protocol version.
--- 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
0xFF: NACK

3 Error-Code (only NACK):

0x00: no error / no error code available
0x01: ???
0xFE: ???
0xFF: ???

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

hex mask Description
0x80 Factory Flag:
  • 1 = factory settings
  • 0 = stored settings

System Types

hex Name Description
0x00 System 1 Up to:
  • 256 GAs
  • 256 GA-ComObj relations
  • 256 ComObjects
  • 256 Parameters
0x01 System 2 Up to:
  • 128 GAs
  • 128 GA-ComObj relations
  • 128 ComObjects
  • 128 Parameters
0x02 System 3 - DRAFT Up to:
  • 65535 GAs (32*8*256)
  • 65535 GA-ComObj relations
  • 65535 ComObjects
  • 65535 Parameters

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
0x01 = ON

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
Retrieved from "http://wiki.konnekting.de/index.php?title=KONNEKTING_Protocol_Specification_0x01&oldid=245"