tiltnshake  2.0.0.0
tiltnshake.h
Go to the documentation of this file.
1 /*
2  * MikroSDK - MikroE Software Development Kit
3  * Copyright© 2020 MikroElektronika d.o.o.
4  *
5  * Permission is hereby granted, free of charge, to any person
6  * obtaining a copy of this software and associated documentation
7  * files (the "Software"), to deal in the Software without restriction,
8  * including without limitation the rights to use, copy, modify, merge,
9  * publish, distribute, sublicense, and/or sell copies of the Software,
10  * and to permit persons to whom the Software is furnished to do so,
11  * subject to the following conditions:
12  *
13  * The above copyright notice and this permission notice shall be
14  * included in all copies or substantial portions of the Software.
15  *
16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
17  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
19  * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
20  * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
21  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE
22  * OR OTHER DEALINGS IN THE SOFTWARE.
23  */
24 
33 // ----------------------------------------------------------------------------
34 
35 #ifndef TILTNSHAKE_H
36 #define TILTNSHAKE_H
37 
38 #include "drv_digital_out.h"
39 #include "drv_digital_in.h"
40 #include "drv_i2c_master.h"
41 
42 
43 // -------------------------------------------------------------- PUBLIC MACROS
53 #define TILTNSHAKE_MAP_MIKROBUS( cfg, mikrobus ) \
54  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
55  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
56  cfg.en = MIKROBUS( mikrobus, MIKROBUS_CS ); \
57  cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT );
58 
64 #define TILTNSHAKE_RETVAL uint8_t
65 
66 #define TILTNSHAKE_OK 0x00
67 #define TILTNSHAKE_INIT_ERROR 0xFF
68 
74 #define TILTNSHAKE_MMA8491Q_I2C 0x55
75 
81 #define TILTNSHAKE_ENABLE 1
82 #define TILTNSHAKE_DISABLE 0
83 
89 #define TILTNSHAKE_STATUS_REG 0x00
90 #define TILTNSHAKE_DATA_READY 0x0F
91 
97 #define TILTNSHAKE_OUT_X_MSB_REG 0x01
98 #define TILTNSHAKE_OUT_X_LSB_REG 0x02
99 #define TILTNSHAKE_OUT_Y_MSB_REG 0x03
100 #define TILTNSHAKE_OUT_Y_LSB_REG 0x04
101 #define TILTNSHAKE_OUT_Z_MSB 0x05
102 #define TILTNSHAKE_OUT_Z_LSB 0x06
103  // End group macro
106 // --------------------------------------------------------------- PUBLIC TYPES
115 typedef struct
116 {
117  // Output pins
118 
119  digital_out_t en;
120 
121  // Input pins
122 
123  digital_in_t int_pin;
124 
125  // Modules
126 
127  i2c_master_t i2c;
128 
129  // ctx variable
130 
131  uint8_t slave_address;
132 
133 } tiltnshake_t;
134 
138 typedef struct
139 {
140  // Communication gpio pins
141 
142  pin_name_t scl;
143  pin_name_t sda;
144 
145  // Additional gpio pins
146 
147  pin_name_t en;
148  pin_name_t int_pin;
149 
150  // static variable
151 
152  uint32_t i2c_speed;
153  uint8_t i2c_address;
154 
156  // End types group
158 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
159 
165 #ifdef __cplusplus
166 extern "C"{
167 #endif
168 
178 
188 
199 void tiltnshake_generic_write ( tiltnshake_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
200 
211 void tiltnshake_generic_read ( tiltnshake_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
212 
221 void tiltnshake_enable ( tiltnshake_t *ctx, uint8_t en );
222 
234 void tiltnshake_read_status_and_axis ( tiltnshake_t *ctx, uint8_t *status, uint16_t *out_x, uint16_t *out_y, uint16_t *out_z );
235 
249 void tiltnshake_conversion ( uint16_t *out_x, uint16_t *out_y, uint16_t *out_z, float *out_x_flo, float *out_y_flo, float *out_z_flo );
250 
251 #ifdef __cplusplus
252 }
253 #endif
254 #endif // _TILTNSHAKE_H_
255  // End public_function group
258 
259 // ------------------------------------------------------------------------- END
tiltnshake_init
TILTNSHAKE_RETVAL tiltnshake_init(tiltnshake_t *ctx, tiltnshake_cfg_t *cfg)
Initialization function.
tiltnshake_cfg_t
Click configuration structure definition.
Definition: tiltnshake.h:138
tiltnshake_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: tiltnshake.h:152
tiltnshake_enable
void tiltnshake_enable(tiltnshake_t *ctx, uint8_t en)
Function for enabled chip.
tiltnshake_cfg_t::i2c_address
uint8_t i2c_address
Definition: tiltnshake.h:153
tiltnshake_generic_read
void tiltnshake_generic_read(tiltnshake_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
Generic read function.
tiltnshake_cfg_t::scl
pin_name_t scl
Definition: tiltnshake.h:142
tiltnshake_t::i2c
i2c_master_t i2c
Definition: tiltnshake.h:127
tiltnshake_cfg_t::int_pin
pin_name_t int_pin
Definition: tiltnshake.h:148
tiltnshake_conversion
void tiltnshake_conversion(uint16_t *out_x, uint16_t *out_y, uint16_t *out_z, float *out_x_flo, float *out_y_flo, float *out_z_flo)
Function for conversion.
tiltnshake_cfg_t::sda
pin_name_t sda
Definition: tiltnshake.h:143
tiltnshake_t::slave_address
uint8_t slave_address
Definition: tiltnshake.h:131
tiltnshake_t::en
digital_out_t en
Definition: tiltnshake.h:119
tiltnshake_cfg_setup
void tiltnshake_cfg_setup(tiltnshake_cfg_t *cfg)
Config Object Initialization function.
TILTNSHAKE_RETVAL
#define TILTNSHAKE_RETVAL
Definition: tiltnshake.h:64
tiltnshake_cfg_t::en
pin_name_t en
Definition: tiltnshake.h:147
tiltnshake_t
Click ctx object definition.
Definition: tiltnshake.h:115
tiltnshake_generic_write
void tiltnshake_generic_write(tiltnshake_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
Generic write function.
tiltnshake_read_status_and_axis
void tiltnshake_read_status_and_axis(tiltnshake_t *ctx, uint8_t *status, uint16_t *out_x, uint16_t *out_y, uint16_t *out_z)
Function for read status and axis.
tiltnshake_t::int_pin
digital_in_t int_pin
Definition: tiltnshake.h:123