nRF5 SDK for Mesh v5.0.0
mesh_config.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 #ifndef MESH_CONFIG_H__
38 #define MESH_CONFIG_H__
39 
40 #include <stdint.h>
41 #include <stdbool.h>
42 #include "mesh_config_entry.h"
43 
53 typedef enum
54 {
59 
63 void mesh_config_init(void);
64 
72 void mesh_config_load(void);
73 
84 void mesh_config_clear(void);
85 
92 void mesh_config_power_down(void);
93 
99 bool mesh_config_is_busy(void);
100 
114 uint32_t mesh_config_power_down_time_get(void);
115 
127 void mesh_config_file_clear(uint16_t file_id);
128 
131 #endif /* MESH_CONFIG_H__ */
The state owner rejected the data.
Definition: mesh_config.h:56
uint32_t mesh_config_power_down_time_get(void)
Calculate the longest time required to store all power down state.
The loaded entry was shorter than specified by the state owner.
Definition: mesh_config.h:55
void mesh_config_power_down(void)
Store all power-down state.
void mesh_config_init(void)
Initialize the configuration module.
void mesh_config_load(void)
Load all configuration data from persistent storage.
The loaded ID was unknown to the configuration.
Definition: mesh_config.h:57
mesh_config_load_failure_t
Definition: mesh_config.h:53
bool mesh_config_is_busy(void)
Check whether the configuration is waiting for an operation to finish.
void mesh_config_file_clear(uint16_t file_id)
Clean up the file area.
void mesh_config_clear(void)
Clear all configuration data.

Documentation feedback | Developer Zone | Subscribe | Updated