alphanumr  2.0.0.0
alphanumr.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 ALPHANUMR_H
29 #define ALPHANUMR_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 ALPHANUMR_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  // alphanumr_map // alphanumr
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 } alphanumr_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  ALPHANUMR_ERROR = -1
122 
124 
141 
157 
167 void alphanumr_set_display_interval ( alphanumr_t *ctx, uint16_t delay_char_display );
168 
179 void alphanumr_display_write ( alphanumr_t *ctx, uint16_t left_char, uint16_t right_char );
180 
191 void alphanumr_write_character ( alphanumr_t *ctx, uint8_t left_char, uint8_t right_char );
192 
203 void alphanumr_write_number ( alphanumr_t *ctx, uint8_t left_char, uint8_t right_char );
204 
214 
224 
234 
244 
254 
264 
265 #ifdef __cplusplus
266 }
267 #endif
268 #endif // ALPHANUMR_H
269  // alphanumr
271 
272 // ------------------------------------------------------------------------ END
alphanumr_cfg_t::spi_speed
uint32_t spi_speed
Definition: alphanumr.h:108
alphanumr_set_pwm_low
void alphanumr_set_pwm_low(alphanumr_t *ctx)
PWM set low function.
alphanumr_cfg_t::miso
pin_name_t miso
Definition: alphanumr.h:97
alphanumr_set_display_interval
void alphanumr_set_display_interval(alphanumr_t *ctx, uint16_t delay_char_display)
Delay character display function.
alphanumr_cfg_t::le2
pin_name_t le2
Definition: alphanumr.h:103
alphanumr_t::display_speed
uint16_t display_speed
Definition: alphanumr.h:87
alphanumr_t::chip_select
pin_name_t chip_select
Definition: alphanumr.h:85
alphanumr_t
AlphaNum R Click context object.
Definition: alphanumr.h:76
alphanumr_init
err_t alphanumr_init(alphanumr_t *ctx, alphanumr_cfg_t *cfg)
AlphaNum R initialization function.
alphanumr_cfg_t::ns
pin_name_t ns
Definition: alphanumr.h:105
ALPHANUMR_ERROR
@ ALPHANUMR_ERROR
Definition: alphanumr.h:121
alphanumr_t::ns
digital_out_t ns
Definition: alphanumr.h:80
alphanumr_cfg_t::cs
pin_name_t cs
Definition: alphanumr.h:100
alphanumr_t::le2
digital_out_t le2
Definition: alphanumr.h:78
alphanumr_set_pwm_high
void alphanumr_set_pwm_high(alphanumr_t *ctx)
PWM set high function.
alphanumr_return_value_t
alphanumr_return_value_t
AlphaNum R Click return value data.
Definition: alphanumr.h:119
alphanumr_cfg_t::sck
pin_name_t sck
Definition: alphanumr.h:99
alphanumr_cfg_t
AlphaNum R Click configuration object.
Definition: alphanumr.h:95
alphanumr_set_rst_low
void alphanumr_set_rst_low(alphanumr_t *ctx)
Reset set low function.
alphanumr_cfg_setup
void alphanumr_cfg_setup(alphanumr_cfg_t *cfg)
AlphaNum R configuration object setup function.
alphanumr_set_int_high
void alphanumr_set_int_high(alphanumr_t *ctx)
Interrupt set high function.
alphanumr_cfg_t::cs_polarity
spi_master_chip_select_polarity_t cs_polarity
Definition: alphanumr.h:110
alphanumr_set_int_low
void alphanumr_set_int_low(alphanumr_t *ctx)
Interrupt set low function.
alphanumr_cfg_t::mosi
pin_name_t mosi
Definition: alphanumr.h:98
alphanumr_display_write
void alphanumr_display_write(alphanumr_t *ctx, uint16_t left_char, uint16_t right_char)
Display write function.
alphanumr_t::spi
spi_master_t spi
Definition: alphanumr.h:83
alphanumr_cfg_t::spi_mode
spi_master_mode_t spi_mode
Definition: alphanumr.h:109
alphanumr_cfg_t::ns1
pin_name_t ns1
Definition: alphanumr.h:104
ALPHANUMR_OK
@ ALPHANUMR_OK
Definition: alphanumr.h:120
alphanumr_write_number
void alphanumr_write_number(alphanumr_t *ctx, uint8_t left_char, uint8_t right_char)
Number write function.
alphanumr_write_character
void alphanumr_write_character(alphanumr_t *ctx, uint8_t left_char, uint8_t right_char)
Character write function.
alphanumr_t::ns1
digital_out_t ns1
Definition: alphanumr.h:79
alphanumr_set_rst_high
void alphanumr_set_rst_high(alphanumr_t *ctx)
Reset set high function.