Received Events

After establishing a WebSocket connection, the SDK can receive the following events:

Event	Description
deviceDidConnect	Device connection
deviceDidDisconnect	Device disconnection
read	Button and knob events (reading starts only after sending the read event)
getFirmVersion	Return value of getFirmVersion

deviceDidConnect

Triggered when a device connects.

{
    "event": "deviceDidConnect",
    "path": "XFw/XEhJRCNWSURfNjYwMiZQSURfMTAwMSZNSV8wMCM4JjE0NTM2YWViJjAmMDAwMCN7NGQxZTU1YjItZjE2Zi0xMWNmLTg4Y2ItMDAxMTExMDAwMDMwfQ==",
    "payload": null
}

Member	Description
event	deviceDidConnect
path	Device path (unique ID)
payload	null

deviceDidDisconnect

Triggered when a device disconnects.

{
    "event": "deviceDidDisconnect",
    "path": "XFw/XEhJRCNWSURfNjYwMiZQSURfMTAwMSZNSV8wMCM4JjE0NTM2YWViJjAmMDAwMCN7NGQxZTU1YjItZjE2Zi0xMWNmLTg4Y2ItMDAxMTExMDAwMDMwfQ==",
    "payload": null
}

Member	Description
event	deviceDidDisconnect
path	Device path (unique ID)
payload	null

read

Button and knob events (reading starts only after sending the read event).

Button Events

{
    "event": "read",
    "path": "XFw/XEhJRCNWSURfNTUwMCZQSURfMTAwMSM2JjY5M2Y3ZWUmMiYwMDAwI3s0ZDFlNTViMi1mMTZmLTExY2YtODhjYi0wMDExMTEwMDAwMzB9",
    "payload": {
        "key": 5,
        "keyUpOrKeyDown": "keyDown"
    }
}

Member	Description
event	read
path	Device path (unique ID)
payload	json

The payload object contains the following member:

payload	Description
key	Key index (starting from 1)
keyUpOrKeyDown	Key press or release

Knob Events

Knob rotation message (dialRotate: -1 for counterclockwise, 1 for clockwise):
{
    "event": "read",
    "path": "XFw/XEhJRCNWSURfNjYwMyZQSURfMTAwMiZNSV8wMCM3JjMyZGZjYmIxJjAmMDAwMCN7NGQxZTU1YjItZjE2Zi0xMWNmLTg4Y2ItMDAxMTExMDAwMDMwfQ==",
    "payload": {
        "dialRotate": -1,
        "key": 1
    }
}

Knob press/release message:
{
    "event": "read",
    "path": "XFw/XEhJRCNWSURfNjYwMyZQSURfMTAwMiZNSV8wMCM3JjMyZGZjYmIxJjAmMDAwMCN7NGQxZTU1YjItZjE2Zi0xMWNmLTg4Y2ItMDAxMTExMDAwMDMwfQ==",
    "payload": {
        "dialDownOrUp": "dialDown",
        "key": 1
    }
}

Member	Description
event	read
path	Device path (unique ID)
payload	json

The payload object contains the following member:

payload	Description
key	Key index (starting from 1)
dialRotate	Knob rotation (-1 for counterclockwise, 1 for clockwise)
dialDownOrUp	Knob press or release

Event triggered after the background image is set successfully:

{
    "event": "read",
    "path": "XFw/XEhJRCNWSURfNTUwMCZQSURfMTAwMSM2JjM4NjJkMmM2JjEmMDAwMCN7NGQxZTU1YjItZjE2Zi0xMWNmLTg4Y2ItMDAxMTExMDAwMDMwfQ==",
    "payload": {
    "setBackgroundImg": "ok"
    }
}

Member	Description
event	read
path	Device path (unique identifier) ​​
payload	json

The payload object contains the following members:

payload	Description
setBackgroundImg	String "ok"

getFirmVersion

Return value of getFirmVersion.

{
    "event": "getFirmVersion",
    "path": "XFw/XEhJRCNWSURfNTUwMCZQSURfMTAwMSM2JjY5M2Y3ZWUmMiYwMDAwI3s0ZDFlNTViMi1mMTZmLTExY2YtODhjYi0wMDExMTEwMDAwMzB9",
    "payload": {
        "firmVersion": "AVYyLjI5M1YyLjAwLjAwMc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3N"
    }
}

Member	Description
event	getFirmVersion
path	Device path (unique ID)
payload	json

The payload object contains the following member:

payload	Description
firmVersion	Device firmware version (base64 encoded)