nRF5 SDK for Mesh v4.0.0
mesh_provisionee.h
1 /* Copyright (c) 2010 - 2019, 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 MESH_PROVISIONEE_H__
39 #define MESH_PROVISIONEE_H__
40 
41 #include <stdint.h>
42 #include <stdbool.h>
43 
58 
71 typedef void (*mesh_provisionee_prov_device_identification_start)(uint8_t attention_duration_s);
72 
81 
90 typedef void (*mesh_provisionee_prov_abort)(void);
91 
99 typedef struct
100 {
111 
117 
123 
129 
135  const char * p_device_uri;
136 
141  const uint8_t * p_static_data;
142 
144 
156 uint32_t mesh_provisionee_prov_start(const mesh_provisionee_start_params_t * p_start_params);
157 
164 uint32_t mesh_provisionee_prov_listen_stop(void);
165 
170 #endif /* MESH_PROVISIONEE_H__ */
mesh_provisionee_prov_device_identification_stop prov_device_identification_stop_cb
Pointer to a function used to signal the device to stop identifying itself.
mesh_provisionee_prov_complete_cb_t prov_complete_cb
Pointer to a function used to signal the completion of the device provisioning procedure.
void(* mesh_provisionee_prov_complete_cb_t)(void)
Provisioning complete callback type.
void(* mesh_provisionee_prov_device_identification_stop)(void)
Stop device identification callback type.
mesh_provisionee_prov_abort prov_abort_cb
Pointer to a function used to signal the abort of the device provisioning procedure.
uint32_t mesh_provisionee_prov_start(const mesh_provisionee_start_params_t *p_start_params)
Start the provisioning process for a device in the provisionee role using static OOB authentication...
void(* mesh_provisionee_prov_abort)(void)
Provisioning abort callback type.
mesh_provisionee_prov_device_identification_start prov_device_identification_start_cb
Pointer to a function used to signal the device to start identifying itself.
uint32_t mesh_provisionee_prov_listen_stop(void)
Stops listening for incoming provisioning links.
const uint8_t * p_static_data
Data used for static OOB authentication.
const char * p_device_uri
NULL-terminated device URI string.
void(* mesh_provisionee_prov_device_identification_start)(uint8_t attention_duration_s)
Start device identification callback type.
Mesh stack configuration parameters.

Documentation feedback | Developer Zone | Subscribe | Updated