Skip to content

Latest commit

 

History

History
340 lines (228 loc) · 11.8 KB

MESH_PROTOCOL.md

File metadata and controls

340 lines (228 loc) · 11.8 KB

Bluenet mesh protocol

This only documents the latest protocol, older versions can be found in the git history.

Message types

Crownstone mesh message

Type Name Length Description
uint8_t Message type 1 A type of mesh message (see table below)
uint8_t Payload 7 Payload for the mesh message

This is in total 8 bytes (an unsegmented message). There's currently no versioning in use except for bumping the identifier of a message.

id name Payload Result data
0 TEST cs_mesh_model_msg_test_t
1 CS_MESH_MODEL_TYPE_ACK none
3 CS_MESH_MODEL_TYPE_CMD_TIME cs_mesh_model_msg_time_t
4 CS_MESH_MODEL_TYPE_CMD_NOOP none
5 CS_MESH_MODEL_TYPE_CMD_MULTI_SWITCH cs_mesh_model_msg_multi_switch_item_t
8 CS_MESH_MODEL_TYPE_STATE_0 cs_mesh_model_msg_state_0_t
9 CS_MESH_MODEL_TYPE_STATE_1 cs_mesh_model_msg_state_1_t
10 CS_MESH_MODEL_TYPE_PROFILE_LOCATION cs_mesh_model_msg_profile_location_t
11 CS_MESH_MODEL_TYPE_SET_BEHAVIOUR_SETTINGS Behaviour settings
12 CS_MESH_MODEL_TYPE_TRACKED_DEVICE_REGISTER cs_mesh_model_msg_device_register_t
13 CS_MESH_MODEL_TYPE_TRACKED_DEVICE_TOKEN cs_mesh_model_msg_device_token_t
14 CS_MESH_MODEL_TYPE_SYNC_REQUEST cs_mesh_model_msg_sync_request_t
16 CS_MESH_MODEL_TYPE_TRACKED_DEVICE_LIST_SIZE cs_mesh_model_msg_device_list_size_t
17 CS_MESH_MODEL_TYPE_STATE_SET cs_mesh_model_msg_state_set cs-mesh-model-msg-state-header-t
18 CS_MESH_MODEL_TYPE_RESULT cs_mesh_model_msg_result
19 CS_MESH_MODEL_TYPE_SET_IBEACON_CONFIG_ID Ibeacon config ID packet
20 CS_MESH_MODEL_TYPE_TRACKED_DEVICE_HEARTBEAT Device heartbeat packet
22 CS_MESH_MODEL_TYPE_TIME_SYNC cs_mesh_model_msg_time_sync_message_t
25 CS_MESH_MODEL_TYPE_STONE_MAC cs_mesh_model_msg_stone_mac_t
26 CS_MESH_MODEL_TYPE_ASSET_FILTER_VERSION cs_mesh_model_msg_asset_filter_version_t
27 CS_MESH_MODEL_TYPE_ASSET_INFO_MAC Asset MAC report
28 CS_MESH_MODEL_TYPE_NEIGHBOUR_RSSI cs_mesh_model_msg_neighbour_rssi_t
29 CS_MESH_MODEL_TYPE_CTRL_CMD cs_mesh_model_msg_ctrl_cmd_t cs_mesh_model_msg_ctrl_cmd_header_t
30 CS_MESH_MODEL_TYPE_ASSET_INFO_ID Asset ID report

Packet descriptors

cs_mesh_model_msg_test_t

Time

Type Name Length Description
uint32_t Counter 4
uint8_t[3] Dummy 3

cs_mesh_model_msg_time_t

Time

When a Crownstone receives this message over the mesh, it will synchronize the whole mesh to the given value. Behaviour is identical to the set time command

Type Name Length Description
uint32_t Timestamp 4 posix time stamp

cs_mesh_model_msg_profile_location_t

profile location

Type Name Length Description
uint8_t Profile 1
uint8_t Location 1

cs_mesh_model_msg_state_0_t

model state 0

Type Name Length Description
uint8_t Switch state 1
uint8_t Flags 1
int8_t Power factor 1
int16_t Power usage real 2
uint16_t Partial timestamp 2

cs_mesh_model_msg_state_1_t

model state 1

Type Name Length Description
int8 Temperature 1
int32 Energy used 4
uint16 Partial timestamp 2

cs_mesh_model_msg_multi_switch_item_t

multi switch item

Type Name Length Description
uint8_t Stone ID 1
uint8_t Switch value 1
uint16_t Delay 2
cmd_source_with_counter_t Source 3

cs_mesh_model_msg_device_register_t

register device

Type Name Length Description
device_id_t Device ID 2
uint8_t Location ID 1
uint8_t Profile ID 1
int8_t RSSI offset 1
uint8_t Flags 1
uint8_t Access level 1

cs_mesh_model_msg_device_token_t

device token

Type Name Length Description
device_id_t Device ID 2
uint8_t[3] Device token 3
uint16_t TTL minutes 2

cs_mesh_model_msg_device_heartbeat_t

device heartbeat

Type Name Length Description
device_id_t Device ID 2
uint8_t Location ID 1
uint8_t TTL minutes 1

cs_mesh_model_msg_device_list_size_t

device list

Type Name Length Description
uint8_t List size 1 Size of tracked devices list.

cs_mesh_model_msg_sync_request_t

sync request

Type Name Length Description
uint8_t Stone ID 1 ID of stone that requests for a sync.
uint32_t requestBitmask 4 Bitmask of all things that are requested to be synced.

Sync bitmask

Bit Name Description
0 Time
1 Registered devices
2 Behaviour settings
3-31 Reserved Reserved for future use, must be 0 for now.

cs_mesh_model_msg_state_set

state set

Type Name Length Description
state header State header 3
uint8_t[] Payload N Payload data, depends on state type.

cs_mesh_model_msg_state_header_ext_t

state header

Type Name Length in bits Description
cs_mesh_model_msg_state_header_t Header 16 State header.
uint8_t Access level 3 Shortened version of access level: 0=ADMIN, 1=MEMBER, 2=BASIC, 6=SETUP, 7=NOT_SET.
uint8_t Source ID 5 Shortened version of source ID: 0=NONE, 2=INTERNAL, 3=UART, 4=CONNECTION, 5=SWITCHCRAFT, 30=BROADCAST

cs_mesh_model_msg_state_header_t

state header ext

Type Name Length in bits Description
uint8_t Type 8 State type.
uint8_t State ID 6 ID of state to get. Most state types will only have ID 0.
uint8_t Persistence mode 2 Type of persistence mode.

cs_mesh_model_msg_ctrl_cmd_t

Type Name Length Description
header Header 3
uint8_t[] Payload N Payload data, depends on command type.

cs_mesh_model_msg_ctrl_cmd_header_ext_t

Type Name Length in bits Description
header Header 16
uint8_t Access level 3 Shortened version of access level: 0=ADMIN, 1=MEMBER, 2=BASIC, 6=SETUP, 7=NOT_SET.
uint8_t Source ID 5 Shortened version of source ID: 0=NONE, 2=INTERNAL, 3=UART, 4=CONNECTION, 5=SWITCHCRAFT, 30=BROADCAST

cs_mesh_model_msg_ctrl_cmd_header_t

Type Name Length Description
uint16_t Command type 2 Command type.

high_resolution_time_stamp_t

High resolution time stamp

Type Name Length Description
uint32_t posix_s 4 seconds since epoch
uint16_t posix_ms, version 2 bits 0-9: milliseconds passed since posix_s. bits 10-15: synchronisation version

cs_mesh_model_msg_time_sync_message_t

Time sync message

Type Name Length Description
high_resolution_time_stamp_t stamp 6 current stamp of root clock
uint8_t root_id 1 id of root clock (may differ from sender id)

cs_mesh_model_msg_stone_mac_t

Type Name Length Description
uint8_t Type 1 Type: 0 = request, 1 = reply.
uint8_t[] MAC address 6 Mac address of the replier, ignored for request.

cs_mesh_model_msg_asset_filter_version_t

Type Name Length Description
uint8_t Protocol 1 Supported protocol.
uint16_t Master version 2 Master version.
uint32_t Master CRC 4 Master CRC.

Asset MAC report

asset MAC report

Type Name Length Description
uint8[] MAC 6 The MAC address of the asset.
rssi Rssi 1 Signal strength of the asset advertisement.

RSSI and channel

RSSI and channel packet

Type Name Length in bits Description
uint8 Channel 2 The BLE channel: 0 = unknown, 1 = 37, 2 = 38, 3 = 39.
uint8 RSSI halved 6 RSSI / -2, or 0 if RSSI is positive.

Asset ID report

Asset ID report

Type Name Length Description
Asset ID Asset ID 3 The asset ID.
uint8 Filter bitmask 1 Bitmask of filters that the asset advertisement passed and lead to this asset ID. Nth bit set, means the asset passed filter ID = N, and lead to this asset ID.
int8 RSSI 1 Signal strength of the asset advertisement.
channel Channel 1
uint8 Reserved 1 Reserved for future use, 0 for now.

Asset ID report channel

Type Name Length in bits Description
uint8 Channel 2 The BLE channel: 0 = unknown, 1 = 37, 2 = 38, 3 = 39.
uint8 Reserved 6 Reserved for future use, 0 for now.

cs_mesh_model_msg_neighbour_rssi_t

Type Name Length Description
uint8_t Type 1 Always 0 for now.
uint8_t Neighbour ID 1 ID of the observed neighbour.
int8_t RSSI channel 37 1 RSSI on channel 37.
int8_t RSSI channel 38 1 RSSI on channel 38.
int8_t RSSI channel 39 1 RSSI on channel 39.
uint8_t Last seen 1 How many seconds ago the neighbour was last seen.
uint8_t Message number 1 Message number that increases by 1 each time this message is sent. Used to identify package loss.

cs_mesh_model_msg_result

state set

Type Name Length Description
result header Result header 2 Header.
uint8_t[] Payload N Payload data, depends on result type.

cs_mesh_model_msg_result_header_t

result header

Type Name Length Description
uint8_t Type 1 The type of mesh msg this is the result of.
uint8_t Result code 1 Shortened version of result code.