Go to the documentation of this file.
38 #include "drv_digital_out.h"
39 #include "drv_digital_in.h"
40 #include "drv_i2c_master.h"
52 #define SMOKE_MAP_MIKROBUS( cfg, mikrobus ) \
53 cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
54 cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
55 cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
62 #define SMOKE_RETVAL uint8_t
65 #define SMOKE_INIT_ERROR 0xFF
66 #define SMOKE_PARAMETER_ERROR 0xFE
73 #define SMOKE_I2C_ADDRESS 0x57
85 #define SMOKE_INT_STAT1 0x00
86 #define SMOKE_INT_STAT2 0x01
87 #define SMOKE_INT_ENABLE1 0x02
88 #define SMOKE_INT_ENABLE2 0x03
95 #define SMOKE_INT_FLAG_GET_MAIN 1
96 #define SMOKE_INT_FLAG_GET_TEMP_DATA 2
98 #define SMOKE_INT_FLAG_SET_AFULL 0
99 #define SMOKE_INT_FLAG_SET_DATA_RDY 1
100 #define SMOKE_INT_FLAG_SET_ALS_OVF 2
101 #define SMOKE_INT_FLAG_SET_PROXY_THRESH 3
102 #define SMOKE_INT_FLAG_SET_TEMP 4
104 #define SMOKE_INT_FLAG_SET_ENABLE 1
105 #define SMOKE_INT_FLAG_SET_DISABLE 0
112 #define SMOKE_FIFO_WRITE_PTR 0x04
113 #define SMOKE_FIFO_OVERFLOW 0x05
114 #define SMOKE_FIFO_READ_PTR 0x06
115 #define SMOKE_FIFO_DATA 0x07
116 #define SMOKE_BUFFER_LENGTH 32
123 #define SMOKE_REG_FIFO_CONFIG 0x08
124 #define SMOKE_REG_MODE_CONFIG 0x09
125 #define SMOKE_REG_PARTICLE_CONFIG 0x0A
126 #define SMOKE_REG_LED_RED_PULSE_AMP 0x0C
127 #define SMOKE_REG_LED_IR_PULSE_AMP 0x0D
128 #define SMOKE_REG_LED_GREEN_PULSE_AMP 0x0E
129 #define SMOKE_REG_LED_PROX_AMP 0x10
130 #define SMOKE_REG_LED_PROX_THRESH 0x30
131 #define SMOKE_REG_MULTI_LED_CONFIG1 0x11
132 #define SMOKE_REG_MULTI_LED_CONFIG2 0x12
133 #define SMOKE_REG_MIN_POWER_LEVEL 0x01
134 #define SMOKE_REG_AVG_POWER_LEVEL 0x1F
135 #define SMOKE_REG_MAX_POWER_LEVEL 0xFF
142 #define SMOKE_DIE_TEMP_INT 0x1F
143 #define SMOKE_DIE_TEMP_FRAC 0x20
144 #define SMOKE_DIE_TEMP_CONFIG 0x21
151 #define SMOKE_PROX_INT_THRESH 0x30
158 #define SMOKE_REVISION_ID 0xFE
159 #define SMOKE_PART_ID 0xFF
173 #define SMOKE_INT_A_FULL_MASK (uint8_t)~0b10000000
174 #define SMOKE_INT_A_FULL_ENABLE 0x80
175 #define SMOKE_INT_A_FULL_DISABLE 0x00
176 #define SMOKE_INT_DATA_RDY_MASK (uint8_t)~0b01000000
177 #define SMOKE_INT_DATA_RDY_ENABLE 0x40
178 #define SMOKE_INT_DATA_RDY_DISABLE 0x00
179 #define SMOKE_INT_ALC_OVF_MASK (uint8_t)~0b00100000
180 #define SMOKE_INT_ALC_OVF_ENABLE 0x20
181 #define SMOKE_INT_ALC_OVF_DISABLE 0x00
182 #define SMOKE_INT_PROX_INT_MASK (uint8_t)~0b00010000
183 #define SMOKE_INT_PROX_INT_ENABLE 0x10
184 #define SMOKE_INT_PROX_INT_DISABLE 0x00
185 #define SMOKE_INT_DIE_TEMP_RDY_MASK (uint8_t)~0b00000010
186 #define SMOKE_INT_DIE_TEMP_RDY_ENABLE 0x02
187 #define SMOKE_INT_DIE_TEMP_RDY_DISABLE 0x00
194 #define SMOKE_SAMPLEAVG_MASK (uint8_t)~0b11100000
195 #define SMOKE_SAMPLEAVG_1 0x00
196 #define SMOKE_SAMPLEAVG_2 0x20
197 #define SMOKE_SAMPLEAVG_4 0x40
198 #define SMOKE_SAMPLEAVG_8 0x60
199 #define SMOKE_SAMPLEAVG_16 0x80
200 #define SMOKE_SAMPLEAVG_32 0xA0
201 #define SMOKE_ROLLOVER_MASK 0xEF
202 #define SMOKE_ROLLOVER_ENABLE 0x10
203 #define SMOKE_ROLLOVER_DISABLE 0x00
204 #define SMOKE_A_FULL_MASK 0xF0
211 #define SMOKE_SHUTDOWN_MASK 0x7F
212 #define SMOKE_SHUTDOWN 0x80
213 #define SMOKE_WAKEUP 0x00
214 #define SMOKE_RESET_MASK 0xBF
215 #define SMOKE_RESET 0x40
216 #define SMOKE_MODE_MASK 0xF8
217 #define SMOKE_MODE_REDONLY 0x02
218 #define SMOKE_MODE_REDIRONLY 0x03
219 #define SMOKE_MODE_MULTILED 0x07
226 #define SMOKE_ADCRANGE_MASK 0x9F
227 #define SMOKE_ADCRANGE_2048 0x00
228 #define SMOKE_ADCRANGE_4096 0x20
229 #define SMOKE_ADCRANGE_8192 0x40
230 #define SMOKE_ADCRANGE_16384 0x60
231 #define SMOKE_SAMPLERATE_MASK 0xE3
232 #define SMOKE_SAMPLERATE_50 0x00
233 #define SMOKE_SAMPLERATE_100 0x04
234 #define SMOKE_SAMPLERATE_200 0x08
235 #define SMOKE_SAMPLERATE_400 0x0C
236 #define SMOKE_SAMPLERATE_800 0x10
237 #define SMOKE_SAMPLERATE_1000 0x14
238 #define SMOKE_SAMPLERATE_1600 0x18
239 #define SMOKE_SAMPLERATE_3200 0x1C
240 #define SMOKE_PULSEWIDTH_MASK 0xFC
241 #define SMOKE_PULSEWIDTH_69 0x00
242 #define SMOKE_PULSEWIDTH_118 0x01
243 #define SMOKE_PULSEWIDTH_215 0x02
244 #define SMOKE_PULSEWIDTH_411 0x03
251 #define SMOKE_SLOT1_MASK 0xF8
252 #define SMOKE_SLOT2_MASK 0x8F
253 #define SMOKE_SLOT3_MASK 0xF8
254 #define SMOKE_SLOT4_MASK 0x8F
256 #define SMOKE_SLOT_NONE 0x00
257 #define SMOKE_SLOT_RED_LED 0x01
258 #define SMOKE_SLOT_IR_LED 0x02
259 #define SMOKE_SLOT_GREEN_LED 0x03
261 #define SMOKE_SLOT_NONE_PILOT 0x04
262 #define SMOKE_SLOT_RED_PILOT 0x05
263 #define SMOKE_SLOT_IR_PILOT 0x06
264 #define SMOKE_SLOT_GREEN_PILOT 0x07
float smoke_read_temp(smoke_t *ctx)
Read temperature in Centigrade function.
#define SMOKE_RETVAL
Definition: smoke.h:62
i2c_master_t i2c
Definition: smoke.h:285
void smoke_disable_slots(smoke_t *ctx)
Disable slots in MultiLED mode function.
uint8_t smoke_enable_slot(smoke_t *ctx, uint8_t slot_num, uint8_t dev)
Define slots in MultiLED mode function.
void smoke_set_new_value(smoke_t *ctx, smoke_set_new_value_t *new_value_data)
Set new value function.
uint8_t slave_address
Definition: smoke.h:289
SMOKE_RETVAL smoke_init(smoke_t *ctx, smoke_cfg_t *cfg)
Initialization function.
uint8_t pulse_width
Definition: smoke.h:328
pin_name_t int_pin
Definition: smoke.h:310
uint8_t adc_range
Definition: smoke.h:326
void smoke_generic_read(smoke_t *ctx, uint8_t rd_addr, uint8_t *buffer, uint8_t cnt)
Generic read function.
uint8_t num_en_led
Definition: smoke.h:291
uint8_t smoke_set_led_amplitude(smoke_t *ctx, uint8_t led, uint8_t amplitude)
Set led amplitude.
uint8_t mask
Definition: smoke.h:339
uint32_t ir_value
Definition: smoke.h:293
void smoke_write_data(smoke_t *ctx, uint8_t wr_addr, uint8_t wr_data)
Generic write function.
uint8_t samp_rate
Definition: smoke.h:327
uint8_t smoke_set_rollover_state(smoke_t *ctx, uint8_t state)
Set rollover state.
New value object definition.
Definition: smoke.h:337
uint8_t value
Definition: smoke.h:340
uint8_t smoke_set_led_mode(smoke_t *ctx, uint8_t mode)
Enable leds.
uint8_t smoke_set_adc_range(smoke_t *ctx, uint8_t adc_range)
Set ADC range.
uint8_t smoke_set_registers(smoke_t *ctx, smoke_set_registers_t *registers)
Set registers values function.
uint32_t i2c_speed
Definition: smoke.h:314
uint8_t smoke_get_intrrupt(smoke_t *ctx, uint8_t flag)
Get desired interrupt function.
uint8_t smoke_set_sample_avarage(smoke_t *ctx, uint8_t samples)
Set avarage samples.
uint32_t green_value
Definition: smoke.h:294
void smoke_clear_fifo(smoke_t *ctx)
Clearing FIFO pointers function.
Click configuration structure definition.
Definition: smoke.h:302
void smoke_default_cfg(smoke_t *ctx)
Click Default Configuration function.
uint8_t smoke_get_write_ptr(smoke_t *ctx)
Read the FIFO Write Pointer function.
uint8_t led_pow_lvl
Definition: smoke.h:329
uint8_t smoke_set_proximity_amplitude_threshold(smoke_t *ctx, uint8_t threshold)
Set proximity threshold.
uint8_t avg_samp
Definition: smoke.h:324
void smoke_reset(smoke_t *ctx)
Reset device function.
Click registers object definition.
Definition: smoke.h:323
Click ctx object definition.
Definition: smoke.h:278
uint8_t smoke_enable_disable_interrupts(smoke_t *ctx, uint8_t interrupt_flag, uint8_t enable_flag)
Enable or disable interrupt function.
uint8_t i2c_address
Definition: smoke.h:315
uint8_t mode
Definition: smoke.h:325
uint8_t reg_addr
Definition: smoke.h:338
uint32_t red_value
Definition: smoke.h:292
uint8_t smoke_set_almost_full_trigger(smoke_t *ctx, uint8_t trigger_range)
Set almost full trigger.
uint8_t smoke_read_device_id(smoke_t *ctx)
Read device ID function.
void smoke_cfg_setup(smoke_cfg_t *cfg)
Config Object Initialization function.
uint8_t smoke_set_pulse_width(smoke_t *ctx, uint8_t pulse_width)
Set pulse width.
pin_name_t sda
Definition: smoke.h:306
uint8_t smoke_get_read_ptr(smoke_t *ctx)
Read the FIFO Read Pointer function.
uint8_t smoke_read_data(smoke_t *ctx, uint8_t rd_addr)
Generic read function.
uint8_t smoke_set_power(smoke_t *ctx, uint8_t state)
I2C power setter.
digital_in_t int_pin
Definition: smoke.h:281
pin_name_t scl
Definition: smoke.h:305
uint8_t smoke_read_leds(smoke_t *ctx)
Function for reading enabled leds.
uint8_t smoke_check_int(smoke_t *ctx)
Get Interrupt state function.
uint8_t smoke_set_sample_rate(smoke_t *ctx, uint8_t sample_rate)
Set sample rate.