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
32extern "C"{
33#endif
34
35#include "drv_digital_in.h"
36#include "drv_i2c_master.h"
37
58#define AMBIENT16_CONTROL_REG 0x00
59#define AMBIENT16_TIMING_REG 0x01
60#define AMBIENT16_INTERRUPT_REG 0x02
61#define AMBIENT16_TH_LOW_LSB_REG 0x03
62#define AMBIENT16_TH_LOW_MSB_REG 0x04
63#define AMBIENT16_TH_HIGH_LSB_REG 0x05
64#define AMBIENT16_TH_HIGH_MSB_REG 0x06
65#define AMBIENT16_GAIN_REG 0x07
66#define AMBIENT16_PART_ID_REG 0x12
67#define AMBIENT16_DATA0_LSB_REG 0x14
68#define AMBIENT16_DATA0_MSB_REG 0x15
69#define AMBIENT16_DATA1_LSB_REG 0x16
70#define AMBIENT16_DATA1_MSB_REG 0x17
71#define AMBIENT16_WAIT_REG 0x18
72 // ambient16_reg
74
94#define AMBIENT16_SOFTWARE_RESET 0xE4
95#define AMBIENT16_INTERRUPT_RESET 0xE1
96
101#define AMBIENT16_ADC_INTERRUPT_ENABLE 0x20
102#define AMBIENT16_ADC_ENABLE 0x02
103#define AMBIENT16_POWER_ENABLE 0x01
104
105#define AMBIENT16_UNLATCH_MODE 0x20
106#define AMBIENT16_LATCH_MODE 0x00
107
108#define AMBIENT16_INTERRUPT_ENABLE 0x10
109#define AMBIENT16_INTERRUPT_DISABLE 0x00
110
115#define AMBIENT16_INT_ACTIVE_ON_END_OF_MEASURMENT 0x00
116#define AMBIENT16_INT_UPDATE_ON_END_OF_MEASURMENT 0x01
117#define AMBIENT16_INT_UPDATE_ON_2_CONSEC_TRESHOLDS 0x02
118#define AMBIENT16_INT_UPDATE_ON_3_CONSEC_TRESHOLDS 0x03
119#define AMBIENT16_INT_UPDATE_ON_4_CONSEC_TRESHOLDS 0x04
120#define AMBIENT16_INT_UPDATE_ON_5_CONSEC_TRESHOLDS 0x05
121#define AMBIENT16_INT_UPDATE_ON_6_CONSEC_TRESHOLDS 0x06
122#define AMBIENT16_INT_UPDATE_ON_7_CONSEC_TRESHOLDS 0x07
123#define AMBIENT16_INT_UPDATE_ON_8_CONSEC_TRESHOLDS 0x08
124#define AMBIENT16_INT_UPDATE_ON_9_CONSEC_TRESHOLDS 0x09
125#define AMBIENT16_INT_UPDATE_ON_10_CONSEC_TRESHOLDS 0x0A
126#define AMBIENT16_INT_UPDATE_ON_11_CONSEC_TRESHOLDS 0x0B
127#define AMBIENT16_INT_UPDATE_ON_12_CONSEC_TRESHOLDS 0x0C
128#define AMBIENT16_INT_UPDATE_ON_13_CONSEC_TRESHOLDS 0x0D
129#define AMBIENT16_INT_UPDATE_ON_14_CONSEC_TRESHOLDS 0x0E
130#define AMBIENT16_INT_UPDATE_ON_15_CONSEC_TRESHOLDS 0x0F
131
136#define AMBIENT16_X1_GAIN 0x00
137#define AMBIENT16_X2_GAIN 0x01
138#define AMBIENT16_X64_GAIN 0x02
139#define AMBIENT16_X128_GAIN 0x03
140
145#define AMBIENT16_ENABLE_WAIT 0x01
146#define AMBIENT16_DISABLE_WAIT 0x00
147
152#define AMBIENT16_INT_STATE_HIGH 0x01
153#define AMBIENT16_INT_STATE_LOW 0x00
154
160#define AMBIENT16_I2C_SLAVE_ADR_0 0x29
161#define AMBIENT16_I2C_SLAVE_ADR_1 0x39
162 // ambient16_set
164
179#define AMBIENT16_MAP_MIKROBUS( cfg, mikrobus ) \
180 cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
181 cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
182 cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
183 // ambient16_map // ambient16
186
191typedef struct
192{
193 // Input pins
194 digital_in_t int_pin;
196 // Modules
197 i2c_master_t i2c;
199 // I2C slave address
203
208typedef struct
209{
210 pin_name_t scl;
211 pin_name_t sda;
213 pin_name_t int_pin;
215 uint32_t i2c_speed;
216 uint8_t i2c_address;
219
224typedef enum
225{
227 AMBIENT16_ERROR = -1
228
230
247
262
277
292err_t ambient16_generic_write ( ambient16_t *ctx, uint8_t reg, uint8_t *tx_buf, uint8_t tx_len );
293
308err_t ambient16_generic_read ( ambient16_t *ctx, uint8_t reg, uint8_t *rx_buf, uint8_t rx_len );
309
319
333err_t ambient16_set_reg ( ambient16_t *ctx, uint8_t reg, uint8_t value );
334
346err_t ambient16_send_cmd ( ambient16_t *ctx, uint8_t cmd );
347
359
371
384err_t ambient16_set_th_low ( ambient16_t *ctx, uint16_t th_val );
385
398err_t ambient16_set_th_high ( ambient16_t *ctx, uint16_t th_val );
399
413err_t ambient16_set_gain ( ambient16_t *ctx, uint8_t data0_gain, uint8_t data1_gain );
414
427err_t ambient16_get_part_id ( ambient16_t *ctx, uint8_t *part_id );
428
442err_t ambient16_get_data ( ambient16_t *ctx, uint16_t *data0, uint16_t *data1 );
443
457err_t ambient16_read_data ( ambient16_t *ctx, float *data0, float *data1 );
458
469void ambient16_set_wait ( ambient16_t *ctx, uint8_t wait_mode );
470
471#ifdef __cplusplus
472}
473#endif
474#endif // AMBIENT16_H
475 // ambient16
477
478// ------------------------------------------------------------------------ END
ambient16_return_value_t
Ambient 16 Click return value data.
Definition: ambient16.h:225
@ AMBIENT16_OK
Definition: ambient16.h:226
@ AMBIENT16_ERROR
Definition: ambient16.h:227
err_t ambient16_read_data(ambient16_t *ctx, float *data0, float *data1)
Ambient 16 get data function.
err_t ambient16_default_cfg(ambient16_t *ctx)
Ambient 16 default configuration function.
void ambient16_cfg_setup(ambient16_cfg_t *cfg)
Ambient 16 configuration object setup function.
err_t ambient16_int_reset(ambient16_t *ctx)
Ambient 16 interrupt reset function.
err_t ambient16_set_th_low(ambient16_t *ctx, uint16_t th_val)
Ambient 16 set interrupt threshold lower level function.
void ambient16_set_wait(ambient16_t *ctx, uint8_t wait_mode)
Ambient 16 set wait function.
err_t ambient16_generic_read(ambient16_t *ctx, uint8_t reg, uint8_t *rx_buf, uint8_t rx_len)
Ambient 16 I2C reading function.
err_t ambient16_get_data(ambient16_t *ctx, uint16_t *data0, uint16_t *data1)
Ambient 16 get ADC data function.
err_t ambient16_send_cmd(ambient16_t *ctx, uint8_t cmd)
Ambient 16 send command function.
err_t ambient16_init(ambient16_t *ctx, ambient16_cfg_t *cfg)
Ambient 16 initialization function.
err_t ambient16_generic_write(ambient16_t *ctx, uint8_t reg, uint8_t *tx_buf, uint8_t tx_len)
Ambient 16 I2C writing function.
err_t ambient16_set_reg(ambient16_t *ctx, uint8_t reg, uint8_t value)
Ambient 16 set register value function.
err_t ambient16_set_th_high(ambient16_t *ctx, uint16_t th_val)
Ambient 16 set interrupt threshold upper level function.
err_t ambient16_sw_reset(ambient16_t *ctx)
Ambient 16 software reset function.
err_t ambient16_set_gain(ambient16_t *ctx, uint8_t data0_gain, uint8_t data1_gain)
Ambient 16 set ADC gain function.
uint8_t ambient16_get_int_state(ambient16_t *ctx)
Ambient 16 get INT state function.
err_t ambient16_get_part_id(ambient16_t *ctx, uint8_t *part_id)
Ambient 16 get part ID function.
Ambient 16 Click configuration object.
Definition: ambient16.h:209
uint32_t i2c_speed
Definition: ambient16.h:215
pin_name_t scl
Definition: ambient16.h:210
pin_name_t int_pin
Definition: ambient16.h:213
pin_name_t sda
Definition: ambient16.h:211
uint8_t i2c_address
Definition: ambient16.h:216
Ambient 16 Click context object.
Definition: ambient16.h:192
digital_in_t int_pin
Definition: ambient16.h:194
i2c_master_t i2c
Definition: ambient16.h:197
uint8_t slave_address
Definition: ambient16.h:200