tmp00x.h
Go to the documentation of this file.
1 /*
2  * Copyright (C) 2014 PHYTEC Messtechnik GmbH
3  * 2017 - 2019 HAW Hamburg
4  *
5  * This file is subject to the terms and conditions of the GNU Lesser
6  * General Public License v2.1. See the file LICENSE in the top level
7  * directory for more details.
8  */
9 
10 #pragma once
11 
82 #include <stdint.h>
83 #include <stdbool.h>
84 #include "periph/i2c.h"
85 #include "kernel_defines.h"
86 
87 #ifdef __cplusplus
88 extern "C"
89 {
90 #endif
91 
92 #define BUS (dev->p.i2c)
93 #define ADDR (dev->p.addr)
108 #ifndef CONFIG_TMP00X_I2C_ADDRESS
109 #define CONFIG_TMP00X_I2C_ADDRESS (0x40)
110 #endif
111 
119 #if IS_ACTIVE(CONFIG_TMP00X_CONVERSION_TIME_0_25S)
120 #define CONFIG_TMP00X_CONVERSION_TIME (25E4)
121 #elif IS_ACTIVE(CONFIG_TMP00X_CONVERSION_TIME_0_5S)
122 #define CONFIG_TMP00X_CONVERSION_TIME (5E5)
123 #elif IS_ACTIVE(CONFIG_TMP00X_CONVERSION_TIME_1S)
124 #define CONFIG_TMP00X_CONVERSION_TIME (1E6)
125 #elif IS_ACTIVE(CONFIG_TMP00X_CONVERSION_TIME_2S)
126 #define CONFIG_TMP00X_CONVERSION_TIME (2E6)
127 #elif IS_ACTIVE(CONFIG_TMP00X_CONVERSION_TIME_4S)
128 #define CONFIG_TMP00X_CONVERSION_TIME (4E6)
129 #endif
130 
131 #ifndef CONFIG_TMP00X_CONVERSION_TIME
132 #define CONFIG_TMP00X_CONVERSION_TIME (1E6)
133 #endif
134 
143 #ifdef DOXYGEN
144 #define CONFIG_TMP00X_USE_LOW_POWER
145 #endif
146 
153 #ifdef DOXYGEN
154 #define CONFIG_TMP00X_USE_RAW_VALUES
155 #endif
162 #define TMP00X_CONFIG_CR_AS1 (0x00)
163 #define TMP00X_CONFIG_CR_AS2 (0x01)
164 #define TMP00X_CONFIG_CR_AS4 (0x02)
165 #define TMP00X_CONFIG_CR_AS8 (0x03)
166 #define TMP00X_CONFIG_CR_AS16 (0x04)
167 #define TMP00X_CONFIG_CR_DEF TMP00X_CONFIG_CR_AS4
174 #ifndef TMP00X_CCONST_S0
175 #define TMP00X_CCONST_S0 (6.4E-14)
176 #endif
177 #define TMP00X_CCONST_A1 (1.75E-3)
178 #define TMP00X_CCONST_A2 (-1.678E-5)
179 #define TMP00X_CCONST_TREF (298.15)
180 #define TMP00X_CCONST_B0 (-2.94E-5)
181 #define TMP00X_CCONST_B1 (-5.7E-7)
182 #define TMP00X_CCONST_B2 (4.63E-9)
183 #define TMP00X_CCONST_C2 (13.4)
184 #define TMP00X_CCONST_LSB_SIZE (156.25E-9)
190 typedef struct {
192  uint8_t addr;
193  uint8_t rate;
195 
199 typedef struct {
201 } tmp00x_t;
202 
206 enum {
212 };
213 
225 int tmp00x_init(tmp00x_t *dev, const tmp00x_params_t *params);
226 
235 int tmp00x_reset(const tmp00x_t *dev);
236 
245 int tmp00x_set_active(const tmp00x_t *dev);
246 
255 int tmp00x_set_standby(const tmp00x_t *dev);
256 
268 int tmp00x_read(const tmp00x_t *dev, int16_t *rawv, int16_t *rawt, uint16_t *drdy);
269 
278 void tmp00x_convert(int16_t rawv, int16_t rawt, float *tamb, float *tobj);
279 
293 int tmp00x_read_temperature(const tmp00x_t *dev, int16_t *ta, int16_t *to);
294 
295 #ifdef __cplusplus
296 }
297 #endif
298 
uint_fast8_t i2c_t
Default i2c_t type definition.
Definition: i2c.h:144
int tmp00x_read(const tmp00x_t *dev, int16_t *rawv, int16_t *rawt, uint16_t *drdy)
Read sensor's data.
int tmp00x_set_standby(const tmp00x_t *dev)
Set standby mode.
int tmp00x_read_temperature(const tmp00x_t *dev, int16_t *ta, int16_t *to)
Convenience function to get ambient and object temperatures in [°C].
void tmp00x_convert(int16_t rawv, int16_t rawt, float *tamb, float *tobj)
Convert raw sensor values to temperature.
int tmp00x_init(tmp00x_t *dev, const tmp00x_params_t *params)
Initialize the TMP00X sensor driver.
int tmp00x_reset(const tmp00x_t *dev)
Reset the TMP00X sensor, afterwards it should be reinitialized.
int tmp00x_set_active(const tmp00x_t *dev)
Set active mode, this enables periodic measurements.
@ TMP00X_ERROR_DEV
internal device error
Definition: tmp00x.h:209
@ TMP00X_ERROR_CONF
invalid device configuration
Definition: tmp00x.h:210
@ TMP00X_ERROR
general error
Definition: tmp00x.h:211
@ TMP00X_OK
Success, no error.
Definition: tmp00x.h:207
@ TMP00X_ERROR_BUS
I2C bus error.
Definition: tmp00x.h:208
Low-level I2C peripheral driver interface definition.
Common macros and compiler attributes/pragmas configuration.
Parameters needed for device initialization.
Definition: tmp00x.h:190
i2c_t i2c
I2C device, the sensor is connected to.
Definition: tmp00x.h:191
uint8_t rate
number of averaged samples
Definition: tmp00x.h:193
uint8_t addr
the sensor's slave address on the I2C bus
Definition: tmp00x.h:192
Device descriptor for TMP00X sensors.
Definition: tmp00x.h:199
tmp00x_params_t p
Configuration parameters.
Definition: tmp00x.h:200