Provisioning over Mesh (PB-remote) Messages

Data Structures
struct	pb_remote_msg_scan_start_filter_t
	Remote Provisioning Scan Start with Filter Message. More...
struct	pb_remote_msg_scan_unprov_device_number_t
	Remote Provisioning Scan Unprovisioned Device Number Message. More...
struct	pb_remote_msg_scan_unprov_device_number_report_t
	Remote Provisioning Scan UUID Number Report Message. More...
struct	pb_remote_msg_scan_uuid_report_t
	Remote Provisioning Scan UUID Report. More...
struct	pb_remote_msg_scan_report_status_t
	Remote Provisioning Scan Report Status Message. More...
struct	pb_remote_msg_scan_status_t
	Remote Provisioning Scan Status Message. More...
struct	pb_remote_msg_scan_stopped_t
	Remote Provisioning Scan Stopped Message. More...
struct	pb_remote_msg_link_open_t
	Remote Provisioning Link Open Message. More...
struct	pb_remote_msg_link_status_t
	Remote Provisioning Link Status Message. More...
struct	pb_remote_msg_link_close_t
	Remote Prvisioning Link Close Message. More...
struct	pb_remote_msg_link_status_report_t
	Remote Provisioning Link Status Report Message. More...
struct	pb_remote_msg_packet_transfer_t
	Remote Provisioning Packet Transfer Message. More...
struct	pb_remote_msg_packet_transfer_report_t
	Remote Provisioning Packet Transfer Report Message. More...
struct	pb_remote_msg_packet_transfer_status_t
	Remote Provisioning Packet Transport Status Message. More...

Macros
#define	BEARER_LINK_REASON_NOT_SUPPORTED   (0xFF)
	Reason code not supported. More...

Enumerations
enum	pb_remote_opcode_t {   PB_REMOTE_OP_PACKET_TRANSFER_REPORT = 0x11, PB_REMOTE_OP_PACKET_TRANSFER = 0x12, PB_REMOTE_OP_PACKET_TRANSFER_STATUS = 0x8060, PB_REMOTE_OP_LINK_CLOSE = 0x8061,   PB_REMOTE_OP_LINK_OPEN = 0x8062, PB_REMOTE_OP_LINK_STATUS = 0x8063, PB_REMOTE_OP_SCAN_CANCEL = 0x8064, PB_REMOTE_OP_SCAN_START = 0x8065,   PB_REMOTE_OP_SCAN_START_FILTER = 0x8066, PB_REMOTE_OP_SCAN_STATUS = 0x8067, PB_REMOTE_OP_SCAN_UNPROVISIONED_DEVICE_NUMBER = 0x8068, PB_REMOTE_OP_SCAN_UUID_REPORT = 0x806A,   PB_REMOTE_OP_SCAN_UUID_NUMBER_REPORT = 0x806B, PB_REMOTE_OP_LINK_STATUS_REPORT = 0x806C, PB_REMOTE_OP_SCAN_REPORT_STATUS = 0x806D, PB_REMOTE_OP_SCAN_STOPPED = 0x806E }
	Remote provisioning opcodes. More...
enum	pb_remote_report_status_t { PB_REMOTE_REPORT_STATUS_ACCEPTED = 0x00, PB_REMOTE_REPORT_STATUS_REJECTED = 0x01 }
	Remote Provisioning Report Status Codes. More...
enum	pb_remote_scan_status_t {   PB_REMOTE_SCAN_STATUS_STARTED = 0x00, PB_REMOTE_SCAN_STATUS_CANCELED = 0x01, PB_REMOTE_SCAN_STATUS_CANNOT_START_SCANNING = 0x02, PB_REMOTE_SCAN_STATUS_CANNOT_CANCEL_SCANNING = 0x03,   PB_REMOTE_SCAN_STATUS_ACCEPTED = 0x04, PB_REMOTE_SCAN_STATUS_REJECTED = 0x05 }
	Remote Provisioning Scan Status Codes. More...
enum	pb_remote_scan_stopped_status_t { PB_REMOTE_SCAN_STOPPED_OUT_OF_RESOURCES = 0x01, PB_REMOTE_SCAN_STOPPED_TIMEOUT = 0x02 }
	Remote Provisioning Scan Stopped Status Codes. More...
enum	pb_remote_link_status_t {   PB_REMOTE_REMOTE_LINK_STATUS_OPENING = 0x00, PB_REMOTE_REMOTE_LINK_STATUS_ALREADY_OPEN = 0x01, PB_REMOTE_REMOTE_LINK_STATUS_CANNOT_CLOSE = 0x02, PB_REMOTE_REMOTE_LINK_STATUS_LINK_NOT_ACTIVE = 0x03,   PB_REMOTE_REMOTE_LINK_STATUS_INVALID_UNPROV_DEVICE_ID = 0x04, PB_REMOTE_REMOTE_LINK_STATUS_ACCEPTED = 0x05, PB_REMOTE_REMOTE_LINK_STATUS_REJECTED = 0x06 }
	Remote Link Status Codes. More...
enum	pb_remote_bearer_type_t { PB_REMOTE_BEARER_TYPE_PB_ADV = 0x00, PB_REMOTE_BEARER_TYPE_PB_GATT = 0x01 }
	Remote Provisioning bearer type. More...
enum	pb_remote_link_status_report_t {   PB_REMOTE_LINK_STATUS_REPORT_OPENED = 0x00, PB_REMOTE_LINK_STATUS_REPORT_OPEN_TIMEOUT = 0x01, PB_REMOTE_LINK_STATUS_REPORT_CLOSED = 0x02, PB_REMOTE_LINK_STATUS_REPORT_CLOSED_BY_DEVICE = 0x03,   PB_REMOTE_LINK_STATUS_REPORT_CLOSED_BY_SERVER = 0x04 }
	Provisioning Bearer Link Status Report. More...
enum	pb_remote_packet_transfer_delivery_status_t { PB_REMOTE_PACKET_TRANSFER_DELIVERY_STATUS_DELIVERED = 0x00, PB_REMOTE_PACKET_TRANSFER_DELIVERY_STATUS_NOT_DELIVERED = 0x01 }
	Remote Provisioning Packet Transfer Report Delivery Status. More...
enum	pb_remote_packet_transfer_status_t {   PB_REMOTE_PACKET_TRANSFER_STATUS_BUFFER_ACCEPTED = 0x00, PB_REMOTE_PACKET_TRANSFER_STATUS_LINK_NOT_ACTIVE = 0x01, PB_REMOTE_PACKET_TRANSFER_STATUS_CANNOT_ACCEPT_BUFFER = 0x02, PB_REMOTE_PACKET_TRANSFER_STATUS_ACCEPTED = 0x03,   PB_REMOTE_PACKET_TRANSFER_STATUS_REJECTED = 0x04 }
	Remote Provisioning Packet Transfer Status. More...

Detailed Description

Some of them are not consistent. E.g., scan_status and status. Fix that.

Macro Definition Documentation

BEARER_LINK_REASON_NOT_SUPPORTED

#define BEARER_LINK_REASON_NOT_SUPPORTED   (0xFF)

Reason code not supported.

Definition at line 55 of file pb_remote_msgs.h.

Enumeration Type Documentation

pb_remote_opcode_t

enum pb_remote_opcode_t

Remote provisioning opcodes.

Enumerator
PB_REMOTE_OP_PACKET_TRANSFER_REPORT	Sent from the Server to the Client to indicate the state of the local packet transfer. Is acknowledged with a PB_REMOTE_OP_PACKET_TRANSFER_STATUS.
PB_REMOTE_OP_PACKET_TRANSFER	Provisioning PDU from the Remote Client/Server.
PB_REMOTE_OP_PACKET_TRANSFER_STATUS	Status message sent as reply to a PB_REMOTE_OP_PACKET_TRANSFER or PB_REMOTE_OP_PACKET_TRANSFER_REPORT.
PB_REMOTE_OP_LINK_CLOSE	Command to close the local link from the Client to the Server.
PB_REMOTE_OP_LINK_OPEN	Command to open the local link from the Client to the Server.
PB_REMOTE_OP_LINK_STATUS	Link status sent as a reply to the PB_REMOTE_OP_LINK_OPEN or PB_REMOTE_OP_LINK_CLOSE commands or as an acknowledgment of the PB_REMOTE_OP_LINK_STATUS_REPORT.
PB_REMOTE_OP_SCAN_CANCEL	Command to cancel scanning for unprovisioned devices from the Client to the Server.
PB_REMOTE_OP_SCAN_START	Command to start scanning from the Client to the Server.
PB_REMOTE_OP_SCAN_START_FILTER	Command to start scanning with a filter from the Client to the Server.
PB_REMOTE_OP_SCAN_STATUS	Scan status. Used to acknowledge the PB_REMOTE_OP_SCAN_START, PB_REMOTE_OP_SCAN_START_FILTER, PB_REMOTE_OP_SCAN_UNPROVISIONED_DEVICE_NUMBER and PB_REMOTE_OP_SCAN_CANCEL commands.
PB_REMOTE_OP_SCAN_UNPROVISIONED_DEVICE_NUMBER	Command to start scanning while reporting the number of unprovisioned devices nearby.
PB_REMOTE_OP_SCAN_UUID_REPORT	Report of the UUID and device ID of an unprovisioned device sent from the Server to the Client.
PB_REMOTE_OP_SCAN_UUID_NUMBER_REPORT	Number of unprovisioned devices report.
PB_REMOTE_OP_LINK_STATUS_REPORT	Link status report. A reliable message used to indicate to the Client that the state of the Local provisioning link has changed.
PB_REMOTE_OP_SCAN_REPORT_STATUS	Message used by the Client to acknowledge the scan reports.
PB_REMOTE_OP_SCAN_STOPPED	Acknowledgment message from the Server that the scanning was stopped.

Definition at line 63 of file pb_remote_msgs.h.

pb_remote_report_status_t

enum pb_remote_report_status_t

Remote Provisioning Report Status Codes.

Enumerator
PB_REMOTE_REPORT_STATUS_ACCEPTED	Report status accepted. pb_remote_msg_scan_report_status_t.
PB_REMOTE_REPORT_STATUS_REJECTED	Report status rejected. pb_remote_msg_scan_report_status_t.

Definition at line 131 of file pb_remote_msgs.h.

pb_remote_scan_status_t

enum pb_remote_scan_status_t

Remote Provisioning Scan Status Codes.

Enumerator
PB_REMOTE_SCAN_STATUS_STARTED	The scanning was successfully started.
PB_REMOTE_SCAN_STATUS_CANCELED	The Provisioning Server has stopped scanning upon reception of the Remote Provisioning Scan Cancel message.
PB_REMOTE_SCAN_STATUS_CANNOT_START_SCANNING	The Provisioning Server cannot start the scanning procedure due to internal state of the server.
PB_REMOTE_SCAN_STATUS_CANNOT_CANCEL_SCANNING	The Provisioning Server cannot cancel the scanning procedure due to internal state of the server: scanning procedure is not running or scanning was started by a different client.
PB_REMOTE_SCAN_STATUS_ACCEPTED	The Provisioning Client accepted that the Provisioning Server has stopped scanning.
PB_REMOTE_SCAN_STATUS_REJECTED	The Provisioning Client received a message, but the message was not expected.

Definition at line 142 of file pb_remote_msgs.h.

pb_remote_scan_stopped_status_t

enum pb_remote_scan_stopped_status_t

Remote Provisioning Scan Stopped Status Codes.

Enumerator
PB_REMOTE_SCAN_STOPPED_OUT_OF_RESOURCES	The Unprovisioned Devices List is full and scanning cannot be continued.
PB_REMOTE_SCAN_STOPPED_TIMEOUT	The scanning has reached timeout.

Definition at line 177 of file pb_remote_msgs.h.

pb_remote_link_status_t

enum pb_remote_link_status_t

Remote Link Status Codes.

Enumerator
PB_REMOTE_REMOTE_LINK_STATUS_OPENING	The Server started the procedure to open the Local Provisioning Bearer link to the unprovisioned device.
PB_REMOTE_REMOTE_LINK_STATUS_ALREADY_OPEN	The Local Provisioning Bearer link cannot be opened because the Provisioning Server has already another active Local Provisioning Bearer link opened.
PB_REMOTE_REMOTE_LINK_STATUS_CANNOT_CLOSE	The Server cannot close the Local Provisioning Bearer link beacause the Client that requested the link to be closed is different than the Client that opened it.
PB_REMOTE_REMOTE_LINK_STATUS_LINK_NOT_ACTIVE	The link between the Provisioning Server and the unprovisioned device was not active upon reception of the Link Close message.
PB_REMOTE_REMOTE_LINK_STATUS_INVALID_UNPROV_DEVICE_ID	The provided Unprovisioned Device ID in the Remote Provisioning Link Open message was invalid.
PB_REMOTE_REMOTE_LINK_STATUS_ACCEPTED	The Provisioning Client accepted that the Local Provisioning Bearer link was closed.
PB_REMOTE_REMOTE_LINK_STATUS_REJECTED	The Provisioning Client received a message, but the message was not expected.

Definition at line 191 of file pb_remote_msgs.h.

pb_remote_bearer_type_t

enum pb_remote_bearer_type_t

Remote Provisioning bearer type.

Enumerator
PB_REMOTE_BEARER_TYPE_PB_ADV	PB-ADV bearer type.
PB_REMOTE_BEARER_TYPE_PB_GATT	PB-GATT bearer type.

Definition at line 235 of file pb_remote_msgs.h.

pb_remote_link_status_report_t

enum pb_remote_link_status_report_t

Provisioning Bearer Link Status Report.

Enumerator
PB_REMOTE_LINK_STATUS_REPORT_OPENED	The Local Provisioning Bearer link is opened.
PB_REMOTE_LINK_STATUS_REPORT_OPEN_TIMEOUT	The Local Provisioning Bearer link open procedure timed out.
PB_REMOTE_LINK_STATUS_REPORT_CLOSED	The Local Provisioning Bearer link was closed.
PB_REMOTE_LINK_STATUS_REPORT_CLOSED_BY_DEVICE	The unprovisioned device closed the Local Provisioning bearer link.
PB_REMOTE_LINK_STATUS_REPORT_CLOSED_BY_SERVER	The Provisioning Server closed the Local Provisioning bearer link.

Definition at line 246 of file pb_remote_msgs.h.

pb_remote_packet_transfer_delivery_status_t

enum pb_remote_packet_transfer_delivery_status_t

Remote Provisioning Packet Transfer Report Delivery Status.

Enumerator
PB_REMOTE_PACKET_TRANSFER_DELIVERY_STATUS_DELIVERED	The buffer was successfully delivered to the unprovisioned device.
PB_REMOTE_PACKET_TRANSFER_DELIVERY_STATUS_NOT_DELIVERED	Delivering the buffer to the unprovisioned device failed.

Definition at line 263 of file pb_remote_msgs.h.

pb_remote_packet_transfer_status_t

enum pb_remote_packet_transfer_status_t

Remote Provisioning Packet Transfer Status.

Enumerator
PB_REMOTE_PACKET_TRANSFER_STATUS_BUFFER_ACCEPTED	The whole buffer is accepted and the packet transfer is successfully completed.
PB_REMOTE_PACKET_TRANSFER_STATUS_LINK_NOT_ACTIVE	The Provisioning Server does not have an active Local Provisioning Bearer link.
PB_REMOTE_PACKET_TRANSFER_STATUS_CANNOT_ACCEPT_BUFFER	Sent as a reply to the Remote Provisioning Packet Transfer when the packet transfer cannot be accepted.
PB_REMOTE_PACKET_TRANSFER_STATUS_ACCEPTED	The receiver accepted the Remote Provisioning Packet Transfer Report.
PB_REMOTE_PACKET_TRANSFER_STATUS_REJECTED	The Remote Provisioning Packet Transfer Report message was receive, but the message was not expected.

Definition at line 274 of file pb_remote_msgs.h.