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
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
|
/**
******************************************************************************
* @file generic.h
* @author BLE Mesh Team
* @brief Header file for the user application file
******************************************************************************
* @attention
*
* <h2><center>© Copyright (c) 2020 STMicroelectronics.
* All rights reserved.</center></h2>
*
* This software component is licensed by ST under Ultimate Liberty license
* SLA0044, the "License"; You may not use this file except in compliance with
* the License. You may obtain a copy of the License at:
* www.st.com/SLA0044
*
******************************************************************************
*/
/* Define to prevent recursive inclusion -------------------------------------*/
#ifndef __GENERIC_H
#define __GENERIC_H
/* Includes ------------------------------------------------------------------*/
#include "types.h"
#include "ble_mesh.h"
/* Exported macro ------------------------------------------------------------*/
/******************************************************************************/
/********** Following Section defines the Opcodes for the Messages ************/
/******************************************************************************/
/* 7.1 Messages summary Page 298 */
/* Generic OnOff Server Model Opcode */
#define GENERIC_ON_OFF_GET 0x8201
#define GENERIC_ON_OFF_SET_ACK 0x8202
#define GENERIC_ON_OFF_SET_UNACK 0x8203
#define GENERIC_ON_OFF_STATUS 0x8204
/* Generic Level Server Model Opcode */
#define GENERIC_LEVEL_GET 0x8205
#define GENERIC_LEVEL_SET_ACK 0x8206
#define GENERIC_LEVEL_SET_UNACK 0x8207
#define GENERIC_LEVEL_STATUS 0x8208
#define GENERIC_DELTA_SET 0x8209
#define GENERIC_DELTA_SET_UNACK 0x820A
#define GENERIC_MOVE_SET 0x820B
#define GENERIC_MOVE_SET_UNACK 0x820C
/* Generic Default Transition Time Server Model Opcode */
#define GENERIC_DEFAULT_TRANSITION_TIME_GET 0x820D
#define GENERIC_DEFAULT_TRANSITION_TIME_SET 0x820E
#define GENERIC_DEFAULT_TRANSITION_TIME_SET_UNACK 0x820F
#define GENERIC_DEFAULT_TRANSITION_TIME_STATUS 0x8210
/* Generic Power OnOff Server Model Opcode */
#define GENERIC_POWER_ON_OFF_GET 0x8211
#define GENERIC_POWER_ON_OFF_STATUS 0x8212
/* Generic Power OnOff Setup Server Model Opcode */
#define GENERIC_POWER_ON_OFF_SET 0x8213
#define GENERIC_POWER_ON_OFF_SET_UNACK 0x8214
/* Generic Power Level Server Model Opcode */
#define GENERIC_POWER_LEVEL_GET 0X8215
#define GENERIC_POWER_LEVEL_SET 0X8216
#define GENERIC_POWER_LEVEL_SET_UNACK 0X8217
#define GENERIC_POWER_LEVEL_STATUS 0X8218
#define GENERIC_POWER_LAST_GET 0X8219
#define GENERIC_POWER_LAST_STATUS 0X821A
#define GENERIC_POWER_DEFAULT_GET 0X821B
#define GENERIC_POWER_DEFAULT_STATUS 0X821C
#define GENERIC_POWER_RANGE_GET 0X821D
#define GENERIC_POWER_RANGE_STATUS 0X821E
/* Generic Power Level Setup Server Model Opcode */
#define GENERIC_POWER_DEFAULT_SET 0X821F
#define GENERIC_POWER_DEFAULT_SET_UNACK 0X8220
#define GENERIC_POWER_RANGE_SET 0X8221
#define GENERIC_POWER_RANGE_SET_UNACK 0X8222
/* Generic Battery Server Model Opcode */
#define GENERIC_BATTERY_GET 0X8223
#define GENERIC_BATTERY_STATUS 0X8224
/* Generic Location Server Model Opcode */
#define GENERIC_LOCATION_GLOBAL_GET 0X8225
#define GENERIC_LOCATION_GLOBAL_STATUS 0X40
#define GENERIC_LOCATION_LOCAL_GET 0X8226
#define GENERIC_LOCATION_LOCAL_STATUS 0X8227
/* Generic Location Setup Server Model Opcode */
#define GENERIC_LOCATION_GLOBAL_SET 0X41
#define GENERIC_LOCATION_GLOBAL_SET_UNACK 0X42
#define GENERIC_LOCATION_LOCAL_SET 0X8228
#define GENERIC_LOCATION_LOCAL_SET_UNACK 0X8229
/* Generic Manufacturer Property Server Model Opcode */
#define GENERIC_MANUFACTURER_PROPERTIES_GET 0X822A
#define GENERIC_MANUFACTURER_PROPERTIES_STATUS 0X43
#define GENERIC_MANUFACTURER_PROPERTY_GET 0X822B
#define GENERIC_MANUFACTURER_PROPERTY_SET 0X44
#define GENERIC_MANUFACTURER_PROPERTY_SET_UNACK 0X45
#define GENERIC_MANUFACTURER_PROPERTY_STATUS 0X46
/* Generic Admin Property Server Model Opcode */
#define GENERIC_ADMIN_PROPERTIES_GET 0X822C
#define GENERIC_ADMIN_PROPERTIES_STATUS 0X47
#define GENERIC_ADMIN_PROPERTY_GET 0X822D
#define GENERIC_ADMIN_PROPERTY_SET 0X48
#define GENERIC_ADMIN_PROPERTY_SET_UNACK 0X49
#define GENERIC_ADMIN_PROPERTY_STATUS 0X4A
/* Generic User Property Server Model Opcode */
#define GENERIC_USER_PROPERTIES_GET 0X822E
#define GENERIC_USER_PROPERTIES_STATUS 0X4B
#define GENERIC_USER_PROPERTY_GET 0X822F
#define GENERIC_USER_PROPERTY_SET 0X4C
#define GENERIC_USER_PROPERTY_SET_UNACK 0X4D
#define GENERIC_USER_PROPERTY_STATUS 0X4E
#define MAXSTEPVALUE 0X3E
#define MINSTEPVALUE 0X00
#define UNDEFSTEPVAL 0x3F
#define STEP_HEX_VALUE_0 0X00
#define STEP_HEX_VALUE_1 0X01
#define STEP_HEX_VALUE_2 0X02
#define STEP_HEX_VALUE_3 0X03
/****Generic Power on off states****/
#define GENERIC_POWER_OFF_STATE 0X00
#define GENERIC_POWER_ON_STATE 0X01
#define GENERIC_POWER_RESTORE_STATE 0X02
#define LEVEL_MIN_VALID_RANGE 0x8000
#define LEVEL_MAX_VALID_RANGE 0x7FFF
#define TRANSITION_MIN_VALID_RANGE 0x00
#define TRANSITION_MAX_VALID_RANGE 0xFE
#define MAX_BATTERY_LEVEL 0X64
#define PROHIBITED_MIN_BATTERY_LEVEL 0X65
#define PROHIBITED_MAX_BATTERY_LEVEL 0XFE
#define UNKNOWN_BATTERY_LEVEL 0XFF
#define BATTERY_VALID_CHARGE_TIME 0XFFFE
#define BATTERY_UNKLNOWN_CHARGE_TIME 0XFFFF
#define BATTERY_VALID_DISCHARGE_TIME 0XFFFE
#define BATTERY_UNKLNOWN_DISCHARGE_TIME 0XFFFF
/* Generic Client Property Server Model Opcode */
#define GENERIC_CLIENT_PROPERTIES_GET 0X4F
#define GENERIC_CLIENT_PROPERTIES_STATUS 0X50
#define APPLI_LED_OFF 0X00
#define APPLI_LED_ON 0X01
#define NO_TRANSITION 0X01
#define IN_TRANSITION 0X02
#define DEFAULT_TRANSITION 0X03
#define GENERIC_ON_OFF_TRANSITION_START 0X01
#define GENERIC_LEVEL_TRANSITION_START 0X02
#define BINDING_GENERIC_ON_OFF_SET 0X00
#define BINDING_GENERIC_LEVEL_SET 0X01
#define PACKET_CACHE_SIZE 2
/* Exported variables ------------------------------------------------------ */
/* Temporary message to store the application vaiables*/
#pragma pack(push, 1)
typedef struct
{
MOBLEUINT8 RemainingTime;
MOBLEINT16 PresentValue16;
MOBLEINT16 TargetValue16;
} Generic_TemporaryStatus_t;
/* Transition time variables */
typedef struct
{
MOBLEINT8 StepValue ;
MOBLEUINT8 ResBitValue;
MOBLEUINT32 Res_Value;
MOBLEUINT32 TotalTime;
}Generic_TimeParam_t;
/* Transition Flag variables */
typedef struct
{
MOBLEUINT8 GenericTransitionFlag;
MOBLEUINT8 GenericOptionalParam;
MOBLEUINT8 Generic_Trnsn_Cmplt;
}Generic_ModelFlag_t;
/*****************************************************/
/* Generic On Off state Messages */
typedef struct
{
MOBLEUINT8 TargetOnOffState;
MOBLEUINT8 Generic_TID;
MOBLEUINT8 Transition_Time;
MOBLEUINT8 Delay_Time;
} Generic_OnOffParam_t;
typedef struct
{
MOBLEUINT8 Present_OnOff_State;
MOBLEUINT16 Present_OnOff_Value;
MOBLEUINT16 Target_OnOff;
MOBLEUINT8 RemainingTime;
}Generic_OnOffStatus_t;
/* Generic Level state Messages */
typedef struct
{
MOBLEINT16 TargetLevel;
MOBLEUINT8 Generic_TID;
MOBLEUINT8 Transition_Time;
MOBLEUINT8 Delay_Time;
} Generic_LevelParam_t;
typedef struct
{
MOBLEINT16 Present_Level16;
MOBLEINT16 Target_Level16;
MOBLEUINT8 RemainingTime;
MOBLEUINT8 Last_Level_TID;
MOBLEINT16 Last_Present_Level16;
MOBLEINT32 Last_delta_level;
}Generic_LevelStatus_t;
typedef struct
{
MOBLEINT32 TargetDeltaLevel32;
MOBLEUINT8 Generic_TID;
MOBLEUINT8 Transition_Time;
MOBLEUINT8 Delay_Time;
} Generic_DeltaLevelParam_t;
typedef struct
{
MOBLEUINT16 TargetMoveLevel16;
MOBLEUINT8 Generic_TID;
MOBLEUINT8 Transition_Time;
MOBLEUINT8 Delay_Time;
} Generic_LevelMoveParam_t;
/******************************************************/
/* Generic Power on off messages*/
typedef struct
{
MOBLEUINT8 PowerOnOffState;
}Generic_PowerOnOffParam_t;
/******************************************************/
/* Generic Default transition time messages*/
typedef struct
{
MOBLEUINT8 DefaultTransitionTime;
}Generic_DefaultTransitionParam_t;
typedef union {
Generic_LevelParam_t sGeneric_LevelParam;
MOBLEUINT8 a_Level_param[sizeof(Generic_LevelParam_t)];
} _Generic_LevelParam;
/******************************************************/
typedef struct
{
/* Pointer to the function Appli_Generic_OnOff_Set used for callback
from the middle layer to Application layer
*/
MOBLE_RESULT (*OnOff_Set_cb)(Generic_OnOffStatus_t*, uint8_t, uint16_t, \
uint8_t);
MOBLE_RESULT (*OnOff_Status_cb)(MOBLEUINT8 const *, MOBLEUINT32, uint16_t,\
uint8_t);
/* Pointer to the function Appli_Generic_Level_Set used for callback
from the middle layer to Application layer
*/
MOBLE_RESULT (*Level_Set_cb)(Generic_LevelStatus_t*, MOBLEUINT8, uint16_t,\
uint8_t);
/* Pointer to the function Appli_Generic_Delta_Set used for callback
from the middle layer to Application layer
*/
MOBLE_RESULT (*LevelDelta_Set_cb)(Generic_LevelStatus_t*, MOBLEUINT8, uint16_t,\
uint8_t);
/* Pointer to the function Appli_Generic_Move_Set used for callback
from the middle layer to Application layer
*/
MOBLE_RESULT (*LevelDeltaMove_Set_cb)(Generic_LevelStatus_t*, MOBLEUINT8, \
uint16_t, uint8_t);
MOBLE_RESULT (*Level_Status_cb)(MOBLEUINT8 const *, MOBLEUINT32, uint16_t, \
uint8_t);
/* Pointer to the function Appli_Generic_PowerOnOff_Set used for callback
from the middle layer to Application layer
*/
MOBLE_RESULT (*GenericPowerOnOff_cb)(Generic_PowerOnOffParam_t*, MOBLEUINT8, \
uint16_t, uint8_t);
MOBLE_RESULT (*GenericPowerOnOff_Status_cb)(MOBLEUINT8 const *, MOBLEUINT32, \
uint16_t, uint8_t);
/* Pointer to the function Generic_DefaultTransitionTime_Set used for callback
from the middle layer to Application layer
*/
MOBLE_RESULT (*GenericDefaultTransition_cb)(Generic_DefaultTransitionParam_t*,\
MOBLEUINT8, uint16_t, uint8_t);
MOBLE_RESULT (*GenericDefaultTransition_Status_cb)(MOBLEUINT8 const *, MOBLEUINT32, \
uint16_t, uint8_t);
} Appli_Generic_cb_t;
typedef struct
{
MOBLE_RESULT (*GetOnOffStatus_cb)(MOBLEUINT8*, uint16_t, uint8_t);
MOBLE_RESULT (*GetOnOffValue_cb)(MOBLEUINT8*, uint16_t, uint8_t);
MOBLE_RESULT (*GetLevelStatus_cb)(MOBLEUINT8*, uint16_t, uint8_t);
MOBLE_RESULT (*GetPowerOnOffStatus_cb)(MOBLEUINT8*, uint16_t, uint8_t);
MOBLE_RESULT (*GetDefaultTransitionStatus_cb)(MOBLEUINT8*, uint16_t, uint8_t);
}Appli_Generic_State_cb_t;
#pragma pack(pop)
extern const Appli_Generic_State_cb_t Appli_GenericState_cb;
extern const Appli_Generic_cb_t GenericAppli_cb;
/* Exported Functions Prototypes ---------------------------------------------*/
void BLEMesh_GenericModelAppliCb (Appli_Generic_cb_t* map );
MOBLE_RESULT Generic_OnOff_Set(MOBLEUINT8 const*, MOBLEUINT32, MODEL_MessageHeader_t*);
MOBLE_RESULT Generic_OnOff_Status(MOBLEUINT8*, MOBLEUINT32*, MODEL_MessageHeader_t*);
MOBLE_RESULT Generic_Level_Set(const MOBLEUINT8*, MOBLEUINT32, MODEL_MessageHeader_t*);
MOBLE_RESULT Generic_Delta_Set(const MOBLEUINT8*, MOBLEUINT32, MODEL_MessageHeader_t*);
MOBLE_RESULT Generic_Move_Set(const MOBLEUINT8*, MOBLEUINT32, MODEL_MessageHeader_t*);
MOBLE_RESULT Generic_Level_Status(MOBLEUINT8*, MOBLEUINT32*, MODEL_MessageHeader_t*);
MOBLE_RESULT Generic_PowerOnOff_Set(const MOBLEUINT8*, MOBLEUINT32 length, MODEL_MessageHeader_t*);
MOBLE_RESULT Generic_PowerOnOff_Status(MOBLEUINT8*, MOBLEUINT32*, MODEL_MessageHeader_t*);
MOBLE_RESULT Generic_DefaultTransitionTime_Set(const MOBLEUINT8*, MOBLEUINT32 length,\
MODEL_MessageHeader_t*);
MOBLE_RESULT Generic_DefaultTransitionTime_Status(MOBLEUINT8 *pTransition_status , \
MOBLEUINT32 *plength,
MODEL_MessageHeader_t*);
MOBLE_RESULT GenericModelServer_GetOpcodeTableCb(const MODEL_OpcodeTableParam_t **data,
MOBLEUINT16 *length);
MOBLE_RESULT GenericModelServer_GetStatusRequestCb(MODEL_MessageHeader_t *pmsgParam,
MOBLEUINT16 opcode,
MOBLEUINT8 *pResponsedata,
MOBLEUINT32 *plength,
MOBLEUINT8 const *pData,
MOBLEUINT32 length,
MOBLEBOOL response);
MOBLE_RESULT GenericModelServer_ProcessMessageCb(MODEL_MessageHeader_t *pmsgParam,
MOBLEUINT16 opcode,
MOBLEUINT8 const *data,
MOBLEUINT32 length,
MOBLEBOOL response);
void Generic_Process(void);
void Generic_Publish(MOBLE_ADDRESS srcAddress);
MOBLE_RESULT BLEMesh_AddGenericModels(void);
void Generic_GetStepValue(MOBLEUINT8 stepParam, MOBLEUINT8 elementIndex);
void GenericOnOff_LightActualBinding(Generic_OnOffStatus_t* onOff_param, MOBLEUINT8 elementIndex,
MOBLEUINT8 trnsnFlag,MOBLEUINT8 trnsnCmplt);
void GenericLevel_LightBinding(Generic_LevelStatus_t* gLevel_param , MOBLEUINT8 flag, MOBLEUINT8 elementIndex,
MOBLEUINT8 trnsnFlag,MOBLEUINT8 trnsnCmplt);
void GenericLevel_CtlTempBinding(Generic_LevelStatus_t * bLevelParam,MOBLEUINT8 elementIndex);
void GenericLevel_HslHueBinding(Generic_LevelStatus_t * bLevelParam,MOBLEUINT8 elementIndex);
void GenericLevel_HslSaturationBinding(Generic_LevelStatus_t * bLevelParam,MOBLEUINT8 elementIndex);
MOBLE_RESULT Generic_TransitionBehaviour(MOBLEUINT8 *GetValue, MOBLEUINT8 elementIndex);
MOBLE_RESULT Generic_OnOffStateUpdate_Process(MOBLEUINT8 elementIndex);
MOBLE_RESULT Generic_LevelStateUpdate_Process(MOBLEUINT8 elementIndex);
void Generic_OnOffDefaultTransitionValue(MOBLEUINT8 elementIndex);
void Generic_LevelDefaultTransitionValue(MOBLEUINT8 elementIndex, MOBLEUINT16 levelValue);
void Generic_DeltaDefaultTransitionValue(MOBLEUINT8 elementIndex, MOBLEUINT32 deltaValue);
void Generic_OnOffUpdate(MOBLEUINT8 elementIndex, MOBLEUINT8 onOff);
void Generic_TransitionParameterReset(MOBLEUINT8 elementIndex);
void Generic_RestoreModelStates(void *model_State,MOBLEUINT8 elementIndex);
void Generic_SaveModelStates(void *model_State,MOBLEUINT8 elementIndex);
#endif /* __GENERIC_H */
/******************* (C) COPYRIGHT 2020 STMicroelectronics *****END OF FILE****/
|
