nRF5 SDK for Mesh v5.0.0
nrf_mesh_opt.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 NRF_MESH_OPT_H_
39 #define NRF_MESH_OPT_H_
40 
41 #include <stdint.h>
42 #include "toolchain.h"
43 
51 #define NRF_MESH_OPT_PROV_START 200
52 
53 #define NRF_MESH_OPT_TRS_START 300
54 
55 #define NRF_MESH_OPT_NET_START 400
56 
63 typedef enum
64 {
98 
99 
103 typedef struct
104 {
106  uint32_t len;
108  union
109  {
111  uint32_t val;
113  uint8_t * p_array;
114  } opt;
116 
127 _DEPRECATED uint32_t nrf_mesh_opt_set(nrf_mesh_opt_id_t id, const nrf_mesh_opt_t * const p_opt);
128 
139 _DEPRECATED uint32_t nrf_mesh_opt_get(nrf_mesh_opt_id_t id, nrf_mesh_opt_t * const p_opt);
140 
142 #endif
uint8_t * p_array
Byte array.
Definition: nrf_mesh_opt.h:113
uint32_t len
Length of opt field (for future compatibility).
Definition: nrf_mesh_opt.h:106
Number of retransmits per relayed packet.
Definition: nrf_mesh_opt.h:86
_DEPRECATED uint32_t nrf_mesh_opt_get(nrf_mesh_opt_id_t id, nrf_mesh_opt_t *const p_opt)
Function for getting various nRF Mesh options.
Options structure.
Definition: nrf_mesh_opt.h:103
#define NRF_MESH_OPT_PROV_START
Start of provisioning parameters.
Definition: nrf_mesh_opt.h:51
Base transport SAR RX ack timeout.
Definition: nrf_mesh_opt.h:70
Number of retransmits per network packet originating from this device.
Definition: nrf_mesh_opt.h:92
TX power for packets originating from this device.
Definition: nrf_mesh_opt.h:96
SAR RX ack timeout addition per hop.
Definition: nrf_mesh_opt.h:72
Enable (1) / disable (0) ECDH offloading in provisioning.
Definition: nrf_mesh_opt.h:66
Transport SAR RX timeout.
Definition: nrf_mesh_opt.h:68
Packet relaying enabled (1) or disabled (0).
Definition: nrf_mesh_opt.h:84
32-bit (NRF_MESH_TRANSMIC_SIZE_SMALL) or 64-bit (NRF_MESH_TRANSMIC_SIZE_LARGE) MIC size for transport...
Definition: nrf_mesh_opt.h:82
uint32_t val
Unsigned 32-bit value.
Definition: nrf_mesh_opt.h:111
Relay retransmit interval in milliseconds.
Definition: nrf_mesh_opt.h:88
#define NRF_MESH_OPT_NET_START
Start of network layer parameters.
Definition: nrf_mesh_opt.h:55
_DEPRECATED uint32_t nrf_mesh_opt_set(nrf_mesh_opt_id_t id, const nrf_mesh_opt_t *const p_opt)
Function for setting various nRF Mesh options.
Number of retries before cancelling a SAR session.
Definition: nrf_mesh_opt.h:78
Default TTL value for segment acknowledgement messages.
Definition: nrf_mesh_opt.h:80
#define NRF_MESH_OPT_TRS_START
Start of transport layer parameters.
Definition: nrf_mesh_opt.h:53
nrf_mesh_opt_id_t
Option ID type.
Definition: nrf_mesh_opt.h:63
Interval between retransmitted packets originating from this device in milliseconds.
Definition: nrf_mesh_opt.h:94

Documentation feedback | Developer Zone | Subscribe | Updated