Welcome to mirror list, hosted at ThFree Co, Russian Federation.

light_client.h « Inc « MeshModel « mesh « ble « STM32_WPAN « ST « Middlewares - github.com/Flipper-Zero/STM32CubeWB.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
blob: 6952d3583f95f2e6d81e58afd812d9da2948b1b5 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
/**
******************************************************************************
* @file    light_client.h
* @author  BLE Mesh Team
* @brief   Header file for the user application file 
******************************************************************************
* @attention
*
* Copyright (c) 2018-2021 STMicroelectronics.
* All rights reserved.
*
* This software is licensed under terms that can be found in the LICENSE file
* in the root directory of this software component.
* If no LICENSE file comes with this software, it is provided AS-IS.
*
******************************************************************************
*/

/* Define to prevent recursive inclusion -------------------------------------*/
#ifndef __LIGHT_CLIENT_H
#define __LIGHT_CLIENT_H

/* Includes ------------------------------------------------------------------*/
#include "types.h"
#include "ble_mesh.h"


/* Exported macro ------------------------------------------------------------*/

/* Variable ------------------------------------------------------------------*/
  
/******************************************************************************/
/********** Following Section defines the Opcodes for the Messages ************/
/******************************************************************************/
/* Light Client Structures */
/* Light Ctl Temperature parameters*/
typedef struct
{
  MOBLEUINT16 CTL_Temperature;
  MOBLEINT16 CTL_DeltaUv;
  MOBLEUINT8  CTL_TID;
  MOBLEUINT8  CTL_TransitionTime;
  MOBLEUINT8  CTL_Delay;
}Light_CtlTemperatureParam_t;

typedef struct
{
  MOBLEUINT16 HslHueLightness16;
  MOBLEUINT8  Hsl_TID;
  MOBLEUINT8  Hsl_TransitionTime;
  MOBLEUINT8  Hsl_Delay;
}Light_HslHueParam_t;

typedef struct
{
  MOBLEUINT16 HslSaturation16;
  MOBLEUINT8  Hsl_TID;
  MOBLEUINT8  Hsl_TransitionTime;
  MOBLEUINT8  Hsl_Delay;
}Light_HslSaturationParam_t;

/* Exported Functions Prototypes ---------------------------------------------*/
MOBLE_RESULT LightModelClient_GetOpcodeTableCb(const MODEL_OpcodeTableParam_t **data, 
                                               MOBLEUINT16 *length);

MOBLE_RESULT LightModelClient_GetStatusRequestCb(MODEL_MessageHeader_t* pmsgParam, 
                                                 MOBLEUINT16 opcode, 
                                                 MOBLEUINT8 *pResponsedata, 
                                                 MOBLEUINT32 *plength, 
                                                 MOBLEUINT8 const *pRxData,
                                                 MOBLEUINT32 dataLength,
                                                 MOBLEBOOL response);

MOBLE_RESULT LightModelClient_ProcessMessageCb(MODEL_MessageHeader_t* pmsgParam, 
                                               MOBLEUINT16 opcode, 
                                               MOBLEUINT8 const *pRxData, 
                                               MOBLEUINT32 dataLength, 
                                               MOBLEBOOL response);

MOBLE_RESULT LightClient_Lightness_Get(MOBLEUINT8 elementIndex); 
MOBLE_RESULT LightClient_Lightness_Set_Ack(MOBLEUINT8 elementIndex,  
                                           MOBLEUINT8 *pLightness_param, 
                                           MOBLEUINT32 length);
MOBLE_RESULT LightClient_Lightness_Set_Unack(MOBLEUINT8 elementIndex,  
                                             MOBLEUINT8 *pLightness_param, 
                                             MOBLEUINT32 length);

MOBLE_RESULT LightClient_Lightness_Linear_Get(MOBLEUINT8 elementIndex);
MOBLE_RESULT LightClient_Lightness_Linear_Set_Ack(MOBLEUINT8 elementIndex, 
                                                  MOBLEUINT8 *pLightnessLinear_param, 
                                                  MOBLEUINT32 length);
MOBLE_RESULT LightClient_Lightness_Linear_Set_Unack(MOBLEUINT8 elementIndex, 
                                                    MOBLEUINT8 *pLightnessLinear_param, 
                                                    MOBLEUINT32 length);

MOBLE_RESULT LightClient_Lightness_Default_Get(MOBLEUINT8 elementIndex);
MOBLE_RESULT LightClient_Lightness_Default_Set_Ack(MOBLEUINT8 elementIndex, 
                                                   MOBLEUINT8 *pLightnessDefault_param, 
                                                   MOBLEUINT32 length);
MOBLE_RESULT LightClient_Lightness_Default_Set_Unack(MOBLEUINT8 elementIndex, 
                                                     MOBLEUINT8 *pLightnessDefault_param, 
                                                     MOBLEUINT32 length);

MOBLE_RESULT LightClient_Lightness_Range_Get(MOBLEUINT8 elementIndex);
MOBLE_RESULT LightClient_Lightness_Range_Set_Ack(MOBLEUINT8 elementIndex, 
                                                 MOBLEUINT8 *pLightnessRange_param, 
                                                 MOBLEUINT32 length);
MOBLE_RESULT LightClient_Lightness_Range_Set_Unack(MOBLEUINT8 elementIndex, 
                                                   MOBLEUINT8 *pLightnessRange_param, 
                                                   MOBLEUINT32 length);

MOBLE_RESULT LightClient_Ctl_Get(MOBLEUINT8 elementIndex);
MOBLE_RESULT LightClient_Ctl_Set_Ack(MOBLEUINT8 elementIndex, 
                                     MOBLEUINT8 *pLightCtl_param, 
                                     MOBLEUINT32 length); 
MOBLE_RESULT LightClient_Ctl_Set_Unack(MOBLEUINT8 elementIndex, 
                                       MOBLEUINT8 *pLightCtl_param,
                                       MOBLEUINT32 length);

MOBLE_RESULT LightClient_Ctl_Temperature_Get(MOBLEUINT8 elementIndex);
MOBLE_RESULT LightClient_Ctl_Temperature_Set_Ack(MOBLEUINT8 elementIndex, 
                                                 MOBLEUINT8 *pLightCtlTemperature_param, 
                                                 MOBLEUINT32 length); 
MOBLE_RESULT LightClient_Ctl_Temperature_Set_Unack(MOBLEUINT8 elementIndex, 
                                                   MOBLEUINT8 *pLightCtlTemperature_param,
                                                   MOBLEUINT32 length); 

MOBLE_RESULT LightClient_Ctl_Temperature_Range_Get(MOBLEUINT8 elementIndex);
MOBLE_RESULT LightClient_Ctl_Temperature_Range_Set_Ack(MOBLEUINT8 elementIndex, 
                                                       MOBLEUINT8 *pLightCtlTemperatureRange_param, 
                                                       MOBLEUINT32 length); 
MOBLE_RESULT LightClient_Ctl_Temperature_Range_Set_Unack(MOBLEUINT8 elementIndex, 
                                                         MOBLEUINT8 *pLightCtlTemperatureRange_param,
                                                         MOBLEUINT32 length); 

MOBLE_RESULT LightClient_Ctl_Default_Get(MOBLEUINT8 elementIndex);
MOBLE_RESULT LightClient_Ctl_Default_Set_Ack(MOBLEUINT8 elementIndex, 
                                             MOBLEUINT8 *pLightCtlDefault_param, 
                                             MOBLEUINT32 length); 
MOBLE_RESULT LightClient_Ctl_Default_Set_Unack(MOBLEUINT8 elementIndex, 
                                               MOBLEUINT8 *pLightCtlDefault_param,
                                               MOBLEUINT32 length); 

MOBLE_RESULT LightClient_Hsl_Get(MOBLEUINT8 elementIndex) ;
MOBLE_RESULT LightClient_Hsl_Set_Ack(MOBLEUINT8 elementIndex, 
                                     MOBLEUINT8 *pLightHsl_param, 
                                     MOBLEUINT32 length); 

MOBLE_RESULT LightClient_Hsl_Set_Unack(MOBLEUINT8 elementIndex, 
                                     MOBLEUINT8 *pLightHsl_param,
                                     MOBLEUINT32 length); 

MOBLE_RESULT LightClient_Hsl_Default_Get(MOBLEUINT8 elementIndex);
MOBLE_RESULT LightClient_Hsl_Default_Set_Ack(MOBLEUINT8 elementIndex, 
                                             MOBLEUINT8 *pLightHslDefault_param, 
                                             MOBLEUINT32 length); 
MOBLE_RESULT LightClient_Hsl_Default_Set_Unack(MOBLEUINT8 elementIndex, 
                                               MOBLEUINT8 *pLightHslDefault_param,
                                               MOBLEUINT32 length); 
                                             
MOBLE_RESULT LightClient_Hsl_Range_Get(MOBLEUINT8 elementIndex);
MOBLE_RESULT LightClient_Hsl_Range_Set_Ack(MOBLEUINT8 elementIndex, 
                                           MOBLEUINT8 *pLightHslRange_param, 
                                           MOBLEUINT32 length); 
MOBLE_RESULT LightClient_Hsl_Range_Set_Unack(MOBLEUINT8 elementIndex, 
                                             MOBLEUINT8 *pLightHslRange_param,
                                             MOBLEUINT32 length); 
 
MOBLE_RESULT LightClient_Hsl_Hue_Get(MOBLEUINT8 elementIndex);
MOBLE_RESULT LightClient_Hsl_Hue_Set_Ack(MOBLEUINT8 elementIndex, 
                                         MOBLEUINT8 *pLightHslHue_param, 
                                         MOBLEUINT32 length); 
MOBLE_RESULT LightClient_Hsl_Hue_Set_Unack(MOBLEUINT8 elementIndex, 
                                           MOBLEUINT8 *pLightHslHue_param,
                                           MOBLEUINT32 length);

MOBLE_RESULT LightClient_Hsl_Saturation_Get(MOBLEUINT8 elementIndex);
MOBLE_RESULT LightClient_Hsl_Saturation_Set_Ack(MOBLEUINT8 elementIndex, 
                                         MOBLEUINT8 *pLightHslSaturation_param, 
                                         MOBLEUINT32 length); 
MOBLE_RESULT LightClient_Hsl_Saturation_Set_Unack(MOBLEUINT8 elementIndex, 
                                           MOBLEUINT8 *pLightHslSaturation_param,
                                           MOBLEUINT32 length);

#ifdef ENABLE_LIGHT_MODEL_CLIENT_LC  
MOBLE_RESULT LightClient_LC_Mode_Get(MOBLEUINT8 elementIndex);
MOBLE_RESULT LightClient_LC_Mode_Set_Ack(MOBLEUINT8 elementIndex, 
                                         MOBLEUINT8 *pLightLCMode_param, 
                                         MOBLEUINT32 length); 
MOBLE_RESULT LightClient_LC_Mode_Set_Unack(MOBLEUINT8 elementIndex, 
                                           MOBLEUINT8 *pLightLCMode_param,
                                           MOBLEUINT32 length);

MOBLE_RESULT LightClient_LC_OM_Get(MOBLEUINT8 elementIndex);
MOBLE_RESULT LightClient_LC_OM_Set_Ack(MOBLEUINT8 elementIndex, 
                                       MOBLEUINT8 *pLightLCOccupancyMode_param, 
                                       MOBLEUINT32 length); 
MOBLE_RESULT LightClient_LC_OM_Set_Unack(MOBLEUINT8 elementIndex, 
                                         MOBLEUINT8 *pLightLCOccupancyMode_param,
                                         MOBLEUINT32 length);

MOBLE_RESULT LightClient_LC_OnOff_Get(MOBLEUINT8 elementIndex);
MOBLE_RESULT LightClient_LC_OnOff_Set_Ack(MOBLEUINT8 elementIndex, 
                                          MOBLEUINT8 *pLightLCOnOff_param, 
                                          MOBLEUINT32 length); 
MOBLE_RESULT LightClient_LC_OnOff_Set_Unack(MOBLEUINT8 elementIndex, 
                                            MOBLEUINT8 *pLightLCOnOff_param,
                                            MOBLEUINT32 length);

MOBLE_RESULT LightClient_LC_Property_Get(MOBLEUINT8 elementIndex,
                                         MOBLEUINT8 *pLightLCProperty_param);
MOBLE_RESULT LightClient_LC_Property_Set_Ack(MOBLEUINT8 elementIndex, 
                                             MOBLEUINT8 *pLightLCProperty_param, 
                                             MOBLEUINT32 length); 
MOBLE_RESULT LightClient_LC_Property_Set_Unack(MOBLEUINT8 elementIndex, 
                                               MOBLEUINT8 *pLightLCProperty_param,
                                               MOBLEUINT32 length);
#endif /* #ifdef ENABLE_LIGHT_MODEL_CLIENT_LC */

// Status
MOBLE_RESULT Light_Client_Lightness_Status(MOBLEUINT8 const *pLightness_status, 
                                           MOBLEUINT32 plength, 
                                           MOBLEUINT16 dstPeer, 
                                           MOBLEUINT8 elementIndex);

MOBLE_RESULT Light_Client_Lightness_Linear_Status(MOBLEUINT8 const *pLightnessLinear_status, 
                                                  MOBLEUINT32 pLength,
                                                  MOBLEUINT16 dstPeer,
                                                  MOBLEUINT8 elementIndex);
MOBLE_RESULT Light_Client_Lightness_Last_Status(MOBLEUINT8 const *pLightnessLast_status, 
                                                MOBLEUINT32 pLength,
                                                MOBLEUINT16 dstPeer,
                                                MOBLEUINT8 elementIndex);
MOBLE_RESULT Light_Client_Lightness_Default_Status(MOBLEUINT8 const *pLightnessDefault_status, 
                                                   MOBLEUINT32 pLength,
                                                   MOBLEUINT16 dstPeer,
                                                   MOBLEUINT8 elementIndex);
MOBLE_RESULT Light_Client_Lightness_Range_Status(MOBLEUINT8 const *pLightnessRange_status, 
                                                 MOBLEUINT32 pLength,
                                                 MOBLEUINT16 dstPeer,
                                                 MOBLEUINT8 elementIndex);
MOBLE_RESULT Light_Client_Ctl_Status(MOBLEUINT8 const *pLightCtl_status, 
                                     MOBLEUINT32 pLength,
                                     MOBLEUINT16 dstPeer,
                                     MOBLEUINT8 elementIndex);
MOBLE_RESULT Light_Client_CtlTemperature_Range_Status(MOBLEUINT8 const *pCtlTempRange_status, 
                                                      MOBLEUINT32 pLength,
                                                      MOBLEUINT16 dstPeer,
                                                      MOBLEUINT8 elementIndex);
MOBLE_RESULT Light_Client_CtlDefault_Status(MOBLEUINT8 const *pCtlDefault_status, 
                                            MOBLEUINT32 pLength,
                                            MOBLEUINT16 dstPeer,
                                            MOBLEUINT8 elementIndex);
MOBLE_RESULT Light_Client_CtlTemperature_Status(MOBLEUINT8 const *pLightCtlTemp_status, 
                                                MOBLEUINT32 pLength,
                                                MOBLEUINT16 dstPeer,
                                                MOBLEUINT8 elementIndex);
MOBLE_RESULT Light_Client_Hsl_Status(MOBLEUINT8 const *pHsl_status, 
                                     MOBLEUINT32 pLength,
                                     MOBLEUINT16 dstPeer,
                                     MOBLEUINT8 elementIndex);
MOBLE_RESULT Light_Client_HslDefault_Status(MOBLEUINT8 const *pHslDefault_status, 
                                            MOBLEUINT32 pLength,
                                            MOBLEUINT16 dstPeer,
                                            MOBLEUINT8 elementIndex);
MOBLE_RESULT Light_Client_HslRange_Status(MOBLEUINT8 const *pHslRange_status, 
                                          MOBLEUINT32 pLength,
                                          MOBLEUINT16 dstPeer,
                                          MOBLEUINT8 elementIndex);
MOBLE_RESULT Light_Client_HslTarget_Status(MOBLEUINT8 const *pHslTarget_status, 
                                           MOBLEUINT32 pLength,
                                           MOBLEUINT16 dstPeer,
                                           MOBLEUINT8 elementIndex);
MOBLE_RESULT Light_Client_HslHue_Status(MOBLEUINT8 const *pHslHue_status, 
                                        MOBLEUINT32 pLength,
                                        MOBLEUINT16 dstPeer,
                                        MOBLEUINT8 elementIndex);
MOBLE_RESULT Light_Client_HslSaturation_Status(MOBLEUINT8 const *pHslSaturation_status, 
                                               MOBLEUINT32 pLength,
                                               MOBLEUINT16 dstPeer,
                                               MOBLEUINT8 elementIndex);
#ifdef ENABLE_LIGHT_MODEL_CLIENT_LC  
MOBLE_RESULT LightLC_Client_Mode_Status(MOBLEUINT8 const *pLCMode_status, 
                                        MOBLEUINT32 plength, 
                                        MOBLEUINT16 dstPeer, 
                                        MOBLEUINT8 elementIndex);
MOBLE_RESULT LightLC_Client_OM_Status(MOBLEUINT8 const *pLCOccupancyMode_status, 
                                      MOBLEUINT32 plength, 
                                      MOBLEUINT16 dstPeer, 
                                      MOBLEUINT8 elementIndex);
MOBLE_RESULT LightLC_Client_OnOff_Status(MOBLEUINT8 const *pLCOnOff_status, 
                                         MOBLEUINT32 plength, 
                                         MOBLEUINT16 dstPeer, 
                                         MOBLEUINT8 elementIndex);
MOBLE_RESULT LightLC_Client_Property_Status(MOBLEUINT8 const *pLCProperty_status, 
                                            MOBLEUINT32 plength, 
                                            MOBLEUINT16 dstPeer, 
                                            MOBLEUINT8 elementIndex);
#endif /* #ifdef ENABLE_LIGHT_MODEL_CLIENT_LC */

#endif /* __LIGHT_CLIENT_H */