apc1sensor.h

Go to the documentation of this file.

/****************************************************************************
** Copyright (C) 2020 MikroElektronika d.o.o.
** Contact: https://www.mikroe.com/contact
**
** Permission is hereby granted, free of charge, to any person obtaining a copy
** of this software and associated documentation files (the "Software"), to deal
** in the Software without restriction, including without limitation the rights
** to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
** copies of the Software, and to permit persons to whom the Software is
** furnished to do so, subject to the following conditions:
** The above copyright notice and this permission notice shall be
** included in all copies or substantial portions of the Software.
**
** THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
** EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
** OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
** IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
** DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
** OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
**  USE OR OTHER DEALINGS IN THE SOFTWARE.
****************************************************************************/
 
#ifndef APC1SENSOR_H
#define APC1SENSOR_H
 
#ifdef __cplusplus
extern "C"{
#endif
 
#ifdef PREINIT_SUPPORTED
#include "preinit.h"
#endif
 
#ifdef MikroCCoreVersion
    #if MikroCCoreVersion >= 1
        #include "delays.h"
    #endif
#endif
 
#include "drv_digital_out.h"
#include "drv_digital_in.h"
#include "drv_i2c_master.h"
#include "drv_uart.h"
 
#define APC1SENSOR_ADDRESS_CMD              0x40
#define APC1SENSOR_ADDRESS_RESPONSE         0x47
#define APC1SENSOR_CMD_SET_MEAS_MODE        0xE1
#define APC1SENSOR_CMD_REQ_MEASUREMENT      0xE2
#define APC1SENSOR_CMD_SET_MODE             0xE4
#define APC1SENSOR_CMD_GET_INFO             0xE9
 
 // apc1sensor_cmd
 
#define APC1SENSOR_HEADER_0                 0x42
#define APC1SENSOR_HEADER_1                 0x4D
 
#define APC1SENSOR_MEASUREMENT_PASSIVE      0x00
#define APC1SENSOR_MEASUREMENT_ACTIVE       0x01
 
#define APC1SENSOR_MODE_IDLE                0x00
#define APC1SENSOR_MODE_MEASUREMENT         0x01
#define APC1SENSOR_MODE_RESET               0x0F
 
#define APC1SENSOR_OPMODE_NORMAL            0
#define APC1SENSOR_OPMODE_DEEP_SLEEP        1
#define APC1SENSOR_OPMODE_RESET             2
 
#define APC1SENSOR_TX_DRV_BUFFER_SIZE       100
#define APC1SENSOR_RX_DRV_BUFFER_SIZE       300
 
#define APC1SENSOR_DEVICE_ADDRESS           0x12
 
 // apc1sensor_set
 
#define APC1SENSOR_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.tx_pin = MIKROBUS( mikrobus, MIKROBUS_TX ); \
    cfg.rx_pin = MIKROBUS( mikrobus, MIKROBUS_RX ); \
    cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
    cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
    cfg.set = MIKROBUS( mikrobus, MIKROBUS_CS ); \
    cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST );
 
 // apc1sensor_map
 // apc1sensor
 
typedef enum
{
    APC1SENSOR_DRV_SEL_I2C,     
    APC1SENSOR_DRV_SEL_UART     
} apc1sensor_drv_t;
 
typedef struct
{
    digital_out_t set;          
    digital_out_t rst;          
    i2c_master_t i2c;           
    uart_t uart;                
    uint8_t slave_address;      
    uint8_t uart_rx_buffer[ APC1SENSOR_RX_DRV_BUFFER_SIZE ];  
    uint8_t uart_tx_buffer[ APC1SENSOR_TX_DRV_BUFFER_SIZE ];  
    apc1sensor_drv_t drv_sel;   
    uint8_t meas_mode;          
} apc1sensor_t;
 
typedef struct
{
    pin_name_t scl;             
    pin_name_t sda;             
    pin_name_t rx_pin;          
    pin_name_t tx_pin;          
    pin_name_t set;             
    pin_name_t rst;             
    uint32_t   i2c_speed;       
    uint8_t    i2c_address;     
    uint32_t         baud_rate;         
    bool             uart_blocking;     
    uart_data_bits_t data_bit;          
    uart_parity_t    parity_bit;        
    uart_stop_bits_t stop_bit;          
    apc1sensor_drv_t drv_sel;   
} apc1sensor_cfg_t;
 
typedef struct
{
    uint16_t pm1_0;             
    uint16_t pm2_5;             
    uint16_t pm10;              
    uint16_t pm1_0_air;         
    uint16_t pm2_5_air;         
    uint16_t pm10_air;          
    uint16_t part_over_0_3um;   
    uint16_t part_over_0_5um;   
    uint16_t part_over_1_0um;   
    uint16_t part_over_2_5um;   
    uint16_t part_over_5_0um;   
    uint16_t part_over_10um;    
    uint16_t tvoc;              
    uint16_t eco2;              
    float t_comp;               
    float rh_comp;              
    float t_raw;                
    float rh_raw;               
    uint32_t rs0;               
    uint32_t rs1;               
    uint32_t rs2;               
    uint32_t rs3;               
    uint8_t aqi;                
    uint8_t version;            
    uint8_t error_code;         
} apc1sensor_measurement_t;
 
typedef struct
{
    uint8_t module_name[ 7 ];   
    uint8_t serial_num[ 8 ];    
    uint8_t fw_version[ 2 ];    
} apc1sensor_info_t;
 
typedef enum
{
    APC1SENSOR_OK = 0,
    APC1SENSOR_ERROR = -1
 
} apc1sensor_return_value_t;
 
void apc1sensor_cfg_setup ( apc1sensor_cfg_t *cfg );
 
void apc1sensor_drv_interface_sel ( apc1sensor_cfg_t *cfg, apc1sensor_drv_t drv_sel );
 
err_t apc1sensor_init ( apc1sensor_t *ctx, apc1sensor_cfg_t *cfg );
 
err_t apc1sensor_default_cfg ( apc1sensor_t *ctx );
 
err_t apc1sensor_set_idle_mode ( apc1sensor_t *ctx );
 
err_t apc1sensor_start_measurement ( apc1sensor_t *ctx );
 
err_t apc1sensor_sw_reset ( apc1sensor_t *ctx );
 
err_t apc1sensor_set_meas_mode ( apc1sensor_t *ctx, uint8_t mode );
 
err_t apc1sensor_request_meas ( apc1sensor_t *ctx );
 
err_t apc1sensor_read_info ( apc1sensor_t *ctx, apc1sensor_info_t *info );
 
err_t apc1sensor_read_measurement ( apc1sensor_t *ctx, apc1sensor_measurement_t *measurement );
 
void apc1sensor_set_opmode ( apc1sensor_t *ctx, uint8_t opmode );
 
void apc1sensor_reset_device ( apc1sensor_t *ctx );
 
#ifdef __cplusplus
}
#endif
#endif // APC1SENSOR_H
 
 // apc1sensor
 
// ------------------------------------------------------------------------ END