smoke  2.0.0.0
smoke.h
Go to the documentation of this file.
1 /*
2  * MikroSDK - MikroE Software Development Kit
3  * Copyright© 2020 MikroElektronika d.o.o.
4  *
5  * Permission is hereby granted, free of charge, to any person
6  * obtaining a copy of this software and associated documentation
7  * files (the "Software"), to deal in the Software without restriction,
8  * including without limitation the rights to use, copy, modify, merge,
9  * publish, distribute, sublicense, and/or sell copies of the Software,
10  * and to permit persons to whom the Software is furnished to do so,
11  * subject to the following conditions:
12  *
13  * The above copyright notice and this permission notice shall be
14  * included in all copies or substantial portions of the Software.
15  *
16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
17  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
19  * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
20  * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
21  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE
22  * OR OTHER DEALINGS IN THE SOFTWARE.
23  */
24 
33 // ----------------------------------------------------------------------------
34 
35 #ifndef SMOKE_H
36 #define SMOKE_H
37 
42 #ifdef PREINIT_SUPPORTED
43 #include "preinit.h"
44 #endif
45 
46 #ifdef MikroCCoreVersion
47  #if MikroCCoreVersion >= 1
48  #include "delays.h"
49  #endif
50 #endif
51 
52 #include "drv_digital_out.h"
53 #include "drv_digital_in.h"
54 #include "drv_i2c_master.h"
55 
56 // -------------------------------------------------------------- PUBLIC MACROS
66 #define SMOKE_MAP_MIKROBUS( cfg, mikrobus ) \
67  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
68  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
69  cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
70 
76 #define SMOKE_RETVAL uint8_t
77 
78 #define SMOKE_OK 0x00
79 #define SMOKE_INIT_ERROR 0xFF
80 #define SMOKE_PARAMETER_ERROR 0xFE
81 
87 #define SMOKE_I2C_ADDRESS 0x57
88 
99 #define SMOKE_INT_STAT1 0x00
100 #define SMOKE_INT_STAT2 0x01
101 #define SMOKE_INT_ENABLE1 0x02
102 #define SMOKE_INT_ENABLE2 0x03
103 
109 #define SMOKE_INT_FLAG_GET_MAIN 1
110 #define SMOKE_INT_FLAG_GET_TEMP_DATA 2
111 
112 #define SMOKE_INT_FLAG_SET_AFULL 0
113 #define SMOKE_INT_FLAG_SET_DATA_RDY 1
114 #define SMOKE_INT_FLAG_SET_ALS_OVF 2
115 #define SMOKE_INT_FLAG_SET_PROXY_THRESH 3
116 #define SMOKE_INT_FLAG_SET_TEMP 4
117 
118 #define SMOKE_INT_FLAG_SET_ENABLE 1
119 #define SMOKE_INT_FLAG_SET_DISABLE 0
120 
126 #define SMOKE_FIFO_WRITE_PTR 0x04
127 #define SMOKE_FIFO_OVERFLOW 0x05
128 #define SMOKE_FIFO_READ_PTR 0x06
129 #define SMOKE_FIFO_DATA 0x07
130 #define SMOKE_BUFFER_LENGTH 32
131 
137 #define SMOKE_REG_FIFO_CONFIG 0x08
138 #define SMOKE_REG_MODE_CONFIG 0x09
139 #define SMOKE_REG_PARTICLE_CONFIG 0x0A
140 #define SMOKE_REG_LED_RED_PULSE_AMP 0x0C
141 #define SMOKE_REG_LED_IR_PULSE_AMP 0x0D
142 #define SMOKE_REG_LED_GREEN_PULSE_AMP 0x0E
143 #define SMOKE_REG_LED_PROX_AMP 0x10
144 #define SMOKE_REG_LED_PROX_THRESH 0x30
145 #define SMOKE_REG_MULTI_LED_CONFIG1 0x11
146 #define SMOKE_REG_MULTI_LED_CONFIG2 0x12
147 #define SMOKE_REG_MIN_POWER_LEVEL 0x01
148 #define SMOKE_REG_AVG_POWER_LEVEL 0x1F
149 #define SMOKE_REG_MAX_POWER_LEVEL 0xFF
150 
156 #define SMOKE_DIE_TEMP_INT 0x1F
157 #define SMOKE_DIE_TEMP_FRAC 0x20
158 #define SMOKE_DIE_TEMP_CONFIG 0x21
159 
165 #define SMOKE_PROX_INT_THRESH 0x30
166 
172 #define SMOKE_REVISION_ID 0xFE
173 #define SMOKE_PART_ID 0xFF
174 
187 #define SMOKE_INT_A_FULL_MASK (uint8_t)~0b10000000
188 #define SMOKE_INT_A_FULL_ENABLE 0x80
189 #define SMOKE_INT_A_FULL_DISABLE 0x00
190 #define SMOKE_INT_DATA_RDY_MASK (uint8_t)~0b01000000
191 #define SMOKE_INT_DATA_RDY_ENABLE 0x40
192 #define SMOKE_INT_DATA_RDY_DISABLE 0x00
193 #define SMOKE_INT_ALC_OVF_MASK (uint8_t)~0b00100000
194 #define SMOKE_INT_ALC_OVF_ENABLE 0x20
195 #define SMOKE_INT_ALC_OVF_DISABLE 0x00
196 #define SMOKE_INT_PROX_INT_MASK (uint8_t)~0b00010000
197 #define SMOKE_INT_PROX_INT_ENABLE 0x10
198 #define SMOKE_INT_PROX_INT_DISABLE 0x00
199 #define SMOKE_INT_DIE_TEMP_RDY_MASK (uint8_t)~0b00000010
200 #define SMOKE_INT_DIE_TEMP_RDY_ENABLE 0x02
201 #define SMOKE_INT_DIE_TEMP_RDY_DISABLE 0x00
202 
208 #define SMOKE_SAMPLEAVG_MASK (uint8_t)~0b11100000
209 #define SMOKE_SAMPLEAVG_1 0x00
210 #define SMOKE_SAMPLEAVG_2 0x20
211 #define SMOKE_SAMPLEAVG_4 0x40
212 #define SMOKE_SAMPLEAVG_8 0x60
213 #define SMOKE_SAMPLEAVG_16 0x80
214 #define SMOKE_SAMPLEAVG_32 0xA0
215 #define SMOKE_ROLLOVER_MASK 0xEF
216 #define SMOKE_ROLLOVER_ENABLE 0x10
217 #define SMOKE_ROLLOVER_DISABLE 0x00
218 #define SMOKE_A_FULL_MASK 0xF0
219 
225 #define SMOKE_SHUTDOWN_MASK 0x7F
226 #define SMOKE_SHUTDOWN 0x80
227 #define SMOKE_WAKEUP 0x00
228 #define SMOKE_RESET_MASK 0xBF
229 #define SMOKE_RESET 0x40
230 #define SMOKE_MODE_MASK 0xF8
231 #define SMOKE_MODE_REDONLY 0x02
232 #define SMOKE_MODE_REDIRONLY 0x03
233 #define SMOKE_MODE_MULTILED 0x07
234 
240 #define SMOKE_ADCRANGE_MASK 0x9F
241 #define SMOKE_ADCRANGE_2048 0x00
242 #define SMOKE_ADCRANGE_4096 0x20
243 #define SMOKE_ADCRANGE_8192 0x40
244 #define SMOKE_ADCRANGE_16384 0x60
245 #define SMOKE_SAMPLERATE_MASK 0xE3
246 #define SMOKE_SAMPLERATE_50 0x00
247 #define SMOKE_SAMPLERATE_100 0x04
248 #define SMOKE_SAMPLERATE_200 0x08
249 #define SMOKE_SAMPLERATE_400 0x0C
250 #define SMOKE_SAMPLERATE_800 0x10
251 #define SMOKE_SAMPLERATE_1000 0x14
252 #define SMOKE_SAMPLERATE_1600 0x18
253 #define SMOKE_SAMPLERATE_3200 0x1C
254 #define SMOKE_PULSEWIDTH_MASK 0xFC
255 #define SMOKE_PULSEWIDTH_69 0x00
256 #define SMOKE_PULSEWIDTH_118 0x01
257 #define SMOKE_PULSEWIDTH_215 0x02
258 #define SMOKE_PULSEWIDTH_411 0x03
259 
265 #define SMOKE_SLOT1_MASK 0xF8
266 #define SMOKE_SLOT2_MASK 0x8F
267 #define SMOKE_SLOT3_MASK 0xF8
268 #define SMOKE_SLOT4_MASK 0x8F
269 
270 #define SMOKE_SLOT_NONE 0x00
271 #define SMOKE_SLOT_RED_LED 0x01
272 #define SMOKE_SLOT_IR_LED 0x02
273 #define SMOKE_SLOT_GREEN_LED 0x03
274 
275 #define SMOKE_SLOT_NONE_PILOT 0x04
276 #define SMOKE_SLOT_RED_PILOT 0x05
277 #define SMOKE_SLOT_IR_PILOT 0x06
278 #define SMOKE_SLOT_GREEN_PILOT 0x07
279  // End group macro
282 // --------------------------------------------------------------- PUBLIC TYPES
291 typedef struct
292 {
293  // Input pins
294 
295  digital_in_t int_pin;
296 
297  // Modules
298 
299  i2c_master_t i2c;
300 
301  // ctx variable
302 
303  uint8_t slave_address;
304 
305  uint8_t num_en_led;
306  uint32_t red_value;
307  uint32_t ir_value;
308  uint32_t green_value;
309 
310 } smoke_t;
311 
315 typedef struct
316 {
317  // Communication gpio pins
318 
319  pin_name_t scl;
320  pin_name_t sda;
321 
322  // Additional gpio pins
323 
324  pin_name_t int_pin;
325 
326  // static variable
327 
328  uint32_t i2c_speed;
329  uint8_t i2c_address;
330 
331 } smoke_cfg_t;
332 
336 typedef struct
337 {
338  uint8_t avg_samp;
339  uint8_t mode;
340  uint8_t adc_range;
341  uint8_t samp_rate;
342  uint8_t pulse_width;
343  uint8_t led_pow_lvl;
344 
346 
350 typedef struct
351 {
352  uint8_t reg_addr;
353  uint8_t mask;
354  uint8_t value;
355 
357  // End types group
359 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
360 
366 #ifdef __cplusplus
367 extern "C"{
368 #endif
369 
379 
389 
398 
408 void smoke_write_data ( smoke_t *ctx, uint8_t wr_addr, uint8_t wr_data );
409 
420 uint8_t smoke_read_data ( smoke_t *ctx, uint8_t rd_addr );
421 
432 void smoke_generic_read ( smoke_t *ctx, uint8_t rd_addr, uint8_t *buffer, uint8_t cnt );
433 
444 void smoke_set_new_value ( smoke_t *ctx, smoke_set_new_value_t *new_value_data );
445 
456 uint8_t smoke_get_intrrupt ( smoke_t *ctx, uint8_t flag );
457 
486 uint8_t smoke_enable_disable_interrupts ( smoke_t *ctx, uint8_t interrupt_flag, uint8_t enable_flag );
487 
497 uint8_t smoke_read_device_id ( smoke_t *ctx );
498 
505 void smoke_reset ( smoke_t *ctx );
506 
516 float smoke_read_temp ( smoke_t *ctx );
517 
539 uint8_t smoke_set_power ( smoke_t *ctx, uint8_t state );
540 
563 uint8_t smoke_set_led_mode ( smoke_t *ctx, uint8_t mode );
564 
588 uint8_t smoke_set_adc_range ( smoke_t *ctx, uint8_t adc_range );
589 
617 uint8_t smoke_set_sample_rate ( smoke_t *ctx, uint8_t sample_rate );
618 
642 uint8_t smoke_set_pulse_width ( smoke_t *ctx, uint8_t pulse_width );
643 
667 uint8_t smoke_set_led_amplitude ( smoke_t *ctx, uint8_t led, uint8_t amplitude );
668 
687 uint8_t smoke_set_proximity_amplitude_threshold( smoke_t *ctx, uint8_t threshold );
688 
700 uint8_t smoke_enable_slot ( smoke_t *ctx, uint8_t slot_num, uint8_t dev );
701 
710 
718 void smoke_clear_fifo ( smoke_t *ctx );
719 
729 uint8_t smoke_get_write_ptr ( smoke_t *ctx );
730 
740 uint8_t smoke_get_read_ptr ( smoke_t *ctx );
741 
763 uint8_t smoke_set_rollover_state( smoke_t *ctx, uint8_t state );
764 
783 uint8_t smoke_set_almost_full_trigger( smoke_t *ctx, uint8_t trigger_range );
784 
810 uint8_t smoke_set_sample_avarage ( smoke_t *ctx, uint8_t samples );
811 
836 uint8_t smoke_set_registers ( smoke_t *ctx, smoke_set_registers_t *registers );
837 
854 uint8_t smoke_read_leds ( smoke_t *ctx );
855 
863 uint8_t smoke_check_int ( smoke_t *ctx );
864 
865 #ifdef __cplusplus
866 }
867 #endif
868 #endif // _SMOKE_H_
869  // End public_function group
872 
873 // ------------------------------------------------------------------------- END
smoke_read_temp
float smoke_read_temp(smoke_t *ctx)
Read temperature in Centigrade function.
SMOKE_RETVAL
#define SMOKE_RETVAL
Definition: smoke.h:76
smoke_t::i2c
i2c_master_t i2c
Definition: smoke.h:299
smoke_disable_slots
void smoke_disable_slots(smoke_t *ctx)
Disable slots in MultiLED mode function.
smoke_enable_slot
uint8_t smoke_enable_slot(smoke_t *ctx, uint8_t slot_num, uint8_t dev)
Define slots in MultiLED mode function.
smoke_set_new_value
void smoke_set_new_value(smoke_t *ctx, smoke_set_new_value_t *new_value_data)
Set new value function.
smoke_t::slave_address
uint8_t slave_address
Definition: smoke.h:303
smoke_init
SMOKE_RETVAL smoke_init(smoke_t *ctx, smoke_cfg_t *cfg)
Initialization function.
smoke_set_registers_t::pulse_width
uint8_t pulse_width
Definition: smoke.h:342
smoke_cfg_t::int_pin
pin_name_t int_pin
Definition: smoke.h:324
smoke_set_registers_t::adc_range
uint8_t adc_range
Definition: smoke.h:340
smoke_generic_read
void smoke_generic_read(smoke_t *ctx, uint8_t rd_addr, uint8_t *buffer, uint8_t cnt)
Generic read function.
smoke_t::num_en_led
uint8_t num_en_led
Definition: smoke.h:305
smoke_set_led_amplitude
uint8_t smoke_set_led_amplitude(smoke_t *ctx, uint8_t led, uint8_t amplitude)
Set led amplitude.
smoke_set_new_value_t::mask
uint8_t mask
Definition: smoke.h:353
smoke_t::ir_value
uint32_t ir_value
Definition: smoke.h:307
smoke_write_data
void smoke_write_data(smoke_t *ctx, uint8_t wr_addr, uint8_t wr_data)
Generic write function.
smoke_set_registers_t::samp_rate
uint8_t samp_rate
Definition: smoke.h:341
smoke_set_rollover_state
uint8_t smoke_set_rollover_state(smoke_t *ctx, uint8_t state)
Set rollover state.
smoke_set_new_value_t
New value object definition.
Definition: smoke.h:351
smoke_set_new_value_t::value
uint8_t value
Definition: smoke.h:354
smoke_set_led_mode
uint8_t smoke_set_led_mode(smoke_t *ctx, uint8_t mode)
Enable leds.
smoke_set_adc_range
uint8_t smoke_set_adc_range(smoke_t *ctx, uint8_t adc_range)
Set ADC range.
smoke_set_registers
uint8_t smoke_set_registers(smoke_t *ctx, smoke_set_registers_t *registers)
Set registers values function.
smoke_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: smoke.h:328
smoke_get_intrrupt
uint8_t smoke_get_intrrupt(smoke_t *ctx, uint8_t flag)
Get desired interrupt function.
smoke_set_sample_avarage
uint8_t smoke_set_sample_avarage(smoke_t *ctx, uint8_t samples)
Set avarage samples.
smoke_t::green_value
uint32_t green_value
Definition: smoke.h:308
smoke_clear_fifo
void smoke_clear_fifo(smoke_t *ctx)
Clearing FIFO pointers function.
smoke_cfg_t
Click configuration structure definition.
Definition: smoke.h:316
smoke_default_cfg
void smoke_default_cfg(smoke_t *ctx)
Click Default Configuration function.
smoke_get_write_ptr
uint8_t smoke_get_write_ptr(smoke_t *ctx)
Read the FIFO Write Pointer function.
smoke_set_registers_t::led_pow_lvl
uint8_t led_pow_lvl
Definition: smoke.h:343
smoke_set_proximity_amplitude_threshold
uint8_t smoke_set_proximity_amplitude_threshold(smoke_t *ctx, uint8_t threshold)
Set proximity threshold.
smoke_set_registers_t::avg_samp
uint8_t avg_samp
Definition: smoke.h:338
smoke_reset
void smoke_reset(smoke_t *ctx)
Reset device function.
smoke_set_registers_t
Click registers object definition.
Definition: smoke.h:337
smoke_t
Click ctx object definition.
Definition: smoke.h:292
smoke_enable_disable_interrupts
uint8_t smoke_enable_disable_interrupts(smoke_t *ctx, uint8_t interrupt_flag, uint8_t enable_flag)
Enable or disable interrupt function.
smoke_cfg_t::i2c_address
uint8_t i2c_address
Definition: smoke.h:329
smoke_set_registers_t::mode
uint8_t mode
Definition: smoke.h:339
smoke_set_new_value_t::reg_addr
uint8_t reg_addr
Definition: smoke.h:352
smoke_t::red_value
uint32_t red_value
Definition: smoke.h:306
smoke_set_almost_full_trigger
uint8_t smoke_set_almost_full_trigger(smoke_t *ctx, uint8_t trigger_range)
Set almost full trigger.
smoke_read_device_id
uint8_t smoke_read_device_id(smoke_t *ctx)
Read device ID function.
smoke_cfg_setup
void smoke_cfg_setup(smoke_cfg_t *cfg)
Config Object Initialization function.
smoke_set_pulse_width
uint8_t smoke_set_pulse_width(smoke_t *ctx, uint8_t pulse_width)
Set pulse width.
smoke_cfg_t::sda
pin_name_t sda
Definition: smoke.h:320
smoke_get_read_ptr
uint8_t smoke_get_read_ptr(smoke_t *ctx)
Read the FIFO Read Pointer function.
smoke_read_data
uint8_t smoke_read_data(smoke_t *ctx, uint8_t rd_addr)
Generic read function.
smoke_set_power
uint8_t smoke_set_power(smoke_t *ctx, uint8_t state)
I2C power setter.
smoke_t::int_pin
digital_in_t int_pin
Definition: smoke.h:295
smoke_cfg_t::scl
pin_name_t scl
Definition: smoke.h:319
smoke_read_leds
uint8_t smoke_read_leds(smoke_t *ctx)
Function for reading enabled leds.
smoke_check_int
uint8_t smoke_check_int(smoke_t *ctx)
Get Interrupt state function.
smoke_set_sample_rate
uint8_t smoke_set_sample_rate(smoke_t *ctx, uint8_t sample_rate)
Set sample rate.