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 "mikrosdk_version.h"
39 
40 #ifdef __GNUC__
41 #if mikroSDK_GET_VERSION < 20800ul
42 #include "rcu_delays.h"
43 #else
44 #include "delays.h"
45 #endif
46 #endif
47 
48 #include "drv_digital_out.h"
49 #include "drv_digital_in.h"
50 #include "drv_i2c_master.h"
51 
52 
53 // -------------------------------------------------------------- PUBLIC MACROS
63 #define TILTNSHAKE_MAP_MIKROBUS( cfg, mikrobus ) \
64  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
65  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
66  cfg.en = MIKROBUS( mikrobus, MIKROBUS_CS ); \
67  cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT );
68 
74 #define TILTNSHAKE_OK 0
75 #define TILTNSHAKE_ERROR -1
76 
82 #define TILTNSHAKE_MMA8491Q_I2C 0x55
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  digital_out_t en;
119 
120  // Input pins
121  digital_in_t int_pin;
122 
123  // Modules
124  i2c_master_t i2c;
125 
126  // ctx variable
127  uint8_t slave_address;
128 
129 } tiltnshake_t;
130 
134 typedef struct
135 {
136  // Communication gpio pins
137  pin_name_t scl;
138  pin_name_t sda;
139 
140  // Additional gpio pins
141  pin_name_t en;
142  pin_name_t int_pin;
143 
144  // static variable
145  uint32_t i2c_speed;
146  uint8_t i2c_address;
147 
149  // End types group
151 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
152 
158 #ifdef __cplusplus
159 extern "C"{
160 #endif
161 
171 
181 
192 void tiltnshake_generic_write ( tiltnshake_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
193 
204 void tiltnshake_generic_read ( tiltnshake_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
205 
214 
223 
235 void tiltnshake_read_status_and_axis ( tiltnshake_t *ctx, uint8_t *status,
236  float *out_x, float *out_y, float *out_z );
237 
238 #ifdef __cplusplus
239 }
240 #endif
241 #endif // _TILTNSHAKE_H_
242  // End public_function group
245 
246 // ------------------------------------------------------------------------- END
tiltnshake_cfg_t
Click configuration structure definition.
Definition: tiltnshake.h:135
tiltnshake_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: tiltnshake.h:145
tiltnshake_cfg_t::i2c_address
uint8_t i2c_address
Definition: tiltnshake.h:146
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:137
tiltnshake_t::i2c
i2c_master_t i2c
Definition: tiltnshake.h:124
tiltnshake_cfg_t::int_pin
pin_name_t int_pin
Definition: tiltnshake.h:142
tiltnshake_cfg_t::sda
pin_name_t sda
Definition: tiltnshake.h:138
tiltnshake_t::slave_address
uint8_t slave_address
Definition: tiltnshake.h:127
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:118
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:141
tiltnshake_t
Click ctx object definition.
Definition: tiltnshake.h:116
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:121