nRF5 SDK for Mesh v5.0.0
light_lc_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 LIGHT_LC_MC_H__
39 #define LIGHT_LC_MC_H__
40 
41 #include <stdint.h>
42 
43 #include "light_lc_common.h"
44 #include "mesh_config.h"
45 #include "mesh_opt.h"
46 #include "model_config_file.h"
47 
48 #if (SCENE_SETUP_SERVER_INSTANCES_MAX > 0) || (DOXYGEN)
49 #include "scene_common.h"
50 #endif
51 
65 #if (SCENE_SETUP_SERVER_INSTANCES_MAX > 0) || (DOXYGEN)
66 #define LIGHT_LC_SETUP_SERVER_STORED_WITH_SCENE_STATES \
67  (LIGHT_LC_SETUP_SERVER_INSTANCES_MAX + (SCENE_REGISTER_ARRAY_SIZE * LIGHT_LC_SETUP_SERVER_INSTANCES_MAX))
68 #else
69 #define LIGHT_LC_SETUP_SERVER_STORED_WITH_SCENE_STATES \
70  (LIGHT_LC_SETUP_SERVER_INSTANCES_MAX)
71 #endif
72 
73 #define LIGHT_LC_MODE_EID_START (MESH_APP_MODEL_LIGHT_LC_SERVER_ID_START)
74 #define LIGHT_LC_OCC_MODE_EID_START (LIGHT_LC_MODE_EID_START + LIGHT_LC_SETUP_SERVER_STORED_WITH_SCENE_STATES)
75 #define LIGHT_LC_LIGHT_ONOFF_EID_START (LIGHT_LC_OCC_MODE_EID_START + LIGHT_LC_SETUP_SERVER_STORED_WITH_SCENE_STATES)
76 #define LIGHT_LC_PR_LUXLEVEL_ON_EID_START (LIGHT_LC_LIGHT_ONOFF_EID_START + LIGHT_LC_SETUP_SERVER_STORED_WITH_SCENE_STATES)
77 #define LIGHT_LC_PR_LUXLEVEL_PROLONG_EID_START (LIGHT_LC_PR_LUXLEVEL_ON_EID_START + LIGHT_LC_SETUP_SERVER_STORED_WITH_SCENE_STATES)
78 #define LIGHT_LC_PR_LUXLEVEL_STANDBY_EID_START (LIGHT_LC_PR_LUXLEVEL_PROLONG_EID_START + LIGHT_LC_SETUP_SERVER_STORED_WITH_SCENE_STATES)
79 #define LIGHT_LC_PR_LIGHTNESS_ON_EID_START (LIGHT_LC_PR_LUXLEVEL_STANDBY_EID_START + LIGHT_LC_SETUP_SERVER_STORED_WITH_SCENE_STATES)
80 #define LIGHT_LC_PR_LIGHTNESS_PROLONG_EID_START (LIGHT_LC_PR_LIGHTNESS_ON_EID_START + LIGHT_LC_SETUP_SERVER_STORED_WITH_SCENE_STATES)
81 #define LIGHT_LC_PR_LIGHTNESS_STANDBY_EID_START (LIGHT_LC_PR_LIGHTNESS_PROLONG_EID_START + LIGHT_LC_SETUP_SERVER_STORED_WITH_SCENE_STATES)
82 #define LIGHT_LC_PR_REGULATOR_ACCURACY_EID_START (LIGHT_LC_PR_LIGHTNESS_STANDBY_EID_START + LIGHT_LC_SETUP_SERVER_STORED_WITH_SCENE_STATES)
83 #define LIGHT_LC_PR_REGULATOR_KID_EID_START (LIGHT_LC_PR_REGULATOR_ACCURACY_EID_START + LIGHT_LC_SETUP_SERVER_STORED_WITH_SCENE_STATES)
84 #define LIGHT_LC_PR_REGULATOR_KIU_EID_START (LIGHT_LC_PR_REGULATOR_KID_EID_START + LIGHT_LC_SETUP_SERVER_STORED_WITH_SCENE_STATES)
85 #define LIGHT_LC_PR_REGULATOR_KPD_EID_START (LIGHT_LC_PR_REGULATOR_KIU_EID_START + LIGHT_LC_SETUP_SERVER_STORED_WITH_SCENE_STATES)
86 #define LIGHT_LC_PR_REGULATOR_KPU_EID_START (LIGHT_LC_PR_REGULATOR_KPD_EID_START + LIGHT_LC_SETUP_SERVER_STORED_WITH_SCENE_STATES)
87 #define LIGHT_LC_PR_TIME_FADE_EID_START (LIGHT_LC_PR_REGULATOR_KPU_EID_START + LIGHT_LC_SETUP_SERVER_STORED_WITH_SCENE_STATES)
88 #define LIGHT_LC_PR_TIME_FADE_ON_EID_START (LIGHT_LC_PR_TIME_FADE_EID_START + LIGHT_LC_SETUP_SERVER_STORED_WITH_SCENE_STATES)
89 #define LIGHT_LC_PR_TIME_FADE_STANDBY_AUTO_EID_START (LIGHT_LC_PR_TIME_FADE_ON_EID_START + LIGHT_LC_SETUP_SERVER_STORED_WITH_SCENE_STATES)
90 #define LIGHT_LC_PR_TIME_FADE_STANDBY_MANUAL_EID_START (LIGHT_LC_PR_TIME_FADE_STANDBY_AUTO_EID_START + LIGHT_LC_SETUP_SERVER_STORED_WITH_SCENE_STATES)
91 #define LIGHT_LC_PR_TIME_OCCUPANCY_DELAY_EID_START (LIGHT_LC_PR_TIME_FADE_STANDBY_MANUAL_EID_START + LIGHT_LC_SETUP_SERVER_STORED_WITH_SCENE_STATES)
92 #define LIGHT_LC_PR_TIME_PROLONG_EID_START (LIGHT_LC_PR_TIME_OCCUPANCY_DELAY_EID_START + LIGHT_LC_SETUP_SERVER_STORED_WITH_SCENE_STATES)
93 #define LIGHT_LC_PR_TIME_RUN_ON_EID_START (LIGHT_LC_PR_TIME_PROLONG_EID_START + LIGHT_LC_SETUP_SERVER_STORED_WITH_SCENE_STATES)
94 
96 #define LIGHT_LC_MODE_EID MESH_CONFIG_ENTRY_ID(MESH_OPT_MODEL_FILE_ID, LIGHT_LC_MODE_EID_START)
97 
99 #define LIGHT_LC_OCC_MODE_EID MESH_CONFIG_ENTRY_ID(MESH_OPT_MODEL_FILE_ID, LIGHT_LC_OCC_MODE_EID_START)
100 
102 #define LIGHT_LC_LIGHT_ONOFF_EID MESH_CONFIG_ENTRY_ID(MESH_OPT_MODEL_FILE_ID, LIGHT_LC_LIGHT_ONOFF_EID_START)
103 
105 #define LIGHT_LC_PR_LUXLEVEL_ON_EID MESH_CONFIG_ENTRY_ID(MESH_OPT_MODEL_FILE_ID, LIGHT_LC_PR_LUXLEVEL_ON_EID_START)
106 
108 #define LIGHT_LC_PR_LUXLEVEL_PROLONG_EID MESH_CONFIG_ENTRY_ID(MESH_OPT_MODEL_FILE_ID, LIGHT_LC_PR_LUXLEVEL_PROLONG_EID_START)
109 
111 #define LIGHT_LC_PR_LUXLEVEL_STANDBY_EID MESH_CONFIG_ENTRY_ID(MESH_OPT_MODEL_FILE_ID, LIGHT_LC_PR_LUXLEVEL_STANDBY_EID_START)
112 
114 #define LIGHT_LC_PR_LIGHTNESS_ON_EID MESH_CONFIG_ENTRY_ID(MESH_OPT_MODEL_FILE_ID, LIGHT_LC_PR_LIGHTNESS_ON_EID_START)
115 
117 #define LIGHT_LC_PR_LIGHTNESS_PROLONG_EID MESH_CONFIG_ENTRY_ID(MESH_OPT_MODEL_FILE_ID, LIGHT_LC_PR_LIGHTNESS_PROLONG_EID_START)
118 
120 #define LIGHT_LC_PR_LIGHTNESS_STANDBY_EID MESH_CONFIG_ENTRY_ID(MESH_OPT_MODEL_FILE_ID, LIGHT_LC_PR_LIGHTNESS_STANDBY_EID_START)
121 
123 #define LIGHT_LC_PR_REGULATOR_ACCURACY_EID MESH_CONFIG_ENTRY_ID(MESH_OPT_MODEL_FILE_ID, LIGHT_LC_PR_REGULATOR_ACCURACY_EID_START)
124 
126 #define LIGHT_LC_PR_REGULATOR_KID_EID MESH_CONFIG_ENTRY_ID(MESH_OPT_MODEL_FILE_ID, LIGHT_LC_PR_REGULATOR_KID_EID_START)
127 
129 #define LIGHT_LC_PR_REGULATOR_KIU_EID MESH_CONFIG_ENTRY_ID(MESH_OPT_MODEL_FILE_ID, LIGHT_LC_PR_REGULATOR_KIU_EID_START)
130 
132 #define LIGHT_LC_PR_REGULATOR_KPD_EID MESH_CONFIG_ENTRY_ID(MESH_OPT_MODEL_FILE_ID, LIGHT_LC_PR_REGULATOR_KPD_EID_START)
133 
135 #define LIGHT_LC_PR_REGULATOR_KPU_EID MESH_CONFIG_ENTRY_ID(MESH_OPT_MODEL_FILE_ID, LIGHT_LC_PR_REGULATOR_KPU_EID_START)
136 
138 #define LIGHT_LC_PR_TIME_FADE_EID MESH_CONFIG_ENTRY_ID(MESH_OPT_MODEL_FILE_ID, LIGHT_LC_PR_TIME_FADE_EID_START)
139 
141 #define LIGHT_LC_PR_TIME_FADE_ON_EID MESH_CONFIG_ENTRY_ID(MESH_OPT_MODEL_FILE_ID, LIGHT_LC_PR_TIME_FADE_ON_EID_START)
142 
144 #define LIGHT_LC_PR_TIME_FADE_STANDBY_AUTO_EID MESH_CONFIG_ENTRY_ID(MESH_OPT_MODEL_FILE_ID, LIGHT_LC_PR_TIME_FADE_STANDBY_AUTO_EID_START)
145 
147 #define LIGHT_LC_PR_TIME_FADE_STANDBY_MANUAL_EID MESH_CONFIG_ENTRY_ID(MESH_OPT_MODEL_FILE_ID, LIGHT_LC_PR_TIME_FADE_STANDBY_MANUAL_EID_START)
148 
150 #define LIGHT_LC_PR_TIME_OCCUPANCY_DELAY_EID MESH_CONFIG_ENTRY_ID(MESH_OPT_MODEL_FILE_ID, LIGHT_LC_PR_TIME_OCCUPANCY_DELAY_EID_START)
151 
153 #define LIGHT_LC_PR_TIME_PROLONG_EID MESH_CONFIG_ENTRY_ID(MESH_OPT_MODEL_FILE_ID, LIGHT_LC_PR_TIME_PROLONG_EID_START)
154 
156 #define LIGHT_LC_PR_TIME_RUN_ON_EID MESH_CONFIG_ENTRY_ID(MESH_OPT_MODEL_FILE_ID, LIGHT_LC_PR_TIME_RUN_ON_EID_START)
157 
168 uint32_t light_lc_mc_state_set(uint8_t index, light_lc_state_t lc_state, const void * p_value);
169 
181 uint32_t light_lc_mc_state_get(uint8_t index, light_lc_state_t lc_state, void * p_value);
182 
183 #if (SCENE_SETUP_SERVER_INSTANCES_MAX > 0) || (DOXYGEN)
184 
197 uint32_t light_lc_mc_scene_state_store(uint8_t index, uint8_t scene_index, light_lc_state_t lc_state, const void * p_value);
198 
212 uint32_t light_lc_mc_scene_state_recall(uint8_t index, uint8_t scene_index, light_lc_state_t lc_state, void * p_value);
213 
214 #endif /* (SCENE_SETUP_SERVER_INSTANCES_MAX > 0) || (DOXYGEN) */
215 
226 uint32_t light_lc_mc_open(uint8_t * p_handle);
227 
231 void light_lc_mc_clear(void);
232 
236 void light_lc_mc_init(void);
237 
240 #endif /* LIGHT_LC_MC_H__ */
void light_lc_mc_init(void)
Initialize the Light LC Setup Server persistent memory.
light_lc_state_t
Enum for to determine which state data variable is being set/gotten.
uint32_t light_lc_mc_open(uint8_t *p_handle)
Create an instance of the Light LC Setup Server model states and return the corresponding handle...
uint32_t light_lc_mc_scene_state_recall(uint8_t index, uint8_t scene_index, light_lc_state_t lc_state, void *p_value)
Recalls internal LC state variables for a specific scene index.
uint32_t light_lc_mc_state_set(uint8_t index, light_lc_state_t lc_state, const void *p_value)
Set internal LC state variables.
uint32_t light_lc_mc_state_get(uint8_t index, light_lc_state_t lc_state, void *p_value)
Get internal LC state variables.
void light_lc_mc_clear(void)
Clear all stored data and reset state contexts to default values.
uint32_t light_lc_mc_scene_state_store(uint8_t index, uint8_t scene_index, light_lc_state_t lc_state, const void *p_value)
Stores internal LC state variables for a specific scene index.

Documentation feedback | Developer Zone | Subscribe | Updated