terminal2  2.0.0.0
terminal2.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 TERMINAL2_H
29 #define TERMINAL2_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 TERMINAL2_MAP_MIKROBUS( cfg, mikrobus ) \
59  cfg.an = MIKROBUS( mikrobus, MIKROBUS_AN ); \
60  cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
61  cfg.cs = MIKROBUS( mikrobus, MIKROBUS_CS ); \
62  cfg.pwm = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
63  cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT ); \
64  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
65  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
66  cfg.sck = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
67  cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
68  cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
69  cfg.tx_pin = MIKROBUS( mikrobus, MIKROBUS_RX ); \
70  cfg.rx_pin = MIKROBUS( mikrobus, MIKROBUS_TX )
71  // terminal2_map // terminal2
74 
79 typedef struct
80 {
81  digital_out_t scl;
82  digital_out_t sda;
83  digital_out_t sck;
84  digital_out_t miso;
85  digital_out_t mosi;
86  digital_out_t cs;
87  digital_out_t tx_pin;
88  digital_out_t rx_pin;
89  digital_out_t an;
90  digital_out_t rst;
91  digital_out_t pwm;
92  digital_out_t int_pin;
93 
94 } terminal2_t;
95 
100 typedef struct
101 {
102  pin_name_t scl;
103  pin_name_t sda;
104  pin_name_t sck;
105  pin_name_t miso;
106  pin_name_t mosi;
107  pin_name_t cs;
108  pin_name_t tx_pin;
109  pin_name_t rx_pin;
110  pin_name_t an;
111  pin_name_t rst;
112  pin_name_t pwm;
113  pin_name_t int_pin;
114 
116 
121 typedef enum
122 {
124  TERMINAL2_ERROR = -1
125 
127 
144 
159 
167 void terminal2_set_pin_high ( digital_out_t *pin );
168 
176 void terminal2_set_pin_low ( digital_out_t *pin );
177 
185 void terminal2_toggle_pin ( digital_out_t *pin );
186 
195 
204 
213 
214 #ifdef __cplusplus
215 }
216 #endif
217 #endif // TERMINAL2_H
218  // terminal2
220 
221 // ------------------------------------------------------------------------ END
terminal2_t::miso
digital_out_t miso
Definition: terminal2.h:84
terminal2_t::an
digital_out_t an
Definition: terminal2.h:89
terminal2_t::cs
digital_out_t cs
Definition: terminal2.h:86
terminal2_t::sda
digital_out_t sda
Definition: terminal2.h:82
terminal2_cfg_t::sck
pin_name_t sck
Definition: terminal2.h:104
terminal2_t::pwm
digital_out_t pwm
Definition: terminal2.h:91
terminal2_t::rst
digital_out_t rst
Definition: terminal2.h:90
terminal2_set_all_pins_low
void terminal2_set_all_pins_low(terminal2_t *ctx)
Terminal 2 set all pins low function.
terminal2_cfg_t
Terminal 2 Click configuration object.
Definition: terminal2.h:101
terminal2_t
Terminal 2 Click context object.
Definition: terminal2.h:80
terminal2_cfg_t::int_pin
pin_name_t int_pin
Definition: terminal2.h:113
terminal2_return_value_t
terminal2_return_value_t
Terminal 2 Click return value data.
Definition: terminal2.h:122
terminal2_cfg_t::tx_pin
pin_name_t tx_pin
Definition: terminal2.h:108
terminal2_cfg_t::cs
pin_name_t cs
Definition: terminal2.h:107
terminal2_t::sck
digital_out_t sck
Definition: terminal2.h:83
terminal2_t::rx_pin
digital_out_t rx_pin
Definition: terminal2.h:88
terminal2_toggle_pin
void terminal2_toggle_pin(digital_out_t *pin)
Terminal 2 toggle pin function.
terminal2_cfg_setup
void terminal2_cfg_setup(terminal2_cfg_t *cfg)
Terminal 2 configuration object setup function.
terminal2_cfg_t::scl
pin_name_t scl
Definition: terminal2.h:102
terminal2_t::scl
digital_out_t scl
Definition: terminal2.h:81
terminal2_cfg_t::sda
pin_name_t sda
Definition: terminal2.h:103
terminal2_cfg_t::mosi
pin_name_t mosi
Definition: terminal2.h:106
terminal2_toggle_all_pins
void terminal2_toggle_all_pins(terminal2_t *ctx)
Terminal 2 toggle all pins function.
terminal2_set_pin_low
void terminal2_set_pin_low(digital_out_t *pin)
Terminal 2 set pin low function.
terminal2_cfg_t::rst
pin_name_t rst
Definition: terminal2.h:111
terminal2_cfg_t::an
pin_name_t an
Definition: terminal2.h:110
TERMINAL2_ERROR
@ TERMINAL2_ERROR
Definition: terminal2.h:124
TERMINAL2_OK
@ TERMINAL2_OK
Definition: terminal2.h:123
terminal2_init
err_t terminal2_init(terminal2_t *ctx, terminal2_cfg_t *cfg)
Terminal 2 initialization function.
terminal2_cfg_t::rx_pin
pin_name_t rx_pin
Definition: terminal2.h:109
terminal2_cfg_t::pwm
pin_name_t pwm
Definition: terminal2.h:112
terminal2_set_pin_high
void terminal2_set_pin_high(digital_out_t *pin)
Terminal 2 set pin high function.
terminal2_t::tx_pin
digital_out_t tx_pin
Definition: terminal2.h:87
terminal2_cfg_t::miso
pin_name_t miso
Definition: terminal2.h:105
terminal2_t::int_pin
digital_out_t int_pin
Definition: terminal2.h:92
terminal2_t::mosi
digital_out_t mosi
Definition: terminal2.h:85
terminal2_set_all_pins_high
void terminal2_set_all_pins_high(terminal2_t *ctx)
Terminal 2 set all pins high function.