drv_ccs811.h

/*
  Copyright (c) 2010 - 2017, Nordic Semiconductor ASA
  All rights reserved.

  Redistribution and use in source and binary forms, with or without modification,
  are permitted provided that the following conditions are met:

  1. Redistributions of source code must retain the above copyright notice, this
     list of conditions and the following disclaimer.

  2. Redistributions in binary form, except as embedded into a Nordic
     Semiconductor ASA integrated circuit in a product or a software update for
     such product, must reproduce the above copyright notice, this list of
     conditions and the following disclaimer in the documentation and/or other
     materials provided with the distribution.

  3. Neither the name of Nordic Semiconductor ASA nor the names of its
     contributors may be used to endorse or promote products derived from this
     software without specific prior written permission.

  4. This software, with or without modification, must only be used with a
     Nordic Semiconductor ASA integrated circuit.

  5. Any software provided in binary form under this license must not be reverse
     engineered, decompiled, modified and/or disassembled.

  THIS SOFTWARE IS PROVIDED BY NORDIC SEMICONDUCTOR ASA "AS IS" AND ANY EXPRESS
  OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  OF MERCHANTABILITY, NONINFRINGEMENT, AND FITNESS FOR A PARTICULAR PURPOSE ARE
  DISCLAIMED. IN NO EVENT SHALL NORDIC SEMICONDUCTOR ASA OR CONTRIBUTORS BE
  LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
  GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
  OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef DRV_CCS811_H__
#define DRV_CCS811_H__

#include "nrf_drv_twi.h"

#include <stdint.h>

enum
{
    DRV_CCS811_STATUS_CODE_SUCCESS,      
    DRV_CCS811_STATUS_CODE_DISALLOWED,   
    DRV_CCS811_STATUS_CODE_INVALID_PARAM,
    DRV_CCS811_STATUS_CODE_NOT_SUPPORTED 
};

typedef struct
{
    uint8_t                      twi_addr;        
    nrf_drv_twi_t        const * p_twi_instance;  
    nrf_drv_twi_config_t const * p_twi_cfg;       
} drv_ccs811_cfg_t;

typedef enum
{
    DRV_CCS811_ALG_RESULT_DESCR_ECO2_ONLY = 0,  
    DRV_CCS811_ALG_RESULT_DESCR_TVOC_ONLY,      
    DRV_CCS811_ALG_RESULT_DESCR_ECO2_TVOC,      
    DRV_CCS811_ALG_RESULT_DESCR_ECO2_TVOC_STAT, 
    DRV_CCS811_ALG_RESULT_DESCR_ALL,            
} drv_ccs811_alg_result_descr_t;

typedef struct
{
    uint16_t    ec02_ppm; 
    uint16_t    tvoc_ppb; 
    uint8_t     status;   
    uint8_t     err_id;   
    uint16_t    raw_data; 
} drv_ccs811_alg_result_t;

void drv_ccs811_init(void);

uint32_t drv_ccs811_open(drv_ccs811_cfg_t const * const p_drv_ccs811_cfg);

uint32_t drv_ccs811_status_get(uint8_t * p_status);

uint32_t drv_ccs811_meas_mode_get(uint8_t * p_meas_mode);

uint32_t drv_ccs811_meas_mode_modify(uint8_t set_mask, uint8_t clr_mask);

uint32_t drv_ccs811_alg_result_data_get(drv_ccs811_alg_result_descr_t alg_result_descr, drv_ccs811_alg_result_t * p_alg_result_data);

uint32_t drv_ccs811_raw_data_get(uint16_t * p_raw_data);

uint32_t drv_ccs811_env_data_set(uint16_t rh_ppth, int32_t temp_mdeg);

uint32_t drv_ccs811_thresholds_get(uint16_t * p_low_to_medium, uint16_t * p_medium_to_high, uint8_t * p_hysteresis);

uint32_t drv_ccs811_thresholds_set(uint16_t low_to_medium, uint16_t medium_to_highm, uint8_t hysteresis);

uint32_t drv_ccs811_ntc_get(uint16_t * p_r_ref_mv, uint16_t * p_r_ntc_mv);

uint32_t drv_ccs811_baseline_get(uint16_t * p_baseline);

uint32_t drv_ccs811_baseline_set(uint16_t baseline);

uint32_t drv_ccs811_hw_id_get(uint8_t * p_hw_id);

uint32_t drv_ccs811_hw_version_get(uint8_t * p_hw_version);

uint32_t drv_ccs811_fw_boot_version_get(uint16_t * p_fw_boot_version);

uint32_t drv_ccs811_fw_app_version_get(uint16_t * p_fw_app_version);

uint32_t drv_ccs811_err_id_get(uint8_t * p_err_id);

uint32_t drv_ccs811_app_start(void);

uint32_t drv_ccs811_sw_reset(void);

uint32_t drv_ccs811_close(void);

#endif // DRV_CCS811_H__