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 "drv_digital_out.h"
36 #include "drv_digital_in.h"
37 
58 #define MOTION3_MODULE_ENABLE 0x00
59 #define MOTION3_MODULE_DISABLE 0x01
60 #define MOTION3_NO_DETECT_OBJECT 0x00
61 #define MOTION3_DETECT_OBJECT 0x01
62  // motion3_set
64 
79 #define MOTION3_MAP_MIKROBUS( cfg, mikrobus ) \
80  cfg.en = MIKROBUS( mikrobus, MIKROBUS_RST ); \
81  cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
82  // motion3_map // motion3
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 } motion3_t;
101 
106 typedef struct
107 {
108  // Additional gpio pins
109 
110  pin_name_t en;
111  pin_name_t int_pin;
113 } motion3_cfg_t;
114 
119 typedef enum
120 {
122  MOTION3_ERROR = -1
123 
125 
131 typedef enum
132 {
135 
137 
138 typedef enum
139 {
142 
144 
154 void motion3_cfg_setup ( motion3_cfg_t *cfg );
155 
170 err_t motion3_init ( motion3_t *ctx, motion3_cfg_t *cfg );
171 
181 void motion3_enable ( motion3_t *ctx, uint8_t state );
182 
192 uint8_t motion3_detect_state ( motion3_t *ctx );
193 
194 #ifdef __cplusplus
195 }
196 #endif
197 #endif // MOTION3_H
198  // motion3
200 
201 // ------------------------------------------------------------------------ END
MOTION3_DETECTED
Definition: motion3.h:133
motion3_detect_state_t
motion3_detect_state_t
Definition: motion3.h:130
motion3_pin_state_t
motion3_pin_state_t
Definition: motion3.h:137
motion3_return_value_t
motion3_return_value_t
Motion 3 Click return value data.
Definition: motion3.h:118
MOTION3_ERROR
Definition: motion3.h:121
motion3_detect_state
uint8_t motion3_detect_state(motion3_t *ctx)
Get detection state function.
MOTION3_OK
Definition: motion3.h:120
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:89
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
Definition: motion3.h:140
MOTION3_PIN_STATE_LOW
Definition: motion3.h:139
motion3_cfg_t
Motion 3 Click configuration object.
Definition: motion3.h:105
MOTION3_NO_DETECT
Definition: motion3.h:132