Complex Property Protocol Layout

This section describes the transmission protocol layout for the complex property state transmissions.

Table of Content

RGB Selector State Transmission

This transmission carries all necessary parameter to define the state of a RGB Selector Property.

Byte-Index Description Type
8 On / Off Single char
9 Flag Value Dual hex Char
10 Flag Value Dual hex Char
11 Color Transition Value Dual hex Char
12 Color Transition Value Dual hex Char
13 Red Value Dual hex Char
14 Red Value Dual hex Char
15 Green Value Dual hex Char
16 Green Value Dual hex Char
17 Blue Value Dual hex Char
18 Blue Value Dual hex Char
19 Transition Type Single char
20 Delimiter <CR> Char
On / Off (8)

This field defines if the main switch is on or off.

Char Description
0 Off
1 On
Flag Value (9:10)

The flag value controls the visibility of the containers on the RGB Property Page. The flags are invers, if the appropriate flag is set, the container is hidden, respectively. The format is an 8bit hexadecimal value as string (2 char).

Flag Description
0x01 If set, the On/Off switch is hidden.
0x02 If set, the SingleColor/Transition container is hidden.
0x04 If set, the intensity slider is hidden.
0x08 If set, the Soft/Hard-Transition switch is hidden.
Color Transition Value (11:12)

The transition value controls the speed of the transition. If this value is zero, no transition is active, otherwise the transition is active and the speed depends on the value set. The format is an 8bit hexadecimal value as string (2 char).

Value Description
0 No Transition
1 Slow Transition
2 Semi-Slow Transition
3 Medium Transition.
4 Semi-Fast Transition.
5 Fast Transition.
Red Value (13:14)

The red part of the transmitted RGB color value. The format is an 8bit hexadecimal value as string (2 char).

Green Value (15:16)

The red part of the transmitted RGB color value. The format is an 8bit hexadecimal value as string (2 char).

Blue Value (17:18)

The red part of the transmitted RGB color value. The format is an 8bit hexadecimal value as string (2 char).

Transition Type (19)

This field defines how the color changes. Soft transition means there is a fading effect. By hard transition the new color is immediately applied. This must be implemented on remote side. If this is not done, the control element should be hidden by setting the appropriate flag in the flag value.

Char Description
0 Soft Transition
1 Hard Transition
Extended Level Selector State Transmission

This transmission carries all necessary parameter to define the state of a Extended Level Selector Property.

Byte-Index Description Type
8 On / Off Single char
9 Level Value Quad hex Char
10 Level Value Quad hex Char
11 Level Value Quad hex Char
12 Level Value Quad hex Char
13 Min Value Quad hex Char
14 Min Value Quad hex Char
15 Min Value Quad hex Char
16 Min Value Quad hex Char
17 Max Value Quad hex Char
18 Max Value Quad hex Char
19 Max Value Quad hex Char
20 Max Value Quad hex Char
21 Flag Value Dual hex Char
22 Flag Value Dual hex Char
23 Delimiter <CR> Char
On / Off (8)

This field defines if the switch is on or off.

Char Description
0 Off
1 On
Level Value (9:10:11:12)

This is the level value to display. The value must be within the range defined by the min and max value. The format is a 16bit hexadecimal value as string (4 char). The value can be negative.

Min Value (13:14:15:16)

This is the minimum value of the level selector control scope. The format is a 16bit hexadecimal value as string (4 char). The value can be negative.

Max Value (17:18:19:20)

This is the maximum value of the level selector control scope. The format is a 16bit hexadecimal value as string (4 char). The value can be negative.

Flag Value (21:22)

With the flag value some preferences can be set. The format is an 8bit hexadecimal value as string (2 char).

Flag Description
0x01 Hide On/Off Switch (If set, the On/Off switch is hidden).
0x02 Only transmit start and end of track. (no tracking transmissions are sent)
Time Selector State Transmission

This transmission carries all necessary parameter to define the state of a Time Selector Property.

Byte-Index Description Type
8 Hour Value Dual hex Char
9 Hour Value Dual hex Char
10 Minute Value Dual hex Char
11 Minute Value Dual hex Char
12 Delimiter <CR> Char
Hour Value (8:9)

The Hour Value of the Time-Selector. The format is an 8bit hexadecimal value as string (2 char).

Minute Value (10:11)

The Minute Value of the Time-Selector. The format is an 8bit hexadecimal value as string (2 char).

Time-Frame Selector State Transmission

This transmission carries all necessary parameter to define the state of a Time-Frame Selector Property.

Byte-Index Description Type
8 Start-Time Hour Value Dual hex Char
9 Start-Time Hour Value Dual hex Char
10 Start-Time Minute Value Dual hex Char
11 Start-Time Minute Value Dual hex Char
12 End-Time Hour Value Dual hex Char
13 End-Time Hour Value Dual hex Char
14 End-Time Minute Value Dual hex Char
15 End-Time Minute Value Dual hex Char
16 Delimiter <CR> Char
Start-Time Hour Value (8:9)

The Hour Value of the start- (from) time picker. The format is an 8bit hexadecimal value as string (2 char).

Start-Time Minute Value (10:11)

The Minute Value of the start- (from) time picker. The format is an 8bit hexadecimal value as string (2 char).

End-Time Hour Value (12:13)

The Hour Value of the end- (to) time picker. The format is an 8bit hexadecimal value as string (2 char).

End-Time Minute Value (14:15)

The Minute Value of the end (to) time picker. The format is an 8bit hexadecimal value as string (2 char).

Date Selector State Transmission

This transmission carries all necessary parameter to define the state of a Date Selector Property.

Byte-Index Description Type
8 Day Value Dual hex Char
9 Day Value Dual hex Char
10 Month Value Dual hex Char
11 Month Value Dual hex Char
12 Year Value Dual hex Char
13 Year Value Dual hex Char
14 Year Value Dual hex Char
15 Year Value Dual hex Char
16 Delimiter <CR> Char
Day Value (8:9)

The Day-Value of the date-picker. The format is an 8bit hexadecimal value as string (2 char).

Month Value (10:11)

The Month Value of the date-picker. The format is an 8bit hexadecimal value as string (2 char).

Year Value (12:13:14:15)

The Year Value of the date-picker. The format is an 16bit hexadecimal value as string (4 char).

Unlock Control State Transmission

This transmission carries all necessary parameter to define the state of an UnlockControl Property.

Byte-Index Description Type
8 Locked Value Single char
9 Mode Single char
10 Flag Value Dual hex Char
11 Flag Value Dual hex Char
12 .. Pin String
.. End Delimiter <CR> Char
Locked Value (8)

The parameter indicates if the UnlockContrl-Property is in locked or unlocked state.

Char State
1 Locked
2 Unlocked
Mode Value (9)

This parameter defines the purpose of the current state transmission.

Char Mode
0 Unlock Mode
1 Pin-Change Mode
Flag Value (10:11)

The flag value carries some extra information which may be useful. The format is an 8bit hexadecimal value as string (2 char).

Flag Description
0x08 Connection established with shared binding key.
Pin (12..End)

If required for the current transmission, the pin is appended. Otherwise the delimiter is on position 12. Note that the pin string is limited to 10 characters and the pin is only appended in a transmission from app to device, the other way makes no sense, since the device must approve it.

Navigator State Transmission

This transmission carries all necessary parameter to define the state of a Navigator Control Property.

Byte-Index Description Type
8 Up Button Single char
9 Right Button Single char
10 Down Button Single Char
11 Left Button Single Char
12 Mid Button Single Char
13 Action Type Single Char
14 Delimiter <CR> Char
Up Button (8)

In a property state request response (transmission from remote device to app) this parameter sets the visibility of the upper button on the Navigator Page. If this parameter is set to 1 the button is shown, otherwise it is hidden.

In a property execution transmission (user action - from app to remote device) this parameter indicates if the upper button is object of the transmission. If this parameter is 1, the Action Type parameter indicates the current action which was executed on the button by the user.

Right Button (9)

In a property state request response (transmission from remote device to app) this parameter sets the visibility of the right button on the Navigator Page. If this parameter is set to 1 the button is shown, otherwise it is hidden.

In a property execution transmission (user action - from app to remote device) this parameter indicates if the right button is object of the transmission. If this parameter is 1, the Action Type parameter indicates the current action which was executed on the button by the user.

Down Button (10)

In a property state request response (transmission from remote device to app) this parameter sets the visibility of the down button on the Navigator Page. If this parameter is set to 1 the button is shown, otherwise it is hidden.

In a property execution transmission (user action - from app to remote device) this parameter indicates if the down button is object of the transmission. If this parameter is 1, the Action Type parameter indicates the current action which was executed on the button by the user.

Left Button (11)

In a property state request response (transmission from remote device to app) this parameter sets the visibility of the left button on the Navigator Page. If this parameter is set to 1 the button is shown, otherwise it is hidden.

In a property execution transmission (user action - from app to remote device) this parameter indicates if the left button is object of the transmission. If this parameter is 1, the Action Type parameter indicates the current action which was executed on the button by the user.

Mid Button (12)

In a property state request response (transmission from remote device to app) this parameter sets the visibility of the middle button on the Navigator Page. If this parameter is set to 1 the button is shown, otherwise it is hidden.

In a property execution transmission (user action - from app to remote device) this parameter indicates if the middle button is object of the transmission. If this parameter is 1, the Action Type parameter indicates the current action which was executed on the button by the user.

Action Type (13)

This parameter indicates the action which was executed on the button by the user. In a tansmission from remote device to app, the parameter is ignored.

Char Button Action
0 Unused
1 Touched down
2 Touch released
Bar-Graph State Transmission

This transmission carries all necessary parameter to define the state of a BarGraph Property. Since the state is more complex than other states, it has it's own page:

Click here to show the details.

Line-Graph State Transmission

This transmission carries all necessary parameter to define the state of a LineGraph Property. Since the state is more complex than other states, it has it's own page:

Click here to show the details.

String-Interrogator State Transmission

This transmission carries all necessary parameter to define the state of a String Interrogator Property. Since the state is more complex than other states, it has it's own page:

Click here to show the details.

TextListPresenter State Transmission

This transmission carries all necessary parameter to define the state of a TextListPresenter Property.

Byte-Index Description Type
8 Use background stack Single char
9 Action Single char
10 Element Type Single Char
11 .. Text Message String
.. End Delimiter <CR> Char
Use background stack (8)

If this parameter is set to 1, all transmitted TextListPresenter-Elements are saved while the app is connected to the remote device and will be shown when the TextListPresenter page is opened. Otherwise transmitted elements are only shown if the TextListPresenter page is currently open.

Action (9)

This parameter defines the purpose of the transmission.

Char Action
0 None (used when updating control params)
1 Add element to list (or background stack)
2 Clear all (list and/or background stack)
Element Type (10)

This parameter defines the type of the TextListPresenter element.

Char Element Type
0 None (default text color - enum icon)
1 Info (default text color - info icon
2 Warning (yellow text - warning icon)
3 Error (red text - error icon)
Text Message (11..End)

The Text Message to display in the TextListPresenter element. The format is an ASCII based string. All unicode characters must be escaped.