lsm303dlhc.h
Go to the documentation of this file.
1 /*
2  * Copyright (C) 2014 Freie Universit├Ąt Berlin
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 
24 #ifndef LSM303DLHC_H
25 #define LSM303DLHC_H
26 
27 #include <stdint.h>
28 #include "periph/i2c.h"
29 #include "periph/gpio.h"
30 
31 #ifdef __cplusplus
32 extern "C" {
33 #endif
34 
39 #define LSM303DLHC_ACC_DEFAULT_ADDRESS (0x19)
40 #define LSM303DLHC_MAG_DEFAULT_ADDRESS (0x1e)
41 
46 typedef enum {
58 
62 typedef enum {
68 
72 typedef enum {
82 
86  typedef enum {
95 
99 typedef struct {
100  int16_t x_axis;
101  int16_t y_axis;
102  int16_t z_axis;
104 
108 typedef struct {
110  uint8_t acc_addr;
111  gpio_t acc_pin;
114  uint8_t mag_addr;
115  gpio_t mag_pin;
119 
123 typedef struct {
125 } lsm303dlhc_t;
126 
136 int lsm303dlhc_init(lsm303dlhc_t *dev, const lsm303dlhc_params_t *params);
137 
158 
182 
192 int lsm303dlhc_read_temp(const lsm303dlhc_t *dev, int16_t *value);
193 
202 int lsm303dlhc_enable(const lsm303dlhc_t *dev);
203 
212 int lsm303dlhc_disable(const lsm303dlhc_t *dev);
213 
214 #ifdef __cplusplus
215 }
216 #endif
217 
218 #endif /* LSM303DLHC_H */
219 
Low-level GPIO peripheral driver interface definitions.
lsm303dlhc_params_t params
device initialization parameters
Definition: lsm303dlhc.h:124
uint8_t mag_addr
magnetometer I2C address
Definition: lsm303dlhc.h:114
int lsm303dlhc_init(lsm303dlhc_t *dev, const lsm303dlhc_params_t *params)
Initialize a new LSM303DLHC device.
3d data container
Definition: lsm303dlhc.h:99
lsm303dlhc_mag_sample_rate_t
Possible magnetometer sample rates.
Definition: lsm303dlhc.h:72
i2c_t i2c
I2C bus used.
Definition: lsm303dlhc.h:109
gpio_t mag_pin
magnetometer EXTI pin
Definition: lsm303dlhc.h:115
unsigned int i2c_t
Default i2c_t type definition.
Definition: i2c.h:157
lsm303dlhc_mag_gain_t
Possible magnetometer gain values.
Definition: lsm303dlhc.h:86
Device descriptor for LSM303DLHC sensors.
Definition: lsm303dlhc.h:123
450Gauss XYZ 400Gauss Z
Definition: lsm303dlhc.h:90
lsm303dlhc_acc_scale_t acc_scale
accelerometer scale factor
Definition: lsm303dlhc.h:113
int lsm303dlhc_read_mag(const lsm303dlhc_t *dev, lsm303dlhc_3d_data_t *data)
Read a magnetometer value from the sensor.
int16_t z_axis
surprise, holds the z axis value
Definition: lsm303dlhc.h:102
230Gauss XYZ 205Gauss Z
Definition: lsm303dlhc.h:93
int16_t y_axis
holds the y axis value.
Definition: lsm303dlhc.h:101
1100Gauss XYZ 980Gauss Z
Definition: lsm303dlhc.h:87
lsm303dlhc_acc_scale_t
Possible accelerometer scales.
Definition: lsm303dlhc.h:62
int16_t x_axis
holds the x axis value.
Definition: lsm303dlhc.h:100
gpio_t acc_pin
accelerometer EXTI pin
Definition: lsm303dlhc.h:111
int lsm303dlhc_read_temp(const lsm303dlhc_t *dev, int16_t *value)
Read a temperature value from the sensor.
uint8_t acc_addr
accelerometer I2C address
Definition: lsm303dlhc.h:110
Data structure holding all the information needed for initialization.
Definition: lsm303dlhc.h:108
lsm303dlhc_mag_gain_t mag_gain
magnetometer gain
Definition: lsm303dlhc.h:117
855Gauss XYZ 760Gauss Z
Definition: lsm303dlhc.h:88
400Gauss XYZ 355Gauss Z
Definition: lsm303dlhc.h:91
int lsm303dlhc_enable(const lsm303dlhc_t *dev)
Enable the given sensor.
int lsm303dlhc_disable(const lsm303dlhc_t *dev)
Disable the given sensor.
330Gauss XYZ 295Gauss Z
Definition: lsm303dlhc.h:92
lsm303dlhc_acc_sample_rate_t acc_rate
accelerometer sample rate
Definition: lsm303dlhc.h:112
lsm303dlhc_acc_sample_rate_t
Possible accelerometer sample rates.
Definition: lsm303dlhc.h:46
670Gauss XYZ 600Gauss Z
Definition: lsm303dlhc.h:89
1344Hz normal mode, 5376Hz low power mode
Definition: lsm303dlhc.h:55
int lsm303dlhc_read_acc(const lsm303dlhc_t *dev, lsm303dlhc_3d_data_t *data)
Read a accelerometer value from the sensor.
lsm303dlhc_mag_sample_rate_t mag_rate
magnetometer sample rate
Definition: lsm303dlhc.h:116
Low-level I2C peripheral driver interface definition.