nRF5 SDK for Mesh v5.0.0
pb_remote_msgs.h
1 /* Copyright (c) 2010 - 2020, Nordic Semiconductor ASA
2  * All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without modification,
5  * are permitted provided that the following conditions are met:
6  *
7  * 1. Redistributions of source code must retain the above copyright notice, this
8  * list of conditions and the following disclaimer.
9  *
10  * 2. Redistributions in binary form, except as embedded into a Nordic
11  * Semiconductor ASA integrated circuit in a product or a software update for
12  * such product, must reproduce the above copyright notice, this list of
13  * conditions and the following disclaimer in the documentation and/or other
14  * materials provided with the distribution.
15  *
16  * 3. Neither the name of Nordic Semiconductor ASA nor the names of its
17  * contributors may be used to endorse or promote products derived from this
18  * software without specific prior written permission.
19  *
20  * 4. This software, with or without modification, must only be used with a
21  * Nordic Semiconductor ASA integrated circuit.
22  *
23  * 5. Any software provided in binary form under this license must not be reverse
24  * engineered, decompiled, modified and/or disassembled.
25  *
26  * THIS SOFTWARE IS PROVIDED BY NORDIC SEMICONDUCTOR ASA "AS IS" AND ANY EXPRESS
27  * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
28  * OF MERCHANTABILITY, NONINFRINGEMENT, AND FITNESS FOR A PARTICULAR PURPOSE ARE
29  * DISCLAIMED. IN NO EVENT SHALL NORDIC SEMICONDUCTOR ASA OR CONTRIBUTORS BE
30  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
31  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
32  * GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
33  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
34  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
35  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
36  */
37 
38 #ifndef PB_REMOTE_MSGS_H__
39 #define PB_REMOTE_MSGS_H__
40 
41 #include <stdint.h>
42 #include "nrf_mesh_defines.h"
43 #include "prov_pdu.h"
44 
55 #define BEARER_LINK_REASON_NOT_SUPPORTED (0xFF)
56 
63 typedef enum
64 {
126 
127 
131 typedef enum
132 {
138 
142 typedef enum
143 {
173 
177 typedef enum
178 {
187 
191 typedef enum
192 {
231 
235 typedef enum
236 {
242 
246 typedef enum
247 {
259 
263 typedef enum
264 {
270 
274 typedef enum
275 {
301 
302 /*lint -align_max(push) -align_max(1) */
303 
307 typedef struct __attribute((packed))
308 {
310  uint8_t filter_uuid[NRF_MESH_UUID_SIZE];
312 
316 typedef struct __attribute((packed))
317 {
319  uint8_t report_count;
321 
325 typedef struct __attribute((packed))
326 {
330 
334 typedef struct __attribute((packed))
335 {
337  uint8_t uuid[NRF_MESH_UUID_SIZE];
346 
350 typedef struct __attribute((packed))
351 {
353  uint8_t status;
357 
361 typedef struct __attribute((packed))
362 {
364  uint8_t status;
366 
370 typedef struct __attribute((packed))
371 {
373  uint8_t status;
375 
376 
380 typedef struct __attribute((packed))
381 {
383  uint8_t uuid[NRF_MESH_UUID_SIZE];
385 
389 typedef struct __attribute((packed))
390 {
392  uint8_t status;
394  uint8_t bearer_type;
396 
400 typedef struct __attribute((packed))
401 {
403  uint8_t reason;
405 
409 typedef struct __attribute((packed))
410 {
412  uint8_t status;
414  uint8_t reason;
416 
420 typedef struct __attribute((packed))
421 {
423  uint8_t buffer[PROV_PDU_MAX_LENGTH];
425 
429 typedef struct __attribute((packed))
430 {
435  uint8_t status;
437 
441 typedef struct __attribute((packed))
442 {
444  uint8_t status;
446 
447 /*lint -align_max(pop) */
450 #endif /* PB_REMOTE_MSGS_H__ */
The Provisioning Server closed the Local Provisioning bearer link.
Command to start scanning while reporting the number of unprovisioned devices nearby.
Remote Provisioning Packet Transfer Message.
Sent from the Server to the Client to indicate the state of the local packet transfer.
pb_remote_bearer_type_t
Remote Provisioning bearer type.
Report of the UUID and device ID of an unprovisioned device sent from the Server to the Client...
Remote Provisioning Packet Transfer Report Message.
Command to start scanning from the Client to the Server.
Report status rejected.
Remote Provisioning Scan UUID Number Report Message.
Remote Provisioning Scan Status Message.
pb_remote_link_status_t
Remote Link Status Codes.
The Provisioning Client received a message, but the message was not expected.
#define NRF_MESH_UUID_SIZE
Size (in octets) of a UUID.
Delivering the buffer to the unprovisioned device failed.
Status message sent as reply to a PB_REMOTE_OP_PACKET_TRANSFER or PB_REMOTE_OP_PACKET_TRANSFER_REPORT...
uint8_t report_count
Number of the reports sent before scan stop.
The whole buffer is accepted and the packet transfer is successfully completed.
The Remote Provisioning Packet Transfer Report message was receive, but the message was not expected...
Remote Provisioning Scan Stopped Message.
pb_remote_packet_transfer_status_t
Remote Provisioning Packet Transfer Status.
The Provisioning Client accepted that the Local Provisioning Bearer link was closed.
uint8_t unprov_device_id
ID of the provisioning Server slot where this device UUID is stored.
Remote Provisioning Scan Start with Filter Message.
Number of unprovisioned devices report.
uint8_t unprov_device_count
Number of elements in the provisioning server&#39;s unprovisioned device list.
The Server started the procedure to open the Local Provisioning Bearer link to the unprovisioned devi...
PB-GATT bearer type.
pb_remote_opcode_t
Remote provisioning opcodes.
pb_remote_packet_transfer_delivery_status_t
Remote Provisioning Packet Transfer Report Delivery Status.
The unprovisioned device closed the Local Provisioning bearer link.
pb_remote_scan_stopped_status_t
Remote Provisioning Scan Stopped Status Codes.
The Provisioning Client received a message, but the message was not expected.
Remote Provisioning Scan Report Status Message.
The Local Provisioning Bearer link cannot be opened because the Provisioning Server has already anoth...
The Provisioning Server does not have an active Local Provisioning Bearer link.
pb_remote_report_status_t
Remote Provisioning Report Status Codes.
The receiver accepted the Remote Provisioning Packet Transfer Report.
The Provisioning Server cannot cancel the scanning procedure due to internal state of the server: sca...
The Provisioning Server cannot start the scanning procedure due to internal state of the server...
The provided Unprovisioned Device ID in the Remote Provisioning Link Open message was invalid...
The Provisioning Client accepted that the Provisioning Server has stopped scanning.
The Unprovisioned Devices List is full and scanning cannot be continued.
The Local Provisioning Bearer link is opened.
The Local Provisioning Bearer link was closed.
Command to cancel scanning for unprovisioned devices from the Client to the Server.
The Local Provisioning Bearer link open procedure timed out.
uint8_t status
The status of the report.
Report status accepted.
pb_remote_link_status_report_t
Provisioning Bearer Link Status Report.
The Provisioning Server has stopped scanning upon reception of the Remote Provisioning Scan Cancel me...
Link status sent as a reply to the PB_REMOTE_OP_LINK_OPEN or PB_REMOTE_OP_LINK_CLOSE commands or as a...
The scanning was successfully started.
Command to open the local link from the Client to the Server.
uint8_t unprov_device_id
Unprovisioned Device ID of the reported device.
Acknowledgment message from the Server that the scanning was stopped.
pb_remote_scan_status_t
Remote Provisioning Scan Status Codes.
Command to close the local link from the Client to the Server.
uint8_t status
The status of the scan.
Message used by the Client to acknowledge the scan reports.
Remote Provisioning Scan UUID Report.
Sent as a reply to the Remote Provisioning Packet Transfer when the packet transfer cannot be accepte...
Remote Provisioning Packet Transport Status Message.
Remote Provisioning Scan Unprovisioned Device Number Message.
uint8_t status
Status of the scan.
The Server cannot close the Local Provisioning Bearer link beacause the Client that requested the lin...
PB-ADV bearer type.
The scanning has reached timeout.
Provisioning PDU from the Remote Client/Server.
The buffer was successfully delivered to the unprovisioned device.
uint8_t status
Status of the packet transfer.
uint8_t status
Status of the buffer delivery.
The link between the Provisioning Server and the unprovisioned device was not active upon reception o...
Command to start scanning with a filter from the Client to the Server.

Documentation feedback | Developer Zone | Subscribe | Updated