turbidity  2.0.0.0
turbidity.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 TURBIDITY_H
29 #define TURBIDITY_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_digital_in.h"
47 #include "drv_i2c_master.h"
48 
75 #define TURBIDITY_SET_DEV_ADDR 0x4D
76  // turbidity_set
78 
93 #define TURBIDITY_MAP_MIKROBUS( cfg, mikrobus ) \
94  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
95  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA )
96  // turbidity_map // turbidity
99 
104 typedef struct
105 {
106  // Modules
107  i2c_master_t i2c;
109  // I2C slave address
110  uint8_t slave_address;
112 } turbidity_t;
113 
118 typedef struct
119 {
120  pin_name_t scl;
121  pin_name_t sda;
123  uint32_t i2c_speed;
124  uint8_t i2c_address;
127 
132 typedef enum
133 {
135  TURBIDITY_ERROR = -1
136 
138 
155 
171 
186 
201 err_t turbidity_generic_read ( turbidity_t *ctx, uint8_t *rx_buf, uint8_t rx_len );
202 
216 err_t turbidity_read_adc ( turbidity_t *ctx, uint16_t *adc_val );
217 
231 err_t turbidity_get_adc_voltage ( turbidity_t *ctx, float *voltage );
232 
247 err_t turbidity_get_ntu ( turbidity_t *ctx, float *ntu );
248 
249 #ifdef __cplusplus
250 }
251 #endif
252 #endif // TURBIDITY_H
253  // turbidity
255 
256 // ------------------------------------------------------------------------ END
turbidity_get_ntu
err_t turbidity_get_ntu(turbidity_t *ctx, float *ntu)
Turbidity get NTU function.
TURBIDITY_OK
@ TURBIDITY_OK
Definition: turbidity.h:134
turbidity_cfg_t::scl
pin_name_t scl
Definition: turbidity.h:120
turbidity_cfg_t::sda
pin_name_t sda
Definition: turbidity.h:121
turbidity_t
Turbidity Click context object.
Definition: turbidity.h:105
turbidity_read_adc
err_t turbidity_read_adc(turbidity_t *ctx, uint16_t *adc_val)
Turbidity read ADC function.
turbidity_t::slave_address
uint8_t slave_address
Definition: turbidity.h:110
TURBIDITY_ERROR
@ TURBIDITY_ERROR
Definition: turbidity.h:135
turbidity_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: turbidity.h:123
turbidity_t::i2c
i2c_master_t i2c
Definition: turbidity.h:107
turbidity_generic_read
err_t turbidity_generic_read(turbidity_t *ctx, uint8_t *rx_buf, uint8_t rx_len)
Turbidity I2C reading function.
turbidity_cfg_setup
void turbidity_cfg_setup(turbidity_cfg_t *cfg)
Turbidity configuration object setup function.
turbidity_cfg_t::i2c_address
uint8_t i2c_address
Definition: turbidity.h:124
turbidity_cfg_t
Turbidity Click configuration object.
Definition: turbidity.h:119
turbidity_default_cfg
err_t turbidity_default_cfg(turbidity_t *ctx)
Turbidity default configuration function.
turbidity_return_value_t
turbidity_return_value_t
Turbidity Click return value data.
Definition: turbidity.h:133
turbidity_init
err_t turbidity_init(turbidity_t *ctx, turbidity_cfg_t *cfg)
Turbidity initialization function.
turbidity_get_adc_voltage
err_t turbidity_get_adc_voltage(turbidity_t *ctx, float *voltage)
Turbidity get voltage function.