foxBMS  1.6.0
The foxBMS Battery Management System API Documentation
htsensor.h
Go to the documentation of this file.
1 /**
2  *
3  * @copyright © 2010 - 2023, Fraunhofer-Gesellschaft zur Foerderung der angewandten Forschung e.V.
4  * All rights reserved.
5  *
6  * SPDX-License-Identifier: BSD-3-Clause
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions are met:
10  *
11  * 1. Redistributions of source code must retain the above copyright notice, this
12  * list of conditions and the following disclaimer.
13  *
14  * 2. Redistributions in binary form must reproduce the above copyright notice,
15  * this list of conditions and the following disclaimer in the documentation
16  * and/or other materials provided with the distribution.
17  *
18  * 3. Neither the name of the copyright holder nor the names of its
19  * contributors may be used to endorse or promote products derived from
20  * this software without specific prior written permission.
21  *
22  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
23  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
25  * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
26  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
28  * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
29  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
30  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
31  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
32  *
33  * We kindly request you to use one or more of the following phrases to refer to
34  * foxBMS in your hardware, software, documentation or advertising materials:
35  *
36  * - ″This product uses parts of foxBMS®″
37  * - ″This product includes parts of foxBMS®″
38  * - ″This product is derived from foxBMS®″
39  *
40  */
41 
42 /**
43  * @file htsensor.h
44  * @author foxBMS Team
45  * @date 2021-08-05 (date of creation)
46  * @updated 2023-10-12 (date of last update)
47  * @version v1.6.0
48  * @ingroup DRIVERS
49  * @prefix HTSEN
50  *
51  * @brief Header for the driver for the Sensirion SHT35-DIS I2C humidity/temperature sensor
52  *
53  */
54 
55 #ifndef FOXBMS__HTSENSOR_H_
56 #define FOXBMS__HTSENSOR_H_
57 
58 /*========== Includes =======================================================*/
59 
60 #include <stdint.h>
61 
62 /*========== Macros and Definitions =========================================*/
63 
64 /**
65  * States for the sensor readout
66  */
67 typedef enum {
68  HTSEN_START_MEAS,
69  HTSEN_READ_RESULTS,
70 } HTSEN_STATE_e;
71 
72 /*========== Extern Constant and Variable Declarations ======================*/
73 
74 /*========== Extern Function Prototypes =====================================*/
75 
76 /**
77  * @brief triggers a measurement of the I2C humidity/temperature sensor.
78  * @details This function steps through the state-machine that handles
79  * the measurement with the I2C sensor.
80  */
81 extern void HTSEN_Trigger(void);
82 
83 /*========== Externalized Static Functions Prototypes (Unit Test) ===========*/
84 #ifdef UNITY_UNIT_TEST
85 extern uint8_t TEST_HTSEN_TestCalculateCrc8(uint8_t *data, uint32_t length);
86 #endif
87 
88 #endif /* FOXBMS__HTSENSOR_H_ */
HTSEN_STATE_e
HTSEN_STATE_e
Definition: htsensor.h:67
HTSEN_READ_RESULTS
@ HTSEN_READ_RESULTS
Definition: htsensor.h:69
HTSEN_START_MEAS
@ HTSEN_START_MEAS
Definition: htsensor.h:68
HTSEN_Trigger
void HTSEN_Trigger(void)
triggers a measurement of the I2C humidity/temperature sensor.
Definition: htsensor.c:223