ambient16  2.0.0.0
ambient16.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 AMBIENT16_H
29 #define AMBIENT16_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_in.h"
46 #include "drv_i2c_master.h"
47 
68 #define AMBIENT16_CONTROL_REG 0x00
69 #define AMBIENT16_TIMING_REG 0x01
70 #define AMBIENT16_INTERRUPT_REG 0x02
71 #define AMBIENT16_TH_LOW_LSB_REG 0x03
72 #define AMBIENT16_TH_LOW_MSB_REG 0x04
73 #define AMBIENT16_TH_HIGH_LSB_REG 0x05
74 #define AMBIENT16_TH_HIGH_MSB_REG 0x06
75 #define AMBIENT16_GAIN_REG 0x07
76 #define AMBIENT16_PART_ID_REG 0x12
77 #define AMBIENT16_DATA0_LSB_REG 0x14
78 #define AMBIENT16_DATA0_MSB_REG 0x15
79 #define AMBIENT16_DATA1_LSB_REG 0x16
80 #define AMBIENT16_DATA1_MSB_REG 0x17
81 #define AMBIENT16_WAIT_REG 0x18
82  // ambient16_reg
84 
104 #define AMBIENT16_SOFTWARE_RESET 0xE4
105 #define AMBIENT16_INTERRUPT_RESET 0xE1
106 
111 #define AMBIENT16_ADC_INTERRUPT_ENABLE 0x20
112 #define AMBIENT16_ADC_ENABLE 0x02
113 #define AMBIENT16_POWER_ENABLE 0x01
114 
115 #define AMBIENT16_UNLATCH_MODE 0x20
116 #define AMBIENT16_LATCH_MODE 0x00
117 
118 #define AMBIENT16_INTERRUPT_ENABLE 0x10
119 #define AMBIENT16_INTERRUPT_DISABLE 0x00
120 
125 #define AMBIENT16_INT_ACTIVE_ON_END_OF_MEASURMENT 0x00
126 #define AMBIENT16_INT_UPDATE_ON_END_OF_MEASURMENT 0x01
127 #define AMBIENT16_INT_UPDATE_ON_2_CONSEC_TRESHOLDS 0x02
128 #define AMBIENT16_INT_UPDATE_ON_3_CONSEC_TRESHOLDS 0x03
129 #define AMBIENT16_INT_UPDATE_ON_4_CONSEC_TRESHOLDS 0x04
130 #define AMBIENT16_INT_UPDATE_ON_5_CONSEC_TRESHOLDS 0x05
131 #define AMBIENT16_INT_UPDATE_ON_6_CONSEC_TRESHOLDS 0x06
132 #define AMBIENT16_INT_UPDATE_ON_7_CONSEC_TRESHOLDS 0x07
133 #define AMBIENT16_INT_UPDATE_ON_8_CONSEC_TRESHOLDS 0x08
134 #define AMBIENT16_INT_UPDATE_ON_9_CONSEC_TRESHOLDS 0x09
135 #define AMBIENT16_INT_UPDATE_ON_10_CONSEC_TRESHOLDS 0x0A
136 #define AMBIENT16_INT_UPDATE_ON_11_CONSEC_TRESHOLDS 0x0B
137 #define AMBIENT16_INT_UPDATE_ON_12_CONSEC_TRESHOLDS 0x0C
138 #define AMBIENT16_INT_UPDATE_ON_13_CONSEC_TRESHOLDS 0x0D
139 #define AMBIENT16_INT_UPDATE_ON_14_CONSEC_TRESHOLDS 0x0E
140 #define AMBIENT16_INT_UPDATE_ON_15_CONSEC_TRESHOLDS 0x0F
141 
146 #define AMBIENT16_X1_GAIN 0x00
147 #define AMBIENT16_X2_GAIN 0x01
148 #define AMBIENT16_X64_GAIN 0x02
149 #define AMBIENT16_X128_GAIN 0x03
150 
155 #define AMBIENT16_ENABLE_WAIT 0x01
156 #define AMBIENT16_DISABLE_WAIT 0x00
157 
162 #define AMBIENT16_INT_STATE_HIGH 0x01
163 #define AMBIENT16_INT_STATE_LOW 0x00
164 
170 #define AMBIENT16_I2C_SLAVE_ADR_0 0x29
171 #define AMBIENT16_I2C_SLAVE_ADR_1 0x39
172  // ambient16_set
174 
189 #define AMBIENT16_MAP_MIKROBUS( cfg, mikrobus ) \
190  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
191  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
192  cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
193  // ambient16_map // ambient16
196 
201 typedef struct
202 {
203  // Input pins
204  digital_in_t int_pin;
206  // Modules
207  i2c_master_t i2c;
209  // I2C slave address
210  uint8_t slave_address;
212 } ambient16_t;
213 
218 typedef struct
219 {
220  pin_name_t scl;
221  pin_name_t sda;
223  pin_name_t int_pin;
225  uint32_t i2c_speed;
226  uint8_t i2c_address;
229 
234 typedef enum
235 {
237  AMBIENT16_ERROR = -1
238 
240 
257 
272 
287 
302 err_t ambient16_generic_write ( ambient16_t *ctx, uint8_t reg, uint8_t *tx_buf, uint8_t tx_len );
303 
318 err_t ambient16_generic_read ( ambient16_t *ctx, uint8_t reg, uint8_t *rx_buf, uint8_t rx_len );
319 
329 
343 err_t ambient16_set_reg ( ambient16_t *ctx, uint8_t reg, uint8_t value );
344 
356 err_t ambient16_send_cmd ( ambient16_t *ctx, uint8_t cmd );
357 
369 
381 
394 err_t ambient16_set_th_low ( ambient16_t *ctx, uint16_t th_val );
395 
408 err_t ambient16_set_th_high ( ambient16_t *ctx, uint16_t th_val );
409 
423 err_t ambient16_set_gain ( ambient16_t *ctx, uint8_t data0_gain, uint8_t data1_gain );
424 
437 err_t ambient16_get_part_id ( ambient16_t *ctx, uint8_t *part_id );
438 
452 err_t ambient16_get_data ( ambient16_t *ctx, uint16_t *data0, uint16_t *data1 );
453 
467 err_t ambient16_read_data ( ambient16_t *ctx, float *data0, float *data1 );
468 
479 void ambient16_set_wait ( ambient16_t *ctx, uint8_t wait_mode );
480 
481 #ifdef __cplusplus
482 }
483 #endif
484 #endif // AMBIENT16_H
485  // ambient16
487 
488 // ------------------------------------------------------------------------ END
ambient16_set_th_low
err_t ambient16_set_th_low(ambient16_t *ctx, uint16_t th_val)
Ambient 16 set interrupt threshold lower level function.
AMBIENT16_ERROR
@ AMBIENT16_ERROR
Definition: ambient16.h:237
ambient16_sw_reset
err_t ambient16_sw_reset(ambient16_t *ctx)
Ambient 16 software reset function.
ambient16_t::i2c
i2c_master_t i2c
Definition: ambient16.h:207
ambient16_cfg_t
Ambient 16 Click configuration object.
Definition: ambient16.h:219
ambient16_set_wait
void ambient16_set_wait(ambient16_t *ctx, uint8_t wait_mode)
Ambient 16 set wait function.
ambient16_t::slave_address
uint8_t slave_address
Definition: ambient16.h:210
ambient16_cfg_t::i2c_address
uint8_t i2c_address
Definition: ambient16.h:226
ambient16_default_cfg
err_t ambient16_default_cfg(ambient16_t *ctx)
Ambient 16 default configuration function.
ambient16_get_int_state
uint8_t ambient16_get_int_state(ambient16_t *ctx)
Ambient 16 get INT state function.
ambient16_init
err_t ambient16_init(ambient16_t *ctx, ambient16_cfg_t *cfg)
Ambient 16 initialization function.
ambient16_t
Ambient 16 Click context object.
Definition: ambient16.h:202
ambient16_return_value_t
ambient16_return_value_t
Ambient 16 Click return value data.
Definition: ambient16.h:235
ambient16_cfg_setup
void ambient16_cfg_setup(ambient16_cfg_t *cfg)
Ambient 16 configuration object setup function.
ambient16_get_data
err_t ambient16_get_data(ambient16_t *ctx, uint16_t *data0, uint16_t *data1)
Ambient 16 get ADC data function.
ambient16_int_reset
err_t ambient16_int_reset(ambient16_t *ctx)
Ambient 16 interrupt reset function.
ambient16_generic_read
err_t ambient16_generic_read(ambient16_t *ctx, uint8_t reg, uint8_t *rx_buf, uint8_t rx_len)
Ambient 16 I2C reading function.
ambient16_set_reg
err_t ambient16_set_reg(ambient16_t *ctx, uint8_t reg, uint8_t value)
Ambient 16 set register value function.
ambient16_generic_write
err_t ambient16_generic_write(ambient16_t *ctx, uint8_t reg, uint8_t *tx_buf, uint8_t tx_len)
Ambient 16 I2C writing function.
ambient16_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: ambient16.h:225
ambient16_set_gain
err_t ambient16_set_gain(ambient16_t *ctx, uint8_t data0_gain, uint8_t data1_gain)
Ambient 16 set ADC gain function.
ambient16_get_part_id
err_t ambient16_get_part_id(ambient16_t *ctx, uint8_t *part_id)
Ambient 16 get part ID function.
AMBIENT16_OK
@ AMBIENT16_OK
Definition: ambient16.h:236
ambient16_cfg_t::sda
pin_name_t sda
Definition: ambient16.h:221
ambient16_t::int_pin
digital_in_t int_pin
Definition: ambient16.h:204
ambient16_set_th_high
err_t ambient16_set_th_high(ambient16_t *ctx, uint16_t th_val)
Ambient 16 set interrupt threshold upper level function.
ambient16_send_cmd
err_t ambient16_send_cmd(ambient16_t *ctx, uint8_t cmd)
Ambient 16 send command function.
ambient16_read_data
err_t ambient16_read_data(ambient16_t *ctx, float *data0, float *data1)
Ambient 16 get data function.
ambient16_cfg_t::int_pin
pin_name_t int_pin
Definition: ambient16.h:223
ambient16_cfg_t::scl
pin_name_t scl
Definition: ambient16.h:220