digipot14  2.1.0.0
digipot14.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 DIGIPOT14_H
29 #define DIGIPOT14_H
30 
31 #ifdef __cplusplus
32 extern "C"{
33 #endif
34 
39 #ifdef PREINIT_SUPPORTED
40 #include "preinit.h"
41 #endif
42 
43 #ifdef MikroCCoreVersion
44  #if MikroCCoreVersion >= 1
45  #include "delays.h"
46  #endif
47 #endif
48 
49 #include "drv_digital_out.h"
50 #include "drv_digital_in.h"
51 #include "drv_i2c_master.h"
52 
73 #define DIGIPOT14_VOLATILE_REG_WRA 0x00
74 #define DIGIPOT14_VOLATILE_REG_WRB 0x01
75 #define DIGIPOT14_VOLATILE_REG_ACR 0x10
76 #define DIGIPOT14_NON_VOLATILE_REG_IVRA 0x00
77 #define DIGIPOT14_NON_VOLATILE_REG_IVRB 0x01
78  // digipot14_reg
80 
95 #define DIGIPOT14_VOLATILE_REG_WRITE 0x80
96 #define DIGIPOT14_NON_VOLATILE_REG_WRITE 0x00
97 #define DIGIPOT14_DISABLE_SHUT_DOWN 0x40
98 #define DIGIPOT14_ENABLE_SHUT_DOWN 0x00
99 #define DIGIPOT14_NON_VOLATILE_WR_IN_PROGRESS 0x20
100 #define DIGIPOT14_NON_VOLATILE_WR_NOT_IN_PROGRESS 0x00
101 
102 #define DIGIPOT14_MAX_RESISTANCE_KOHM 100.0
103 #define DIGIPOT14_MAX_POSITION 255
104 #define DIGIPOT14_MAX_POSITION_NUM 256.0
105 #define DIGIPOT14_MIN_POSITION 0
106 
112 #define DIGIPOT14_DEVICE_ADDRESS_000 0x50
113 #define DIGIPOT14_DEVICE_ADDRESS_001 0x51
114 #define DIGIPOT14_DEVICE_ADDRESS_010 0x52
115 #define DIGIPOT14_DEVICE_ADDRESS_011 0x53
116 #define DIGIPOT14_DEVICE_ADDRESS_100 0x54
117 #define DIGIPOT14_DEVICE_ADDRESS_101 0x55
118 #define DIGIPOT14_DEVICE_ADDRESS_110 0x56
119 #define DIGIPOT14_DEVICE_ADDRESS_111 0x57
120  // digipot14_set
122 
137 #define DIGIPOT14_MAP_MIKROBUS( cfg, mikrobus ) \
138  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
139  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA );
140  // digipot14_map // digipot14
143 
148 typedef struct
149 {
150  // Modules
151  i2c_master_t i2c;
153  // I2C slave address
154  uint8_t slave_address;
156 } digipot14_t;
157 
162 typedef struct
163 {
164  pin_name_t scl;
165  pin_name_t sda;
167  uint32_t i2c_speed;
168  uint8_t i2c_address;
171 
176 typedef enum
177 {
179  DIGIPOT14_ERROR = -1
180 
182 
199 
214 
228 
243 err_t digipot14_generic_write ( digipot14_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len );
244 
259 err_t digipot14_generic_read ( digipot14_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len );
260 
274 err_t digipot14_reg_write ( digipot14_t *ctx, uint8_t reg, uint8_t data_in );
275 
289 err_t digipot14_reg_read ( digipot14_t *ctx, uint8_t reg, uint8_t *data_out );
290 
304 err_t digipot14_set_pot_a_wiper ( digipot14_t *ctx, uint8_t wiper_pos );
305 
319 err_t digipot14_set_pot_b_wiper ( digipot14_t *ctx, uint8_t wiper_pos );
320 
321 #ifdef __cplusplus
322 }
323 #endif
324 #endif // DIGIPOT14_H
325  // digipot14
327 
328 // ------------------------------------------------------------------------ END
digipot14_cfg_setup
void digipot14_cfg_setup(digipot14_cfg_t *cfg)
DIGI POT 14 configuration object setup function.
digipot14_generic_read
err_t digipot14_generic_read(digipot14_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len)
DIGI POT 14 I2C reading function.
digipot14_return_value_t
digipot14_return_value_t
DIGI POT 14 Click return value data.
Definition: digipot14.h:177
digipot14_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: digipot14.h:167
digipot14_generic_write
err_t digipot14_generic_write(digipot14_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len)
DIGI POT 14 I2C writing function.
digipot14_default_cfg
err_t digipot14_default_cfg(digipot14_t *ctx)
DIGI POT 14 default configuration function.
digipot14_t
DIGI POT 14 Click context object.
Definition: digipot14.h:149
digipot14_cfg_t::i2c_address
uint8_t i2c_address
Definition: digipot14.h:168
digipot14_t::i2c
i2c_master_t i2c
Definition: digipot14.h:151
digipot14_cfg_t::scl
pin_name_t scl
Definition: digipot14.h:164
digipot14_set_pot_b_wiper
err_t digipot14_set_pot_b_wiper(digipot14_t *ctx, uint8_t wiper_pos)
DIGI POT 14 set the wiper position of potentiometer B function.
digipot14_t::slave_address
uint8_t slave_address
Definition: digipot14.h:154
digipot14_set_pot_a_wiper
err_t digipot14_set_pot_a_wiper(digipot14_t *ctx, uint8_t wiper_pos)
DIGI POT 14 set the wiper position of potentiometer A function.
digipot14_cfg_t::sda
pin_name_t sda
Definition: digipot14.h:165
digipot14_reg_write
err_t digipot14_reg_write(digipot14_t *ctx, uint8_t reg, uint8_t data_in)
DIGI POT 14 register write function.
digipot14_reg_read
err_t digipot14_reg_read(digipot14_t *ctx, uint8_t reg, uint8_t *data_out)
DIGI POT 14 register reading function.
digipot14_cfg_t
DIGI POT 14 Click configuration object.
Definition: digipot14.h:163
DIGIPOT14_OK
@ DIGIPOT14_OK
Definition: digipot14.h:178
digipot14_init
err_t digipot14_init(digipot14_t *ctx, digipot14_cfg_t *cfg)
DIGI POT 14 initialization function.
DIGIPOT14_ERROR
@ DIGIPOT14_ERROR
Definition: digipot14.h:179