illuminance  2.0.0.0
illuminance.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 ILLUMINANCE_H
29 #define ILLUMINANCE_H
30 
31 #ifdef __cplusplus
32 extern "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 ILLUMINANCE_REG_CONTROL 0x00
60 #define ILLUMINANCE_REG_TIMING 0x01
61 #define ILLUMINANCE_REG_INTERRUPT 0x02
62 #define ILLUMINANCE_REG_THL_LOW 0x03
63 #define ILLUMINANCE_REG_THL_HIGH 0x04
64 #define ILLUMINANCE_REG_THH_LOW 0x05
65 #define ILLUMINANCE_REG_THH_HIGH 0x06
66 #define ILLUMINANCE_REG_ANALOG 0x07
67 #define ILLUMINANCE_REG_ID 0x12
68 #define ILLUMINANCE_REG_DATA0_LOW 0x14
69 #define ILLUMINANCE_REG_DATA0_HIGH 0x15
70 #define ILLUMINANCE_REG_DATA1_LOW 0x16
71 #define ILLUMINANCE_REG_DATA1_HIGH 0x17
72 #define ILLUMINANCE_REG_TIMER_LOW 0x18
73 #define ILLUMINANCE_REG_TIMER_HIGH 0x19
74 #define ILLUMINANCE_REG_ID2 0x1E
75  // illuminance_reg
77 
92 #define ILLUMINANCE_CMD_BIT 0x80
93 #define ILLUMINANCE_TRANSACTION_REPEATED 0x00
94 #define ILLUMINANCE_TRANSACTION_AUTO_INC 0x20
95 #define ILLUMINANCE_TRANSACTION_SPEC_FUNC 0x60
96 #define ILLUMINANCE_SPEC_FUNC_INT_CLEAR 0x01
97 #define ILLUMINANCE_SPEC_FUNC_STOP_MAN_INT 0x02
98 #define ILLUMINANCE_SPEC_FUNC_START_MAN_INT 0x03
99 
104 #define ILLUMINANCE_CONTROL_ADC_INTR 0x20
105 #define ILLUMINANCE_CONTROL_ADC_VALID 0x10
106 #define ILLUMINANCE_CONTROL_ADC_ENABLE 0x02
107 #define ILLUMINANCE_CONTROL_POWER_ON 0x01
108 
113 #define ILLUMINANCE_ATIME_MAX 688.5
114 #define ILLUMINANCE_ATIME_MIN 2.7
115 #define ILLUMINANCE_ATIME_STEP 2.7
116 #define ILLUMINANCE_DEFAULT_ATIME 200.0
117 
122 #define ILLUMINANCE_ENABLE_INTERRUPT 0x10
123 
128 #define ILLUMINANCE_GAIN_1X 0x00
129 #define ILLUMINANCE_GAIN_8X 0x01
130 #define ILLUMINANCE_GAIN_16X 0x02
131 #define ILLUMINANCE_GAIN_111X 0x03
132 
137 #define ILLUMINANCE_ID_PARTNO 0x90
138 #define ILLUMINANCE_ID2 0x30
139 
145 #define ILLUMINANCE_SET_DEV_ADDR_GND 0x29
146 #define ILLUMINANCE_SET_DEV_ADDR_FLOAT 0x39
147 #define ILLUMINANCE_SET_DEV_ADDR_VCC 0x49
148  // illuminance_set
150 
165 #define ILLUMINANCE_MAP_MIKROBUS( cfg, mikrobus ) \
166  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
167  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
168  cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
169  // illuminance_map // illuminance
172 
177 typedef struct
178 {
179  // Input pins
180  digital_in_t int_pin;
182  // Modules
183  i2c_master_t i2c;
185  // I2C slave address
186  uint8_t slave_address;
188  float atime_ms;
189  uint8_t gain;
191 } illuminance_t;
192 
197 typedef struct
198 {
199  pin_name_t scl;
200  pin_name_t sda;
202  pin_name_t int_pin;
204  uint32_t i2c_speed;
205  uint8_t i2c_address;
208 
213 typedef enum
214 {
216  ILLUMINANCE_ERROR = -1
217 
219 
236 
252 
267 
282 err_t illuminance_generic_write ( illuminance_t *ctx, uint8_t reg, uint8_t *tx_buf, uint8_t tx_len );
283 
298 err_t illuminance_generic_read ( illuminance_t *ctx, uint8_t reg, uint8_t *rx_buf, uint8_t rx_len );
299 
312 err_t illuminance_write_register ( illuminance_t *ctx, uint8_t reg, uint8_t data_in );
313 
326 err_t illuminance_read_register ( illuminance_t *ctx, uint8_t reg, uint8_t *data_out );
327 
337 
349 
361 err_t illuminance_set_atime ( illuminance_t *ctx, float atime_ms );
362 
374 err_t illuminance_set_gain ( illuminance_t *ctx, uint8_t gain );
375 
388 err_t illuminance_read_raw_data ( illuminance_t *ctx, uint16_t *ch_0, uint16_t *ch_1 );
389 
390 #ifdef __cplusplus
391 }
392 #endif
393 #endif // ILLUMINANCE_H
394  // illuminance
396 
397 // ------------------------------------------------------------------------ END
illuminance_t::atime_ms
float atime_ms
Definition: illuminance.h:188
illuminance_cfg_t::sda
pin_name_t sda
Definition: illuminance.h:200
illuminance_default_cfg
err_t illuminance_default_cfg(illuminance_t *ctx)
Illuminance default configuration function.
illuminance_t::int_pin
digital_in_t int_pin
Definition: illuminance.h:180
illuminance_read_register
err_t illuminance_read_register(illuminance_t *ctx, uint8_t reg, uint8_t *data_out)
Illuminance read register function.
illuminance_get_int_pin
uint8_t illuminance_get_int_pin(illuminance_t *ctx)
Illuminance get int pin function.
ILLUMINANCE_OK
@ ILLUMINANCE_OK
Definition: illuminance.h:215
illuminance_init
err_t illuminance_init(illuminance_t *ctx, illuminance_cfg_t *cfg)
Illuminance initialization function.
illuminance_check_communication
err_t illuminance_check_communication(illuminance_t *ctx)
Illuminance check communication function.
illuminance_set_atime
err_t illuminance_set_atime(illuminance_t *ctx, float atime_ms)
Illuminance set atime function.
illuminance_t::gain
uint8_t gain
Definition: illuminance.h:189
ILLUMINANCE_ERROR
@ ILLUMINANCE_ERROR
Definition: illuminance.h:216
illuminance_t::slave_address
uint8_t slave_address
Definition: illuminance.h:186
illuminance_generic_read
err_t illuminance_generic_read(illuminance_t *ctx, uint8_t reg, uint8_t *rx_buf, uint8_t rx_len)
Illuminance I2C reading function.
illuminance_return_value_t
illuminance_return_value_t
Illuminance Click return value data.
Definition: illuminance.h:214
illuminance_cfg_t::i2c_address
uint8_t i2c_address
Definition: illuminance.h:205
illuminance_cfg_t::int_pin
pin_name_t int_pin
Definition: illuminance.h:202
illuminance_t::i2c
i2c_master_t i2c
Definition: illuminance.h:183
illuminance_cfg_t::scl
pin_name_t scl
Definition: illuminance.h:199
illuminance_write_register
err_t illuminance_write_register(illuminance_t *ctx, uint8_t reg, uint8_t data_in)
Illuminance write register function.
illuminance_t
Illuminance Click context object.
Definition: illuminance.h:178
illuminance_cfg_t
Illuminance Click configuration object.
Definition: illuminance.h:198
illuminance_set_gain
err_t illuminance_set_gain(illuminance_t *ctx, uint8_t gain)
Illuminance set gain function.
illuminance_read_raw_data
err_t illuminance_read_raw_data(illuminance_t *ctx, uint16_t *ch_0, uint16_t *ch_1)
Illuminance read raw data function.
illuminance_cfg_setup
void illuminance_cfg_setup(illuminance_cfg_t *cfg)
Illuminance configuration object setup function.
illuminance_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: illuminance.h:204
illuminance_generic_write
err_t illuminance_generic_write(illuminance_t *ctx, uint8_t reg, uint8_t *tx_buf, uint8_t tx_len)
Illuminance I2C writing function.