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 
35 #include "drv_digital_out.h"
36 #include "drv_digital_in.h"
37 
58 #define SHUTTER_STATE_OFF 0
59 #define SHUTTER_STATE_ON 1
60  // shutter_set
62 
77 #define SHUTTER_MAP_MIKROBUS( cfg, mikrobus ) \
78  cfg.af = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
79  cfg.sht = MIKROBUS( mikrobus, MIKROBUS_AN );
80  // shutter_map // shutter
83 
88 typedef struct
89 {
90  digital_out_t af;
91  digital_out_t sht;
93 } shutter_t;
94 
99 typedef struct
100 {
101  pin_name_t af;
102  pin_name_t sht;
104 } shutter_cfg_t;
105 
110 typedef enum
111 {
113  SHUTTER_ERROR = -1
114 
116 
133 
147 err_t shutter_init ( shutter_t *ctx, shutter_cfg_t *cfg );
148 
158 void shutter_set_auto_focus ( shutter_t *ctx, uint8_t state );
159 
169 void shutter_set_shutter ( shutter_t *ctx, uint8_t state );
170 
182 void shutter_take_picture ( shutter_t *ctx, uint8_t auto_focus );
183 
184 #ifdef __cplusplus
185 }
186 #endif
187 #endif // SHUTTER_H
188  // shutter
190 
191 // ------------------------------------------------------------------------ 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:111
shutter_cfg_t::af
pin_name_t af
Definition: shutter.h:101
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:102
SHUTTER_OK
@ SHUTTER_OK
Definition: shutter.h:112
shutter_t
Shutter Click context object.
Definition: shutter.h:89
shutter_t::af
digital_out_t af
Definition: shutter.h:90
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:100
SHUTTER_ERROR
@ SHUTTER_ERROR
Definition: shutter.h:113
shutter_t::sht
digital_out_t sht
Definition: shutter.h:91
shutter_take_picture
void shutter_take_picture(shutter_t *ctx, uint8_t auto_focus)
Shutter take picture function.