motion2  2.0.0.0
motion2.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 MOTION2_H
29 #define MOTION2_H
30 
31 #ifdef __cplusplus
32 extern "C"{
33 #endif
34 
35 #include "drv_digital_out.h"
36 #include "drv_digital_in.h"
37 
58 #define MOTION2_MODULE_ENABLE 0x00
59 #define MOTION2_MODULE_DISABLE 0x01
60 #define MOTION2_NO_DETECT_OBJECT 0x00
61 #define MOTION2_DETECT_OBJECT 0x01
62  // motion2_set
64 
79 #define MOTION2_MAP_MIKROBUS( cfg, mikrobus ) \
80  cfg.en = MIKROBUS( mikrobus, MIKROBUS_RST ); \
81  cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT );
82  // motion2_map // motion2
85 
90 typedef struct
91 {
92  // Output pins
93 
94  digital_out_t en;
95 
96  // Input pins
97 
98  digital_in_t int_pin;
99 
100 } motion2_t;
101 
106 typedef struct
107 {
108  // Additional gpio pins
109 
110  pin_name_t en;
111  pin_name_t int_pin;
112 
113 } motion2_cfg_t;
114 
119 typedef enum
120 {
122  MOTION2_ERROR = -1
123 
131 typedef enum
132 {
135 
137 
138 typedef enum
139 {
142 
144 
145 
155 
163 err_t motion2_init ( motion2_t *ctx, motion2_cfg_t *cfg );
164 
172 void motion2_enable ( motion2_t *ctx, uint8_t state );
173 
183 
184 #ifdef __cplusplus
185 }
186 #endif
187 #endif // MOTION2_H
188  // motion2
190 
191 // ------------------------------------------------------------------------ END
MOTION2_ERROR
@ MOTION2_ERROR
Definition: motion2.h:122
MOTION2_DETECTED
@ MOTION2_DETECTED
Definition: motion2.h:134
motion2_t::en
digital_out_t en
Definition: motion2.h:94
motion2_enable
void motion2_enable(motion2_t *ctx, uint8_t state)
Enable motion sensor function.
MOTION2_PIN_STATE_HIGH
@ MOTION2_PIN_STATE_HIGH
Definition: motion2.h:141
motion2_detect_state_t
motion2_detect_state_t
Definition: motion2.h:132
motion2_detect_state
uint8_t motion2_detect_state(motion2_t *ctx)
Get detection state function.
motion2_cfg_t::en
pin_name_t en
Definition: motion2.h:110
motion2_return_value_t
motion2_return_value_t
Motion 2 Click return value data.
Definition: motion2.h:120
MOTION2_NO_DETECT
@ MOTION2_NO_DETECT
Definition: motion2.h:133
motion2_t
Motion 2 Click context object.
Definition: motion2.h:91
motion2_pin_state_t
motion2_pin_state_t
Definition: motion2.h:139
motion2_t::int_pin
digital_in_t int_pin
Definition: motion2.h:98
MOTION2_PIN_STATE_LOW
@ MOTION2_PIN_STATE_LOW
Definition: motion2.h:140
motion2_cfg_setup
void motion2_cfg_setup(motion2_cfg_t *cfg)
Config Object Initialization function.
MOTION2_OK
@ MOTION2_OK
Definition: motion2.h:121
motion2_cfg_t::int_pin
pin_name_t int_pin
Definition: motion2.h:111
motion2_cfg_t
Motion 2 Click configuration object.
Definition: motion2.h:107
motion2_init
err_t motion2_init(motion2_t *ctx, motion2_cfg_t *cfg)
Initialization function.