nRF5 SDK for Mesh v5.0.0
generic_onoff_mc.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 GENERIC_ONOFF_MC_H__
39 #define GENERIC_ONOFF_MC_H__
40 
41 #include <stdint.h>
42 
43 #include "generic_onoff_common.h"
44 #include "mesh_config.h"
45 #include "mesh_opt.h"
46 #include "nrf_mesh_assert.h"
47 #include "model_config_file.h"
48 
49 #if (SCENE_SETUP_SERVER_INSTANCES_MAX > 0) || (DOXYGEN)
50 #include "scene_common.h"
51 #endif
52 
66 #if (SCENE_SETUP_SERVER_INSTANCES_MAX > 0) || (DOXYGEN)
67 #define GENERIC_ONOFF_SERVER_STORED_WITH_SCENE_STATES (GENERIC_ONOFF_SERVER_INSTANCES_MAX + \
68  (SCENE_REGISTER_ARRAY_SIZE * GENERIC_ONOFF_SERVER_INSTANCES_MAX))
69 #else
70 #define GENERIC_ONOFF_SERVER_STORED_WITH_SCENE_STATES \
71  (GENERIC_ONOFF_SERVER_INSTANCES_MAX)
72 #endif
73 
74 #define GENERIC_ONOFF_EID_START (MESH_APP_MODEL_GENERIC_ONOFF_ID_START)
75 #define GENERIC_ONOFF_EID_END (GENERIC_ONOFF_EID_START + GENERIC_ONOFF_SERVER_STORED_WITH_SCENE_STATES - 1)
76 
78 
80 #define GENERIC_ONOFF_EID MESH_CONFIG_ENTRY_ID(MESH_OPT_MODEL_FILE_ID, GENERIC_ONOFF_EID_START)
81 
91 uint32_t generic_onoff_mc_onoff_state_set(uint8_t index, bool value);
92 
103 uint32_t generic_onoff_mc_onoff_state_get(uint8_t index, bool * p_value);
104 
105 #if (SCENE_SETUP_SERVER_INSTANCES_MAX > 0) || (DOXYGEN)
106 
118 uint32_t generic_onoff_mc_scene_onoff_store(uint8_t index, uint8_t scene_index, bool value);
119 
131 uint32_t generic_onoff_mc_scene_onoff_recall(uint8_t index, uint8_t scene_index, bool * p_value);
132 
133 #endif /* (SCENE_SETUP_SERVER_INSTANCES_MAX > 0) || (DOXYGEN) */
134 
145 uint32_t generic_onoff_mc_open(uint8_t * p_handle);
146 
150 void generic_onoff_mc_clear(void);
151 
155 void generic_onoff_mc_init(void);
156 
159 #endif /* GENERIC_ONOFF_MC_H__ */
void generic_onoff_mc_clear(void)
Clear all stored data and reset state contexts to default values.
uint32_t generic_onoff_mc_open(uint8_t *p_handle)
Create an instance of the Generic OnOff Server model states and return the corresponding handle...
uint32_t generic_onoff_mc_scene_onoff_store(uint8_t index, uint8_t scene_index, bool value)
Stores the given OnOff value for the specific scene index.
uint32_t generic_onoff_mc_scene_onoff_recall(uint8_t index, uint8_t scene_index, bool *p_value)
Restores the given OnOff value for the specific scene index.
uint32_t generic_onoff_mc_onoff_state_set(uint8_t index, bool value)
Set internal OnOff state variable.
void generic_onoff_mc_init(void)
Initialize the Generic OnOff Server persistent memory.
uint32_t generic_onoff_mc_onoff_state_get(uint8_t index, bool *p_value)
Get internal OnOff state variable.
#define NRF_MESH_STATIC_ASSERT(...)
Compile-time assertion.
#define MESH_APP_MODEL_GENERIC_ONOFF_ID_END
End of Generic OnOff Server record entry IDs.

Documentation feedback | Developer Zone | Subscribe | Updated