ambient23 2.1.0.0
ambient23.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 AMBIENT23_H
29#define AMBIENT23_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_i2c_master.h"
38
59#define AMBIENT23_REG_CONFIG 0x00
60#define AMBIENT23_REG_WHITE_DATA 0x04
61#define AMBIENT23_REG_ALS_DATA 0x05
62#define AMBIENT23_REG_DEVICE_ID 0x09
63 // ambient23_reg
65
80#define AMBIENT23_DEVICE_ID 0x35
81
86#define AMBIENT23_GAIN_1 0x0000u
87#define AMBIENT23_GAIN_2 0x0800u
88#define AMBIENT23_GAIN_4 0x1800u
89#define AMBIENT23_GAIN_MSK 0x1800u
90
95#define AMBIENT23_DATA_GAIN_1 0x0000u
96#define AMBIENT23_DATA_GAIN_2 0x2000u
97#define AMBIENT23_DATA_GAIN_MASK 0x2000u
98
103#define AMBIENT23_SDO_SHUTDOWN_ON 0x8000u
104#define AMBIENT23_SDO_SHUTDOWN_OFF 0x0000u
105#define AMBIENT23_SHUTDOWN_ON 0x0001u
106#define AMBIENT23_SHUTDOWN_OFF 0x0000u
107
112#define AMBIENT23_TRIGGER_ON 0x0004u
113#define AMBIENT23_TRIGGER_OFF 0x0000u
114
119#define AMBIENT23_AUTO_FORCE_MODE 0x0800u
120#define AMBIENT23_MANUAL_FORCE_MODE 0x0000u
121
126#define AMBIENT23_INTEGRATION_50_mS 0x0000u
127#define AMBIENT23_INTEGRATION_100_mS 0x0010u
128#define AMBIENT23_INTEGRATION_200_mS 0x0020u
129#define AMBIENT23_INTEGRATION_400_mS 0x0030u
130#define AMBIENT23_INTEGRATION_800_mS 0x0040u
131#define AMBIENT23_INTEGRATION_TIME_MSK 0x0070u
132
137#define AMBIENT23_CONFIG_DEF_VAL 0x0100u
138
143#define AMBIENT23_PART_ID 0x35
144
149#define AMBIENT23_TYPICAL_RESOLUTION 0.27264f
150
156#define AMBIENT23_DEVICE_ADDRESS 0x10
157 // ambient23_set
159
174#define AMBIENT23_MAP_MIKROBUS( cfg, mikrobus ) \
175 cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
176 cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA );
177 // ambient23_map // ambient23
180
185typedef struct
186{
187 // Modules
188 i2c_master_t i2c;
190 // I2C slave address
193 // Resolution
197
202typedef struct
203{
204 pin_name_t scl;
205 pin_name_t sda;
207 uint32_t i2c_speed;
208 uint8_t i2c_address;
211
216typedef enum
217{
219 AMBIENT23_ERROR = -1
220
222
239
254
268
283err_t ambient23_generic_write ( ambient23_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len );
284
299err_t ambient23_generic_read ( ambient23_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len );
300
314err_t ambient23_reg_write ( ambient23_t *ctx, uint8_t reg, uint16_t data_in );
315
329err_t ambient23_reg_read ( ambient23_t *ctx, uint8_t reg, uint16_t *data_out );
330
343
355err_t ambient23_read_light_data ( ambient23_t *ctx, float *light_data );
356
357#ifdef __cplusplus
358}
359#endif
360#endif // AMBIENT23_H
361 // ambient23
363
364// ------------------------------------------------------------------------ END
ambient23_return_value_t
Ambient 23 Click return value data.
Definition: ambient23.h:217
@ AMBIENT23_ERROR
Definition: ambient23.h:219
@ AMBIENT23_OK
Definition: ambient23.h:218
void ambient23_cfg_setup(ambient23_cfg_t *cfg)
Ambient 23 configuration object setup function.
err_t ambient23_read_light_data(ambient23_t *ctx, float *light_data)
Ambient 23 get light data function.
err_t ambient23_generic_read(ambient23_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len)
Ambient 23 I2C reading function.
err_t ambient23_reg_write(ambient23_t *ctx, uint8_t reg, uint16_t data_in)
Ambient 23 register data writing function.
err_t ambient23_reg_read(ambient23_t *ctx, uint8_t reg, uint16_t *data_out)
Ambient 23 register reading function.
err_t ambient23_get_conversion_data(ambient23_t *ctx)
Ambient 23 get conversion data function.
err_t ambient23_generic_write(ambient23_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len)
Ambient 23 I2C writing function.
err_t ambient23_init(ambient23_t *ctx, ambient23_cfg_t *cfg)
Ambient 23 initialization function.
err_t ambient23_default_cfg(ambient23_t *ctx)
Ambient 23 default configuration function.
Ambient 23 Click configuration object.
Definition: ambient23.h:203
uint32_t i2c_speed
Definition: ambient23.h:207
pin_name_t scl
Definition: ambient23.h:204
pin_name_t sda
Definition: ambient23.h:205
uint8_t i2c_address
Definition: ambient23.h:208
Ambient 23 Click context object.
Definition: ambient23.h:186
i2c_master_t i2c
Definition: ambient23.h:188
uint8_t slave_address
Definition: ambient23.h:191
float conversion_mul
Definition: ambient23.h:194