pot4  2.1.0.0
pot4.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 POT4_H
29 #define POT4_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_analog_in.h"
38 #include "drv_i2c_master.h"
39 
60 #define POT4_PERCENTS 100
61 #define POT4_ROUND_TO_NEAREST_INT 0.5
62 
67 #define POT4_ADC_RESOLUTION 0x0FFF
68 #define POT4_VREF_3V3 3.3
69 #define POT4_VREF_5V 5.0
70 
76 #define POT4_SET_DEV_ADDR 0x4D
77  // pot4_set
79 
94 #define POT4_MAP_MIKROBUS( cfg, mikrobus ) \
95  cfg.an = MIKROBUS( mikrobus, MIKROBUS_AN ); \
96  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
97  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
98  cfg.sw = MIKROBUS( mikrobus, MIKROBUS_INT )
99  // pot4_map // pot4
102 
107 typedef enum
108 {
113 
118 typedef struct
119 {
120  digital_in_t sw;
122  analog_in_t adc;
123  i2c_master_t i2c;
125  uint8_t slave_address;
126  pin_name_t chip_select;
127  float vref;
130 } pot4_t;
131 
136 typedef struct
137 {
138  pin_name_t an;
139  pin_name_t scl;
140  pin_name_t sda;
141  pin_name_t sw;
143  analog_in_resolution_t resolution;
144  float vref;
146  uint32_t i2c_speed;
147  uint8_t i2c_address;
151 } pot4_cfg_t;
152 
157 typedef enum
158 {
159  POT4_OK = 0,
160  POT4_ERROR = -1
161 
163 
180 
196 
210 err_t pot4_init ( pot4_t *ctx, pot4_cfg_t *cfg );
211 
223 err_t pot4_read_raw_adc ( pot4_t *ctx, uint16_t *raw_adc );
224 
236 err_t pot4_read_voltage ( pot4_t *ctx, float *voltage );
237 
249 err_t pot4_set_vref ( pot4_t *ctx, float vref );
250 
259 uint8_t pot4_get_switch_pin ( pot4_t *ctx );
260 
269 uint8_t pot4_convert_voltage_to_percents ( pot4_t *ctx, float voltage );
270 
271 #ifdef __cplusplus
272 }
273 #endif
274 #endif // POT4_H
275  // pot4
277 
278 // ------------------------------------------------------------------------ END
pot4_read_voltage
err_t pot4_read_voltage(pot4_t *ctx, float *voltage)
POT 4 read voltage level function.
POT4_ERROR
@ POT4_ERROR
Definition: pot4.h:160
pot4_cfg_t::resolution
analog_in_resolution_t resolution
Definition: pot4.h:143
pot4_cfg_t::vref
float vref
Definition: pot4.h:144
pot4_get_switch_pin
uint8_t pot4_get_switch_pin(pot4_t *ctx)
POT 4 get switch pin function.
pot4_t::i2c
i2c_master_t i2c
Definition: pot4.h:123
pot4_cfg_t::an
pin_name_t an
Definition: pot4.h:138
pot4_cfg_setup
void pot4_cfg_setup(pot4_cfg_t *cfg)
POT 4 configuration object setup function.
pot4_init
err_t pot4_init(pot4_t *ctx, pot4_cfg_t *cfg)
POT 4 initialization function.
pot4_t::chip_select
pin_name_t chip_select
Definition: pot4.h:126
pot4_cfg_t::scl
pin_name_t scl
Definition: pot4.h:139
pot4_t::adc
analog_in_t adc
Definition: pot4.h:122
POT4_DRV_SEL_ADC
@ POT4_DRV_SEL_ADC
Definition: pot4.h:109
pot4_cfg_t::sw
pin_name_t sw
Definition: pot4.h:141
pot4_cfg_t::drv_sel
pot4_drv_t drv_sel
Definition: pot4.h:149
pot4_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: pot4.h:146
pot4_t::drv_sel
pot4_drv_t drv_sel
Definition: pot4.h:128
pot4_read_raw_adc
err_t pot4_read_raw_adc(pot4_t *ctx, uint16_t *raw_adc)
POT 4 read raw ADC value function.
pot4_t::slave_address
uint8_t slave_address
Definition: pot4.h:125
pot4_cfg_t
POT 4 Click configuration object.
Definition: pot4.h:137
pot4_set_vref
err_t pot4_set_vref(pot4_t *ctx, float vref)
POT 4 set vref function.
pot4_drv_t
pot4_drv_t
POT 4 Click driver selector.
Definition: pot4.h:108
pot4_drv_interface_selection
void pot4_drv_interface_selection(pot4_cfg_t *cfg, pot4_drv_t drv_sel)
POT 4 driver interface setup function.
pot4_t
POT 4 Click context object.
Definition: pot4.h:119
pot4_cfg_t::sda
pin_name_t sda
Definition: pot4.h:140
pot4_return_value_t
pot4_return_value_t
POT 4 Click return value data.
Definition: pot4.h:158
pot4_cfg_t::i2c_address
uint8_t i2c_address
Definition: pot4.h:147
pot4_convert_voltage_to_percents
uint8_t pot4_convert_voltage_to_percents(pot4_t *ctx, float voltage)
POT 4 convert voltage to percents function.
pot4_t::vref
float vref
Definition: pot4.h:127
pot4_t::sw
digital_in_t sw
Definition: pot4.h:120
POT4_OK
@ POT4_OK
Definition: pot4.h:159
POT4_DRV_SEL_I2C
@ POT4_DRV_SEL_I2C
Definition: pot4.h:110