smoke2  2.0.0.0
smoke2.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 SMOKE2_H
29 #define SMOKE2_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 #include "drv_spi_master.h"
39 #include "spi_specifics.h"
40 
61 #define SMOKE2_REG_STATUS 0x00
62 #define SMOKE2_REG_INT_MASK 0x01
63 #define SMOKE2_REG_GPIO_DRV 0x02
64 #define SMOKE2_REG_BG_STATUS 0x04
65 #define SMOKE2_REG_FIFO_THR 0x06
66 #define SMOKE2_REG_DEVID 0x08
67 #define SMOKE2_REG_I2CS_ID 0x09
68 #define SMOKE2_REG_CLK_RATIO 0x0A
69 #define SMOKE2_REG_GPIO_CTRL 0x0B
70 #define SMOKE2_REG_SLAVE_ADDR_KEY 0x0D
71 #define SMOKE2_REG_SW_RESET 0x0F
72 #define SMOKE2_REG_MODE 0x10
73 #define SMOKE2_REG_SLOT_EN 0x11
74 #define SMOKE2_REG_FSAMPLE 0x12
75 #define SMOKE2_REG_PD_LED_SELECT 0x14
76 #define SMOKE2_REG_NUM_AVG 0x15
77 #define SMOKE2_REG_BIG_MEAS_A 0x16
78 #define SMOKE2_REG_INT_SEQ_A 0x17
79 #define SMOKE2_REG_SLOTA_CH1_OFFSET 0x18
80 #define SMOKE2_REG_SLOTA_CH2_OFFSET 0x19
81 #define SMOKE2_REG_SLOTA_CH3_OFFSET 0x1A
82 #define SMOKE2_REG_SLOTA_CH4_OFFSET 0x1B
83 #define SMOKE2_REG_BIG_MEAS_B 0x1C
84 #define SMOKE2_REG_INT_SEQ_B 0x1D
85 #define SMOKE2_REG_SLOTB_CH1_OFFSET 0x1E
86 #define SMOKE2_REG_SLOTB_CH2_OFFSET 0x1F
87 #define SMOKE2_REG_SLOTB_CH3_OFFSET 0x20
88 #define SMOKE2_REG_SLOTB_CH4_OFFSET 0x21
89 #define SMOKE2_REG_ILED3_COARSE 0x22
90 #define SMOKE2_REG_ILED1_COARSE 0x23
91 #define SMOKE2_REG_ILED2_COARSE 0x24
92 #define SMOKE2_REG_ILED_FINE 0x25
93 #define SMOKE2_REG_SLOTA_LED_PULSE 0x30
94 #define SMOKE2_REG_SLOTA_NUM_PULSES 0x31
95 #define SMOKE2_REG_LED_DISABLE 0x34
96 #define SMOKE2_REG_SLOTB_LED_PULSE 0x35
97 #define SMOKE2_REG_SLOTB_NUM_PULSES 0x36
98 #define SMOKE2_REG_ALT_PWR_DN 0x37
99 #define SMOKE2_REG_EXT_SYNC_STARTUP 0x38
100 #define SMOKE2_REG_SLOTA_AFE_WINDOW 0x39
101 #define SMOKE2_REG_SLOTB_AFE_WINDOW 0x3B
102 #define SMOKE2_REG_AFE_PWR_CFG1 0x3C
103 #define SMOKE2_REG_SLOTA_FLOAT_LED 0x3E
104 #define SMOKE2_REG_SLOTB_FLOAT_LED 0x3F
105 #define SMOKE2_REG_SLOTA_TIA_CFG 0x42
106 #define SMOKE2_REG_SLOTA_AFE_CFG 0x43
107 #define SMOKE2_REG_SLOTB_TIA_CFG 0x44
108 #define SMOKE2_REG_SLOTB_AFE_CFG 0x45
109 #define SMOKE2_REG_SAMPLE_CLK 0x4B
110 #define SMOKE2_REG_CLK32M_ADJUST 0x4D
111 #define SMOKE2_REG_EXT_SYNC_SEL 0x4F
112 #define SMOKE2_REG_CLK32M_CAL_EN 0x50
113 #define SMOKE2_REG_AFE_PWR_CFG2 0x54
114 #define SMOKE2_REG_TIA_INDEP_GAIN 0x55
115 #define SMOKE2_REG_MATH 0x58
116 #define SMOKE2_REG_FLT_CONFIG_B 0x59
117 #define SMOKE2_REG_FLT_LED_FIRE 0x5A
118 #define SMOKE2_REG_FLT_CONFIG_A 0x5E
119 #define SMOKE2_REG_DATA_ACCESS_CTL 0x5F
120 #define SMOKE2_REG_FIFO_ACCESS 0x60
121 #define SMOKE2_REG_SLOTA_CH1 0x64
122 #define SMOKE2_REG_SLOTA_CH2 0x65
123 #define SMOKE2_REG_SLOTA_CH3 0x66
124 #define SMOKE2_REG_SLOTA_CH4 0x67
125 #define SMOKE2_REG_SLOTB_CH1 0x68
126 #define SMOKE2_REG_SLOTB_CH2 0x69
127 #define SMOKE2_REG_SLOTB_CH3 0x6A
128 #define SMOKE2_REG_SLOTB_CH4 0x6B
129 #define SMOKE2_REG_A_CH1_LOW 0x70
130 #define SMOKE2_REG_A_CH2_LOW 0x71
131 #define SMOKE2_REG_A_CH3_LOW 0x72
132 #define SMOKE2_REG_A_CH4_LOW 0x73
133 #define SMOKE2_REG_A_CH1_HIGH 0x74
134 #define SMOKE2_REG_A_CH2_HIGH 0x75
135 #define SMOKE2_REG_A_CH3_HIGH 0x76
136 #define SMOKE2_REG_A_CH4_HIGH 0x77
137 #define SMOKE2_REG_B_CH1_LOW 0x78
138 #define SMOKE2_REG_B_CH2_LOW 0x79
139 #define SMOKE2_REG_B_CH3_LOW 0x7A
140 #define SMOKE2_REG_B_CH4_LOW 0x7B
141 #define SMOKE2_REG_B_CH1_HIGH 0x7C
142 #define SMOKE2_REG_B_CH2_HIGH 0x7D
143 #define SMOKE2_REG_B_CH3_HIGH 0x7E
144 #define SMOKE2_REG_B_CH4_HIGH 0x7F
145  // smoke2_reg
147 
162 #define SMOKE2_SLOT_A 0
163 #define SMOKE2_SLOT_B 4
164 
169 #define SMOKE2_CHN_1 0
170 #define SMOKE2_CHN_2 1
171 #define SMOKE2_CHN_3 2
172 #define SMOKE2_CHN_4 3
173 
178 #define SMOKE2_MODE_IDLE 0
179 #define SMOKE2_MODE_PROGRAM 1
180 #define SMOKE2_MODE_NORMAL 2
181 
186 #define SMOKE2_SMOKE_DETECTED 0xCC
187 #define SMOKE2_SMOKE_NOT_DETECTED 0xDD
188 
193 #define SMOKE2_READ_CMD 0
194 #define SMOKE2_WRITE_CMD 1
195 
201 #define SMOKE2_SET_DEV_ADDR 0x64
202 
211 #define SMOKE2_SET_DATA_SAMPLE_EDGE SET_SPI_DATA_SAMPLE_EDGE
212 #define SMOKE2_SET_DATA_SAMPLE_MIDDLE SET_SPI_DATA_SAMPLE_MIDDLE
213  // smoke2_set
215 
230 #define SMOKE2_MAP_MIKROBUS( cfg, mikrobus ) \
231  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
232  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
233  cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
234  cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
235  cfg.sck = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
236  cfg.cs = MIKROBUS( mikrobus, MIKROBUS_CS ); \
237  cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
238  // smoke2_map // smoke2
241 
246 typedef enum
247 {
252 
257 typedef err_t ( *smoke2_master_io_t )( struct smoke2_s*, uint8_t, uint8_t*, uint8_t );
263 typedef struct smoke2_s
264 {
265  digital_in_t int_pin;
267  i2c_master_t i2c;
268  spi_master_t spi;
270  uint8_t slave_address;
271  pin_name_t chip_select;
278  uint16_t threshold_value;
279  uint8_t enabled_slot;
280 
282 
287 typedef struct
288 {
289  pin_name_t scl;
290  pin_name_t sda;
291  pin_name_t miso;
292  pin_name_t mosi;
293  pin_name_t sck;
294  pin_name_t cs;
295  pin_name_t int_pin;
297  uint32_t i2c_speed;
298  uint8_t i2c_address;
300  uint32_t spi_speed;
301  spi_master_mode_t spi_mode;
302  spi_master_chip_select_polarity_t cs_polarity;
306 } smoke2_cfg_t;
307 
312 typedef enum
313 {
315  SMOKE2_ERROR = -1
316 
318 
335 
351 
366 err_t smoke2_init ( smoke2_t *ctx, smoke2_cfg_t *cfg );
367 
379 
395 err_t smoke2_generic_write ( smoke2_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len );
396 
412 err_t smoke2_generic_read ( smoke2_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len );
413 
423 uint8_t smoke2_get_int_pin ( smoke2_t *ctx );
424 
436 void smoke2_write_data( smoke2_t *ctx, uint8_t reg, uint16_t tx_data );
437 
448 uint16_t smoke2_read_data( smoke2_t *ctx, uint8_t reg );
449 
462 void smoke2_set_bit ( smoke2_t *ctx, uint8_t reg, uint8_t bit_num , uint8_t val );
463 
475 uint8_t smoke2_get_bit ( smoke2_t *ctx, uint8_t reg, uint8_t bit_num );
476 
487 void smoke2_set_mode ( smoke2_t *ctx, uint8_t mode );
488 
501 void smoke2_get_int ( smoke2_t *ctx, uint8_t *fifo, uint8_t *slot_a, uint8_t *slot_b );
502 
514 uint16_t smoke2_read_sens_data ( smoke2_t *ctx, uint8_t slot, uint8_t chn );
515 
526 
537 uint16_t smoke2_smoke_calibration ( smoke2_t *ctx, uint16_t threshold );
538 
548 uint8_t smoke2_check_smoke ( smoke2_t *ctx );
549 
550 #ifdef __cplusplus
551 }
552 #endif
553 #endif // SMOKE2_H
554  // smoke2
556 
557 // ------------------------------------------------------------------------ END
smoke2_cfg_t::sda
pin_name_t sda
Definition: smoke2.h:290
smoke2_t
struct smoke2_s smoke2_t
Smoke 2 Click context object.
smoke2_get_bit
uint8_t smoke2_get_bit(smoke2_t *ctx, uint8_t reg, uint8_t bit_num)
Smoke 2 generic function for reading bit state.
smoke2_get_int
void smoke2_get_int(smoke2_t *ctx, uint8_t *fifo, uint8_t *slot_a, uint8_t *slot_b)
Smoke 2 get mode function.
smoke2_s
Smoke 2 Click context object.
Definition: smoke2.h:264
smoke2_generic_write
err_t smoke2_generic_write(smoke2_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len)
Smoke 2 data writing function.
smoke2_s::i2c
i2c_master_t i2c
Definition: smoke2.h:267
smoke2_cfg_t::int_pin
pin_name_t int_pin
Definition: smoke2.h:295
smoke2_s::int_pin
digital_in_t int_pin
Definition: smoke2.h:265
smoke2_cfg_t::cs
pin_name_t cs
Definition: smoke2.h:294
smoke2_cfg_t::sck
pin_name_t sck
Definition: smoke2.h:293
smoke2_read_data
uint16_t smoke2_read_data(smoke2_t *ctx, uint8_t reg)
Smoke 2 generic function for reading data from registar.
spi_specifics.h
This file contains SPI specific macros, functions, etc.
smoke2_cfg_t::i2c_address
uint8_t i2c_address
Definition: smoke2.h:298
smoke2_cfg_setup
void smoke2_cfg_setup(smoke2_cfg_t *cfg)
Smoke 2 configuration object setup function.
smoke2_cfg_t::drv_sel
smoke2_drv_t drv_sel
Definition: smoke2.h:304
smoke2_set_bit
void smoke2_set_bit(smoke2_t *ctx, uint8_t reg, uint8_t bit_num, uint8_t val)
Smoke 2 generic function for writing bit state.
smoke2_s::threshold_value
uint16_t threshold_value
Definition: smoke2.h:278
smoke2_read_sens_data
uint16_t smoke2_read_sens_data(smoke2_t *ctx, uint8_t slot, uint8_t chn)
Smoke 2 reading bit state function.
smoke2_cfg_t::spi_mode
spi_master_mode_t spi_mode
Definition: smoke2.h:301
smoke2_write_data
void smoke2_write_data(smoke2_t *ctx, uint8_t reg, uint16_t tx_data)
Smoke 2 generic function for writing data to register function.
smoke2_drv_t
smoke2_drv_t
Smoke 2 Click driver selector.
Definition: smoke2.h:247
smoke2_cfg_t::spi_speed
uint32_t spi_speed
Definition: smoke2.h:300
smoke2_cfg_t::cs_polarity
spi_master_chip_select_polarity_t cs_polarity
Definition: smoke2.h:302
smoke2_s::slave_address
uint8_t slave_address
Definition: smoke2.h:270
SMOKE2_OK
@ SMOKE2_OK
Definition: smoke2.h:314
smoke2_s::calibration_value
uint16_t calibration_value
Definition: smoke2.h:277
SMOKE2_DRV_SEL_I2C
@ SMOKE2_DRV_SEL_I2C
Definition: smoke2.h:249
smoke2_cfg_t::mosi
pin_name_t mosi
Definition: smoke2.h:292
smoke2_drv_interface_selection
void smoke2_drv_interface_selection(smoke2_cfg_t *cfg, smoke2_drv_t drv_sel)
Smoke 2 driver interface setup function.
smoke2_smoke_calibration
uint16_t smoke2_smoke_calibration(smoke2_t *ctx, uint16_t threshold)
Smoke 2 calibrating data and setting threshold function.
smoke2_init
err_t smoke2_init(smoke2_t *ctx, smoke2_cfg_t *cfg)
Smoke 2 initialization function.
smoke2_default_cfg
void smoke2_default_cfg(smoke2_t *ctx)
Smoke 2 default configuration function.
smoke2_return_value_t
smoke2_return_value_t
Smoke 2 Click return value data.
Definition: smoke2.h:313
smoke2_generic_read
err_t smoke2_generic_read(smoke2_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len)
Smoke 2 data reading function.
smoke2_cfg_t::miso
pin_name_t miso
Definition: smoke2.h:291
smoke2_s::enabled_slot
uint8_t enabled_slot
Definition: smoke2.h:279
smoke2_master_io_t
err_t(* smoke2_master_io_t)(struct smoke2_s *, uint8_t, uint8_t *, uint8_t)
Smoke 2 Click driver interface.
Definition: smoke2.h:257
smoke2_s::chip_select
pin_name_t chip_select
Definition: smoke2.h:271
SMOKE2_ERROR
@ SMOKE2_ERROR
Definition: smoke2.h:315
smoke2_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: smoke2.h:297
smoke2_s::drv_sel
smoke2_drv_t drv_sel
Definition: smoke2.h:272
smoke2_s::read_f
smoke2_master_io_t read_f
Definition: smoke2.h:275
smoke2_cfg_t::scl
pin_name_t scl
Definition: smoke2.h:289
smoke2_cfg_t
Smoke 2 Click configuration object.
Definition: smoke2.h:288
smoke2_soft_reset
void smoke2_soft_reset(smoke2_t *ctx)
Smoke 2 reseting device function.
smoke2_s::spi
spi_master_t spi
Definition: smoke2.h:268
smoke2_set_mode
void smoke2_set_mode(smoke2_t *ctx, uint8_t mode)
Smoke 2 setting mode function.
smoke2_s::write_f
smoke2_master_io_t write_f
Definition: smoke2.h:274
smoke2_check_smoke
uint8_t smoke2_check_smoke(smoke2_t *ctx)
Smoke 2 checking smoke detection function.
SMOKE2_DRV_SEL_SPI
@ SMOKE2_DRV_SEL_SPI
Definition: smoke2.h:248
smoke2_get_int_pin
uint8_t smoke2_get_int_pin(smoke2_t *ctx)
Smoke 2 get state of int pin function.