ledflash2  2.0.0.0
ledflash2.h
Go to the documentation of this file.
1 /*
2  * MikroSDK - MikroE Software Development Kit
3  * Copyright© 2020 MikroElektronika d.o.o.
4  *
5  * Permission is hereby granted, free of charge, to any person
6  * obtaining a copy of this software and associated documentation
7  * files (the "Software"), to deal in the Software without restriction,
8  * including without limitation the rights to use, copy, modify, merge,
9  * publish, distribute, sublicense, and/or sell copies of the Software,
10  * and to permit persons to whom the Software is furnished to do so,
11  * subject to the following conditions:
12  *
13  * The above copyright notice and this permission notice shall be
14  * included in all copies or substantial portions of the Software.
15  *
16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
17  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
19  * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
20  * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
21  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE
22  * OR OTHER DEALINGS IN THE SOFTWARE.
23  */
24 
33 // ----------------------------------------------------------------------------
34 
35 #ifndef LEDFLASH2_H
36 #define LEDFLASH2_H
37 
38 #include "drv_digital_out.h"
39 #include "drv_digital_in.h"
40 #include "drv_i2c_master.h"
41 
42 // -------------------------------------------------------------- PUBLIC MACROS
52 #define LEDFLASH2_MAP_MIKROBUS( cfg, mikrobus ) \
53  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
54  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
55  cfg.fi = MIKROBUS( mikrobus, MIKROBUS_AN ); \
56  cfg.en = MIKROBUS( mikrobus, MIKROBUS_RST ); \
57  cfg.fen = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
58  cfg.ten = MIKROBUS( mikrobus, MIKROBUS_INT );
59 
65 #define LEDFLASH2_RETVAL uint8_t
66 
67 #define LEDFLASH2_OK 0x00
68 #define LEDFLASH2_INIT_ERROR 0xFF
69 
75 #define LEDFLASH2_MODE_OFF 0x00
76 #define LEDFLASH2_MODE_FLASH 0x01
77 #define LEDFLASH2_MODE_TORCH 0x02
78 
84 #define LEDFLASH2_CUR_100 0x00
85 #define LEDFLASH2_CUR_90 0x01
86 #define LEDFLASH2_CUR_80 0x02
87 #define LEDFLASH2_CUR_70 0x03
88 #define LEDFLASH2_CUR_63 0x04
89 #define LEDFLASH2_CUR_56 0x05
90 #define LEDFLASH2_CUR_50 0x06
91 #define LEDFLASH2_CUR_44 0x07
92 #define LEDFLASH2_CUR_39 0x08
93 #define LEDFLASH2_CUR_35 0x09
94 #define LEDFLASH2_CUR_31 0x0A
95 #define LEDFLASH2_CUR_28 0x0B
96 #define LEDFLASH2_CUR_25 0x0C
97 #define LEDFLASH2_CUR_22 0x0D
98 #define LEDFLASH2_CUR_20 0x0E
99 #define LEDFLASH2_CUR_18 0x0F
100 
106 #define LEDFLASH2_FTMR_1250 0xE0
107 #define LEDFLASH2_FTMR_1093 0xC0
108 #define LEDFLASH2_FTMR_937 0xA0
109 #define LEDFLASH2_FTMR_781 0x80
110 #define LEDFLASH2_FTMR_625 0x60
111 #define LEDFLASH2_FTMR_468 0x40
112 #define LEDFLASH2_FTMR_312 0x20
113 #define LEDFLASH2_FTMR_156 0x00
114  // End group macro
117 // --------------------------------------------------------------- PUBLIC TYPES
126 typedef struct
127 {
128  // Output pins
129 
130  digital_out_t fi;
131  digital_out_t en;
132  digital_out_t fen;
133  digital_out_t ten;
134 
135  // Modules
136 
137  i2c_master_t i2c;
138 
139  // ctx variable
140 
141  uint8_t slave_address;
142 
143 } ledflash2_t;
144 
148 typedef struct
149 {
150  // Communication gpio pins
151 
152  pin_name_t scl;
153  pin_name_t sda;
154 
155  // Additional gpio pins
156 
157  pin_name_t fi;
158  pin_name_t en;
159  pin_name_t fen;
160  pin_name_t ten;
161 
162  // static variable
163 
164  uint32_t i2c_speed;
165  uint8_t i2c_address;
166 
168  // End types group
170 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
171 
177 #ifdef __cplusplus
178 extern "C"{
179 #endif
180 
190 
199 
210 void ledflash2_generic_write ( ledflash2_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
211 
222 void ledflash2_generic_read ( ledflash2_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
223 
232 uint8_t ledflash2_read_register ( ledflash2_t *ctx, uint8_t reg_address );
233 
243 void ledflash2_write_register ( ledflash2_t *ctx, uint8_t reg_address, uint8_t reg_data );
244 
262 void ledflash2_set_mode ( ledflash2_t *ctx, uint8_t mode, uint8_t intensity, uint8_t flash_duration );
263 
273 void ledflash2_toggle_flash_inhibit ( ledflash2_t *ctx, uint8_t pin_state );
274 
275 #ifdef __cplusplus
276 }
277 #endif
278 #endif // _LEDFLASH2_H_
279  // End public_function group
282 
283 // ------------------------------------------------------------------------- END
ledflash2_t
Click ctx object definition.
Definition: ledflash2.h:127
LEDFLASH2_RETVAL
#define LEDFLASH2_RETVAL
Definition: ledflash2.h:65
ledflash2_cfg_t::en
pin_name_t en
Definition: ledflash2.h:158
ledflash2_t::i2c
i2c_master_t i2c
Definition: ledflash2.h:137
ledflash2_cfg_t
Click configuration structure definition.
Definition: ledflash2.h:149
ledflash2_t::slave_address
uint8_t slave_address
Definition: ledflash2.h:141
ledflash2_t::fi
digital_out_t fi
Definition: ledflash2.h:130
ledflash2_cfg_t::fi
pin_name_t fi
Definition: ledflash2.h:157
ledflash2_t::ten
digital_out_t ten
Definition: ledflash2.h:133
ledflash2_t::en
digital_out_t en
Definition: ledflash2.h:131
ledflash2_t::fen
digital_out_t fen
Definition: ledflash2.h:132
ledflash2_init
LEDFLASH2_RETVAL ledflash2_init(ledflash2_t *ctx, ledflash2_cfg_t *cfg)
Initialization function.
ledflash2_generic_read
void ledflash2_generic_read(ledflash2_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
Generic read function.
ledflash2_write_register
void ledflash2_write_register(ledflash2_t *ctx, uint8_t reg_address, uint8_t reg_data)
Write register function.
ledflash2_read_register
uint8_t ledflash2_read_register(ledflash2_t *ctx, uint8_t reg_address)
Read register function.
ledflash2_cfg_t::fen
pin_name_t fen
Definition: ledflash2.h:159
ledflash2_generic_write
void ledflash2_generic_write(ledflash2_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
Generic write function.
ledflash2_cfg_setup
void ledflash2_cfg_setup(ledflash2_cfg_t *cfg)
Config Object Initialization function.
ledflash2_cfg_t::scl
pin_name_t scl
Definition: ledflash2.h:152
ledflash2_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: ledflash2.h:164
ledflash2_cfg_t::sda
pin_name_t sda
Definition: ledflash2.h:153
ledflash2_toggle_flash_inhibit
void ledflash2_toggle_flash_inhibit(ledflash2_t *ctx, uint8_t pin_state)
Toggle flash inhibit function.
ledflash2_cfg_t::ten
pin_name_t ten
Definition: ledflash2.h:160
ledflash2_set_mode
void ledflash2_set_mode(ledflash2_t *ctx, uint8_t mode, uint8_t intensity, uint8_t flash_duration)
Set mode function.
ledflash2_cfg_t::i2c_address
uint8_t i2c_address
Definition: ledflash2.h:165