illuminance.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 ILLUMINANCE_H
#define ILLUMINANCE_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"
 
#define ILLUMINANCE_REG_CONTROL               0x00
#define ILLUMINANCE_REG_TIMING                0x01
#define ILLUMINANCE_REG_INTERRUPT             0x02
#define ILLUMINANCE_REG_THL_LOW               0x03
#define ILLUMINANCE_REG_THL_HIGH              0x04
#define ILLUMINANCE_REG_THH_LOW               0x05
#define ILLUMINANCE_REG_THH_HIGH              0x06
#define ILLUMINANCE_REG_ANALOG                0x07
#define ILLUMINANCE_REG_ID                    0x12
#define ILLUMINANCE_REG_DATA0_LOW             0x14
#define ILLUMINANCE_REG_DATA0_HIGH            0x15
#define ILLUMINANCE_REG_DATA1_LOW             0x16
#define ILLUMINANCE_REG_DATA1_HIGH            0x17
#define ILLUMINANCE_REG_TIMER_LOW             0x18
#define ILLUMINANCE_REG_TIMER_HIGH            0x19
#define ILLUMINANCE_REG_ID2                   0x1E
 
 // illuminance_reg
 
#define ILLUMINANCE_CMD_BIT                   0x80
#define ILLUMINANCE_TRANSACTION_REPEATED      0x00
#define ILLUMINANCE_TRANSACTION_AUTO_INC      0x20
#define ILLUMINANCE_TRANSACTION_SPEC_FUNC     0x60
#define ILLUMINANCE_SPEC_FUNC_INT_CLEAR       0x01
#define ILLUMINANCE_SPEC_FUNC_STOP_MAN_INT    0x02
#define ILLUMINANCE_SPEC_FUNC_START_MAN_INT   0x03
 
#define ILLUMINANCE_CONTROL_ADC_INTR          0x20
#define ILLUMINANCE_CONTROL_ADC_VALID         0x10
#define ILLUMINANCE_CONTROL_ADC_ENABLE        0x02
#define ILLUMINANCE_CONTROL_POWER_ON          0x01
 
#define ILLUMINANCE_ATIME_MAX                 688.5
#define ILLUMINANCE_ATIME_MIN                 2.7
#define ILLUMINANCE_ATIME_STEP                2.7
#define ILLUMINANCE_DEFAULT_ATIME             200.0
 
#define ILLUMINANCE_ENABLE_INTERRUPT          0x10
 
#define ILLUMINANCE_GAIN_1X                   0x00
#define ILLUMINANCE_GAIN_8X                   0x01
#define ILLUMINANCE_GAIN_16X                  0x02
#define ILLUMINANCE_GAIN_111X                 0x03
 
#define ILLUMINANCE_ID_PARTNO                 0x90
#define ILLUMINANCE_ID2                       0x30
 
#define ILLUMINANCE_SET_DEV_ADDR_GND          0x29
#define ILLUMINANCE_SET_DEV_ADDR_FLOAT        0x39
#define ILLUMINANCE_SET_DEV_ADDR_VCC          0x49
 
 // illuminance_set
 
#define ILLUMINANCE_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
    cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
    cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
 
 // illuminance_map
 // illuminance
 
typedef struct
{
    // Input pins
    digital_in_t  int_pin;      
    // Modules
    i2c_master_t  i2c;          
    // I2C slave address
    uint8_t slave_address;      
    float   atime_ms;           
    uint8_t gain;               
} illuminance_t;
 
typedef struct
{
    pin_name_t  scl;            
    pin_name_t  sda;            
    pin_name_t  int_pin;        
    uint32_t  i2c_speed;        
    uint8_t   i2c_address;      
} illuminance_cfg_t;
 
typedef enum
{
    ILLUMINANCE_OK = 0,
    ILLUMINANCE_ERROR = -1
 
} illuminance_return_value_t;
 
void illuminance_cfg_setup ( illuminance_cfg_t *cfg );
 
err_t illuminance_init ( illuminance_t *ctx, illuminance_cfg_t *cfg );
 
err_t illuminance_default_cfg ( illuminance_t *ctx );
 
err_t illuminance_generic_write ( illuminance_t *ctx, uint8_t reg, uint8_t *tx_buf, uint8_t tx_len );
 
err_t illuminance_generic_read ( illuminance_t *ctx, uint8_t reg, uint8_t *rx_buf, uint8_t rx_len );
 
err_t illuminance_write_register ( illuminance_t *ctx, uint8_t reg, uint8_t data_in );
 
err_t illuminance_read_register ( illuminance_t *ctx, uint8_t reg, uint8_t *data_out );
 
uint8_t illuminance_get_int_pin ( illuminance_t *ctx );
 
err_t illuminance_check_communication ( illuminance_t *ctx );
 
err_t illuminance_set_atime ( illuminance_t *ctx, float atime_ms );
 
err_t illuminance_set_gain ( illuminance_t *ctx, uint8_t gain );
 
err_t illuminance_read_raw_data ( illuminance_t *ctx, uint16_t *ch_0, uint16_t *ch_1 );
 
#ifdef __cplusplus
}
#endif
#endif // ILLUMINANCE_H
 
 // illuminance
 
// ------------------------------------------------------------------------ END