ambient12 2.0.0.0
ambient12.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 AMBIENT12_H
29#define AMBIENT12_H
30
31#ifdef __cplusplus
32extern "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
61#define AMBIENT12_SET_DEV_ADDR 0x4D
62
67#define AMBIENT12_ADC_RESOLUTION 0x0FFF
68#define AMBIENT12_VREF_3V3 3.3
69
74#define AMBIENT12_IOUT_CURRENT_H_GAIN 0.57
75#define AMBIENT12_IOUT_CURRENT_M_GAIN 0.057
76#define AMBIENT12_IOUT_CURRENT_L_GAIN 0.0057
77#define AMBIENT12_MICROAMPER_TO_AMPER 0.000001
78#define AMBIENT12_IOUT_RESISTOR 5700
79 // ambient12_set
81
96#define AMBIENT12_MAP_MIKROBUS( cfg, mikrobus ) \
97 cfg.an = MIKROBUS( mikrobus, MIKROBUS_AN ); \
98 cfg.gc1 = MIKROBUS( mikrobus, MIKROBUS_CS ); \
99 cfg.gc2 = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
100 cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
101 cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA )
102 // ambient12_map // ambient12
105
110typedef enum
111{
116
118
123typedef struct
124{
125 digital_out_t gc1;
126 digital_out_t gc2;
128 analog_in_t adc;
129 i2c_master_t i2c;
133
135
140typedef struct
141{
142 pin_name_t an;
143 pin_name_t gc1;
144 pin_name_t gc2;
145 pin_name_t scl;
146 pin_name_t sda;
148 uint32_t i2c_speed;
149 uint8_t i2c_address;
151 analog_in_resolution_t resolution;
152 float vref;
155
160typedef enum
161{
163 AMBIENT12_ERROR = -1
164
166
183
199
212err_t ambient12_read_an_pin_value ( ambient12_t *ctx, uint16_t *data_out );
213
228err_t ambient12_read_an_pin_voltage ( ambient12_t *ctx, float *data_out );
229
242err_t ambient12_read_raw_adc ( ambient12_t *ctx, uint16_t *raw_adc );
243
257err_t ambient12_read_adc_voltage ( ambient12_t *ctx, float *voltage );
258
268void ambient12_set_gc1_pin ( ambient12_t *ctx, uint8_t state );
269
279void ambient12_set_gc2_pin ( ambient12_t *ctx, uint8_t state );
280
293void ambient12_set_gain_mode ( ambient12_t *ctx, uint8_t mode );
294
303int32_t ambient12_voltage_to_lux ( ambient12_t *ctx, float voltage );
304
305#ifdef __cplusplus
306}
307#endif
308#endif // AMBIENT12_H
309 // ambient12
311
312// ------------------------------------------------------------------------ END
ambient12_return_value_t
Ambient 12 Click return value data.
Definition: ambient12.h:161
@ AMBIENT12_ERROR
Definition: ambient12.h:163
@ AMBIENT12_OK
Definition: ambient12.h:162
ambient12_gain_mode_t
Ambient 12 Click gain mode setting.
Definition: ambient12.h:111
@ AMBIENT12_MODE_M_GAIN
Definition: ambient12.h:114
@ AMBIENT12_MODE_L_GAIN
Definition: ambient12.h:115
@ AMBIENT12_MODE_H_GAIN
Definition: ambient12.h:113
@ AMBIENT12_MODE_SHUTDOWN
Definition: ambient12.h:112
void ambient12_set_gc1_pin(ambient12_t *ctx, uint8_t state)
Ambient 12 set GC1 pin state function.
err_t ambient12_read_an_pin_value(ambient12_t *ctx, uint16_t *data_out)
Ambient 12 read AN pin value function.
void ambient12_cfg_setup(ambient12_cfg_t *cfg)
Ambient 12 configuration object setup function.
err_t ambient12_read_adc_voltage(ambient12_t *ctx, float *voltage)
Ambient 12 read ADC voltage function.
int32_t ambient12_voltage_to_lux(ambient12_t *ctx, float voltage)
Ambient 12 voltage to illuminance function.
void ambient12_set_gain_mode(ambient12_t *ctx, uint8_t mode)
Ambient 12 set gain mode function.
err_t ambient12_init(ambient12_t *ctx, ambient12_cfg_t *cfg)
Ambient 12 initialization function.
void ambient12_set_gc2_pin(ambient12_t *ctx, uint8_t state)
Ambient 12 set GC2 pin state function.
err_t ambient12_read_an_pin_voltage(ambient12_t *ctx, float *data_out)
Ambient 12 read AN pin voltage level function.
err_t ambient12_read_raw_adc(ambient12_t *ctx, uint16_t *raw_adc)
Ambient 12 read raw ADC function.
Ambient 12 Click configuration object.
Definition: ambient12.h:141
pin_name_t gc1
Definition: ambient12.h:143
analog_in_resolution_t resolution
Definition: ambient12.h:151
float vref
Definition: ambient12.h:152
uint32_t i2c_speed
Definition: ambient12.h:148
pin_name_t scl
Definition: ambient12.h:145
pin_name_t gc2
Definition: ambient12.h:144
pin_name_t sda
Definition: ambient12.h:146
pin_name_t an
Definition: ambient12.h:142
uint8_t i2c_address
Definition: ambient12.h:149
Ambient 12 Click context object.
Definition: ambient12.h:124
digital_out_t gc1
Definition: ambient12.h:125
i2c_master_t i2c
Definition: ambient12.h:129
ambient12_gain_mode_t gain_mode
Definition: ambient12.h:132
uint8_t slave_address
Definition: ambient12.h:131
digital_out_t gc2
Definition: ambient12.h:126
analog_in_t adc
Definition: ambient12.h:128