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 "drv_digital_out.h"
36 #include "drv_spi_master.h"
37 
57 #define UTS7SEGR_DISPLAY_ON 0x01
58 #define UTS7SEGR_DISPLAY_OFF 0x00
59 
60 #define UTS7SEGR_DOT_LEFT 0x02
61 #define UTS7SEGR_DOT_RIGHT 0x01
62 #define UTS7SEGR_DOT_LEFT_RIGHT 0x03
63 #define UTS7SEGR_NO_DOT 0x00
64  // uts7segr_set
66 
81 #define UTS7SEGR_MAP_MIKROBUS( cfg, mikrobus ) \
82  cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
83  cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
84  cfg.sck = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
85  cfg.cs = MIKROBUS( mikrobus, MIKROBUS_CS ); \
86  cfg.oe = MIKROBUS( mikrobus, MIKROBUS_PWM );
87  // uts7segr_map // uts7segr
90 
95 typedef struct
96 {
97  // Output pins
98 
99  digital_out_t oe;
101  // Modules
102 
103  spi_master_t spi;
105  pin_name_t chip_select;
107 } uts7segr_t;
108 
113 typedef struct
114 {
115  // Communication gpio pins
116 
117  pin_name_t miso;
118  pin_name_t mosi;
119  pin_name_t sck;
120  pin_name_t cs;
122  pin_name_t oe;
124  // static variable
125 
126  uint32_t spi_speed;
127  spi_master_mode_t spi_mode;
128  spi_master_chip_select_polarity_t cs_polarity;
131 
136 typedef enum
137 {
139  UTS7SEGR_ERROR = -1
140 
142 
158 void uts7segr_cfg_setup ( uts7segr_cfg_t *cfg );
159 
174 err_t uts7segr_init ( uts7segr_t *ctx, uts7segr_cfg_t *cfg );
175 
187 void uts7segr_default_cfg ( uts7segr_t *ctx );
188 
205 err_t uts7segr_generic_write ( uts7segr_t *ctx, uint8_t *data_in );
206 
217 void uts7segr_display_state ( uts7segr_t *ctx, uint8_t state );
218 
232 err_t uts7segr_display_number ( uts7segr_t *ctx, uint8_t number, uint8_t dot_pos );
233 
234 #ifdef __cplusplus
235 }
236 #endif
237 #endif // UTS7SEGR_H
238  // uts7segr
240 
241 // ------------------------------------------------------------------------ END
uts7segr_default_cfg
void uts7segr_default_cfg(uts7segr_t *ctx)
UT-S 7-SEG R default configuration function.
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:112
uts7segr_display_state
void uts7segr_display_state(uts7segr_t *ctx, uint8_t state)
UT-S 7-SEG R display state function.
UTS7SEGR_OK
Definition: uts7segr.h:137
UTS7SEGR_ERROR
Definition: uts7segr.h:138
uts7segr_init
err_t uts7segr_init(uts7segr_t *ctx, uts7segr_cfg_t *cfg)
UT-S 7-SEG R initialization function.
uts7segr_cfg_setup
void uts7segr_cfg_setup(uts7segr_cfg_t *cfg)
UT-S 7-SEG R configuration object setup function.
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_return_value_t
uts7segr_return_value_t
UT-S 7-SEG R Click return value data.
Definition: uts7segr.h:135
uts7segr_t
UT-S 7-SEG R Click context object.
Definition: uts7segr.h:94