opto5 2.0.0.0
opto5.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 OPTO5_H
29#define OPTO5_H
30
31#ifdef __cplusplus
32extern "C"{
33#endif
34
35#include "drv_digital_out.h"
36#include "drv_digital_in.h"
37
58#define OPTO5_MAP_MIKROBUS( cfg, mikrobus ) \
59 cfg.pwm = MIKROBUS( mikrobus, MIKROBUS_PWM )
60 // opto5_map // opto5
63
68typedef struct
69{
70 digital_out_t pwm;
72} opto5_t;
73
78typedef struct
79{
80 pin_name_t pwm;
83
100
115err_t opto5_init ( opto5_t *ctx, opto5_cfg_t *cfg );
116
129
139void opto5_pin_set ( opto5_t *ctx );
140
151
162
163#ifdef __cplusplus
164}
165#endif
166#endif // OPTO5_H
167 // opto5
169
170// ------------------------------------------------------------------------ END
err_t opto5_init(opto5_t *ctx, opto5_cfg_t *cfg)
Opto 5 initialization function.
void opto5_cfg_setup(opto5_cfg_t *cfg)
Opto 5 configuration object setup function.
void opto5_pin_clear(opto5_t *ctx)
Opto 5 pin clearing function.
void opto5_pin_toggle(opto5_t *ctx)
Opto 5 pin toggling function.
void opto5_default_cfg(opto5_t *ctx)
Opto 5 default configuration function.
void opto5_pin_set(opto5_t *ctx)
Opto 5 pin setting function.
Opto 5 Click configuration object.
Definition: opto5.h:79
pin_name_t pwm
Definition: opto5.h:80
Opto 5 Click context object.
Definition: opto5.h:69
digital_out_t pwm
Definition: opto5.h:70