Developer documentation

Serial API documentation

Attention

Serial API is available from the version 2.1.0 on.

The device exposes a serial port (e.g. /dev/ttyACM0) that communicates at 115200 baud 8-N-1.

All communication is in HEX. Commands should be sent as HEX values and responses are returned the same.

Error

Any other than specified responses represent an error and should be ignored. Possible other responses include (but are not limited to):

This method returns the current FW version installed on the keypad in 3-byte HEX format (see Version structure).

Direction	Payload (HEX)	Explanation
Send	10	GetVersion command
Receive	[Version structure]	Version number

Returns the current default preset number.

Direction	Payload (HEX)	Explanation
Send	20	GetDefaultPreset command
Receive	01	Default preset is 1

Sets a new default preset. Returns the newly set default preset number.

Direction	Payload (HEX)	Explanation
Send	21 00	Set default preset to 0
Receive	00	Default preset is set to 0

Returns the desired preset data (see Preset structure).

Direction	Payload (HEX)	Explanation
Send	30 00	Get preset 0 data
Receive	[Preset structure]	Preset 0 data (71b)

Sets the desired preset data to a new value. Returns the new desired preset data (see Preset structure).

Direction	Payload (HEX)	Explanation
Send	31 00 [Preset structure]	Set preset 0 data (2b + 71b)
Receive	[Preset structure]	Preset 0 data (71b)