shutter  2.1.0.0
shutter.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 SHUTTER_H
29 #define SHUTTER_H
30 
31 #ifdef __cplusplus
32 extern "C"{
33 #endif
34 
39 #ifdef PREINIT_SUPPORTED
40 #include "preinit.h"
41 #endif
42 
43 #ifdef MikroCCoreVersion
44  #if MikroCCoreVersion >= 1
45  #include "delays.h"
46  #endif
47 #endif
48 
49 #include "drv_digital_out.h"
50 #include "drv_digital_in.h"
51 
72 #define SHUTTER_STATE_OFF 0
73 #define SHUTTER_STATE_ON 1
74  // shutter_set
76 
91 #define SHUTTER_MAP_MIKROBUS( cfg, mikrobus ) \
92  cfg.af = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
93  cfg.sht = MIKROBUS( mikrobus, MIKROBUS_AN );
94  // shutter_map // shutter
97 
102 typedef struct
103 {
104  digital_out_t af;
105  digital_out_t sht;
107 } shutter_t;
108 
113 typedef struct
114 {
115  pin_name_t af;
116  pin_name_t sht;
118 } shutter_cfg_t;
119 
124 typedef enum
125 {
127  SHUTTER_ERROR = -1
128 
130 
147 
161 err_t shutter_init ( shutter_t *ctx, shutter_cfg_t *cfg );
162 
172 void shutter_set_auto_focus ( shutter_t *ctx, uint8_t state );
173 
183 void shutter_set_shutter ( shutter_t *ctx, uint8_t state );
184 
196 void shutter_take_picture ( shutter_t *ctx, uint8_t auto_focus );
197 
198 #ifdef __cplusplus
199 }
200 #endif
201 #endif // SHUTTER_H
202  // shutter
204 
205 // ------------------------------------------------------------------------ END
shutter_set_auto_focus
void shutter_set_auto_focus(shutter_t *ctx, uint8_t state)
Shutter set auto focus function.
shutter_return_value_t
shutter_return_value_t
Shutter Click return value data.
Definition: shutter.h:125
shutter_cfg_t::af
pin_name_t af
Definition: shutter.h:115
shutter_init
err_t shutter_init(shutter_t *ctx, shutter_cfg_t *cfg)
Shutter initialization function.
shutter_cfg_t::sht
pin_name_t sht
Definition: shutter.h:116
SHUTTER_OK
@ SHUTTER_OK
Definition: shutter.h:126
shutter_t
Shutter Click context object.
Definition: shutter.h:103
shutter_t::af
digital_out_t af
Definition: shutter.h:104
shutter_cfg_setup
void shutter_cfg_setup(shutter_cfg_t *cfg)
Shutter configuration object setup function.
shutter_set_shutter
void shutter_set_shutter(shutter_t *ctx, uint8_t state)
Shutter set shutter function.
shutter_cfg_t
Shutter Click configuration object.
Definition: shutter.h:114
SHUTTER_ERROR
@ SHUTTER_ERROR
Definition: shutter.h:127
shutter_t::sht
digital_out_t sht
Definition: shutter.h:105
shutter_take_picture
void shutter_take_picture(shutter_t *ctx, uint8_t auto_focus)
Shutter take picture function.