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 
42 #ifdef PREINIT_SUPPORTED
43 #include "preinit.h"
44 #endif
45 
46 #ifdef MikroCCoreVersion
47  #if MikroCCoreVersion >= 1
48  #include "delays.h"
49  #endif
50 #endif
51 
52 #include "drv_digital_out.h"
53 #include "drv_digital_in.h"
54 
55 // -------------------------------------------------------------- PUBLIC MACROS
65 #define MOTION_MAP_MIKROBUS( cfg, mikrobus ) \
66  cfg.en = MIKROBUS( mikrobus, MIKROBUS_RST ); \
67  cfg.out = MIKROBUS( mikrobus, MIKROBUS_INT );
68 
74 #define MOTION_RETVAL uint8_t
75 
76 #define MOTION_OK 0x00
77 #define MOTION_INIT_ERROR 0xFF
78  // End group macro
81 // --------------------------------------------------------------- PUBLIC TYPES
90 typedef struct
91 {
92  // Output pins
93 
94  digital_out_t en;
95 
96  // Input pins
97 
98  digital_in_t out;
99 
100 } motion_t;
101 
105 typedef struct
106 {
107  // Additional gpio pins
108 
109  pin_name_t en;
110  pin_name_t out;
111 
112 } motion_cfg_t;
113 
117 typedef enum
118 {
121 
123 
127 typedef enum
128 {
131 
133  // End types group
135 
136 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
137 
143 #ifdef __cplusplus
144 extern "C"{
145 #endif
146 
156 
165 
166 
176 
192 
208 
209 #ifdef __cplusplus
210 }
211 #endif
212 #endif // _MOTION_H_
213  // End public_function group
216 
217 // ------------------------------------------------------------------------- END
motion_t
Click ctx object definition.
Definition: motion.h:91
MOTION_PIN_STATE_HIGH
@ MOTION_PIN_STATE_HIGH
Definition: motion.h:120
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:118
motion_cfg_t::out
pin_name_t out
Definition: motion.h:110
MOTION_NO_DETECT
@ MOTION_NO_DETECT
Definition: motion.h:129
motion_get_detected
motion_detect_state_t motion_get_detected(motion_t *ctx)
Motion detected function.
MOTION_DETECTED
@ MOTION_DETECTED
Definition: motion.h:130
motion_cfg_t
Click configuration structure definition.
Definition: motion.h:106
motion_t::en
digital_out_t en
Definition: motion.h:94
motion_t::out
digital_in_t out
Definition: motion.h:98
motion_detect_state_t
motion_detect_state_t
Motion OUT ( INT ) Pin states.
Definition: motion.h:128
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:109
MOTION_RETVAL
#define MOTION_RETVAL
Definition: motion.h:74
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:119