uts7segr  2.0.0.0
uts7segr.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 UTS7SEGR_H
29 #define UTS7SEGR_H
30 
31 #ifdef __cplusplus
32 extern "C"{
33 #endif
34 
35 #include "mikrosdk_version.h"
36 
37 #ifdef __GNUC__
38 #if mikroSDK_GET_VERSION < 20800ul
39 #include "rcu_delays.h"
40 #else
41 #include "delays.h"
42 #endif
43 #endif
44 
45 #include "drv_digital_out.h"
46 #include "drv_spi_master.h"
47 
67 #define UTS7SEGR_DISPLAY_ON 0x01
68 #define UTS7SEGR_DISPLAY_OFF 0x00
69 
70 #define UTS7SEGR_DOT_LEFT 0x02
71 #define UTS7SEGR_DOT_RIGHT 0x01
72 #define UTS7SEGR_DOT_LEFT_RIGHT 0x03
73 #define UTS7SEGR_NO_DOT 0x00
74  // uts7segr_set
76 
91 #define UTS7SEGR_MAP_MIKROBUS( cfg, mikrobus ) \
92  cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
93  cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
94  cfg.sck = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
95  cfg.cs = MIKROBUS( mikrobus, MIKROBUS_CS ); \
96  cfg.oe = MIKROBUS( mikrobus, MIKROBUS_PWM );
97  // uts7segr_map // uts7segr
100 
105 typedef struct
106 {
107  // Output pins
108 
109  digital_out_t oe;
111  // Modules
112 
113  spi_master_t spi;
115  pin_name_t chip_select;
117 } uts7segr_t;
118 
123 typedef struct
124 {
125  // Communication gpio pins
126 
127  pin_name_t miso;
128  pin_name_t mosi;
129  pin_name_t sck;
130  pin_name_t cs;
132  pin_name_t oe;
134  // static variable
135 
136  uint32_t spi_speed;
137  spi_master_mode_t spi_mode;
138  spi_master_chip_select_polarity_t cs_polarity;
141 
146 typedef enum
147 {
149  UTS7SEGR_ERROR = -1
150 
152 
169 
185 
198 
215 err_t uts7segr_generic_write ( uts7segr_t *ctx, uint8_t *data_in );
216 
227 void uts7segr_display_state ( uts7segr_t *ctx, uint8_t state );
228 
242 err_t uts7segr_display_number ( uts7segr_t *ctx, uint8_t number, uint8_t dot_pos );
243 
244 #ifdef __cplusplus
245 }
246 #endif
247 #endif // UTS7SEGR_H
248  // uts7segr
250 
251 // ------------------------------------------------------------------------ END
uts7segr_cfg_t::cs_polarity
spi_master_chip_select_polarity_t cs_polarity
Definition: uts7segr.h:138
uts7segr_default_cfg
void uts7segr_default_cfg(uts7segr_t *ctx)
UT-S 7-SEG R default configuration function.
uts7segr_t::chip_select
pin_name_t chip_select
Definition: uts7segr.h:115
uts7segr_cfg_t::spi_mode
spi_master_mode_t spi_mode
Definition: uts7segr.h:137
uts7segr_generic_write
err_t uts7segr_generic_write(uts7segr_t *ctx, uint8_t *data_in)
UT-S 7-SEG R data writing function.
uts7segr_cfg_t
UT-S 7-SEG R Click configuration object.
Definition: uts7segr.h:124
uts7segr_t::oe
digital_out_t oe
Definition: uts7segr.h:109
uts7segr_cfg_t::mosi
pin_name_t mosi
Definition: uts7segr.h:128
uts7segr_display_state
void uts7segr_display_state(uts7segr_t *ctx, uint8_t state)
UT-S 7-SEG R display state function.
UTS7SEGR_OK
@ UTS7SEGR_OK
Definition: uts7segr.h:148
UTS7SEGR_ERROR
@ UTS7SEGR_ERROR
Definition: uts7segr.h:149
uts7segr_cfg_t::oe
pin_name_t oe
Definition: uts7segr.h:132
uts7segr_init
err_t uts7segr_init(uts7segr_t *ctx, uts7segr_cfg_t *cfg)
UT-S 7-SEG R initialization function.
uts7segr_cfg_t::sck
pin_name_t sck
Definition: uts7segr.h:129
uts7segr_cfg_setup
void uts7segr_cfg_setup(uts7segr_cfg_t *cfg)
UT-S 7-SEG R configuration object setup function.
uts7segr_t::spi
spi_master_t spi
Definition: uts7segr.h:113
uts7segr_display_number
err_t uts7segr_display_number(uts7segr_t *ctx, uint8_t number, uint8_t dot_pos)
UT-S 7-SEG R display number function.
uts7segr_cfg_t::cs
pin_name_t cs
Definition: uts7segr.h:130
uts7segr_return_value_t
uts7segr_return_value_t
UT-S 7-SEG R Click return value data.
Definition: uts7segr.h:147
uts7segr_cfg_t::miso
pin_name_t miso
Definition: uts7segr.h:127
uts7segr_cfg_t::spi_speed
uint32_t spi_speed
Definition: uts7segr.h:136
uts7segr_t
UT-S 7-SEG R Click context object.
Definition: uts7segr.h:106