opt3001_regs.h

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: 2019 HAW Hamburg
 * SPDX-License-Identifier: LGPL-2.1-only
 */
 
#pragma once

 
#ifdef __cplusplus
 extern "C" {
#endif

 #define OPT3001_REGS_RESULT                  0x00 
 #define OPT3001_REGS_CONFIG                  0x01 
 #define OPT3001_REGS_LOW_LIMIT               0x02 
 #define OPT3001_REGS_HIGH_LIMIT              0x03 
 #define OPT3001_REGS_MANUFACTURER_ID         0x7E 
 #define OPT3001_REGS_DEVICE_ID               0x7F 
 
 #define OPT3001_DID_VALUE                    (0x3001) 
 
 #define OPT3001_CONFIG_RESET                 (0xC810) 
 
 #define OPT3001_CONFIG_RN_FSR                (0xC000) 
 
 #define OPT3001_REGS_CONFIG_CT_MASK          (0x0800) 
 #define OPT3001_REGS_CONFIG_CT(x)            (((uint16_t)(x)) \
                                              & OPT3001_REGS_CONFIG_CT_MASK) 
 
 #define OPT3001_CONFIG_M_SHUTDOWN            (0x0) 
 #define OPT3001_CONFIG_M_SINGLE              (0x1) 
 #define OPT3001_CONFIG_M_CONTINUOUS          (0x2) 
 #define OPT3001_CONFIG_MOC_SHIFT             (9U) 
 #define OPT3001_CONFIG_MOC_MASK              (0x0600) 
 #define OPT3001_REGS_CONFIG_MOC(x)           (((uint16_t)(((uint16_t)(x)) \
                                              << OPT3001_CONFIG_MOC_SHIFT)) \
                                              & OPT3001_CONFIG_MOC_MASK) 
 
 #define OPT3001_REGS_CONFIG_OVF              (1 << 8) 
 #define OPT3001_REGS_CONFIG_CRF              (1 << 7) 
 #define OPT3001_REGS_CONFIG_FH               (1 << 6) 
 #define OPT3001_REGS_CONFIG_FL               (1 << 5) 
 #define OPT3001_REGS_CONFIG_L                (1 << 4) 
 #define OPT3001_REGS_CONFIG_POL              (1 << 3) 
 #define OPT3001_REGS_CONFIG_ME               (1 << 2) 
 
 #define OPT3001_REGS_CONFIG_FC_MASK          (0x0003) 
 
 #define OPT3001_REGS_LOW_LIMIT_EOC_ENABLE    (0xC000) 
 
 #define OPT3001_REGS_REG_EXPONENT(x)         ((x) >> 12) 
 #define OPT3001_REGS_REG_MANTISSA(x)         ((x) & 0xFFF) 
 
/*
 * Time to wait for the conversion to complete.
 * The data sheet of the device (sect. 6.5) indicates that the conversion time is the integration time plus 3 ms.
 * It has been added a bit more time just to be safe.
 */
 #define OPT3001_REGS_INT_TIME_SHORT          100000 
 #define OPT3001_REGS_INT_TIME_LONG           800000 
 
 #define OPT3001_CONVERSION_TIME_OFFSET       4000 
 
 #define OPT3001_CONVERSION_TIME_COMBINED     OPT3001_REGS_INT_TIME_SHORT \
                                              + OPT3001_REGS_INT_TIME_LONG \
                                              + OPT3001_CONVERSION_TIME_OFFSET 

 
#ifdef __cplusplus
}
#endif