opto 2.0.0.0
opto.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 OPTO_H
36#define OPTO_H
37
38#include "drv_digital_out.h"
39#include "drv_digital_in.h"
40
41// -------------------------------------------------------------- PUBLIC MACROS
51#define OPTO_MAP_MIKROBUS( cfg, mikrobus ) \
52 cfg.in4= MIKROBUS( mikrobus, MIKROBUS_AN ); \
53 cfg.in3= MIKROBUS( mikrobus, MIKROBUS_RST ); \
54 cfg.in2= MIKROBUS( mikrobus, MIKROBUS_CS ); \
55 cfg.in1= MIKROBUS( mikrobus, MIKROBUS_INT )
62#define OPTO_RETVAL uint8_t
63
64#define OPTO_OK 0x00
65#define OPTO_INIT_ERROR 0xFF // End group macro
69// --------------------------------------------------------------- PUBLIC TYPES
78typedef struct
79{
80
81 // Input pins
82
83 digital_in_t in4;
84 digital_in_t in3;
85 digital_in_t in2;
86 digital_in_t in1;
87
88} opto_t;
89
93typedef struct
94{
95 // Additional gpio pins
96
97 pin_name_t in4;
98 pin_name_t in3;
99 pin_name_t in2;
100 pin_name_t in1;
101
102} opto_cfg_t;
103 // End types group
105
106// ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
107
113#ifdef __cplusplus
114extern "C"{
115#endif
116
126
135
145uint8_t opto_check_out1( opto_t *ctx );
146
156uint8_t opto_check_out2( opto_t *ctx );
157
167uint8_t opto_check_out3( opto_t *ctx );
168
178uint8_t opto_check_out4( opto_t *ctx );
179
180
181#ifdef __cplusplus
182}
183#endif
184#endif // _OPTO_H_
185 // End public_function group
188
189// ------------------------------------------------------------------------- END
#define OPTO_RETVAL
Definition: opto.h:62
uint8_t opto_check_out4(opto_t *ctx)
OUT4 Check function.
uint8_t opto_check_out3(opto_t *ctx)
OUT3 Check function.
uint8_t opto_check_out1(opto_t *ctx)
OUT1 Check function.
uint8_t opto_check_out2(opto_t *ctx)
OUT2 Check function.
OPTO_RETVAL opto_init(opto_t *ctx, opto_cfg_t *cfg)
Initialization function.
void opto_cfg_setup(opto_cfg_t *cfg)
Config Object Initialization function.
Click configuration structure definition.
Definition: opto.h:94
pin_name_t in2
Definition: opto.h:99
pin_name_t in1
Definition: opto.h:100
pin_name_t in4
Definition: opto.h:97
pin_name_t in3
Definition: opto.h:98
Click ctx object definition.
Definition: opto.h:79
digital_in_t in2
Definition: opto.h:85
digital_in_t in4
Definition: opto.h:83
digital_in_t in3
Definition: opto.h:84
digital_in_t in1
Definition: opto.h:86