ambient3.h

Go to the documentation of this file.

/*
 * MikroSDK - MikroE Software Development Kit
 * Copyright© 2020 MikroElektronika d.o.o.
 * 
 * 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 AMBIENT3_H
#define AMBIENT3_H
 
#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"
 
// -------------------------------------------------------------- PUBLIC MACROS 
#define AMBIENT3_MAP_MIKROBUS( cfg, mikrobus ) \
  cfg.scl     = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
  cfg.sda     = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
  cfg.rst     = MIKROBUS( mikrobus, MIKROBUS_RST ); \
  cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
#define AMBIENT3_RETVAL  uint8_t
 
#define AMBIENT3_OK           0x00
#define AMBIENT3_INIT_ERROR   0xFF
#define AMBIENT3_DEVICE_SLAVE_ADDRESS              0x49          
#define AMBIENT3_REG_HW_VERSION_MSB                0x00
#define AMBIENT3_REG_HW_VERSION_LSB                0x01
#define AMBIENT3_REG_FW_VERSION_MSB                0x02
#define AMBIENT3_REG_FW_VERSION_LSB                0x03
#define AMBIENT3_REG_CONF_CONTROL                  0x04
#define AMBIENT3_REG_INTEGRATION_TIME              0x05
#define AMBIENT3_REG_DEVICE_TEMP                   0x06
#define AMBIENT3_REG_LED_CONFIG                    0x07
#define AMBIENT3_REG_ESP                           0x4F
#define AMBIENT3_REG_DIR_CONFIG                    0x60
#define AMBIENT3_REG_DIR_CONTROL                   0x61
#define AMBIENT3_REG_DIR_CH_1_MSB                  0x62
#define AMBIENT3_REG_DIR_CH_1_LSB                  0x63
#define AMBIENT3_REG_DIR_CH_2_MSB                  0x64
#define AMBIENT3_REG_DIR_CH_2_LSB                  0x65
#define AMBIENT3_REG_DIR_CH_3_MSB                  0x66
#define AMBIENT3_REG_DIR_CH_3_LSB                  0x67
#define AMBIENT3_REG_DIR_LUXT_MSB                  0x70
#define AMBIENT3_REG_DIR_LUXT_LSB                  0x71
#define AMBIENT3_REG_DIR_CCTT_MSB                  0x72
#define AMBIENT3_REG_DIR_CCTT_LSB                  0x73
#define AMBIENT3_REG_RAW_VALUE_0_MSB               0x08
#define AMBIENT3_REG_RAW_VALUE_0_LSB               0x09
#define AMBIENT3_REG_RAW_VALUE_1_MSB               0x0A
#define AMBIENT3_REG_RAW_VALUE_1_LSB               0x0B
#define AMBIENT3_REG_RAW_VALUE_2_MSB               0x0C
#define AMBIENT3_REG_RAW_VALUE_2_LSB               0x0D
#define AMBIENT3_REG_RAW_VALUE_3_MSB               0x0E
#define AMBIENT3_REG_RAW_VALUE_3_LSB               0x0F
#define AMBIENT3_REG_RAW_VALUE_4_MSB               0x10
#define AMBIENT3_REG_RAW_VALUE_4_LSB               0x11
#define AMBIENT3_REG_RAW_VALUE_5_MSB               0x12
#define AMBIENT3_REG_RAW_VALUE_5_LSB               0x13
#define AMBIENT3_REG_COEF_DATA_0                   0x50
#define AMBIENT3_REG_COEF_DATA_1                   0x51
#define AMBIENT3_REG_COEF_DATA_2                   0x52
#define AMBIENT3_REG_COEF_DATA_3                   0x53
#define AMBIENT3_REG_COEF_READ                     0x54
#define AMBIENT3_REG_COEF_WRITE                    0x55
#define AMBIENT3_REG_X_CALIBRATED_B1               0x14
#define AMBIENT3_REG_X_CALIBRATED_B2               0x15
#define AMBIENT3_REG_X_CALIBRATED_B3               0x16
#define AMBIENT3_REG_X_CALIBRATED_B4               0x17
#define AMBIENT3_REG_Y_CALIBRATED_B1               0x18
#define AMBIENT3_REG_Y_CALIBRATED_B2               0x19
#define AMBIENT3_REG_Y_CALIBRATED_B3               0x1A
#define AMBIENT3_REG_Y_CALIBRATED_B4               0x1B
#define AMBIENT3_REG_Z_CALIBRATED_B1               0x1C
#define AMBIENT3_REG_Z_CALIBRATED_B2               0x1D
#define AMBIENT3_REG_Z_CALIBRATED_B3               0x1E
#define AMBIENT3_REG_Z_CALIBRATED_B4               0x1F
#define AMBIENT3_REG_CIE1931_X_CALIBRATED_B1       0x20
#define AMBIENT3_REG_CIE1931_X_CALIBRATED_B2       0x21
#define AMBIENT3_REG_CIE1931_X_CALIBRATED_B3       0x22
#define AMBIENT3_REG_CIE1931_X_CALIBRATED_B4       0x23
#define AMBIENT3_REG_CIE1931_Y_CALIBRATED_B1       0x24
#define AMBIENT3_REG_CIE1931_Y_CALIBRATED_B2       0x25
#define AMBIENT3_REG_CIE1931_Y_CALIBRATED_B3       0x26
#define AMBIENT3_REG_CIE1931_Y_CALIBRATED_B4       0x27
#define AMBIENT3_REG_U_PRI_CALIBRATED_B1           0x28
#define AMBIENT3_REG_U_PRI_CALIBRATED_B2           0x29
#define AMBIENT3_REG_U_PRI_CALIBRATED_B3           0x2A
#define AMBIENT3_REG_U_PRI_CALIBRATED_B4           0x2B
#define AMBIENT3_REG_V_PRI_CALIBRATED_B1           0x2C
#define AMBIENT3_REG_V_PRI_CALIBRATED_B2           0x2D
#define AMBIENT3_REG_V_PRI_CALIBRATED_B3           0x2E
#define AMBIENT3_REG_V_PRI_CALIBRATED_B4           0x2F
#define AMBIENT3_REG_U_CALIBRATED_B1               0x30
#define AMBIENT3_REG_U_CALIBRATED_B2               0x31
#define AMBIENT3_REG_U_CALIBRATED_B3               0x32
#define AMBIENT3_REG_U_CALIBRATED_B4               0x33
#define AMBIENT3_REG_V_CALIBRATED_B1               0x34
#define AMBIENT3_REG_V_CALIBRATED_B2               0x35
#define AMBIENT3_REG_V_CALIBRATED_B3               0x36
#define AMBIENT3_REG_V_CALIBRATED_B4               0x37
#define AMBIENT3_REG_DUV_CALIBRATED_B1             0x38
#define AMBIENT3_REG_DUV_CALIBRATED_B2             0x39
#define AMBIENT3_REG_DUV_CALIBRATED_B3             0x3A
#define AMBIENT3_REG_DUV_CALIBRATED_B4             0x3B
#define AMBIENT3_REG_CAL_LUX_MSB                   0x3C
#define AMBIENT3_REG_CAL_LUX_LSB                   0x3D
#define AMBIENT3_REG_CAL_CCT_MSB                   0x3E
#define AMBIENT3_REG_CAL_CCT_LSB                   0x3F
#define AMBIENT3_CC_GAIN_x1                        0x00
#define AMBIENT3_CC_GAIN_x3_7                      0x10
#define AMBIENT3_CC_GAIN_x16                       0x20
#define AMBIENT3_CC_GAIN_x64                       0x30
#define AMBIENT3_CC_RDY_TO_INT                     0x02
#define AMBIENT3_CC_SOFTWARE_RESET                 0x01
 // End group macro 
// --------------------------------------------------------------- PUBLIC TYPES
typedef struct
{
    // Output pins 
 
    digital_out_t rst;
 
    // Input pins 
 
    digital_in_t int_pin;
    
    // Modules 
 
    i2c_master_t i2c;
 
    // ctx variable 
 
    uint8_t slave_address;
 
} ambient3_t;
 
typedef struct
{
    // Communication gpio pins 
 
    pin_name_t scl;
    pin_name_t sda;
    
    // Additional gpio pins 
 
    pin_name_t rst;
    pin_name_t int_pin;
 
    // static variable 
 
    uint32_t i2c_speed;
    uint8_t i2c_address;
 
} ambient3_cfg_t;
 
 // End types group
// ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
 
#ifdef __cplusplus
extern "C"{
#endif
 
void ambient3_cfg_setup ( ambient3_cfg_t *cfg );
 
AMBIENT3_RETVAL ambient3_init ( ambient3_t *ctx, ambient3_cfg_t *cfg );
 
void ambient3_default_cfg ( ambient3_t *ctx );
 
void ambient3_write_byte ( ambient3_t *ctx, uint8_t virtual_reg, uint8_t data_buf);
 
uint8_t ambient3_read_byte ( ambient3_t *ctx, uint8_t virtual_reg);
 
void ambient3_hardware_reset ( ambient3_t *ctx );
 
uint8_t ambient3_get_device_temperature ( ambient3_t *ctx );
 
uint16_t ambient3_get_data_in_lux ( ambient3_t *ctx );
 
 
uint16_t ambient3_get_cct_data ( ambient3_t *ctx );
 
uint8_t ambient3_get_interrupt ( ambient3_t *ctx );
 
#ifdef __cplusplus
}
#endif
#endif  // _AMBIENT3_H_
 
 // End public_function group
 
// ------------------------------------------------------------------------- END