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 
32 #ifndef MAG3110_H
33 #define MAG3110_H
34 
35 #include <stdint.h>
36 #include <stdbool.h>
37 #include "periph/i2c.h"
38 
39 #ifdef __cplusplus
40 extern "C"
41 {
42 #endif
43 
47 enum {
52 };
53 
54 #ifndef MAG3110_I2C_ADDRESS
55 #define MAG3110_I2C_ADDRESS 0x0E
56 #endif
57 
62 #define MAG3110_DROS_8000_16 0
63 #define MAG3110_DROS_4000_32 1
64 #define MAG3110_DROS_2000_64 2
65 #define MAG3110_DROS_1000_128 3
66 #define MAG3110_DROS_4000_16 4
67 #define MAG3110_DROS_2000_32 5
68 #define MAG3110_DROS_1000_64 6
69 #define MAG3110_DROS_0500_128 7
70 #define MAG3110_DROS_2000_16 8
71 #define MAG3110_DROS_1000_32 9
72 #define MAG3110_DROS_0500_64 10
73 #define MAG3110_DROS_0250_128 11
74 #define MAG3110_DROS_1000_16 12
75 #define MAG3110_DROS_0500_32 13
76 #define MAG3110_DROS_0250_64 14
77 #define MAG3110_DROS_0125_128 15
78 #define MAG3110_DROS_0500_16 16
79 #define MAG3110_DROS_0250_32 17
80 #define MAG3110_DROS_0125_64 18
81 #define MAG3110_DROS_0063_128 19
82 #define MAG3110_DROS_0250_16 20
83 #define MAG3110_DROS_0125_32 21
84 #define MAG3110_DROS_0063_64 22
85 #define MAG3110_DROS_0031_128 23
86 #define MAG3110_DROS_0125_16 24
87 #define MAG3110_DROS_0063_32 25
88 #define MAG3110_DROS_0031_64 26
89 #define MAG3110_DROS_0016_128 27
90 #define MAG3110_DROS_0063_16 28
91 #define MAG3110_DROS_0031_32 29
92 #define MAG3110_DROS_0016_64 30
93 #define MAG3110_DROS_0008_128 31
94 #define MAG3110_DROS_DEFAULT MAG3110_DROS_0125_128
100 typedef struct {
102  uint8_t addr;
103  uint8_t type;
104  uint8_t dros;
105  int16_t offset[3];
107 
111 typedef struct {
113 } mag3110_t;
114 
118 typedef struct {
119  int16_t x;
120  int16_t y;
121  int16_t z;
123 
135 int mag3110_init(mag3110_t *dev, const mag3110_params_t *params);
136 
150 int mag3110_set_user_offset(const mag3110_t *dev, int16_t x, int16_t y, int16_t z);
151 
160 int mag3110_set_active(const mag3110_t *dev);
161 
170 int mag3110_set_standby(const mag3110_t *dev);
171 
181 int mag3110_is_ready(const mag3110_t *dev);
182 
195 int mag3110_read(const mag3110_t *dev, mag3110_data_t *data);
196 
206 int mag3110_read_dtemp(const mag3110_t *dev, int8_t *dtemp);
207 
208 #ifdef __cplusplus
209 }
210 #endif
211 
212 #endif /* MAG3110_H */
213 
all good
Definition: mag3110.h:48
Device MAG3110 not found.
Definition: mag3110.h:50
Configuration parameters.
Definition: mag3110.h:100
Device configuration failed.
Definition: mag3110.h:51
int mag3110_init(mag3110_t *dev, const mag3110_params_t *params)
Initialise the MAG3110 magnetometer driver.
I2C communication failed.
Definition: mag3110.h:49
uint8_t addr
I2C bus address of the device.
Definition: mag3110.h:102
int mag3110_read(const mag3110_t *dev, mag3110_data_t *data)
Read magnetometer&#39;s data.
unsigned int i2c_t
Default i2c_t type definition.
Definition: i2c.h:108
mag3110_params_t params
device configuration parameters
Definition: mag3110.h:112
int mag3110_set_user_offset(const mag3110_t *dev, int16_t x, int16_t y, int16_t z)
Set user offset correction.
uint8_t type
device type
Definition: mag3110.h:103
int16_t z
acceleration in Z direction
Definition: mag3110.h:121
int mag3110_set_standby(const mag3110_t *dev)
Set standby mode.
i2c_t i2c
I2C bus the device is connected to.
Definition: mag3110.h:101
Data type for the result data.
Definition: mag3110.h:118
int16_t y
acceleration in Y direction
Definition: mag3110.h:120
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:119
uint8_t dros
sampling rate to use
Definition: mag3110.h:104
Device descriptor for MAG3110 magnetometer.
Definition: mag3110.h:111
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.