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 "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 
51 // -------------------------------------------------------------- PUBLIC MACROS
61 #define MOTION_MAP_MIKROBUS( cfg, mikrobus ) \
62  cfg.en = MIKROBUS( mikrobus, MIKROBUS_RST ); \
63  cfg.out = MIKROBUS( mikrobus, MIKROBUS_INT );
64 
70 #define MOTION_RETVAL uint8_t
71 
72 #define MOTION_OK 0x00
73 #define MOTION_INIT_ERROR 0xFF
74  // End group macro
77 // --------------------------------------------------------------- PUBLIC TYPES
86 typedef struct
87 {
88  // Output pins
89 
90  digital_out_t en;
91 
92  // Input pins
93 
94  digital_in_t out;
95 
96 } motion_t;
97 
101 typedef struct
102 {
103  // Additional gpio pins
104 
105  pin_name_t en;
106  pin_name_t out;
107 
108 } motion_cfg_t;
109 
113 typedef enum
114 {
117 
119 
123 typedef enum
124 {
127 
129  // End types group
131 
132 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
133 
139 #ifdef __cplusplus
140 extern "C"{
141 #endif
142 
152 
161 
162 
172 
188 
204 
205 #ifdef __cplusplus
206 }
207 #endif
208 #endif // _MOTION_H_
209  // End public_function group
212 
213 // ------------------------------------------------------------------------- END
motion_t
Click ctx object definition.
Definition: motion.h:87
MOTION_PIN_STATE_HIGH
@ MOTION_PIN_STATE_HIGH
Definition: motion.h:116
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:114
motion_cfg_t::out
pin_name_t out
Definition: motion.h:106
MOTION_NO_DETECT
@ MOTION_NO_DETECT
Definition: motion.h:125
motion_get_detected
motion_detect_state_t motion_get_detected(motion_t *ctx)
Motion detected function.
MOTION_DETECTED
@ MOTION_DETECTED
Definition: motion.h:126
motion_cfg_t
Click configuration structure definition.
Definition: motion.h:102
motion_t::en
digital_out_t en
Definition: motion.h:90
motion_t::out
digital_in_t out
Definition: motion.h:94
motion_detect_state_t
motion_detect_state_t
Motion OUT ( INT ) Pin states.
Definition: motion.h:124
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:105
MOTION_RETVAL
#define MOTION_RETVAL
Definition: motion.h:70
motion_cfg_setup
void motion_cfg_setup(motion_cfg_t *cfg)
Config Object Initialization function.
MOTION_PIN_STATE_LOW
@ MOTION_PIN_STATE_LOW
Definition: motion.h:115