lm75.h
Go to the documentation of this file.
1 /*
2  * Copyright (C) 2021 ML!PA Consulting GmbH
3  *
4  * This file is subject to the terms and conditions of the GNU Lesser
5  * General Public License v2.1. See the file LICENSE in the top level
6  * directory for more details.
7  */
8 
9 #pragma once
10 
28 #include <stdbool.h>
29 #include "periph/i2c.h"
30 #include "periph/gpio.h"
31 
32 #ifdef __cplusplus
33 extern "C" {
34 #endif
35 
39 enum {
40  LM75_SUCCESS = 0,
41  LM75_ERROR_I2C,
42  LM75_ERROR
43 };
44 
48 typedef struct lm75_properties {
49  uint16_t os_res;
50  uint16_t os_mult;
51  uint16_t temp_res;
52  uint16_t temp_mult;
53  uint8_t os_shift;
54  uint8_t temp_shift;
56 
63 typedef struct lm75_params {
65  uint16_t conv_rate;
66  gpio_t gpio_alarm;
68  uint8_t i2c_addr;
69  uint8_t shutdown_mode;
70  uint8_t tm_mode;
71  uint8_t polarity;
72  uint8_t fault_q;
73  /* only configurable for the TMP1075 */
74  uint8_t conv_rate_reg;
76 
80 typedef struct lm75 {
83 
96 int lm75_init(lm75_t *dev, const lm75_params_t *params);
97 
113 int lm75_get_temperature_raw(lm75_t *dev, int *temperature);
114 
127 int lm75_get_temperature(lm75_t *dev, int *temperature);
128 
144 int lm75_set_temp_limits(lm75_t *dev, int temp_hyst, int temp_os, gpio_cb_t cb, void *arg);
145 
157 int lm75_get_os_temp(lm75_t *dev, int *temperature);
158 
170 int lm75_get_hyst_temp(lm75_t *dev, int *temperature);
171 
185 int lm75_get_os_pin(lm75_t *dev, bool *os_pin_state);
186 
196 
206 
219 
238 int lm75_low_power_mode(lm75_t *dev, uint16_t interval);
239 
240 #ifdef __cplusplus
241 }
242 #endif
243 
Low-level GPIO peripheral driver interface definitions.
void(* gpio_cb_t)(void *arg)
Signature of event callback functions triggered from interrupts.
Definition: gpio.h:146
uint_fast8_t i2c_t
Default i2c_t type definition.
Definition: i2c.h:144
Low-level I2C peripheral driver interface definition.
int lm75_get_hyst_temp(lm75_t *dev, int *temperature)
Hysteresis temperature value of LM75 sensor.
int tmp1075_one_shot(lm75_t *dev)
Activates one shot conversion mode.
struct lm75_properties lm75_properties_t
temperature reading properties/resolutions struct of the LM75 sensors
lm75_properties_t tmp1075_properties
declaration present in lm75.c
int lm75_poweron(lm75_t *dev)
Deactivate the LM75 sensor shutdown mode.
int lm75_low_power_mode(lm75_t *dev, uint16_t interval)
Activates low power mode operation.
int lm75_get_os_pin(lm75_t *dev, bool *os_pin_state)
Read the current state of the OS pin to see if it's active.
int lm75_get_temperature_raw(lm75_t *dev, int *temperature)
Temperature values of LM75 sensor.
int lm75_get_temperature(lm75_t *dev, int *temperature)
Temperature values of LM75 sensor.
struct lm75 lm75_t
lm75 device descriptor
int lm75_init(lm75_t *dev, const lm75_params_t *params)
Initialization of the LM75 sensor.
lm75_properties_t lm75a_properties
declaration present in lm75.c
int lm75_poweroff(lm75_t *dev)
Activate the LM75 sensor shutdown mode.
struct lm75_params lm75_params_t
params required for initialization
int lm75_get_os_temp(lm75_t *dev, int *temperature)
Overshutdown temperature value of LM75 sensor.
int lm75_set_temp_limits(lm75_t *dev, int temp_hyst, int temp_os, gpio_cb_t cb, void *arg)
Sets the values for Overtemperature shutdown(OS) and Hysteresis temperature(HYST).
params required for initialization
Definition: lm75.h:63
uint8_t shutdown_mode
Shutdown mode register.
Definition: lm75.h:69
const lm75_properties_t * res
Temperature resolutions.
Definition: lm75.h:64
gpio_t gpio_alarm
Over-temperature alarm.
Definition: lm75.h:66
uint8_t fault_q
Fault Queue register.
Definition: lm75.h:72
uint8_t conv_rate_reg
Device Conversion rate register.
Definition: lm75.h:74
i2c_t i2c_bus
I2C Bus used.
Definition: lm75.h:67
uint8_t i2c_addr
i2c address
Definition: lm75.h:68
uint8_t polarity
OS polarity register.
Definition: lm75.h:71
uint16_t conv_rate
Conversion rate in ms.
Definition: lm75.h:65
uint8_t tm_mode
Thermistor Mode.
Definition: lm75.h:70
temperature reading properties/resolutions struct of the LM75 sensors
Definition: lm75.h:48
uint8_t os_shift
how many bits need to be shifted (2 bytes - any unused bits)
Definition: lm75.h:53
uint16_t temp_mult
multiplier required for getting the temperature into ºC
Definition: lm75.h:52
uint8_t temp_shift
how many bits need to be shifted (2 bytes - any unused bits)
Definition: lm75.h:54
uint16_t os_res
resolution of the OS and HYST registers
Definition: lm75.h:49
uint16_t os_mult
multiplier required for getting the OS and HYST into ºC
Definition: lm75.h:50
uint16_t temp_res
resolution of the temperature register
Definition: lm75.h:51
lm75 device descriptor
Definition: lm75.h:80
lm75_params_t lm75_params
Configuration Parameters.
Definition: lm75.h:81