Difference between revisions of "KONNEKTING Protocol Specification 0x01"

From KONNEKTING Wiki
Jump to navigation Jump to search
(→‎System Type: fixed default system to 512 params, see https://gitlab.com/konnekting/KonnektingSuite/-/issues/38)
 
(96 intermediate revisions by 2 users not shown)
Line 13: Line 13:
  
 
After ProgMode has been achived, it's time to do the actual device programming.  
 
After ProgMode has been achived, it's time to do the actual device programming.  
 +
For getting an answer for the "... changed?" decision-blocks, a comparison between the "DeviceMemory" section (see: https://gitlab.com/konnekting/KonnektingXmlSchema/blob/develop/src/main/xsd/KonnektingDeviceV0.xsd) of .kconfig.xml with the data the application wants to write. If there are any differences, data has to be written. Either complete, or only the blocks with changes (will speed up programming a lot, especially for small changes).
  
 
{{#drawio:Protocol0x01WorkflowTables}}
 
{{#drawio:Protocol0x01WorkflowTables}}
Line 29: Line 30:
  
 
{{#drawio:Protocol0x01MemoryLayout}}
 
{{#drawio:Protocol0x01MemoryLayout}}
 +
 +
Hints:
 +
 +
* The AddressTable is sorted by the GroupAdress ascending by its integer value.
 +
* The AssociationTable is sorted by the GroupAddress ID ascending by its integer value. 
  
 
== System Table ==
 
== System Table ==
  
−
* '''Total table size in bytes:''' 32 bytes, first 16 bytes: fixed, read only; next 16 bytes: variable, readable/writeable
+
* '''Total table size in bytes:''' 64 bytes, first 48 bytes: fixed, read only; next 16 bytes: variable, readable/writeable
  
 
{| class="wikitable"  
 
{| class="wikitable"  
Line 41: Line 47:
 
|R
 
|R
 
|0
 
|0
−
|version byte LO
+
|version byte HI
 
|-
 
|-
 
|R
 
|R
 
|1
 
|1
−
|version byte HI
+
|version byte LO
 
|-
 
|-
 
|R
 
|R
 
|2
 
|2
−
|'''Device Flags''', see below
+
|[[#Device Flags]]
 
|-
 
|-
 
|R
 
|R
 
|3
 
|3
−
|addresstable LO
+
|[[#GroupAddress Table]] address HI
 
|-
 
|-
 
|R
 
|R
 
|4
 
|4
−
|addresstable HI
+
|GroupAddress Table address LO
 
|-
 
|-
 
|R
 
|R
 
|5
 
|5
−
|associationtable LO
+
|[[#Association Table]] address HI
 
|-
 
|-
 
|R
 
|R
 
|6
 
|6
−
|associationtable HI
+
|Association Table address LO
 
|-
 
|-
 
|R
 
|R
 
|7
 
|7
−
|comobjecttable LO
+
|[[#CommObject Table]] address HI
 
|-
 
|-
 
|R
 
|R
 
|8
 
|8
−
|comobjecttable HI
+
|CommObject Table address LO
 
|-
 
|-
 
|R
 
|R
 
|9
 
|9
−
|parametertable LO
+
|[[#Parameter Table]] address HI
 
|-
 
|-
 
|R
 
|R
 
|10
 
|10
−
|parametertable HI
+
|Parameter Table address LO
 +
|-
 +
|R
 +
|11..14
 +
|CRC System Table
 +
|-
 +
|R
 +
|15..18
 +
|CRC Address Table
 +
|-
 +
|R
 +
|19..22
 +
|CRC Association Table
 +
|-
 +
|R
 +
|23..26
 +
|CRC CommObject Table
 +
|-
 +
|R
 +
|27..30
 +
|CRC Parameter Table
 
|-
 
|-
 
|R
 
|R
−
|11..15
+
|31..47
 
|0xFF, unused
 
|0xFF, unused
 
|-
 
|-
 
|R/W
 
|R/W
−
|16
+
|48
−
|IndividualAddress LO
+
|IndividualAddress HI
 
|-
 
|-
 
|R/W
 
|R/W
−
|17
+
|49
−
|IndividualAddress HI
+
|IndividualAddress LO
 
|-
 
|-
 
|R/W
 
|R/W
−
|18..31
+
|50..63
 
|0xFF, unused
 
|0xFF, unused
 
|}
 
|}
Line 114: Line 140:
 
|b7
 
|b7
 
|0x80
 
|0x80
−
|Factory Flag:<br>
+
|Factory flag:<br>
 
* 1 = factory settings
 
* 1 = factory settings
 
* 0 = stored settings
 
* 0 = stored settings
 
|-
 
|-
−
|b6..b0
+
|b6
 +
|0x40
 +
|IA flag:<br>
 +
* 1 = factory settings
 +
* 0 = stored IA
 +
|-
 +
|b5
 +
|0x20
 +
|CO flag:<br>
 +
* 1 = factory settings
 +
* 0 = stored COs
 +
|-
 +
|b4
 +
|0x10
 +
|Params flag:<br>
 +
* 1 = factory settings
 +
* 0 = stored params
 +
|-
 +
|b3
 +
|0x08
 +
|data storage flag:<br>
 +
* 1 = factory settings
 +
* 0 = storage in use
 +
|-
 +
|b2..b0
 
|n/a
 
|n/a
 
|unused
 
|unused
Line 135: Line 185:
 
|-
 
|-
 
|1
 
|1
−
|GroupAddress 0 LO
+
|GroupAddress 0 HI
 
|-
 
|-
 
|2
 
|2
−
|GroupAddress 0 HI
+
|GroupAddress 0 LO
 
|-
 
|-
 
|3
 
|3
−
|GroupAddress 1 LO
+
|GroupAddress 1 HI
 
|-
 
|-
 
|4
 
|4
−
|GroupAddress 1 HI
+
|GroupAddress 1 LO
 
|-
 
|-
 
|5
 
|5
−
|GroupAddress 2 LO
+
|GroupAddress 2 HI
 
|-
 
|-
 
|6
 
|6
−
|GroupAddress 2 HI
+
|GroupAddress 2 LO
 
|-
 
|-
 
|...
 
|...
Line 224: Line 274:
 
|b7
 
|b7
 
|0x80
 
|0x80
−
|TODO
+
|unused, 0x00
 
|-
 
|-
−
|b6..b0
+
|b6
−
|n/a
+
|0x40
−
|unused
+
|unused, 0x00
 +
|-
 +
|b5
 +
|0x20
 +
|C: the Communication flag
 +
|-
 +
|b4
 +
|0x10
 +
|R: the Read flag
 +
|-
 +
|b3
 +
|0x08
 +
|T: the Transmit flag
 +
|-
 +
|b2
 +
|0x04
 +
|W: the Write flag
 +
|-
 +
|b1
 +
|0x02
 +
|U: the Update flag
 +
|-
 +
|b0
 +
|0x01
 +
|I: the Initialization flag
 
|}
 
|}
  
Line 258: Line 332:
  
 
This is the space where user data can be stored. The [[KONNEKTING Device Library]] provides an API to query the start address for this user space in memory.
 
This is the space where user data can be stored. The [[KONNEKTING Device Library]] provides an API to query the start address for this user space in memory.
 +
 +
= Property Pages =
 +
 +
Property pages are blocks information with up to 12 bytes of length. Property pages are read-only and do not directly belong to the device's memory (f.i. EEPROM or Flash). The information is mostly stored in the device firmware.
 +
 +
== 0x00 Device Info ==
 +
 +
* '''Property Page Number:''' 0 dec / 0x00 hex
 +
* '''Property Page Name:''' Device Information
 +
 +
{| class="wikitable"
 +
!style="text-align:center"|Byte no#
 +
!style="text-align:center"|Description
 +
|-
 +
|2
 +
|Manufacturer-ID HI
 +
|-
 +
|3
 +
|Manufacturer-ID LO
 +
|-
 +
|4
 +
|Device-ID
 +
|-
 +
|5
 +
|RevisionID
 +
|-
 +
|6
 +
|'''System Type''', see [[#System Type]]
 +
|-
 +
|7..13
 +
|0xFF, unused
 +
|}
 +
 +
 +
=== System Type ===
 +
 +
{| class="wikitable"
 +
!hex
 +
!Name
 +
!Description
 +
|-
 +
|0x00
 +
|System 0<br>''Simple''
 +
|Up to:<br>
 +
* 128 GAs
 +
* 128 GA-ComObj relations
 +
* 128 ComObjects
 +
* 128 Parameters
 +
* Supports Default Frame
 +
|-
 +
|0x01
 +
|System 1<br>''Default''
 +
| Up to:<br>
 +
* 255 GAs
 +
* 255 GA-ComObj relations
 +
* 255 ComObjects
 +
* 512 Parameters
 +
* Supports FOTB (firmware-over-the-bus)
 +
* Supports Extended Frame (DRAFT)
 +
|-
 +
|0x02
 +
|System 2<br>Extended<br>''DRAFT''
 +
| Up to:<br>
 +
* 65535 GAs (32*8*256)
 +
* 65535 GA-ComObj relations
 +
* 65535 ComObjects
 +
* 65535 Parameters
 +
* Supports FOTB (firmware-over-the-bus)
 +
* Supports Extended Frame
 +
|-
 +
|}
 +
 +
GAs = Unique GroupAddresses<br>
 +
GA-ComObj relations = Assignments of GAs to ComObjects<br>
 +
ComObjects = Number of ComObjects<br>
 +
Parameters = Number of Parameters<br>
  
 
= Message Types for Protocol-Version 0x01 =
 
= Message Types for Protocol-Version 0x01 =
  
−
--- DRAFT ---<br>
+
These are the messages KONNEKTING uses to communicate between the programming device and the KONNEKTING device.  
−
This is the second protocol version (version=0x01), starting with 1.0.0 beta5 <br>
 
−
--- DRAFT ---<br>
 
 
    
 
    
 
== 0x00 Acknowledge ==
 
== 0x00 Acknowledge ==
Line 308: Line 456:
 
|-
 
|-
 
|0x00
 
|0x00
−
|no error / no error code available
+
|ERR_CODE_OK
 
|-
 
|-
 
|0x01
 
|0x01
−
|PropertyPage not available/invalid
+
|ERR_CODE_NOT_SUPPORTED
 
|-
 
|-
 
|0x02
 
|0x02
−
|Memory adress not available/invalid
+
|ERR_CODE_DATA_OPEN_WRITE_FAILED
 +
|-
 +
|0x03
 +
|ERR_CODE_DATA_OPEN_READ_FAILED
 +
|-
 +
|0x04
 +
|ERR_CODE_DATA_WRITE_FAILED
 +
|-
 +
|0x05
 +
|ERR_CODE_DATA_READ_FAILED
 +
|-
 +
|0x06
 +
|ERR_CODE_DATA_CRC_FAILED
 +
|-
 +
|0x07
 +
|ERR_CODE_TIMEOUT
 +
|-
 +
|0x08
 +
|ERR_CODE_ILLEGAL_STATE
 +
|-
 +
|0x09
 +
|ERR_CODE_TABLE_CRC_FAILED
 
|}
 
|}
  
Line 331: Line 500:
 
|-
 
|-
 
|2
 
|2
−
|IndividualAddress LO
+
|addressflag: 0x00=only reply when progmode is set; 0xFF=only reply if following IA does match
 
|-
 
|-
 
|3
 
|3
−
|IndividualAddress HI
+
|IndividualAddress HI; 0xFF/unused if b[2]=0x00
 
|-
 
|-
 
|4
 
|4
 +
|IndividualAddress LO; 0xFF/unused if b[2]=0x00
 +
|-
 +
|5
 
|property page num, 0x00..0xFF, see [[#Property Pages]] for more details
 
|property page num, 0x00..0xFF, see [[#Property Pages]] for more details
 
|-
 
|-
−
|4..13
+
|6..13
 
|0xFF, unused
 
|0xFF, unused
 
|}
 
|}
  
−
=== Property Pages ===
+
== 0x02 PropertyPageResponse ==
  
−
==== 0x00 Device Info ====
+
* '''Message Name:''' PropertyPageResponse 
−
 
+
* '''Message-Type-ID:''' 2 dec / 0x02 hex
−
* '''Property Page Number:''' 0 dec / 0x00 hex
+
* '''Direction:''' Device -> Suite 
−
* '''Property Page Name:''' Device Information
+
* '''Expected Response:''' n/a
 +
* '''Description:''' One page of property data 
 +
* '''Requires Programming Mode:''' no
  
 
{| class="wikitable"  
 
{| class="wikitable"  
Line 354: Line 528:
 
!style="text-align:center"|Description
 
!style="text-align:center"|Description
 
|-
 
|-
−
|2
+
|2..13
−
|Manufacturer-ID LO
+
|12 bytes of property page data, see [[#Property Pages]] for more details
−
|-
 
−
|3
 
−
|Manufacturer-ID HI
 
−
|-
 
−
|4
 
−
|Device-ID
 
−
|-
 
−
|5
 
−
|RevisionID
 
−
|-
 
−
|6
 
−
|'''Device Flags''', see below
 
−
|-
 
−
|7
 
−
|'''System Type''', see below
 
−
|-
 
−
|8..13
 
−
|0xFF, unused
 
 
|}
 
|}
  
−
===== Device Flags =====
 
  
−
b7 ist the left most bit, b0 is the right most bit.
+
== 0x03 ChecksumSet ==
 +
 
 +
* '''Message Name:''' ChecksumSet 
 +
* '''Message-Type-ID:''' 3 dec / 0x03 hex 
 +
* '''Direction:''' Suite -> Device
 +
* '''Expected Response:''' [[#0x00 Acknowledge]]
 +
* '''Description:''' store a CRC value
 +
* '''Requires Programming Mode:''' yes
  
 
{| class="wikitable"  
 
{| class="wikitable"  
−
!bit
+
!style="text-align:center"|Byte no#
−
!hex mask
+
!style="text-align:center"|Description
−
!Description
+
|-
 +
|2
 +
|CRC identifier, see [[#CRC identifier]]
 
|-
 
|-
−
|b7
+
|3..6
−
|0x80
+
|CRC32, 4 byte value
−
|Factory Flag:<br>
 
−
* 1 = factory settings
 
−
* 0 = stored settings
 
 
|-
 
|-
−
|b6..b0
+
|7..16
−
|n/a
+
|0xFF, unused
−
|unused
 
 
|}
 
|}
  
−
===== System Type =====
+
 
 +
=== CRC identifier ===
  
 
{| class="wikitable"  
 
{| class="wikitable"  
−
!hex
+
!style="text-align:center"|hex
−
!Name
+
!style="text-align:center"|Description
−
!Description
 
 
|-
 
|-
 
|0x00
 
|0x00
−
|System 1<br>''Default''
+
|SystemTable ReadWriteable section checksum
−
| Up to:<br>
 
−
* 256 GAs
 
−
* 256 GA-ComObj relations
 
−
* 256 ComObjects
 
−
* 256 Parameters
 
 
|-
 
|-
 
|0x01
 
|0x01
−
|System 2<br>''Simple''
+
|AddressTable checksum
−
|Up to:<br>
 
−
* 128 GAs
 
−
* 128 GA-ComObj relations
 
−
* 128 ComObjects
 
−
* 128 Parameters
 
 
|-
 
|-
 
|0x02
 
|0x02
−
|System 3<br>Extended<br>''DRAFT''
+
|AssociationTable checksum
−
| Up to:<br>
+
|-
−
* 65535 GAs (32*8*256)
+
|0x03
−
* 65535 GA-ComObj relations
+
|CommObjectTable checksum
−
* 65535 ComObjects
 
−
* 65535 Parameters
 
 
|-
 
|-
 +
|0x04
 +
|PaameterTable checksum
 
|}
 
|}
  
−
GAs = Unique GroupAddresses<br>
+
== 0x08 Unload ==
−
GA-ComObj relations = Assignments of GAs to ComObjects<br>
 
−
ComObjects = Number of ComObjects<br>
 
−
Parameters = Number of Paramaters<br>
 
  
−
== 0x02 PropertyPageResponse ==
+
* '''Message Name:''' Unload  
−
 
+
* '''Message-Type-ID:''' 8 dec / 0x08 hex   
−
* '''Message Name:''' PropertyPageResponse  
+
* '''Direction:''' Suite -> Device
−
* '''Message-Type-ID:''' 2 dec / 0x02 hex   
+
* '''Expected Response:''' [[#0x00 Acknowledge]] 
−
* '''Direction:''' Device -> Suite 
+
* '''Description:''' Unload device. After successfull unload, device will reboot.
−
* '''Expected Response:''' n/a
+
* '''Requires Programming Mode:''' yes
−
* '''Description:''' One page of property data 
 
−
* '''Requires Programming Mode:''' no
 
  
 
{| class="wikitable"  
 
{| class="wikitable"  
Line 447: Line 592:
 
!style="text-align:center"|Description
 
!style="text-align:center"|Description
 
|-
 
|-
−
|2..13
+
|2
−
|12 bytes of property page data, see [[#Property Pages]] for more details
+
|Factory Reset, 0x00 = false, 0xFF=true<br>if true, all other bits are irrelevant
 +
|-
 +
|3
 +
|Unload Individual Address, 0x00 = false, 0xFF=true
 +
|-
 +
|4
 +
|Unload ComObjects, 0x00 = false, 0xFF=true
 +
|-
 +
|5
 +
|Unload Parameters, 0x00 = false, 0xFF=true
 +
|-
 +
|6
 +
|Unload data storage (see: #0x28 DataWriteprepare etc), 0x00 = false, 0xFF=true
 +
|-
 +
|7..13
 +
|0xFF, unused
 
|}
 
|}
  
Line 465: Line 625:
 
|-
 
|-
 
|2
 
|2
−
|IndividualAddress LO
+
|IndividualAddress HI
 
|-
 
|-
 
|3
 
|3
−
|IndividualAddress HI
+
|IndividualAddress LO
 
|-
 
|-
 
|4..13
 
|4..13
Line 490: Line 650:
 
|-
 
|-
 
|2
 
|2
−
|IndividualAddress LO
+
|IndividualAddress HI
 
|-
 
|-
 
|3
 
|3
−
|IndividualAddress HI
+
|IndividualAddress LO
 
|-
 
|-
 
|4
 
|4
Line 509: Line 669:
  
 
* '''Message Name:''' ProgrammingModeRead   
 
* '''Message Name:''' ProgrammingModeRead   
−
* '''Message-Type-ID:''' 11 dec / 0x10 hex   
+
* '''Message-Type-ID:''' 11 dec / 0x0B hex   
 
* '''Direction:''' Suite -> Device  
 
* '''Direction:''' Suite -> Device  
 
* '''Expected Response:''' [[#0x0C ProgrammingModeResponse]]   
 
* '''Expected Response:''' [[#0x0C ProgrammingModeResponse]]   
Line 537: Line 697:
 
|-
 
|-
 
|2
 
|2
−
|IndividualAddress LO
+
|IndividualAddress HI
 
|-
 
|-
 
|3
 
|3
−
|IndividualAddress HI
+
|IndividualAddress LO
 
|-
 
|-
 
|4..13
 
|4..13
Line 550: Line 710:
  
 
* '''Message Name:''' MemoryWrite
 
* '''Message Name:''' MemoryWrite
−
* '''Message-Type-ID:''' ?? dec / 0x?? hex   
+
* '''Message-Type-ID:''' 30 dec / 0x1E hex   
 
* '''Direction:''' Suite -> Device
 
* '''Direction:''' Suite -> Device
 
* '''Expected Response:''' [[#0x00 Acknowledge]]   
 
* '''Expected Response:''' [[#0x00 Acknowledge]]   
Line 564: Line 724:
 
|-
 
|-
 
|3
 
|3
−
|Address uint16[1] LO
+
|Address uint16[0] HI
 
|-
 
|-
 
|4
 
|4
−
|Address uint16[0] HI
+
|Address uint16[1] LO
 
|-
 
|-
 
|5..13
 
|5..13
Line 576: Line 736:
  
 
* '''Message Name:''' MemoryRead   
 
* '''Message Name:''' MemoryRead   
−
* '''Message-Type-ID:''' ?? dec / 0x?? hex   
+
* '''Message-Type-ID:''' 31 dec / 0x1F hex   
 
* '''Direction:''' Suite -> Device
 
* '''Direction:''' Suite -> Device
 
* '''Expected Response:''' [[#0x20 MemoryResponse]]   
 
* '''Expected Response:''' [[#0x20 MemoryResponse]]   
Line 590: Line 750:
 
|-
 
|-
 
|3
 
|3
−
|Address LO
+
|Address HI
 
|-
 
|-
 
|4
 
|4
−
|Address HI
+
|Address LO
 
|-
 
|-
 
|5..13
 
|5..13
Line 602: Line 762:
  
 
With help of [[#0x1F MemoryRead]] and [[#0x1E MemoryWrite]] one can access the device's memory (EEPROM, flash, ...). The memory stores different tables for different usage.  
 
With help of [[#0x1F MemoryRead]] and [[#0x1E MemoryWrite]] one can access the device's memory (EEPROM, flash, ...). The memory stores different tables for different usage.  
−
As both messages access memory by memory address, one has to know at which address which table starts. To get the start addresses of all tables, see [[#0x01 PropertyPageRead]] and [[#0x01 Table Addresses]].
+
As both messages access memory by memory address, one has to know at which address which table starts. To get the start addresses of all tables, see [[#System Table]].
  
 
== 0x20 MemoryResponse ==
 
== 0x20 MemoryResponse ==
  
 
* '''Message Name:''' MemoryResponse   
 
* '''Message Name:''' MemoryResponse   
−
* '''Message-Type-ID:''' ?? dec / 0x?? hex   
+
* '''Message-Type-ID:''' 32 dec / 0x20 hex   
 
* '''Direction:''' Device -> Suite
 
* '''Direction:''' Device -> Suite
 
* '''Expected Response:''' n/a
 
* '''Expected Response:''' n/a
Line 621: Line 781:
 
|-
 
|-
 
|3
 
|3
−
|Address LO
+
|Address HI
 
|-
 
|-
 
|4
 
|4
−
|Address HI
+
|Address LO
 
|-
 
|-
 
|5..13
 
|5..13
Line 631: Line 791:
  
  
−
== 0x28 DataPrepare ==
+
== 0x28 DataWritePrepare ==
  
−
* '''Message Name:''' DataPrepare
+
* '''Message Name:''' DataWritePrepare
 
* '''Message-Type-ID:''' 40 dec / 0x28 hex   
 
* '''Message-Type-ID:''' 40 dec / 0x28 hex   
 
* '''Direction:''' Suite -> Device
 
* '''Direction:''' Suite -> Device
 
* '''Expected Response:''' [[#0x00 Acknowledge]]   
 
* '''Expected Response:''' [[#0x00 Acknowledge]]   
−
* '''Description:''' prepare update
+
* '''Description:''' prepare writing data
 
* '''Requires Programming Mode:''' yes
 
* '''Requires Programming Mode:''' yes
  
Line 708: Line 868:
 
<references />
 
<references />
  
−
== 0x2A DataFinish ==
+
== 0x2A DataWriteFinish ==
  
−
* '''Message Name:''' DataFinish
+
* '''Message Name:''' DataWriteFinish
 
* '''Message-Type-ID:''' 42 dec / 0x2A hex   
 
* '''Message-Type-ID:''' 42 dec / 0x2A hex   
 
* '''Description:''' finish writing data
 
* '''Description:''' finish writing data
Line 738: Line 898:
 
<references />
 
<references />
  
−
== 0x2B DataRemove ==
+
 
 +
== 0x2B DataRead ==
 +
 
 +
* '''Message Name:''' DataRead
 +
* '''Message-Type-ID:''' 43 dec / 0x2B hex 
 +
* '''Direction:''' Suite -> Device
 +
* '''Expected Response:''' [[#0x2C DataReadResponse]], providing the size, followed by n times [[#0x2D DataReadData]] until end of data and finally again [[#0x2C DataReadResponse]], providing the CRC32
 +
* '''Description:''' trigger reading data
 +
* '''Requires Programming Mode:''' yes
 +
 
 +
{| class="wikitable"
 +
!style="text-align:center"|Byte no#
 +
!style="text-align:center"|Description
 +
|-
 +
|2
 +
|'''[[Data Type]]'''<br>range: 0x01..01FF (0x00 can't be read, as this is firmware)
 +
|-
 +
|3
 +
|Data ID<br/>unique identifier for the data to read
 +
|-
 +
|4..13
 +
|unused, 0xFF
 +
|}
 +
 
 +
== 0x2C DataReadResponse ==
 +
 
 +
* '''Message Name:''' DataReadResponse
 +
* '''Message-Type-ID:''' 44 dec / 0x2C hex 
 +
* '''Direction:''' Device -> Suite
 +
* '''Expected Response:''' n/a
 +
* '''Description:''' meta data about the requested data. The actual data will follow in separate messages ([[#0x2D DataReadData]])
 +
* '''Requires Programming Mode:''' yes
 +
 
 +
{| class="wikitable"
 +
!style="text-align:center"|Byte no#
 +
!style="text-align:center"|Description
 +
|-
 +
|2
 +
|'''[[#Data_Type|Data Type]]'''
 +
|-
 +
|3
 +
|Data ID<br/>unique identifier for the data
 +
|-
 +
|4
 +
|size of data uint32[0]
 +
|-
 +
|5
 +
|size of data uint32[1]
 +
|-
 +
|6
 +
|size of data uint32[2]
 +
|-
 +
|7
 +
|size of data uint32[3]
 +
|-
 +
|8
 +
|CRC32[0] <ref>https://github.com/bakercp/CRC32</ref>
 +
|-
 +
|9
 +
|CRC32[1]
 +
|-
 +
|10
 +
|CRC32[2]
 +
|-
 +
|11
 +
|CRC32[3]
 +
|-
 +
|12..13
 +
|unused, 0xFF
 +
|}
 +
 
 +
== 0x2D DataReadData ==
 +
 
 +
* '''Message Name:''' DataReadData
 +
* '''Message-Type-ID:''' 45 dec / 0x2D hex 
 +
* '''Direction:''' Device -> Suite
 +
* '''Expected Response:''' [[#0x00 Acknowledge]] 
 +
* '''Description:''' packet of requested data from device. Device will send several messages of this type until whole data is transferred
 +
* '''Requires Programming Mode:''' yes
 +
 
 +
{| class="wikitable"
 +
!style="text-align:center"|Byte no#
 +
!style="text-align:center"|Description
 +
|-
 +
|2
 +
|Count<ref>required to determin the end of data in message</ref>: 1..11 bytes
 +
|-
 +
|3..13
 +
|1..11 bytes of Data, depends on "Count". Remaining bytes: 0xFF
 +
|}
 +
 
 +
== 0x2E DataRemove ==
  
 
* '''Message Name:''' DataRemove
 
* '''Message Name:''' DataRemove
−
* '''Message-Type-ID:''' 43 dec / 0x2B hex   
+
* '''Message-Type-ID:''' 46 dec / 0x2E hex   
 
* '''Direction:''' Suite -> Device
 
* '''Direction:''' Suite -> Device
 
* '''Expected Response:''' [[#0x00 Acknowledge]]   
 
* '''Expected Response:''' [[#0x00 Acknowledge]]   
Line 752: Line 1,003:
 
|-
 
|-
 
|2
 
|2
−
|'''[[#Data_Type|Data Type]]'''<br/>0x01..0xFF<ref>0x00 is reserved for UPDATE</ref>
+
|'''[[#Data_Type|Data Type]]'''<br/>range: 0x01..0xFF<ref>0x00 is reserved for UPDATE</ref>
 
|-
 
|-
 
|3
 
|3
Line 760: Line 1,011:
 
|unused, 0xFF
 
|unused, 0xFF
 
|}
 
|}
 +
 +
  
 
'''Notes:'''
 
'''Notes:'''
 
<references />
 
<references />

Latest revision as of 15:22, 26 March 2021

Workflow

The following describes the workflow for programming a KONNEKTING device. The diagrams show the required actions the programming device (f.i. KONNEKTING Suite) needs to do in order to program a KONNEKTING device.

Start Programming Mode

Before the programming can start, the KONNEKTING device needs to be in "programming mode" (short: ProgMode). The following diagram describes the two possible ways to achive ProgMode.

drawio: Protocol0x01WorkflowProgMode

Do Programming

After ProgMode has been achived, it's time to do the actual device programming. For getting an answer for the "... changed?" decision-blocks, a comparison between the "DeviceMemory" section (see: https://gitlab.com/konnekting/KonnektingXmlSchema/blob/develop/src/main/xsd/KonnektingDeviceV0.xsd) of .kconfig.xml with the data the application wants to write. If there are any differences, data has to be written. Either complete, or only the blocks with changes (will speed up programming a lot, especially for small changes).

drawio: Protocol0x01WorkflowTables

The parts for "Program CommObjects" and "Program Parameters" are optional an depend on what the user want to program. So you can skip or include them, as you like.

Working with files

This is about working with files, means transfering files to the device, including firmware upgrade

todo ...

Device Memory Layout

The device's memory is divided in multiple sections:

drawio: Protocol0x01MemoryLayout

Hints:

  • The AddressTable is sorted by the GroupAdress ascending by its integer value.
  • The AssociationTable is sorted by the GroupAddress ID ascending by its integer value.

System Table

  • Total table size in bytes: 64 bytes, first 48 bytes: fixed, read only; next 16 bytes: variable, readable/writeable
Access Mode Table Byte Index Description
R 0 version byte HI
R 1 version byte LO
R 2 #Device Flags
R 3 #GroupAddress Table address HI
R 4 GroupAddress Table address LO
R 5 #Association Table address HI
R 6 Association Table address LO
R 7 #CommObject Table address HI
R 8 CommObject Table address LO
R 9 #Parameter Table address HI
R 10 Parameter Table address LO
R 11..14 CRC System Table
R 15..18 CRC Address Table
R 19..22 CRC Association Table
R 23..26 CRC CommObject Table
R 27..30 CRC Parameter Table
R 31..47 0xFF, unused
R/W 48 IndividualAddress HI
R/W 49 IndividualAddress LO
R/W 50..63 0xFF, unused



Device Flags

b7 ist the left most bit, b0 is the right most bit.

bit hex mask Description
b7 0x80 Factory flag:
  • 1 = factory settings
  • 0 = stored settings
b6 0x40 IA flag:
  • 1 = factory settings
  • 0 = stored IA
b5 0x20 CO flag:
  • 1 = factory settings
  • 0 = stored COs
b4 0x10 Params flag:
  • 1 = factory settings
  • 0 = stored params
b3 0x08 data storage flag:
  • 1 = factory settings
  • 0 = storage in use
b2..b0 n/a unused

GroupAddress Table

  • Total table size in bytes: 1+(n*2) bytes, where n = GroupAddress limit, see #System_Type
Table Byte Index Description
0 number of filled entries in table
1 GroupAddress 0 HI
2 GroupAddress 0 LO
3 GroupAddress 1 HI
4 GroupAddress 1 LO
5 GroupAddress 2 HI
6 GroupAddress 2 LO
... ...

Association Table

  • Total table size in bytes: 1+(n*2) bytes, where n = GA-CommObj relation limit, see #System_Type
Table Byte Index Description
0 number of filled entries in GA<->CommObj relations table
1 GroupAddress ID Nr.1
2 CommObj ID Nr.1
3 GroupAddress ID Nr.2
4 CommObj ID Nr.2
5 GroupAddress ID Nr.3
6 CommObj ID Nr.3
... ...

CommObject Table

  • Total table size in bytes: 1+(n) bytes, where n = CommObjects limit, see #System_Type
Table Byte Index Description
0 number of existing CommObjects
1 config byte (see below) of CommObject ID 0
2 config byte of CommObject ID 1
3 config byte of CommObject ID 2
... ...

CommObject config byte

b7 ist the left most bit, b0 is the right most bit.

bit hex mask Description
b7 0x80 unused, 0x00
b6 0x40 unused, 0x00
b5 0x20 C: the Communication flag
b4 0x10 R: the Read flag
b3 0x08 T: the Transmit flag
b2 0x04 W: the Write flag
b1 0x02 U: the Update flag
b0 0x01 I: the Initialization flag

Parameter Table

  • Total table size in bytes: depends on actual by device provided parameters
Table Byte Index Description
0 ...
1 ...
2 ...
3 ...
... ...

User Space

This is the space where user data can be stored. The KONNEKTING Device Library provides an API to query the start address for this user space in memory.

Property Pages

Property pages are blocks information with up to 12 bytes of length. Property pages are read-only and do not directly belong to the device's memory (f.i. EEPROM or Flash). The information is mostly stored in the device firmware.

0x00 Device Info

  • Property Page Number: 0 dec / 0x00 hex
  • Property Page Name: Device Information
Byte no# Description
2 Manufacturer-ID HI
3 Manufacturer-ID LO
4 Device-ID
5 RevisionID
6 System Type, see #System Type
7..13 0xFF, unused


System Type

hex Name Description
0x00 System 0
Simple 		Up to:
  • 128 GAs
  • 128 GA-ComObj relations
  • 128 ComObjects
  • 128 Parameters
  • Supports Default Frame
0x01 System 1
Default 		Up to:
  • 255 GAs
  • 255 GA-ComObj relations
  • 255 ComObjects
  • 512 Parameters
  • Supports FOTB (firmware-over-the-bus)
  • Supports Extended Frame (DRAFT)
0x02 System 2
Extended
DRAFT 		Up to:
  • 65535 GAs (32*8*256)
  • 65535 GA-ComObj relations
  • 65535 ComObjects
  • 65535 Parameters
  • Supports FOTB (firmware-over-the-bus)
  • Supports Extended Frame

GAs = Unique GroupAddresses
GA-ComObj relations = Assignments of GAs to ComObjects
ComObjects = Number of ComObjects
Parameters = Number of Parameters

Message Types for Protocol-Version 0x01

These are the messages KONNEKTING uses to communicate between the programming device and the KONNEKTING device.

0x00 Acknowledge

  • Message Name: Acknowledge
  • Message-Type-ID: 0 dec / 0x00 hex
  • Direction: Device -> Suite
  • Expected Response: n/a
  • Description: Sent by device as answer to most WRITE messages
  • Requires Programming Mode: n/a
Byte no# Description
2 Acknowledge Type
3 Error Code
4..13 0xFF, unused

Acknowledge Type

hex Description
0x00 ACK
0xFF NACK

Error Code

hex Description
0x00 ERR_CODE_OK
0x01 ERR_CODE_NOT_SUPPORTED
0x02 ERR_CODE_DATA_OPEN_WRITE_FAILED
0x03 ERR_CODE_DATA_OPEN_READ_FAILED
0x04 ERR_CODE_DATA_WRITE_FAILED
0x05 ERR_CODE_DATA_READ_FAILED
0x06 ERR_CODE_DATA_CRC_FAILED
0x07 ERR_CODE_TIMEOUT
0x08 ERR_CODE_ILLEGAL_STATE
0x09 ERR_CODE_TABLE_CRC_FAILED

0x01 PropertyPageRead

  • Message Name: PropertyPageRead
  • Message-Type-ID: 1 dec / 0x01 hex
  • Direction: Suite -> Device
  • Expected Response: #0x02 PropertyPageResponse
  • Description: Read one page of property data
  • Requires Programming Mode: no
Byte no# Description
2 addressflag: 0x00=only reply when progmode is set; 0xFF=only reply if following IA does match
3 IndividualAddress HI; 0xFF/unused if b[2]=0x00
4 IndividualAddress LO; 0xFF/unused if b[2]=0x00
5 property page num, 0x00..0xFF, see #Property Pages for more details
6..13 0xFF, unused

0x02 PropertyPageResponse

  • Message Name: PropertyPageResponse
  • Message-Type-ID: 2 dec / 0x02 hex
  • Direction: Device -> Suite
  • Expected Response: n/a
  • Description: One page of property data
  • Requires Programming Mode: no
Byte no# Description
2..13 12 bytes of property page data, see #Property Pages for more details


0x03 ChecksumSet

  • Message Name: ChecksumSet
  • Message-Type-ID: 3 dec / 0x03 hex
  • Direction: Suite -> Device
  • Expected Response: #0x00 Acknowledge
  • Description: store a CRC value
  • Requires Programming Mode: yes
Byte no# Description
2 CRC identifier, see #CRC identifier
3..6 CRC32, 4 byte value
7..16 0xFF, unused


CRC identifier

hex Description
0x00 SystemTable ReadWriteable section checksum
0x01 AddressTable checksum
0x02 AssociationTable checksum
0x03 CommObjectTable checksum
0x04 PaameterTable checksum

0x08 Unload

  • Message Name: Unload
  • Message-Type-ID: 8 dec / 0x08 hex
  • Direction: Suite -> Device
  • Expected Response: #0x00 Acknowledge
  • Description: Unload device. After successfull unload, device will reboot.
  • Requires Programming Mode: yes
Byte no# Description
2 Factory Reset, 0x00 = false, 0xFF=true
if true, all other bits are irrelevant
3 Unload Individual Address, 0x00 = false, 0xFF=true
4 Unload ComObjects, 0x00 = false, 0xFF=true
5 Unload Parameters, 0x00 = false, 0xFF=true
6 Unload data storage (see: #0x28 DataWriteprepare etc), 0x00 = false, 0xFF=true
7..13 0xFF, unused

0x09 Restart

  • Message Name: Restart
  • Message-Type-ID: 9 dec / 0x09 hex
  • Direction: Suite -> Device
  • Expected Response: #0x00 Acknowledge
  • 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
  • Direction: Suite -> Device
  • Expected Response: #0x00 Acknowledge
  • 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 / 0x0B hex
  • Direction: Suite -> Device
  • Expected Response: #0x0C ProgrammingModeResponse
  • Description: Reads current programming mode of all listening devices. If more than one device is in programming-mode, you will get more then one #0x0C ProgrammingModeResponse messages.
  • Requires Programming Mode: no
Byte no# Description
2..13 0xFF, unused

0x0C ProgrammingModeResponse

  • Message Name: ProgrammingModeResponse
  • Message-Type-ID: 12 dec / 0x11 hex
  • Direction: Device -> Suite
  • Expected Response: n/a
  • Description: Response to ProgrammingModeRead message.
  • 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: 30 dec / 0x1E hex
  • Direction: Suite -> Device
  • Expected Response: #0x00 Acknowledge
  • 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 uint16[0] HI
4 Address uint16[1] LO
5..13 1..9 bytes of Data, depends on "Count". Remaining bytes: 0xFF

0x1F MemoryRead

  • Message Name: MemoryRead
  • Message-Type-ID: 31 dec / 0x1F hex
  • Direction: Suite -> Device
  • Expected Response: #0x20 MemoryResponse
  • Description: Reads data from device memory
  • Requires Programming Mode: yes
Byte no# Description
2 Count: Number of bytes to read from address. Range 1..9
3 Address HI
4 Address LO
5..13 0xFF, unused

Memory Tables

With help of #0x1F MemoryRead and #0x1E MemoryWrite one can access the device's memory (EEPROM, flash, ...). The memory stores different tables for different usage. As both messages access memory by memory address, one has to know at which address which table starts. To get the start addresses of all tables, see #System Table.

0x20 MemoryResponse

  • Message Name: MemoryResponse
  • Message-Type-ID: 32 dec / 0x20 hex
  • Direction: Device -> Suite
  • Expected Response: n/a
  • 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


0x28 DataWritePrepare

  • Message Name: DataWritePrepare
  • Message-Type-ID: 40 dec / 0x28 hex
  • Direction: Suite -> Device
  • Expected Response: #0x00 Acknowledge
  • Description: prepare writing data
  • Requires Programming Mode: yes
Byte no# Description
2 Data Type, see below
3 Data ID
unique identifier for the data
4 size of data uint32[0]
5 size of data uint32[1]
6 size of data uint32[2]
7 size of data uint32[3]
8..13 unused, 0xFF

Data Type

hex Name Data ID range Description
0x00 UPDATE always 0x00 Firmware update for KONNEKTING device
0x01 DATA 0x00..0xFF f.i. additional configuration, images, sounds, ...

0x29 DataWrite

  • Message Name: DataWrite
  • Message-Type-ID: 41 dec / 0x29 hex
  • Direction: Suite -> Device
  • Expected Response: #0x00 Acknowledge
  • Description: Writing data
  • Requires Programming Mode: yes
Byte no# Description
2 Count[1]: 1..11 bytes
3..13 1..11 bytes of Data, depends on "Count". Remaining bytes: 0xFF

Notes:

  1. ↑ required to determin the end of data in last DataWrite message

0x2A DataWriteFinish

  • Message Name: DataWriteFinish
  • Message-Type-ID: 42 dec / 0x2A hex
  • Description: finish writing data
  • Requires Programming Mode: yes
Byte no# Description
2 CRC32[0] [1]
3 CRC32[1]
4 CRC32[2]
5 CRC32[3]
6..13 unused, 0xFF

Notes:

  1. ↑ https://github.com/bakercp/CRC32


0x2B DataRead

  • Message Name: DataRead
  • Message-Type-ID: 43 dec / 0x2B hex
  • Direction: Suite -> Device
  • Expected Response: #0x2C DataReadResponse, providing the size, followed by n times #0x2D DataReadData until end of data and finally again #0x2C DataReadResponse, providing the CRC32
  • Description: trigger reading data
  • Requires Programming Mode: yes
Byte no# Description
2 Data Type
range: 0x01..01FF (0x00 can't be read, as this is firmware)
3 Data ID
unique identifier for the data to read
4..13 unused, 0xFF

0x2C DataReadResponse

  • Message Name: DataReadResponse
  • Message-Type-ID: 44 dec / 0x2C hex
  • Direction: Device -> Suite
  • Expected Response: n/a
  • Description: meta data about the requested data. The actual data will follow in separate messages (#0x2D DataReadData)
  • Requires Programming Mode: yes
Byte no# Description
2 Data Type
3 Data ID
unique identifier for the data
4 size of data uint32[0]
5 size of data uint32[1]
6 size of data uint32[2]
7 size of data uint32[3]
8 CRC32[0] [1]
9 CRC32[1]
10 CRC32[2]
11 CRC32[3]
12..13 unused, 0xFF

0x2D DataReadData

  • Message Name: DataReadData
  • Message-Type-ID: 45 dec / 0x2D hex
  • Direction: Device -> Suite
  • Expected Response: #0x00 Acknowledge
  • Description: packet of requested data from device. Device will send several messages of this type until whole data is transferred
  • Requires Programming Mode: yes
Byte no# Description
2 Count[2]: 1..11 bytes
3..13 1..11 bytes of Data, depends on "Count". Remaining bytes: 0xFF

0x2E DataRemove

  • Message Name: DataRemove
  • Message-Type-ID: 46 dec / 0x2E hex
  • Direction: Suite -> Device
  • Expected Response: #0x00 Acknowledge
  • Description: remove previously stored data
  • Requires Programming Mode: yes
Byte no# Description
2 Data Type
range: 0x01..0xFF[3]
3 Data ID
unique identifier for the data
4..13 unused, 0xFF


Notes:

  1. ↑ https://github.com/bakercp/CRC32
  2. ↑ required to determin the end of data in message
  3. ↑ 0x00 is reserved for UPDATE
Retrieved from "http://wiki.konnekting.de/index.php?title=KONNEKTING_Protocol_Specification_0x01&oldid=938"