alphanumg  2.0.0.0
alphanumg.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 ALPHANUMG_H
29 #define ALPHANUMG_H
30 
31 #ifdef __cplusplus
32 extern "C"{
33 #endif
34 
35 #include "drv_digital_out.h"
36 #include "drv_digital_in.h"
37 #include "drv_spi_master.h"
38 
59 #define ALPHANUMG_MAP_MIKROBUS( cfg, mikrobus ) \
60  cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
61  cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
62  cfg.sck = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
63  cfg.cs = MIKROBUS( mikrobus, MIKROBUS_CS ); \
64  cfg.le2 = MIKROBUS( mikrobus, MIKROBUS_RST ); \
65  cfg.ns1 = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
66  cfg.ns = MIKROBUS( mikrobus, MIKROBUS_INT )
67  // alphanumg_map // alphanumg
70 
75 typedef struct
76 {
77  // Output pins
78  digital_out_t le2;
79  digital_out_t ns1;
80  digital_out_t ns;
81 
82  // Modules
83  spi_master_t spi;
85  pin_name_t chip_select;
87  uint16_t display_speed;
88 } alphanumg_t;
89 
94 typedef struct
95 {
96  // Communication gpio pins
97  pin_name_t miso;
98  pin_name_t mosi;
99  pin_name_t sck;
100  pin_name_t cs;
102  // Additional gpio pins
103  pin_name_t le2;
104  pin_name_t ns1;
105  pin_name_t ns;
106 
107  // static variable
108  uint32_t spi_speed;
109  spi_master_mode_t spi_mode;
110  spi_master_chip_select_polarity_t cs_polarity;
113 
118 typedef enum
119 {
121  ALPHANUMG_ERROR = -1
122 
124 
141 
156 err_t alphanumg_init ( alphanumg_t *ctx, alphanumg_cfg_t *cfg );
157 
167 void alphanumg_set_display_interval ( alphanumg_t *ctx, uint16_t delay_char_display );
168 
179 void alphanumg_display_write ( alphanumg_t *ctx, uint16_t left_char, uint16_t right_char );
180 
191 void alphanumg_write_character ( alphanumg_t *ctx, uint8_t left_char, uint8_t right_char );
192 
203 void alphanumg_write_number ( alphanumg_t *ctx, uint8_t left_char, uint8_t right_char );
204 
213 void alphanumg_set_rst_high ( alphanumg_t *ctx );
214 
223 void alphanumg_set_rst_low ( alphanumg_t *ctx );
224 
233 void alphanumg_set_pwm_high ( alphanumg_t *ctx );
234 
243 void alphanumg_set_pwm_low ( alphanumg_t *ctx );
244 
253 void alphanumg_set_int_high ( alphanumg_t *ctx );
254 
263 void alphanumg_set_int_low ( alphanumg_t *ctx );
264 
265 #ifdef __cplusplus
266 }
267 #endif
268 #endif // ALPHANUMG_H
269  // alphanumg
271 
272 // ------------------------------------------------------------------------ END
alphanumg_set_display_interval
void alphanumg_set_display_interval(alphanumg_t *ctx, uint16_t delay_char_display)
Delay character display function.
alphanumg_set_pwm_low
void alphanumg_set_pwm_low(alphanumg_t *ctx)
PWM set low function.
alphanumg_cfg_t
AlphaNum G Click configuration object.
Definition: alphanumg.h:93
alphanumg_init
err_t alphanumg_init(alphanumg_t *ctx, alphanumg_cfg_t *cfg)
AlphaNum G initialization function.
alphanumg_display_write
void alphanumg_display_write(alphanumg_t *ctx, uint16_t left_char, uint16_t right_char)
Display write function.
alphanumg_return_value_t
alphanumg_return_value_t
AlphaNum G Click return value data.
Definition: alphanumg.h:117
ALPHANUMG_ERROR
Definition: alphanumg.h:120
alphanumg_set_int_high
void alphanumg_set_int_high(alphanumg_t *ctx)
Interrupt set high function.
alphanumg_set_rst_low
void alphanumg_set_rst_low(alphanumg_t *ctx)
Reset set low function.
alphanumg_set_rst_high
void alphanumg_set_rst_high(alphanumg_t *ctx)
Reset set high function.
alphanumg_write_character
void alphanumg_write_character(alphanumg_t *ctx, uint8_t left_char, uint8_t right_char)
Character write function.
alphanumg_set_int_low
void alphanumg_set_int_low(alphanumg_t *ctx)
Interrupt set low function.
alphanumg_write_number
void alphanumg_write_number(alphanumg_t *ctx, uint8_t left_char, uint8_t right_char)
Number write function.
alphanumg_cfg_setup
void alphanumg_cfg_setup(alphanumg_cfg_t *cfg)
AlphaNum G configuration object setup function.
alphanumg_t
AlphaNum G Click context object.
Definition: alphanumg.h:74
alphanumg_set_pwm_high
void alphanumg_set_pwm_high(alphanumg_t *ctx)
PWM set high function.
ALPHANUMG_OK
Definition: alphanumg.h:119