cs_MeshModelPackets.h File Reference

#include <mesh/cs_MeshDefines.h>
#include <protocol/cs_AssetFilterPackets.h>
#include <protocol/cs_CmdSource.h>
#include <protocol/cs_RssiAndChannel.h>
#include <protocol/cs_Typedefs.h>

Include dependency graph for cs_MeshModelPackets.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	cs_mesh_model_msg_test_t
struct	cs_mesh_model_msg_time_t
struct	cs_mesh_model_msg_profile_location_t
struct	cs_mesh_model_msg_state_0_t
struct	cs_mesh_model_msg_state_1_t
struct	cs_mesh_model_msg_multi_switch_item_t
struct	cs_mesh_model_msg_device_register_t
struct	cs_mesh_model_msg_device_token_t
struct	cs_mesh_model_msg_device_heartbeat_t
struct	cs_mesh_model_msg_device_list_size_t
struct	cs_mesh_model_msg_sync_request_t
struct	cs_mesh_model_msg_state_header_t
struct	cs_mesh_model_msg_state_header_ext_t
struct	cs_mesh_model_msg_ctrl_cmd_header_t
struct	cs_mesh_model_msg_ctrl_cmd_header_ext_t
struct	cs_mesh_model_msg_result_header_t
struct	cs_mesh_model_msg_time_sync_t
	Packed version of time_sync_message_t. More...
struct	mac_address_t
	MAC address struct, with some useful functions. More...
struct	cs_mesh_model_msg_asset_report_mac_t
struct	cs_mesh_model_msg_asset_report_id_t
struct	rssi_ping_message_t
	Sent from a crownstone when it has too little rssi information from its neighbors. More...
struct	rssi_data_t
	The data in this packet contains information about a bluetooth channel between this crownstone and the one with id sender_id. More...
struct	rssi_data_message_t
struct	cs_mesh_model_msg_neighbour_rssi_t
struct	cs_mesh_model_msg_stone_mac_t
struct	cs_mesh_model_msg_asset_filter_version_t

Enumerations
enum	cs_mesh_model_id_t { CS_MESH_MODEL_ID_MULTICAST = 0 , CS_MESH_MODEL_ID_MULTICAST_ACKED = 1 , CS_MESH_MODEL_ID_UNICAST = 2 , CS_MESH_MODEL_ID_NEIGHBOURS = 3 }
	Author: Crownstone Team Copyright: Crownstone (https://crownstone.rocks) Date: 7 May., 2019 License: LGPLv3+, Apache License 2.0, and/or MIT (triple-licensed) More...
enum	cs_mesh_model_opcode_t {   CS_MESH_MODEL_OPCODE_MSG = 0xC0 , CS_MESH_MODEL_OPCODE_UNICAST_RELIABLE_MSG = 0xC1 , CS_MESH_MODEL_OPCODE_UNICAST_REPLY = 0xC2 , CS_MESH_MODEL_OPCODE_MULTICAST_RELIABLE_MSG = 0xC3 ,   CS_MESH_MODEL_OPCODE_MULTICAST_REPLY = 0xC4 , CS_MESH_MODEL_OPCODE_MULTICAST_NEIGHBOURS = 0xC5 }
	Message opcodes. More...
enum	cs_mesh_model_msg_type_t {   CS_MESH_MODEL_TYPE_TEST = 0 , CS_MESH_MODEL_TYPE_ACK = 1 , CS_MESH_MODEL_TYPE_CMD_TIME = 3 , CS_MESH_MODEL_TYPE_CMD_NOOP = 4 ,   CS_MESH_MODEL_TYPE_CMD_MULTI_SWITCH = 5 , CS_MESH_MODEL_TYPE_STATE_0 = 8 , CS_MESH_MODEL_TYPE_STATE_1 = 9 , CS_MESH_MODEL_TYPE_PROFILE_LOCATION = 10 ,   CS_MESH_MODEL_TYPE_SET_BEHAVIOUR_SETTINGS = 11 , CS_MESH_MODEL_TYPE_TRACKED_DEVICE_REGISTER = 12 , CS_MESH_MODEL_TYPE_TRACKED_DEVICE_TOKEN = 13 , CS_MESH_MODEL_TYPE_SYNC_REQUEST = 14 ,   CS_MESH_MODEL_TYPE_TRACKED_DEVICE_LIST_SIZE = 16 , CS_MESH_MODEL_TYPE_STATE_SET = 17 , CS_MESH_MODEL_TYPE_RESULT = 18 , CS_MESH_MODEL_TYPE_SET_IBEACON_CONFIG_ID = 19 ,   CS_MESH_MODEL_TYPE_TRACKED_DEVICE_HEARTBEAT = 20 , CS_MESH_MODEL_TYPE_RSSI_PING , CS_MESH_MODEL_TYPE_TIME_SYNC = 22 , CS_MESH_MODEL_TYPE_RSSI_DATA ,   CS_MESH_MODEL_TYPE_STONE_MAC = 25 , CS_MESH_MODEL_TYPE_ASSET_FILTER_VERSION = 26 , CS_MESH_MODEL_TYPE_ASSET_INFO_MAC = 27 , CS_MESH_MODEL_TYPE_NEIGHBOUR_RSSI = 28 ,   CS_MESH_MODEL_TYPE_CTRL_CMD = 29 , CS_MESH_MODEL_TYPE_ASSET_INFO_ID = 30 , CS_MESH_MODEL_TYPE_MICROAPP = 200 , CS_MESH_MODEL_TYPE_UNKNOWN = 255 }

Variables
static constexpr uint8_t	MAX_MESH_MSG_SIZE = 3 * 12 - 4 - 3
	Max message size. More...
static constexpr uint8_t	MAX_MESH_MSG_NON_SEGMENTED_SIZE = 15 - 4 - 3
static constexpr uint8_t	MESH_HEADER_SIZE = 1
	Size of the header of each mesh model message. More...
static constexpr uint8_t	MAX_MESH_MSG_PAYLOAD_SIZE = MAX_MESH_MSG_NON_SEGMENTED_SIZE - MESH_HEADER_SIZE

Enumeration Type Documentation

cs_mesh_model_id_t

enum cs_mesh_model_id_t

Author: Crownstone Team Copyright: Crownstone (https://crownstone.rocks) Date: 7 May., 2019 License: LGPLv3+, Apache License 2.0, and/or MIT (triple-licensed)

Model IDs

Not sure if these are part of protocol, but it doesn't hurt to have them fixed.

Enumerator
CS_MESH_MODEL_ID_MULTICAST
CS_MESH_MODEL_ID_MULTICAST_ACKED
CS_MESH_MODEL_ID_UNICAST
CS_MESH_MODEL_ID_NEIGHBOURS

cs_mesh_model_msg_type_t

enum cs_mesh_model_msg_type_t

Enumerator
CS_MESH_MODEL_TYPE_TEST
CS_MESH_MODEL_TYPE_ACK
CS_MESH_MODEL_TYPE_CMD_TIME
CS_MESH_MODEL_TYPE_CMD_NOOP
CS_MESH_MODEL_TYPE_CMD_MULTI_SWITCH
CS_MESH_MODEL_TYPE_STATE_0
CS_MESH_MODEL_TYPE_STATE_1
CS_MESH_MODEL_TYPE_PROFILE_LOCATION
CS_MESH_MODEL_TYPE_SET_BEHAVIOUR_SETTINGS
CS_MESH_MODEL_TYPE_TRACKED_DEVICE_REGISTER
CS_MESH_MODEL_TYPE_TRACKED_DEVICE_TOKEN
CS_MESH_MODEL_TYPE_SYNC_REQUEST
CS_MESH_MODEL_TYPE_TRACKED_DEVICE_LIST_SIZE
CS_MESH_MODEL_TYPE_STATE_SET
CS_MESH_MODEL_TYPE_RESULT
CS_MESH_MODEL_TYPE_SET_IBEACON_CONFIG_ID
CS_MESH_MODEL_TYPE_TRACKED_DEVICE_HEARTBEAT
CS_MESH_MODEL_TYPE_RSSI_PING
CS_MESH_MODEL_TYPE_TIME_SYNC
CS_MESH_MODEL_TYPE_RSSI_DATA
CS_MESH_MODEL_TYPE_STONE_MAC
CS_MESH_MODEL_TYPE_ASSET_FILTER_VERSION
CS_MESH_MODEL_TYPE_ASSET_INFO_MAC
CS_MESH_MODEL_TYPE_NEIGHBOUR_RSSI
CS_MESH_MODEL_TYPE_CTRL_CMD
CS_MESH_MODEL_TYPE_ASSET_INFO_ID
CS_MESH_MODEL_TYPE_MICROAPP
CS_MESH_MODEL_TYPE_UNKNOWN

cs_mesh_model_opcode_t

enum cs_mesh_model_opcode_t

Message opcodes.

Must be in the range 0xC0 - 0xFF See access_opcode_t

Enumerator
CS_MESH_MODEL_OPCODE_MSG
CS_MESH_MODEL_OPCODE_UNICAST_RELIABLE_MSG
CS_MESH_MODEL_OPCODE_UNICAST_REPLY
CS_MESH_MODEL_OPCODE_MULTICAST_RELIABLE_MSG
CS_MESH_MODEL_OPCODE_MULTICAST_REPLY
CS_MESH_MODEL_OPCODE_MULTICAST_NEIGHBOURS

Variable Documentation

MAX_MESH_MSG_NON_SEGMENTED_SIZE

constexpr uint8_t MAX_MESH_MSG_NON_SEGMENTED_SIZE = 15 - 4 - 3

staticconstexpr

MAX_MESH_MSG_PAYLOAD_SIZE

constexpr uint8_t MAX_MESH_MSG_PAYLOAD_SIZE = MAX_MESH_MSG_NON_SEGMENTED_SIZE - MESH_HEADER_SIZE

staticconstexpr

MAX_MESH_MSG_SIZE

constexpr uint8_t MAX_MESH_MSG_SIZE = 3 * 12 - 4 - 3

staticconstexpr

Max message size.

When you send packets that are longer than 15 bytes (including opCode of 1-3B, and MIC of 4 or 8B), they will be sent as segmented packets of 12 byte each. See https://devzone.nordicsemi.com/f/nordic-q-a/32854/max-size-of-data-to-send-from-one-node-to-other-ble-mesh The minimum advertising interval that mesh are using now is 20ms, so each advertisement / segment, takes 20ms.

MESH_HEADER_SIZE

constexpr uint8_t MESH_HEADER_SIZE = 1

staticconstexpr

Size of the header of each mesh model message.

1B for the message type.