motion3  2.0.0.0
motion3.h
Go to the documentation of this file.
1 /****************************************************************************
2 ** Copyright (C) 2020 MikroElektronika d.o.o.
3 ** Contact: https://www.mikroe.com/contact
4 **
5 ** Permission is hereby granted, free of charge, to any person obtaining a copy
6 ** of this software and associated documentation files (the "Software"), to deal
7 ** in the Software without restriction, including without limitation the rights
8 ** to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9 ** copies of the Software, and to permit persons to whom the Software is
10 ** furnished to do so, subject to the following conditions:
11 ** The above copyright notice and this permission notice shall be
12 ** included in all copies or substantial portions of the Software.
13 **
14 ** THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
15 ** EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
16 ** OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
17 ** IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
18 ** DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
19 ** OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
20 ** USE OR OTHER DEALINGS IN THE SOFTWARE.
21 ****************************************************************************/
22 
28 #ifndef MOTION3_H
29 #define MOTION3_H
30 
31 #ifdef __cplusplus
32 extern "C"{
33 #endif
34 
35 #include "mikrosdk_version.h"
36 
37 #ifdef __GNUC__
38 #if mikroSDK_GET_VERSION < 20800ul
39 #include "rcu_delays.h"
40 #else
41 #include "delays.h"
42 #endif
43 #endif
44 
45 #include "drv_digital_out.h"
46 #include "drv_digital_in.h"
47 
68 #define MOTION3_MODULE_ENABLE 0x00
69 #define MOTION3_MODULE_DISABLE 0x01
70 #define MOTION3_NO_DETECT_OBJECT 0x00
71 #define MOTION3_DETECT_OBJECT 0x01
72  // motion3_set
74 
89 #define MOTION3_MAP_MIKROBUS( cfg, mikrobus ) \
90  cfg.en = MIKROBUS( mikrobus, MIKROBUS_RST ); \
91  cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
92  // motion3_map // motion3
95 
100 typedef struct
101 {
102  // Output pins
103 
104  digital_out_t en;
105 
106  // Input pins
107 
108  digital_in_t int_pin;
109 
110 } motion3_t;
111 
116 typedef struct
117 {
118  // Additional gpio pins
119 
120  pin_name_t en;
121  pin_name_t int_pin;
123 } motion3_cfg_t;
124 
129 typedef enum
130 {
132  MOTION3_ERROR = -1
133 
135 
141 typedef enum
142 {
145 
147 
148 typedef enum
149 {
152 
154 
165 
180 err_t motion3_init ( motion3_t *ctx, motion3_cfg_t *cfg );
181 
191 void motion3_enable ( motion3_t *ctx, uint8_t state );
192 
203 
204 #ifdef __cplusplus
205 }
206 #endif
207 #endif // MOTION3_H
208  // motion3
210 
211 // ------------------------------------------------------------------------ END
MOTION3_DETECTED
@ MOTION3_DETECTED
Definition: motion3.h:144
motion3_detect_state_t
motion3_detect_state_t
Definition: motion3.h:142
motion3_pin_state_t
motion3_pin_state_t
Definition: motion3.h:149
motion3_return_value_t
motion3_return_value_t
Motion 3 Click return value data.
Definition: motion3.h:130
MOTION3_ERROR
@ MOTION3_ERROR
Definition: motion3.h:132
motion3_cfg_t::en
pin_name_t en
Definition: motion3.h:120
motion3_t::int_pin
digital_in_t int_pin
Definition: motion3.h:108
motion3_detect_state
uint8_t motion3_detect_state(motion3_t *ctx)
Get detection state function.
MOTION3_OK
@ MOTION3_OK
Definition: motion3.h:131
motion3_init
err_t motion3_init(motion3_t *ctx, motion3_cfg_t *cfg)
Motion 3 initialization function.
motion3_t
Motion 3 Click context object.
Definition: motion3.h:101
motion3_enable
void motion3_enable(motion3_t *ctx, uint8_t state)
Enable motion sensor function.
motion3_cfg_setup
void motion3_cfg_setup(motion3_cfg_t *cfg)
Motion 3 configuration object setup function.
MOTION3_PIN_STATE_HIGH
@ MOTION3_PIN_STATE_HIGH
Definition: motion3.h:151
MOTION3_PIN_STATE_LOW
@ MOTION3_PIN_STATE_LOW
Definition: motion3.h:150
motion3_cfg_t
Motion 3 Click configuration object.
Definition: motion3.h:117
motion3_t::en
digital_out_t en
Definition: motion3.h:104
motion3_cfg_t::int_pin
pin_name_t int_pin
Definition: motion3.h:121
MOTION3_NO_DETECT
@ MOTION3_NO_DETECT
Definition: motion3.h:143