ambient16.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 AMBIENT16_H
#define AMBIENT16_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_in.h"
#include "drv_i2c_master.h"
 
#define AMBIENT16_CONTROL_REG               0x00
#define AMBIENT16_TIMING_REG                0x01
#define AMBIENT16_INTERRUPT_REG             0x02
#define AMBIENT16_TH_LOW_LSB_REG            0x03
#define AMBIENT16_TH_LOW_MSB_REG            0x04
#define AMBIENT16_TH_HIGH_LSB_REG           0x05
#define AMBIENT16_TH_HIGH_MSB_REG           0x06
#define AMBIENT16_GAIN_REG                  0x07
#define AMBIENT16_PART_ID_REG               0x12
#define AMBIENT16_DATA0_LSB_REG             0x14
#define AMBIENT16_DATA0_MSB_REG             0x15
#define AMBIENT16_DATA1_LSB_REG             0x16
#define AMBIENT16_DATA1_MSB_REG             0x17
#define AMBIENT16_WAIT_REG                  0x18
 
 // ambient16_reg
 
#define AMBIENT16_SOFTWARE_RESET                                0xE4
#define AMBIENT16_INTERRUPT_RESET                               0xE1
 
#define AMBIENT16_ADC_INTERRUPT_ENABLE                          0x20
#define AMBIENT16_ADC_ENABLE                                    0x02
#define AMBIENT16_POWER_ENABLE                                  0x01
 
#define AMBIENT16_UNLATCH_MODE                                  0x20
#define AMBIENT16_LATCH_MODE                                    0x00
 
#define AMBIENT16_INTERRUPT_ENABLE                              0x10
#define AMBIENT16_INTERRUPT_DISABLE                             0x00
 
#define AMBIENT16_INT_ACTIVE_ON_END_OF_MEASURMENT               0x00
#define AMBIENT16_INT_UPDATE_ON_END_OF_MEASURMENT               0x01
#define AMBIENT16_INT_UPDATE_ON_2_CONSEC_TRESHOLDS              0x02
#define AMBIENT16_INT_UPDATE_ON_3_CONSEC_TRESHOLDS              0x03
#define AMBIENT16_INT_UPDATE_ON_4_CONSEC_TRESHOLDS              0x04
#define AMBIENT16_INT_UPDATE_ON_5_CONSEC_TRESHOLDS              0x05
#define AMBIENT16_INT_UPDATE_ON_6_CONSEC_TRESHOLDS              0x06
#define AMBIENT16_INT_UPDATE_ON_7_CONSEC_TRESHOLDS              0x07
#define AMBIENT16_INT_UPDATE_ON_8_CONSEC_TRESHOLDS              0x08
#define AMBIENT16_INT_UPDATE_ON_9_CONSEC_TRESHOLDS              0x09
#define AMBIENT16_INT_UPDATE_ON_10_CONSEC_TRESHOLDS             0x0A
#define AMBIENT16_INT_UPDATE_ON_11_CONSEC_TRESHOLDS             0x0B
#define AMBIENT16_INT_UPDATE_ON_12_CONSEC_TRESHOLDS             0x0C
#define AMBIENT16_INT_UPDATE_ON_13_CONSEC_TRESHOLDS             0x0D
#define AMBIENT16_INT_UPDATE_ON_14_CONSEC_TRESHOLDS             0x0E
#define AMBIENT16_INT_UPDATE_ON_15_CONSEC_TRESHOLDS             0x0F
 
#define AMBIENT16_X1_GAIN                                       0x00
#define AMBIENT16_X2_GAIN                                       0x01
#define AMBIENT16_X64_GAIN                                      0x02
#define AMBIENT16_X128_GAIN                                     0x03
 
#define AMBIENT16_ENABLE_WAIT                                   0x01
#define AMBIENT16_DISABLE_WAIT                                  0x00
 
#define AMBIENT16_INT_STATE_HIGH                                0x01
#define AMBIENT16_INT_STATE_LOW                                 0x00
 
#define AMBIENT16_I2C_SLAVE_ADR_0                               0x29
#define AMBIENT16_I2C_SLAVE_ADR_1                               0x39
 
 // ambient16_set
 
#define AMBIENT16_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
    cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
    cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
 
 // ambient16_map
 // ambient16
 
typedef struct
{
    // Input pins
    digital_in_t  int_pin;       
    // Modules
    i2c_master_t i2c;            
    // I2C slave address
    uint8_t slave_address;       
} ambient16_t;
 
typedef struct
{
    pin_name_t  scl;        
    pin_name_t  sda;        
    pin_name_t  int_pin;    
    uint32_t  i2c_speed;    
    uint8_t   i2c_address;  
} ambient16_cfg_t;
 
typedef enum
{
    AMBIENT16_OK = 0,
    AMBIENT16_ERROR = -1
 
} ambient16_return_value_t;
 
void ambient16_cfg_setup ( ambient16_cfg_t *cfg );
 
err_t ambient16_init ( ambient16_t *ctx, ambient16_cfg_t *cfg );
 
err_t ambient16_default_cfg ( ambient16_t *ctx );
 
err_t ambient16_generic_write ( ambient16_t *ctx, uint8_t reg, uint8_t *tx_buf, uint8_t tx_len );
 
err_t ambient16_generic_read ( ambient16_t *ctx, uint8_t reg, uint8_t *rx_buf, uint8_t rx_len );
 
uint8_t ambient16_get_int_state ( ambient16_t *ctx );
 
err_t ambient16_set_reg ( ambient16_t *ctx, uint8_t reg, uint8_t value );
 
err_t ambient16_send_cmd ( ambient16_t *ctx, uint8_t cmd );
 
err_t ambient16_sw_reset ( ambient16_t *ctx );
 
err_t ambient16_int_reset ( ambient16_t *ctx );
 
err_t ambient16_set_th_low ( ambient16_t *ctx, uint16_t th_val );
 
err_t ambient16_set_th_high ( ambient16_t *ctx, uint16_t th_val );
 
err_t ambient16_set_gain ( ambient16_t *ctx, uint8_t data0_gain, uint8_t data1_gain );
 
err_t ambient16_get_part_id ( ambient16_t *ctx, uint8_t *part_id );
 
err_t ambient16_get_data ( ambient16_t *ctx, uint16_t *data0, uint16_t *data1 );
 
err_t ambient16_read_data ( ambient16_t *ctx, float *data0, float *data1 );
 
void ambient16_set_wait ( ambient16_t *ctx, uint8_t wait_mode );
 
#ifdef __cplusplus
}
#endif
#endif // AMBIENT16_H
 
 // ambient16
 
// ------------------------------------------------------------------------ END