motion  2.0.0.0
motion.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 MOTION_H
36 #define MOTION_H
37 
38 #include "drv_digital_out.h"
39 #include "drv_digital_in.h"
40 
41 // -------------------------------------------------------------- PUBLIC MACROS
51 #define MOTION_MAP_MIKROBUS( cfg, mikrobus ) \
52  cfg.en = MIKROBUS( mikrobus, MIKROBUS_RST ); \
53  cfg.out = MIKROBUS( mikrobus, MIKROBUS_INT );
54 
60 #define MOTION_RETVAL uint8_t
61 
62 #define MOTION_OK 0x00
63 #define MOTION_INIT_ERROR 0xFF
64  // End group macro
67 // --------------------------------------------------------------- PUBLIC TYPES
76 typedef struct
77 {
78  // Output pins
79 
80  digital_out_t en;
81 
82  // Input pins
83 
84  digital_in_t out;
85 
86 } motion_t;
87 
91 typedef struct
92 {
93  // Additional gpio pins
94 
95  pin_name_t en;
96  pin_name_t out;
97 
98 } motion_cfg_t;
99 
103 typedef enum
104 {
107 
109 
113 typedef enum
114 {
117 
119  // End types group
121 
122 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
123 
129 #ifdef __cplusplus
130 extern "C"{
131 #endif
132 
141 void motion_cfg_setup ( motion_cfg_t *cfg );
142 
151 
152 
161 void motion_default_cfg ( motion_t *ctx );
162 
177 void motion_set_en_pin ( motion_t *ctx, motion_pin_state_t en_state );
178 
194 
195 #ifdef __cplusplus
196 }
197 #endif
198 #endif // _MOTION_H_
199  // End public_function group
202 
203 // ------------------------------------------------------------------------- END
motion_t
Click ctx object definition.
Definition: motion.h:76
MOTION_PIN_STATE_HIGH
Definition: motion.h:106
motion_set_en_pin
void motion_set_en_pin(motion_t *ctx, motion_pin_state_t en_state)
Set states of the enable pin.
motion_init
MOTION_RETVAL motion_init(motion_t *ctx, motion_cfg_t *cfg)
Initialization function.
motion_pin_state_t
motion_pin_state_t
Pin states.
Definition: motion.h:103
motion_cfg_t::out
pin_name_t out
Definition: motion.h:96
motion_get_detected
motion_pin_state_t motion_get_detected(motion_t *ctx)
Motion detected function.
MOTION_NO_DETECT
Definition: motion.h:115
MOTION_DETECTED
Definition: motion.h:116
motion_cfg_t
Click configuration structure definition.
Definition: motion.h:91
motion_t::en
digital_out_t en
Definition: motion.h:80
motion_t::out
digital_in_t out
Definition: motion.h:84
motion_detect_state_t
motion_detect_state_t
Motion OUT ( INT ) Pin states.
Definition: motion.h:113
motion_default_cfg
void motion_default_cfg(motion_t *ctx)
Click Default Configuration function.
motion_cfg_t::en
pin_name_t en
Definition: motion.h:95
MOTION_RETVAL
#define MOTION_RETVAL
Definition: motion.h:60
motion_cfg_setup
void motion_cfg_setup(motion_cfg_t *cfg)
Config Object Initialization function.
MOTION_PIN_STATE_LOW
Definition: motion.h:105