opt3001.h

Go to the documentation of this file.

/*
 * Copyright (c) 2016-2017, Texas Instruments Incorporated
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * *  Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 * *  Redistributions in binary form 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.
 *
 * *  Neither the name of Texas Instruments Incorporated nor the names of
 *    its contributors may be used to endorse or promote products derived
 *    from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER 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 OPT3001_H_
#define OPT3001_H_

#ifdef __cplusplus
extern "C" {
#endif

/* Driver Header files */
#include <ti/drivers/I2C.h>
#include <ti/drivers/GPIO.h>

/* OPT3001 Register Addresses */
#define OPT3001_RESULT    0x0000  /* Result Register (Read-Only)  */
#define OPT3001_CONFIG    0x0001  /* Configuration Register       */
#define OPT3001_LOLIMIT   0x0002  /* Low-Limit Register           */
#define OPT3001_HILIMIT   0x0003  /* High-Limit Register          */
#define OPT3001_MFTID     0x007E  /* Manufacturer ID Register     */
#define OPT3001_DEVICEID  0x007F  /* Device ID Register           */

/* OPT3001 Configuration Register Bits */
#define OPT3001_FL        0x0020  /* Flag Low Field               */
#define OPT3001_FH        0x0040  /* Flag High Field              */
#define OPT3001_CRF       0x0080  /* Conversion Ready Field       */
#define OPT3001_OVF       0x0100  /* Overflow Flag Field          */

#define OPT3001_IGNORE         0xFFFF

typedef enum OPT3001_ConversionMode {
    OPT3001_SHUTDOWN   = 0x0000, 
    OPT3001_SINGLESHOT = 0x0200, 
    OPT3001_CONTINUOUS = 0x0600  
} OPT3001_ConversionMode;

typedef enum OPT3001_ConversionReady {
    OPT3001_CONVRD_DIS = 0x000,
    OPT3001_CONVRD_EN = 0xC000
} OPT3001_ConversionReady;

typedef enum OPT3001_ConversionTime {
    OPT3001_100MS =  0,      
    OPT3001_800MS =  0x0800  
} OPT3001_ConversionTime;


typedef enum OPT3001_FaultCount {
    OPT3001_FAULT1   = 0x0000,  
    OPT3001_FAULT2   = 0x0001,  
    OPT3001_FAULT4   = 0x0002,  
    OPT3001_FAULT8   = 0x0003   
} OPT3001_FaultCount;

typedef enum OPT3001_FullRange {
    OPT3001_RANGE0   = 0x0000,  
    OPT3001_RANGE1   = 0x1000,  
    OPT3001_RANGE2   = 0x2000,  
    OPT3001_RANGE3   = 0x3000,  
    OPT3001_RANGE4   = 0x4000,  
    OPT3001_RANGE5   = 0x5000,  
    OPT3001_RANGE6   = 0x6000,  
    OPT3001_RANGE7   = 0x7000,  
    OPT3001_RANGE8   = 0x8000,  
    OPT3001_RANGE9   = 0x9000,  
    OPT3001_RANGE10  = 0xA000,  
    OPT3001_RANGE11  = 0xB000,  
    OPT3001_AUTO     = 0xC000   
} OPT3001_FullRange;

typedef enum OPT3001_InterruptMode {
    OPT3001_NOLATCH  =  0,      
    OPT3001_LATCH    =  0x0010  
} OPT3001_InterruptMode;


typedef struct OPT3001_Config    *OPT3001_Handle;

typedef enum OPT3001_SlaveAddress {
    OPT3001_SA1 = 0x44,  
    OPT3001_SA2 = 0x45,  
    OPT3001_SA3 = 0x46,  
    OPT3001_SA4 = 0x47,  
} OPT3001_SlaveAddress;

typedef struct OPT3001_Config {
    void const    *hwAttrs;

    void          *object;
} OPT3001_Config;

typedef struct OPT3001_HWAttrs {
    OPT3001_SlaveAddress    slaveAddress;    
    unsigned int            gpioIndex;       
} OPT3001_HWAttrs;

typedef struct OPT3001_Object {
    I2C_Handle                i2cHandle;
    GPIO_CallbackFxn          callback;
    OPT3001_FullRange         range;
} OPT3001_Object;

typedef struct OPT3001_Params {
        OPT3001_ConversionMode    conversionMode;
        OPT3001_ConversionReady   conversionReady;
        OPT3001_ConversionTime    conversionTime;
        OPT3001_FaultCount        faultCount;
        OPT3001_FullRange         range;
        OPT3001_InterruptMode     interruptMode;
        GPIO_CallbackFxn          callback;
} OPT3001_Params;

extern bool OPT3001_close(OPT3001_Handle handle);

extern bool OPT3001_disableInterrupt(OPT3001_Handle handle);

extern bool OPT3001_enableInterrupt(OPT3001_Handle handle);

extern bool OPT3001_getLux(OPT3001_Handle handle, float *data);

extern bool OPT3001_getLuxLimits(OPT3001_Handle handle,
                                float *high, float *low);

extern void OPT3001_init();

extern OPT3001_Handle OPT3001_open(unsigned int index,
        I2C_Handle i2cHandle, OPT3001_Params *params);

extern void OPT3001_Params_init(OPT3001_Params *params);

extern bool OPT3001_readRegister(OPT3001_Handle handle,
        uint16_t *data, uint8_t registerAddress);

extern bool OPT3001_setConversionMode(OPT3001_Handle handle,
        OPT3001_ConversionMode mode);

extern bool OPT3001_setLuxLimits(OPT3001_Handle handle, float high, float low);

extern bool OPT3001_setRange(OPT3001_Handle handle, OPT3001_FullRange range);

extern bool OPT3001_writeRegister(OPT3001_Handle handle, uint16_t data,
        uint8_t registerAddress);

#ifdef __cplusplus
}
#endif

#endif /* OPT3001_H_ */