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_OK 0
65 #define TILTNSHAKE_ERROR -1
66 
72 #define TILTNSHAKE_MMA8491Q_I2C 0x55
73 
79 #define TILTNSHAKE_STATUS_REG 0x00
80 #define TILTNSHAKE_DATA_READY 0x0F
81 
87 #define TILTNSHAKE_OUT_X_MSB_REG 0x01
88 #define TILTNSHAKE_OUT_X_LSB_REG 0x02
89 #define TILTNSHAKE_OUT_Y_MSB_REG 0x03
90 #define TILTNSHAKE_OUT_Y_LSB_REG 0x04
91 #define TILTNSHAKE_OUT_Z_MSB 0x05
92 #define TILTNSHAKE_OUT_Z_LSB 0x06
93  // End group macro
96 // --------------------------------------------------------------- PUBLIC TYPES
105 typedef struct
106 {
107  // Output pins
108  digital_out_t en;
109 
110  // Input pins
111  digital_in_t int_pin;
112 
113  // Modules
114  i2c_master_t i2c;
115 
116  // ctx variable
117  uint8_t slave_address;
118 
119 } tiltnshake_t;
120 
124 typedef struct
125 {
126  // Communication gpio pins
127  pin_name_t scl;
128  pin_name_t sda;
129 
130  // Additional gpio pins
131  pin_name_t en;
132  pin_name_t int_pin;
133 
134  // static variable
135  uint32_t i2c_speed;
136  uint8_t i2c_address;
137 
139  // End types group
141 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
142 
148 #ifdef __cplusplus
149 extern "C"{
150 #endif
151 
161 
171 
182 void tiltnshake_generic_write ( tiltnshake_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
183 
194 void tiltnshake_generic_read ( tiltnshake_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
195 
204 
213 
225 void tiltnshake_read_status_and_axis ( tiltnshake_t *ctx, uint8_t *status,
226  float *out_x, float *out_y, float *out_z );
227 
228 #ifdef __cplusplus
229 }
230 #endif
231 #endif // _TILTNSHAKE_H_
232  // End public_function group
235 
236 // ------------------------------------------------------------------------- END
tiltnshake_cfg_t
Click configuration structure definition.
Definition: tiltnshake.h:125
tiltnshake_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: tiltnshake.h:135
tiltnshake_cfg_t::i2c_address
uint8_t i2c_address
Definition: tiltnshake.h:136
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:127
tiltnshake_t::i2c
i2c_master_t i2c
Definition: tiltnshake.h:114
tiltnshake_cfg_t::int_pin
pin_name_t int_pin
Definition: tiltnshake.h:132
tiltnshake_cfg_t::sda
pin_name_t sda
Definition: tiltnshake.h:128
tiltnshake_t::slave_address
uint8_t slave_address
Definition: tiltnshake.h:117
tiltnshake_read_status_and_axis
void tiltnshake_read_status_and_axis(tiltnshake_t *ctx, uint8_t *status, float *out_x, float *out_y, float *out_z)
Function for read status and axis.
tiltnshake_t::en
digital_out_t en
Definition: tiltnshake.h:108
tiltnshake_enable
void tiltnshake_enable(tiltnshake_t *ctx)
Function for enabling chip.
tiltnshake_cfg_setup
void tiltnshake_cfg_setup(tiltnshake_cfg_t *cfg)
Config Object Initialization function.
tiltnshake_init
err_t tiltnshake_init(tiltnshake_t *ctx, tiltnshake_cfg_t *cfg)
Initialization function.
tiltnshake_cfg_t::en
pin_name_t en
Definition: tiltnshake.h:131
tiltnshake_t
Click ctx object definition.
Definition: tiltnshake.h:106
tiltnshake_generic_write
void tiltnshake_generic_write(tiltnshake_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
Generic write function.
tiltnshake_disable
void tiltnshake_disable(tiltnshake_t *ctx)
Function for disabling chip.
tiltnshake_t::int_pin
digital_in_t int_pin
Definition: tiltnshake.h:111