mag3110.h
Go to the documentation of this file.
1 /*
2  * Copyright (C) 2014 PHYTEC Messtechnik GmbH
3  * 2017 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 
35 #ifndef MAG3110_H
36 #define MAG3110_H
37 
38 #include <stdint.h>
39 #include <stdbool.h>
40 #include "periph/i2c.h"
41 
42 #ifdef __cplusplus
43 extern "C"
44 {
45 #endif
46 
50 enum {
55 };
56 
57 #ifndef MAG3110_I2C_ADDRESS
58 #define MAG3110_I2C_ADDRESS 0x0E
59 #endif
60 
65 #define MAG3110_DROS_8000_16 0
66 #define MAG3110_DROS_4000_32 1
67 #define MAG3110_DROS_2000_64 2
68 #define MAG3110_DROS_1000_128 3
69 #define MAG3110_DROS_4000_16 4
70 #define MAG3110_DROS_2000_32 5
71 #define MAG3110_DROS_1000_64 6
72 #define MAG3110_DROS_0500_128 7
73 #define MAG3110_DROS_2000_16 8
74 #define MAG3110_DROS_1000_32 9
75 #define MAG3110_DROS_0500_64 10
76 #define MAG3110_DROS_0250_128 11
77 #define MAG3110_DROS_1000_16 12
78 #define MAG3110_DROS_0500_32 13
79 #define MAG3110_DROS_0250_64 14
80 #define MAG3110_DROS_0125_128 15
81 #define MAG3110_DROS_0500_16 16
82 #define MAG3110_DROS_0250_32 17
83 #define MAG3110_DROS_0125_64 18
84 #define MAG3110_DROS_0063_128 19
85 #define MAG3110_DROS_0250_16 20
86 #define MAG3110_DROS_0125_32 21
87 #define MAG3110_DROS_0063_64 22
88 #define MAG3110_DROS_0031_128 23
89 #define MAG3110_DROS_0125_16 24
90 #define MAG3110_DROS_0063_32 25
91 #define MAG3110_DROS_0031_64 26
92 #define MAG3110_DROS_0016_128 27
93 #define MAG3110_DROS_0063_16 28
94 #define MAG3110_DROS_0031_32 29
95 #define MAG3110_DROS_0016_64 30
96 #define MAG3110_DROS_0008_128 31
97 #define MAG3110_DROS_DEFAULT MAG3110_DROS_0125_128
103 typedef struct {
105  uint8_t addr;
106  uint8_t type;
107  uint8_t dros;
108  int16_t offset[3];
110 
114 typedef struct {
116 } mag3110_t;
117 
121 typedef struct {
122  int16_t x;
123  int16_t y;
124  int16_t z;
126 
138 int mag3110_init(mag3110_t *dev, const mag3110_params_t *params);
139 
153 int mag3110_set_user_offset(const mag3110_t *dev, int16_t x, int16_t y, int16_t z);
154 
163 int mag3110_set_active(const mag3110_t *dev);
164 
173 int mag3110_set_standby(const mag3110_t *dev);
174 
184 int mag3110_is_ready(const mag3110_t *dev);
185 
198 int mag3110_read(const mag3110_t *dev, mag3110_data_t *data);
199 
209 int mag3110_read_dtemp(const mag3110_t *dev, int8_t *dtemp);
210 
211 #ifdef __cplusplus
212 }
213 #endif
214 
215 #endif /* MAG3110_H */
216 
Configuration parameters.
Definition: mag3110.h:103
I2C communication failed.
Definition: mag3110.h:52
int mag3110_init(mag3110_t *dev, const mag3110_params_t *params)
Initialise the MAG3110 magnetometer driver.
uint8_t addr
I2C bus address of the device.
Definition: mag3110.h:105
int mag3110_read(const mag3110_t *dev, mag3110_data_t *data)
Read magnetometer&#39;s data.
Device configuration failed.
Definition: mag3110.h:54
unsigned int i2c_t
Default i2c_t type definition.
Definition: i2c.h:157
mag3110_params_t params
device configuration parameters
Definition: mag3110.h:115
int mag3110_set_user_offset(const mag3110_t *dev, int16_t x, int16_t y, int16_t z)
Set user offset correction.
Device MAG3110 not found.
Definition: mag3110.h:53
all good
Definition: mag3110.h:51
uint8_t type
device type
Definition: mag3110.h:106
int16_t z
acceleration in Z direction
Definition: mag3110.h:124
int mag3110_set_standby(const mag3110_t *dev)
Set standby mode.
i2c_t i2c
I2C bus the device is connected to.
Definition: mag3110.h:104
Data type for the result data.
Definition: mag3110.h:121
int16_t y
acceleration in Y direction
Definition: mag3110.h:123
int mag3110_set_active(const mag3110_t *dev)
Set active mode, this enables periodic measurements.
int16_t x
acceleration in X direction
Definition: mag3110.h:122
uint8_t dros
sampling rate to use
Definition: mag3110.h:107
Device descriptor for MAG3110 magnetometer.
Definition: mag3110.h:114
int mag3110_read_dtemp(const mag3110_t *dev, int8_t *dtemp)
Read die temperature.
int mag3110_is_ready(const mag3110_t *dev)
Check for new set of measurement data.
Low-level I2C peripheral driver interface definition.