-
Notifications
You must be signed in to change notification settings - Fork 0
/
stts22h.c
640 lines (539 loc) · 14.2 KB
/
stts22h.c
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
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
/**
******************************************************************************
* @file stts22h.c
* @author MEMS Software Solutions Team
* @brief STTS22H driver file
******************************************************************************
* @attention
*
* Copyright (c) 2019 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.
*
******************************************************************************
*/
/* Includes ------------------------------------------------------------------*/
#include "stts22h.h"
/** @addtogroup BSP BSP
* @{
*/
/** @addtogroup Component Component
* @{
*/
/** @defgroup STTS22H STTS22H
* @{
*/
/** @defgroup STTS22H_Exported_Variables STTS22H Exported Variables
* @{
*/
STTS22H_CommonDrv_t STTS22H_COMMON_Driver =
{
STTS22H_Init,
STTS22H_DeInit,
STTS22H_ReadID,
STTS22H_GetCapabilities,
};
STTS22H_TEMP_Drv_t STTS22H_TEMP_Driver =
{
STTS22H_TEMP_Enable,
STTS22H_TEMP_Disable,
STTS22H_TEMP_GetOutputDataRate,
STTS22H_TEMP_SetOutputDataRate,
STTS22H_TEMP_GetTemperature,
};
/**
* @}
*/
/** @defgroup STTS22H_Private_Function_Prototypes STTS22H Private Function Prototypes
* @{
*/
static int32_t ReadRegWrap(void *Handle, uint8_t Reg, uint8_t *pData, uint16_t Length);
static int32_t WriteRegWrap(void *Handle, uint8_t Reg, uint8_t *pData, uint16_t Length);
/**
* @}
*/
/** @defgroup STTS22H_Exported_Functions STTS22H Exported Functions
* @{
*/
/**
* @brief Register Component Bus IO operations
* @param pObj the device pObj
* @retval 0 in case of success, an error code otherwise
*/
int32_t STTS22H_RegisterBusIO(STTS22H_Object_t *pObj, STTS22H_IO_t *pIO)
{
int32_t ret;
if (pObj == NULL)
{
ret = STTS22H_ERROR;
}
else
{
pObj->IO.Init = pIO->Init;
pObj->IO.DeInit = pIO->DeInit;
pObj->IO.BusType = pIO->BusType;
pObj->IO.Address = pIO->Address;
pObj->IO.WriteReg = pIO->WriteReg;
pObj->IO.ReadReg = pIO->ReadReg;
pObj->IO.GetTick = pIO->GetTick;
pObj->Ctx.read_reg = ReadRegWrap;
pObj->Ctx.write_reg = WriteRegWrap;
pObj->Ctx.mdelay = pIO->Delay;
pObj->Ctx.handle = pObj;
if (pObj->IO.Init != NULL)
{
ret = pObj->IO.Init();
}
else
{
ret = STTS22H_ERROR;
}
}
return ret;
}
/**
* @brief Initialize the STTS22H sensor
* @param pObj the device pObj
* @retval 0 in case of success, an error code otherwise
*/
int32_t STTS22H_Init(STTS22H_Object_t *pObj)
{
if (pObj->is_initialized == 0U)
{
/* Set default ODR */
pObj->temp_odr = 1.0f;
/* Enable BDU */
if (stts22h_block_data_update_set(&(pObj->Ctx), PROPERTY_ENABLE) != STTS22H_OK)
{
return STTS22H_ERROR;
}
/* Enable Automatic Address Increment */
if (stts22h_auto_increment_set(&(pObj->Ctx), PROPERTY_ENABLE) != STTS22H_OK)
{
return STTS22H_ERROR;
}
/* Put the component in standby mode. */
if (stts22h_temp_data_rate_set(&(pObj->Ctx), STTS22H_POWER_DOWN) != STTS22H_OK)
{
return STTS22H_ERROR;
}
}
pObj->is_initialized = 1;
return STTS22H_OK;
}
/**
* @brief Deinitialize the STTS22H sensor
* @param pObj the device pObj
* @retval 0 in case of success, an error code otherwise
*/
int32_t STTS22H_DeInit(STTS22H_Object_t *pObj)
{
if (pObj->is_initialized == 1U)
{
/* Put the component in standby mode */
if (STTS22H_TEMP_Disable(pObj) != STTS22H_OK)
{
return STTS22H_ERROR;
}
}
pObj->is_initialized = 0;
return STTS22H_OK;
}
/**
* @brief Get WHO_AM_I value
* @param pObj the device pObj
* @param Id the WHO_AM_I value
* @retval 0 in case of success, an error code otherwise
*/
int32_t STTS22H_ReadID(STTS22H_Object_t *pObj, uint8_t *Id)
{
uint8_t buf;
if (stts22h_dev_id_get(&(pObj->Ctx), &buf) != STTS22H_OK)
{
return STTS22H_ERROR;
}
*Id = buf;
return STTS22H_OK;
}
/**
* @brief Get STTS22H sensor capabilities
* @param pObj Component object pointer
* @param Capabilities pointer to STTS22H sensor capabilities
* @retval 0 in case of success, an error code otherwise
*/
int32_t STTS22H_GetCapabilities(STTS22H_Object_t *pObj, STTS22H_Capabilities_t *Capabilities)
{
/* Prevent unused argument(s) compilation warning */
(void)(pObj);
Capabilities->Humidity = 0;
Capabilities->Pressure = 0;
Capabilities->Temperature = 1;
Capabilities->Gas = 0;
Capabilities->LowPower = 0;
Capabilities->HumMaxOdr = 0.0f;
Capabilities->TempMaxOdr = 200.0f;
Capabilities->PressMaxOdr = 0.0f;
Capabilities->GasMaxOdr = 0.0f;
return STTS22H_OK;
}
/**
* @brief Get the STTS22H initialization status
* @param pObj the device pObj
* @param Status 1 if initialized, 0 otherwise
* @retval 0 in case of success, an error code otherwise
*/
int32_t STTS22H_Get_Init_Status(STTS22H_Object_t *pObj, uint8_t *Status)
{
if (pObj == NULL)
{
return STTS22H_ERROR;
}
*Status = pObj->is_initialized;
return STTS22H_OK;
}
/**
* @brief Enable the STTS22H temperature sensor
* @param pObj the device pObj
* @retval 0 in case of success, an error code otherwise
*/
int32_t STTS22H_TEMP_Enable(STTS22H_Object_t *pObj)
{
/* Check if the component is already enabled */
if (pObj->temp_is_enabled == 1U)
{
return STTS22H_OK;
}
/* Power on the component and set the odr. */
if (STTS22H_TEMP_SetOutputDataRate(pObj, pObj->temp_odr) != STTS22H_OK)
{
return STTS22H_ERROR;
}
pObj->temp_is_enabled = 1;
return STTS22H_OK;
}
/**
* @brief Disable the STTS22H temperature sensor
* @param pObj the device pObj
* @retval 0 in case of success, an error code otherwise
*/
int32_t STTS22H_TEMP_Disable(STTS22H_Object_t *pObj)
{
/* Check if the component is already disabled */
if (pObj->temp_is_enabled == 0U)
{
return STTS22H_OK;
}
/* Save the current odr. */
if (STTS22H_TEMP_GetOutputDataRate(pObj, &pObj->temp_odr) != STTS22H_OK)
{
return STTS22H_ERROR;
}
/* Put the component in standby mode. */
if (stts22h_temp_data_rate_set(&(pObj->Ctx), STTS22H_POWER_DOWN) != STTS22H_OK)
{
return STTS22H_ERROR;
}
pObj->temp_is_enabled = 0;
return STTS22H_OK;
}
/**
* @brief Get the STTS22H temperature sensor output data rate
* @param pObj the device pObj
* @param Odr pointer where the output data rate is written
* @retval 0 in case of success, an error code otherwise
*/
int32_t STTS22H_TEMP_GetOutputDataRate(STTS22H_Object_t *pObj, float *Odr)
{
int32_t ret = STTS22H_OK;
stts22h_odr_temp_t odr_low_level;
if (stts22h_temp_data_rate_get(&(pObj->Ctx), &odr_low_level) != STTS22H_OK)
{
return STTS22H_ERROR;
}
switch (odr_low_level)
{
case STTS22H_POWER_DOWN:
case STTS22H_ONE_SHOT:
*Odr = 0.0f;
break;
case STTS22H_1Hz:
*Odr = 1.0f;
break;
case STTS22H_25Hz:
*Odr = 25.0f;
break;
case STTS22H_50Hz:
*Odr = 50.0f;
break;
case STTS22H_100Hz:
*Odr = 100.0f;
break;
case STTS22H_200Hz:
*Odr = 200.0f;
break;
default:
ret = STTS22H_ERROR;
break;
}
return ret;
}
/**
* @brief Set the STTS22H temperature sensor output data rate
* @param pObj the device pObj
* @param Odr the output data rate value to be set
* @retval 0 in case of success, an error code otherwise
*/
int32_t STTS22H_TEMP_SetOutputDataRate(STTS22H_Object_t *pObj, float Odr)
{
stts22h_odr_temp_t new_odr;
new_odr = (Odr <= 1.0f) ? STTS22H_1Hz
: (Odr <= 25.0f) ? STTS22H_25Hz
: (Odr <= 50.0f) ? STTS22H_50Hz
: (Odr <= 100.0f) ? STTS22H_100Hz
: STTS22H_200Hz;
if (stts22h_temp_data_rate_set(&(pObj->Ctx), new_odr) != STTS22H_OK)
{
return STTS22H_ERROR;
}
return STTS22H_OK;
}
/**
* @brief Get the STTS22H temperature value
* @param pObj the device pObj
* @param Value pointer where the temperature value is written
* @retval 0 in case of success, an error code otherwise
*/
int32_t STTS22H_TEMP_GetTemperature(STTS22H_Object_t *pObj, float *Value)
{
int16_t raw_value;
/* Get the temperature */
if (stts22h_temperature_raw_get(&(pObj->Ctx), &raw_value) != STTS22H_OK)
{
return STTS22H_ERROR;
}
*Value = stts22h_from_lsb_to_celsius(raw_value);
return STTS22H_OK;
}
/**
* @brief Get the STTS22H temperature data ready bit value
* @param pObj the device pObj
* @param Status the status of data ready bit
* @retval 0 in case of success, an error code otherwise
*/
int32_t STTS22H_TEMP_Get_DRDY_Status(STTS22H_Object_t *pObj, uint8_t *Status)
{
uint8_t val;
if (stts22h_temp_flag_data_ready_get(&(pObj->Ctx), &val) != STTS22H_OK)
{
return STTS22H_ERROR;
}
if (val)
{
*Status = 1;
}
else
{
*Status = 0;
}
return STTS22H_OK;
}
/**
* @brief Set the STTS22H high temperature threshold value
* @param pObj the device pObj
* @param Value the high temperature threshold to be set
* @retval 0 in case of success, an error code otherwise
*/
int32_t STTS22H_TEMP_SetHighTemperatureThreshold(STTS22H_Object_t *pObj, float Value)
{
uint8_t raw_value;
raw_value = (uint8_t)((Value / 0.64f) + 63.0f);
/* Set the temperature threshold */
if (stts22h_temp_trshld_high_set(&(pObj->Ctx), raw_value) != STTS22H_OK)
{
return STTS22H_ERROR;
}
return STTS22H_OK;
}
/**
* @brief Set the STTS22H low temperature threshold value
* @param pObj the device pObj
* @param Value the high temperature threshold to be set
* @retval 0 in case of success, an error code otherwise
*/
int32_t STTS22H_TEMP_SetLowTemperatureThreshold(STTS22H_Object_t *pObj, float Value)
{
uint8_t raw_value;
raw_value = (uint8_t)((Value / 0.64f) + 63.0f);
/* Set the temperature threshold */
if (stts22h_temp_trshld_low_set(&(pObj->Ctx), raw_value) != STTS22H_OK)
{
return STTS22H_ERROR;
}
return STTS22H_OK;
}
/**
* @brief Get the STTS22H temperature limits status
* @param pObj the device pObj
* @param HighLimit indicates that high temperature limit has been exceeded
* @param LowhLimit indicates that low temperature limit has been exceeded
* @retval 0 in case of success, an error code otherwise
*/
int32_t STTS22H_TEMP_GetTemperatureLimitStatus(STTS22H_Object_t *pObj, uint8_t *HighLimit, uint8_t *LowLimit)
{
stts22h_temp_trlhd_src_t status;
/* Read status register */
if (stts22h_temp_trshld_src_get(&(pObj->Ctx), &status) != STTS22H_OK)
{
return STTS22H_ERROR;
}
if (HighLimit != NULL)
{
*HighLimit = status.over_thh;
}
if (LowLimit != NULL)
{
*LowLimit = status.under_thl;
}
return STTS22H_OK;
}
/**
* @brief Get the STTS22H register value
* @param pObj the device pObj
* @param Reg address to be read
* @param Data pointer where the value is written
* @retval 0 in case of success, an error code otherwise
*/
int32_t STTS22H_Read_Reg(STTS22H_Object_t *pObj, uint8_t Reg, uint8_t *Data)
{
if (stts22h_read_reg(&(pObj->Ctx), Reg, Data, 1) != STTS22H_OK)
{
return STTS22H_ERROR;
}
return STTS22H_OK;
}
/**
* @brief Set the STTS22H register value
* @param pObj the device pObj
* @param Reg address to be written
* @param Data value to be written
* @retval 0 in case of success, an error code otherwise
*/
int32_t STTS22H_Write_Reg(STTS22H_Object_t *pObj, uint8_t Reg, uint8_t Data)
{
if (stts22h_write_reg(&(pObj->Ctx), Reg, &Data, 1) != STTS22H_OK)
{
return STTS22H_ERROR;
}
return STTS22H_OK;
}
/**
* @brief Set the STTS22H One Shot Mode
* @param pObj the device pObj
* @retval 0 in case of success, an error code otherwise
*/
int32_t STTS22H_Set_One_Shot(STTS22H_Object_t *pObj)
{
/* Start One Shot Measurement */
if (stts22h_temp_data_rate_set(&(pObj->Ctx), STTS22H_ONE_SHOT) != STTS22H_OK)
{
return STTS22H_ERROR;
}
return STTS22H_OK;
}
/**
* @brief Get the STTS22H One Shot Status
* @param pObj the device pObj
* @param Status pointer to the one shot status (1 means measurements available, 0 means measurements not available yet)
* @retval 0 in case of success, an error code otherwise
*/
int32_t STTS22H_Get_One_Shot_Status(STTS22H_Object_t *pObj, uint8_t *Status)
{
stts22h_dev_status_t status;
/* Get Busy flag */
if (stts22h_dev_status_get(&(pObj->Ctx), &status) != STTS22H_OK)
{
return STTS22H_ERROR;
}
if (status.busy)
{
*Status = 0;
}
else
{
*Status = 1;
}
return STTS22H_OK;
}
/**
* @}
*/
/** @defgroup STTS22H_Private_Functions STTS22H Private Functions
* @{
*/
/**
* @brief Wrap Read register component function to Bus IO function
* @param Handle the device handler
* @param Reg the register address
* @param pData the stored data pointer
* @param Length the length
* @retval 0 in case of success, an error code otherwise
*/
static int32_t ReadRegWrap(void *Handle, uint8_t Reg, uint8_t *pData, uint16_t Length)
{
uint16_t i;
int32_t ret = STTS22H_OK;
STTS22H_Object_t *pObj = (STTS22H_Object_t *)Handle;
if (pObj->IO.BusType == (uint32_t)STTS22H_I2C_BUS) /* I2C */
{
for (i = 0; i < Length; i++)
{
ret = pObj->IO.ReadReg(pObj->IO.Address, (Reg + i), &pData[i], 1);
if (ret != STTS22H_OK)
{
return STTS22H_ERROR;
}
}
}
return ret;
}
/**
* @brief Wrap Write register component function to Bus IO function
* @param Handle the device handler
* @param Reg the register address
* @param pData the stored data pointer
* @param Length the length
* @retval 0 in case of success, an error code otherwise
*/
static int32_t WriteRegWrap(void *Handle, uint8_t Reg, uint8_t *pData, uint16_t Length)
{
uint16_t i;
int32_t ret = STTS22H_OK;
STTS22H_Object_t *pObj = (STTS22H_Object_t *)Handle;
if (pObj->IO.BusType == (uint32_t)STTS22H_I2C_BUS) /* I2C */
{
for (i = 0; i < Length; i++)
{
ret = pObj->IO.WriteReg(pObj->IO.Address, (Reg + i), &pData[i], 1);
if (ret != STTS22H_OK)
{
return STTS22H_ERROR;
}
}
}
return ret;
}
/**
* @}
*/
/**
* @}
*/
/**
* @}
*/
/**
* @}
*/