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
|
/**
******************************************************************************
* @file sensors.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 __SENSORS_H
#define __SENSORS_H
/* Includes ------------------------------------------------------------------*/
#include "types.h"
#include "ble_mesh.h"
/* Exported types ------------------------------------------------------------*/
/**
* This structure contains sensor cadence callback parameters
*/
typedef struct
{
MOBLEUINT16 property_ID;
MOBLEUINT8 fastCadenceDevisor;
MOBLEUINT8 statusTriggerType;
MOBLEUINT32 triggerDeltaDown;
MOBLEUINT32 triggerDeltaUp;
MOBLEUINT8 statusMinInterval;
MOBLEUINT32 fastCadenceLow;
MOBLEUINT32 fastCadenceHigh;
}sensor_CadenceCbParam_t;
/**
* This structure contains sensor settings callback parameters
*/
typedef struct
{
MOBLEUINT16 propertyId;
MOBLEUINT16 settingPropertyId;
}sensor_SettingsCbParams_t;
/**
* This structure contains sensor setting callback parameters
*/
typedef struct
{
MOBLEUINT16 property_ID;
MOBLEUINT16 settingPropertyId;
MOBLEUINT32 settingRaw;
MOBLEUINT8 settingAccess;
}sensor_SettingCbParams_t;
/**
* This structure contains sensor descriptor callback parameters
*/
typedef struct
{
MOBLEUINT16 propertyId;
MOBLEUINT16 positiveTolerance;
MOBLEUINT16 negativeTolerance;
MOBLEUINT8 samplingFunction;
MOBLEUINT8 measurementPeriod;
MOBLEUINT8 updateInterval;
}sensor_DescriptorCbParams_t;
/**
* This structure contains sensor column callback parameters
*/
typedef struct
{
MOBLEUINT16 propertyId;
MOBLEUINT32 rawValueX;
MOBLEUINT8 data[8];
MOBLEUINT8 dataLength;
}sensor_ColumnCbParams_t;
/**
* This structure contains sensor series callback parameters
*/
typedef struct
{
MOBLEUINT16 propertyId;
MOBLEUINT32 rawValueX1;
MOBLEUINT32 rawValueX2;
MOBLEUINT8 data[379];
MOBLEUINT16 dataLength;
}sensor_SeriesCbParams_t;
/**
* This structure contains sensor value callback parameters
*/
typedef struct
{
MOBLEUINT16 propertyId;
MOBLEUINT8 data[128];
}sensor_ValueCbParams_t;
/**
* Enum for status trigger type
*/
typedef enum
{
STATUS_TRIGGER_TYPE_VALUE = 0,
STATUS_TRIGGER_TYPE_PC
} status_trigger_type_e;
/**
* Enum for status trigger delta
*/
typedef enum
{
STATUS_TRIGGER_DELTA_DOWN = 0,
STATUS_TRIGGER_DELTA_UP
} status_trigger_delta_e;
/**
* structure of sensor server function pointers callback
*/
typedef struct
{
void (*Sensor_CadenceGet_cb)(sensor_CadenceCbParam_t* pCadenceParam,
MOBLEUINT32 length,
MOBLE_ADDRESS peerAddr,
MOBLE_ADDRESS dstPeer,
MOBLEUINT8 elementIndex);
void (*Sensor_CadenceSet_cb)(sensor_CadenceCbParam_t* pCadenceParam,
MOBLEUINT32 length,
MOBLE_ADDRESS peerAddr,
MOBLE_ADDRESS dstPeer,
MOBLEUINT8 elementIndex);
void (*Sensor_CadenceSetUnack_cb)(sensor_CadenceCbParam_t* pCadenceParam,
MOBLEUINT32 length,
MOBLE_ADDRESS peerAddr,
MOBLE_ADDRESS dstPeer,
MOBLEUINT8 elementIndex);
void (*Sensor_SettingsGet_cb)(sensor_SettingsCbParams_t* pSettingsParam,
MOBLEUINT32 length,
MOBLE_ADDRESS peerAddr,
MOBLE_ADDRESS dstPeer,
MOBLEUINT8 elementIndex);
void (*Sensor_SettingGet_cb)(sensor_SettingCbParams_t* pSettingParam,
MOBLEUINT32 length,
MOBLE_ADDRESS peerAddr,
MOBLE_ADDRESS dstPeer,
MOBLEUINT8 elementIndex);
void (*Sensor_SettingSet_cb)(sensor_SettingCbParams_t* pSettingParam,
MOBLEUINT32 length,
MOBLE_ADDRESS peerAddr,
MOBLE_ADDRESS dstPeer,
MOBLEUINT8 elementIndex);
void (*Sensor_SettingSetUnack_cb)(sensor_SettingCbParams_t* pSettingParam,
MOBLEUINT32 length,
MOBLE_ADDRESS peerAddr,
MOBLE_ADDRESS dstPeer,
MOBLEUINT8 elementIndex);
void (*Sensor_DescriptorGet_cb)(MOBLEUINT8 propID,
MOBLEUINT32 length,
MOBLE_ADDRESS peerAddr,
MOBLE_ADDRESS dstPeer,
MOBLEUINT8 elementIndex);
void (*Sensor_Get_cb)(MOBLEUINT16 propID,
MOBLEUINT32 length,
MOBLE_ADDRESS peerAddr,
MOBLE_ADDRESS dstPeer,
MOBLEUINT8 elementIndex);
void (*Sensor_ColumnGet_cb)(sensor_ColumnCbParams_t* pColumnParam,
MOBLEUINT32 length,
MOBLE_ADDRESS peerAddr,
MOBLE_ADDRESS dstPeer,
MOBLEUINT8 elementIndex);
void (*Sensor_SeriesGet_cb)(sensor_SeriesCbParams_t* pSeriesParam,
MOBLEUINT32 length,
MOBLE_ADDRESS peerAddr,
MOBLE_ADDRESS dstPeer,
MOBLEUINT8 elementIndex);
MOBLE_RESULT (*Sensor_ReadDescriptor_cb)(MOBLEUINT8 sensorOffset,
sensor_DescriptorCbParams_t* pDescriptorParams);
MOBLE_RESULT (*Sensor_ReadValue_cb)(MOBLEUINT8 sensorOffset,
sensor_ValueCbParams_t* pValueParams);
MOBLE_RESULT (*Sensor_ReadColumn_cb)(MOBLEUINT8 sensorOffset,
MOBLEUINT8 columnOffset,
sensor_ColumnCbParams_t* pColumnParams);
MOBLE_RESULT (*Sensor_ReadSeries_cb)(MOBLEUINT8 sensorOffset,
sensor_SeriesCbParams_t* pSeriesParams);
MOBLEUINT8 (*Sensor_IsFastCadence_cb)(MOBLEUINT8 sensorOffset,
void* pFastCadenceLow,
void* pFastCadenceHigh);
MOBLEUINT8 (*Sensor_IsStatusTrigger_cb)(MOBLEUINT8 sensorOffset,
status_trigger_type_e triggerType,
void* pDeltaDown,
void* pDeltaUp);
} sensor_server_cb_t;
/* Exported macro ------------------------------------------------------------*/
#define SENSOR_POSITIVE_TOLERANCE_UNSPECIFIED 0x000
#define SENSOR_NEGATIVE_TOLERANCE_UNSPECIFIED 0x000
#define SENSOR_SAMPLING_FUNC_UNSPECIFIED 0x00
#define SENSOR_SAMPLING_FUNC_INSTANTANEOUS 0x01
#define SENSOR_SAMPLING_FUNC_ARITHMETIC_MEAN 0x02
#define SENSOR_SAMPLING_FUNC_RMS 0x03
#define SENSOR_SAMPLING_FUNC_MAX 0x04
#define SENSOR_SAMPLING_FUNC_MIN 0x05
#define SENSOR_SAMPLING_FUNC_ACCUMULATED 0x06
#define SENSOR_SAMPLING_FUNC_COUNT 0x07
#define SENSOR_SAMPLING_FUNC_RFU(x) x>=0x08 ?\
MOBLE_TRUE:MOBLE_FALSE
#define SENSOR_MEASUREMENT_PERIOD_NA 0x00
#define SENSOR_UPDATE_INTERVAL_NA 0x00
#define SENSOR_SETTING_PROPERTY_ID_PROHIBITED 0x0000
#define SENSOR_SETTING_ACCESS_READ 0x01
#define SENSOR_SETTING_ACCESS_READ_WRITE 0x03
#define SENSOR_SETTING_ACCESS_PROHIBITED(x) ((x == 0x02)||(x>=0x04)) ?\
MOBLE_TRUE:MOBLE_FALSE
#define SENSOR_STATUS_TRIG_FORMAT_PROP_ID 0b0
#define SENSOR_STATUS_TRIG_FORMAT_UNITLESS 0b1
#define SENSOR_FAST_CADENCE_PERIOD_DIV(n) pow(2,n)
#define SENSOR_FAST_CADENCE_PERIOD_DIV_PROHIBITED(x) \
x>=16 ? MOBLE_TRUE:MOBLE_FALSE
#define SENSOR_STATUS_MIN_INTERVAL_PROHIBITED(x) \
x>=27 ? MOBLE_TRUE:MOBLE_FALSE
#define SENSOR_CADENCE_NOT_SUPPORTED 0
#define SENSOR_CADENCE_SUPPORTED 1
#define SENSOR_PROPERTY_ID_LENGTH 2
/* Exported functions ------------------------------------------------------- */
MOBLE_RESULT SensorModelServer_GetOpcodeTableCb(const MODEL_OpcodeTableParam_t **data,
MOBLEUINT16 *length);
MOBLE_RESULT SensorModelServer_ProcessMessageCb(MODEL_MessageHeader_t *pmsgParams,
MOBLEUINT16 opcode,
MOBLEUINT8 const *data,
MOBLEUINT32 length,
MOBLEBOOL response);
MOBLE_RESULT SensorModelServer_GetStatusRequestCb(MODEL_MessageHeader_t *pmsgParams,
MOBLEUINT16 opcode,
MOBLEUINT8 *pResponsedata,
MOBLEUINT32 *plength,
MOBLEUINT8 const *pData,
MOBLEUINT32 length,
MOBLEBOOL response);
MOBLE_RESULT Sensor_Send(MOBLEUINT8 sensorOffset,
MOBLEUINT8 elementIdx,
MOBLEUINT16 propertyId);
MOBLE_RESULT Sensor_UpdateCadence(MOBLEUINT8 sensorOffset,
MOBLEUINT8 elementIdx,
MOBLEUINT16 propertyId);
MOBLE_RESULT Sensor_UpdatePublishState(MOBLEUINT8 sensorOffset, MOBLEUINT8 state);
MOBLEUINT32 Sensor_SleepDurationMs_Get(void);
void Sensor_Process(void);
MOBLE_RESULT SensorServer_Init(void* sensorBuff,
const sensor_server_cb_t* sensor_cb,
MOBLEUINT16 sizeBuff,
const void* sensorServerInitParams);
MOBLE_RESULT Sensor_ModelPublishSet(model_publicationparams_t* pPublishParams);
#endif /* __SENSORS_H */
|
