Low Power, High Sensitivity, I2C Ambient Light Sensor.
Revision 2:cce3af41ab18, committed 2020-03-27
- Comitter:
- mcm
- Date:
- Fri Mar 27 20:24:34 2020 +0000
- Parent:
- 1:1cc877ffc661
- Commit message:
- This driver was completed and tested ( NUCLEO-L476RG ), it works as expected.
Changed in this revision
| VEML6035.cpp | Show annotated file Show diff for this revision Revisions of this file |
| VEML6035.h | Show annotated file Show diff for this revision Revisions of this file |
diff -r 1cc877ffc661 -r cce3af41ab18 VEML6035.cpp
--- a/VEML6035.cpp Thu Mar 26 20:17:41 2020 +0000
+++ b/VEML6035.cpp Fri Mar 27 20:24:34 2020 +0000
@@ -0,0 +1,1318 @@
+/**
+ * @brief VEML6035.cpp
+ * @details Low Power, High Sensitivity, I2C Ambient Light Sensor.
+ * Function file.
+ *
+ *
+ * @return N/A
+ *
+ * @author Manuel Caballero
+ * @date 26/March/2020
+ * @version 26/March/2020 The ORIGIN
+ * @pre N/A.
+ * @warning N/A
+ * @pre This code belongs to AqueronteBlog ( http://unbarquero.blogspot.com ).
+ */
+
+#include "VEML6035.h"
+
+
+VEML6035::VEML6035 ( PinName sda, PinName scl, uint32_t addr, uint32_t freq )
+ : _i2c ( sda, scl )
+ , _VEML6035_Addr ( addr )
+{
+ _i2c.frequency( freq );
+}
+
+
+VEML6035::~VEML6035()
+{
+}
+
+
+
+/**
+ * @brief VEML6035_GetConfigurationRegister ( VEML6035_configuration_register_t* )
+ *
+ * @details It reads the configuration register.
+ *
+ * @param[in] N/A.
+ *
+ * @param[out] myConfReg: Configuration values.
+ *
+ *
+ * @return Status of VEML6035_GetConfigurationRegister.
+ *
+ *
+ * @author Manuel Caballero
+ * @date 26/March/2020
+ * @version 26/March/2020 The ORIGIN
+ * @pre N/A
+ * @warning N/A.
+ */
+VEML6035::VEML6035_status_t VEML6035::VEML6035_GetConfigurationRegister ( VEML6035_configuration_register_t* myConfReg )
+{
+ char cmd[2] = { 0 };
+ uint16_t auxConfiguration = 0U;
+ uint32_t aux;
+
+ /* Read the register */
+ cmd[0] = VEML6035_ALS_CONF;
+ aux = _i2c.write ( _VEML6035_Addr, &cmd[0], 1UL, true );
+ aux |= _i2c.read ( _VEML6035_Addr, &cmd[0], sizeof( cmd )/sizeof( cmd[0] ) );
+
+ /* Update the data */
+ auxConfiguration = cmd[0];
+ auxConfiguration <<= 8U;
+ auxConfiguration |= cmd[1];
+
+ myConfReg->als_sens = (VEML6035_als_conf_sens_t)( auxConfiguration & ALS_CONF_SENS_MASK );
+ myConfReg->als_dg = (VEML6035_als_conf_dg_t)( auxConfiguration & ALS_CONF_DG_MASK );
+ myConfReg->als_gain = (VEML6035_als_conf_gain_t)( auxConfiguration & ALS_CONF_GAIN_MASK );
+ myConfReg->als_it = (VEML6035_als_conf_als_it_t)( auxConfiguration & ALS_CONF_ALS_IT_MASK );
+ myConfReg->als_pers = (VEML6035_als_conf_als_pers_t)( auxConfiguration & ALS_CONF_ALS_PERS_MASK );
+ myConfReg->als_int_channel = (VEML6035_als_conf_als_int_channel_t)( auxConfiguration & ALS_CONF_ALS_INT_CHANNEL_MASK );
+ myConfReg->als_channel_en = (VEML6035_als_conf_als_channel_en_t)( auxConfiguration & ALS_CONF_ALS_CHANNEL_EN_MASK );
+ myConfReg->als_int_en = (VEML6035_als_conf_als_int_en_t)( auxConfiguration & ALS_CONF_ALS_INT_EN_MASK );
+ myConfReg->als_sd = (VEML6035_als_conf_als_sd_t)( auxConfiguration & ALS_CONF_ALS_SD_MASK );
+
+
+
+ if ( aux == I2C_SUCCESS ) {
+ return VEML6035_SUCCESS;
+ } else {
+ return VEML6035_FAILURE;
+ }
+}
+
+
+
+/**
+ * @brief VEML6035_SetConfigurationRegister ( VEML6035_configuration_register_t )
+ *
+ * @details It writes the configuration register.
+ *
+ * @param[in] myConfReg: It writes the configuration values.
+ *
+ * @param[out] N/A.
+ *
+ *
+ * @return Status of VEML6035_SetConfigurationRegister.
+ *
+ *
+ * @author Manuel Caballero
+ * @date 26/March/2020
+ * @version 26/March/2020 The ORIGIN
+ * @pre N/A
+ * @warning It is advisable to use VEML6035_GetConfigurationRegister first, in order to mask the values of
+ * the register.
+ */
+VEML6035::VEML6035_status_t VEML6035::VEML6035_SetConfigurationRegister ( VEML6035_configuration_register_t myConfReg )
+{
+ char cmd[3] = { 0 };
+ uint16_t auxConfiguration = 0U;
+ uint32_t aux;
+
+ /* Update the register */
+ auxConfiguration = ( myConfReg.als_sens | myConfReg.als_dg | myConfReg.als_gain | myConfReg.als_it | myConfReg.als_pers | myConfReg.als_int_channel | myConfReg.als_channel_en | myConfReg.als_int_en | myConfReg.als_sd );
+ cmd[0] = VEML6035_ALS_CONF;
+ cmd[1] = (char)( auxConfiguration >> 8U );
+ cmd[2] = (char)( auxConfiguration );
+ aux = _i2c.write ( _VEML6035_Addr, &cmd[0], sizeof( cmd )/sizeof( cmd[0] ), false );
+
+
+
+ if ( aux == I2C_SUCCESS ) {
+ return VEML6035_SUCCESS;
+ } else {
+ return VEML6035_FAILURE;
+ }
+}
+
+
+
+/**
+ * @brief VEML6035_SetSensitivity ( VEML6035_data_t )
+ *
+ * @details It sets the sensitivity value.
+ *
+ * @param[in] mySENS: Sensitivity value.
+ *
+ * @param[out] N/A.
+ *
+ *
+ * @return Status of VEML6035_SetSensitivity.
+ *
+ *
+ * @author Manuel Caballero
+ * @date 26/March/2020
+ * @version 26/March/2020 The ORIGIN
+ * @pre N/A
+ * @warning N/A.
+ */
+VEML6035::VEML6035_status_t VEML6035::VEML6035_SetSensitivity ( VEML6035_data_t mySENS )
+{
+ VEML6035::VEML6035_configuration_register_t auxConfiguration;
+ VEML6035::VEML6035_status_t aux;
+
+
+ /* Read the register */
+ aux = VEML6035_GetConfigurationRegister ( &auxConfiguration );
+
+ /* Parse the data and update the register */
+ auxConfiguration.als_sens = mySENS.configuration.als_sens;
+ aux = VEML6035_SetConfigurationRegister ( auxConfiguration );
+
+
+ return aux;
+}
+
+
+
+/**
+ * @brief VEML6035_GetSensitivity ( VEML6035_data_t* )
+ *
+ * @details It gets the sensitivity value.
+ *
+ * @param[in] N/A.
+ *
+ * @param[out] mySENS: Sensitivity value.
+ *
+ *
+ * @return Status of VEML6035_GetSensitivity.
+ *
+ *
+ * @author Manuel Caballero
+ * @date 26/March/2020
+ * @version 26/March/2020 The ORIGIN
+ * @pre N/A
+ * @warning N/A.
+ */
+VEML6035::VEML6035_status_t VEML6035::VEML6035_GetSensitivity ( VEML6035_data_t* mySENS )
+{
+ VEML6035_configuration_register_t auxConfiguration;
+ VEML6035::VEML6035_status_t aux;
+
+
+ /* Read the register */
+ aux = VEML6035_GetConfigurationRegister ( &auxConfiguration );
+
+ /* Parse the data */
+ mySENS->configuration.als_sens = auxConfiguration.als_sens;
+
+
+ return aux;
+}
+
+
+
+/**
+ * @brief VEML6035_SetDG ( VEML6035_data_t )
+ *
+ * @details It sets the DG value.
+ *
+ * @param[in] myDG: DG value.
+ *
+ * @param[out] N/A.
+ *
+ *
+ * @return Status of VEML6035_SetDG.
+ *
+ *
+ * @author Manuel Caballero
+ * @date 26/March/2020
+ * @version 26/March/2020 The ORIGIN
+ * @pre N/A
+ * @warning N/A.
+ */
+VEML6035::VEML6035_status_t VEML6035::VEML6035_SetDG ( VEML6035_data_t myDG )
+{
+ VEML6035_configuration_register_t auxConfiguration;
+ VEML6035::VEML6035_status_t aux;
+
+
+ /* Read the register */
+ aux = VEML6035_GetConfigurationRegister ( &auxConfiguration );
+
+ /* Parse the data and update the register */
+ auxConfiguration.als_dg = myDG.configuration.als_dg;
+ aux = VEML6035_SetConfigurationRegister ( auxConfiguration );
+
+
+ return aux;
+}
+
+
+
+/**
+ * @brief VEML6035_GetDG ( VEML6035_data_t* )
+ *
+ * @details It gets the DG value.
+ *
+ * @param[in] N/A.
+ *
+ * @param[out] myDG: DG value.
+ *
+ *
+ * @return Status of VEML6035_GetDG.
+ *
+ *
+ * @author Manuel Caballero
+ * @date 26/March/2020
+ * @version 26/March/2020 The ORIGIN
+ * @pre N/A
+ * @warning N/A.
+ */
+VEML6035::VEML6035_status_t VEML6035::VEML6035_GetDG ( VEML6035_data_t* myDG )
+{
+ VEML6035_configuration_register_t auxConfiguration;
+ VEML6035::VEML6035_status_t aux;
+
+
+ /* Read the register */
+ aux = VEML6035_GetConfigurationRegister ( &auxConfiguration );
+
+ /* Parse the data */
+ myDG->configuration.als_dg = auxConfiguration.als_dg;
+
+
+ return aux;
+}
+
+
+
+/**
+ * @brief VEML6035_SetGain ( VEML6035_data_t )
+ *
+ * @details It sets the gain value.
+ *
+ * @param[in] myGain: Gain value.
+ *
+ * @param[out] N/A.
+ *
+ *
+ * @return Status of VEML6035_SetGain.
+ *
+ *
+ * @author Manuel Caballero
+ * @date 26/March/2020
+ * @version 26/March/2020 The ORIGIN
+ * @pre N/A
+ * @warning N/A.
+ */
+VEML6035::VEML6035_status_t VEML6035::VEML6035_SetGain ( VEML6035_data_t myGain )
+{
+ VEML6035_configuration_register_t auxConfiguration;
+ VEML6035::VEML6035_status_t aux;
+
+
+ /* Read the register */
+ aux = VEML6035_GetConfigurationRegister ( &auxConfiguration );
+
+ /* Parse the data and update the register */
+ auxConfiguration.als_gain = myGain.configuration.als_gain;
+ aux = VEML6035_SetConfigurationRegister ( auxConfiguration );
+
+
+ return aux;
+}
+
+
+
+/**
+ * @brief VEML6035_GetGain ( VEML6035_data_t* )
+ *
+ * @details It gets the gain value.
+ *
+ * @param[in] N/A.
+ *
+ * @param[out] myGain: Gain value.
+ *
+ *
+ * @return Status of VEML6035_GetGain.
+ *
+ *
+ * @author Manuel Caballero
+ * @date 26/March/2020
+ * @version 26/March/2020 The ORIGIN
+ * @pre N/A
+ * @warning N/A.
+ */
+VEML6035::VEML6035_status_t VEML6035::VEML6035_GetGain ( VEML6035_data_t* myGain )
+{
+ VEML6035_configuration_register_t auxConfiguration;
+ VEML6035::VEML6035_status_t aux;
+
+
+ /* Read the register */
+ aux = VEML6035_GetConfigurationRegister ( &auxConfiguration );
+
+ /* Parse the data */
+ myGain->configuration.als_gain = auxConfiguration.als_gain;
+
+
+ return aux;
+}
+
+
+
+/**
+ * @brief VEML6035_SetIntegrationTime ( VEML6035_data_t )
+ *
+ * @details It sets the integration time value.
+ *
+ * @param[in] myALS_IT: Integration time value.
+ *
+ * @param[out] N/A.
+ *
+ *
+ * @return Status of VEML6035_SetIntegrationTime.
+ *
+ *
+ * @author Manuel Caballero
+ * @date 26/March/2020
+ * @version 26/March/2020 The ORIGIN
+ * @pre N/A
+ * @warning N/A.
+ */
+VEML6035::VEML6035_status_t VEML6035::VEML6035_SetIntegrationTime ( VEML6035_data_t myALS_IT )
+{
+ VEML6035_configuration_register_t auxConfiguration;
+ VEML6035::VEML6035_status_t aux;
+
+
+ /* Read the register */
+ aux = VEML6035_GetConfigurationRegister ( &auxConfiguration );
+
+ /* Parse the data and update the register */
+ auxConfiguration.als_it = myALS_IT.configuration.als_it;
+ aux = VEML6035_SetConfigurationRegister ( auxConfiguration );
+
+
+ return aux;
+}
+
+
+
+/**
+ * @brief VEML6035_GetIntegrationTime ( VEML6035_data_t* )
+ *
+ * @details It gets the integration time value.
+ *
+ * @param[in] N/A.
+ *
+ * @param[out] myALS_IT: tegration Time value.
+ *
+ *
+ * @return Status of VEML6035_GetIntegrationTime.
+ *
+ *
+ * @author Manuel Caballero
+ * @date 26/March/2020
+ * @version 26/March/2020 The ORIGIN
+ * @pre N/A
+ * @warning N/A.
+ */
+VEML6035::VEML6035_status_t VEML6035::VEML6035_GetIntegrationTime ( VEML6035_data_t* myALS_IT )
+{
+ VEML6035_configuration_register_t auxConfiguration;
+ VEML6035::VEML6035_status_t aux;
+
+
+ /* Read the register */
+ aux = VEML6035_GetConfigurationRegister ( &auxConfiguration );
+
+ /* Parse the data */
+ myALS_IT->configuration.als_it = auxConfiguration.als_it;
+
+
+ return aux;
+}
+
+
+
+/**
+ * @brief VEML6035_SetInterruptPersistence ( VEML6035_data_t )
+ *
+ * @details It sets the interrupt persistence value.
+ *
+ * @param[in] myALS_PERS: Interrupt persistence value.
+ *
+ * @param[out] N/A.
+ *
+ *
+ * @return Status of VEML6035_SetInterruptPersistence.
+ *
+ *
+ * @author Manuel Caballero
+ * @date 26/March/2020
+ * @version 26/March/2020 The ORIGIN
+ * @pre N/A
+ * @warning N/A.
+ */
+VEML6035::VEML6035_status_t VEML6035::VEML6035_SetInterruptPersistence ( VEML6035_data_t myALS_PERS )
+{
+ VEML6035_configuration_register_t auxConfiguration;
+ VEML6035::VEML6035_status_t aux;
+
+
+ /* Read the register */
+ aux = VEML6035_GetConfigurationRegister ( &auxConfiguration );
+
+ /* Parse the data and update the register */
+ auxConfiguration.als_pers = myALS_PERS.configuration.als_pers;
+ aux = VEML6035_SetConfigurationRegister ( auxConfiguration );
+
+
+ return aux;
+}
+
+
+
+/**
+ * @brief VEML6035_GetInterruptPersistence ( VEML6035_data_t* )
+ *
+ * @details It gets the interrupt persistence value.
+ *
+ * @param[in] N/A.
+ *
+ * @param[out] myALS_PERS: Interrupt persistence value.
+ *
+ *
+ * @return Status of VEML6035_GetInterruptPersistence.
+ *
+ *
+ * @author Manuel Caballero
+ * @date 26/March/2020
+ * @version 26/March/2020 The ORIGIN
+ * @pre N/A
+ * @warning N/A.
+ */
+VEML6035::VEML6035_status_t VEML6035::VEML6035_GetInterruptPersistence ( VEML6035_data_t* myALS_PERS )
+{
+ VEML6035_configuration_register_t auxConfiguration;
+ VEML6035::VEML6035_status_t aux;
+
+
+ /* Read the register */
+ aux = VEML6035_GetConfigurationRegister ( &auxConfiguration );
+
+ /* Parse the data */
+ myALS_PERS->configuration.als_pers = auxConfiguration.als_pers;
+
+
+ return aux;
+}
+
+
+
+/**
+ * @brief VEML6035_SetChannelInterrupt ( VEML6035_data_t )
+ *
+ * @details It sets the channel interrupt value.
+ *
+ * @param[in] myINT_CHANNEL: Channel interrupt value.
+ *
+ * @param[out] N/A.
+ *
+ *
+ * @return Status of VEML6035_SetChannelInterrupt.
+ *
+ *
+ * @author Manuel Caballero
+ * @date 26/March/2020
+ * @version 26/March/2020 The ORIGIN
+ * @pre N/A
+ * @warning N/A.
+ */
+VEML6035::VEML6035_status_t VEML6035::VEML6035_SetChannelInterrupt ( VEML6035_data_t myINT_CHANNEL )
+{
+ VEML6035_configuration_register_t auxConfiguration;
+ VEML6035::VEML6035_status_t aux;
+
+
+ /* Read the register */
+ aux = VEML6035_GetConfigurationRegister ( &auxConfiguration );
+
+ /* Parse the data and update the register */
+ auxConfiguration.als_int_channel = myINT_CHANNEL.configuration.als_int_channel;
+ aux = VEML6035_SetConfigurationRegister ( auxConfiguration );
+
+
+ return aux;
+}
+
+
+
+/**
+ * @brief VEML6035_GetChannelInterrupt ( VEML6035_data_t* )
+ *
+ * @details It gets the channel interrupt value.
+ *
+ * @param[in] N/A.
+ *
+ * @param[out] myINT_CHANNEL: Channel interrupt value.
+ *
+ *
+ * @return Status of VEML6035_GetChannelInterrupt.
+ *
+ *
+ * @author Manuel Caballero
+ * @date 26/March/2020
+ * @version 26/March/2020 The ORIGIN
+ * @pre N/A
+ * @warning N/A.
+ */
+VEML6035::VEML6035_status_t VEML6035::VEML6035_GetChannelInterrupt ( VEML6035_data_t* myINT_CHANNEL )
+{
+ VEML6035_configuration_register_t auxConfiguration;
+ VEML6035::VEML6035_status_t aux;
+
+
+ /* Read the register */
+ aux = VEML6035_GetConfigurationRegister ( &auxConfiguration );
+
+ /* Parse the data */
+ myINT_CHANNEL->configuration.als_int_channel = auxConfiguration.als_int_channel;
+
+
+ return aux;
+}
+
+
+
+/**
+ * @brief VEML6035_SetChannelEnable ( VEML6035_data_t )
+ *
+ * @details It sets the channel enable value.
+ *
+ * @param[in] myCHANNEL_EN: Channel enable value.
+ *
+ * @param[out] N/A.
+ *
+ *
+ * @return Status of VEML6035_SetChannelEnable.
+ *
+ *
+ * @author Manuel Caballero
+ * @date 26/March/2020
+ * @version 26/March/2020 The ORIGIN
+ * @pre N/A
+ * @warning N/A.
+ */
+VEML6035::VEML6035_status_t VEML6035::VEML6035_SetChannelEnable ( VEML6035_data_t myCHANNEL_EN )
+{
+ VEML6035_configuration_register_t auxConfiguration;
+ VEML6035::VEML6035_status_t aux;
+
+
+ /* Read the register */
+ aux = VEML6035_GetConfigurationRegister ( &auxConfiguration );
+
+ /* Parse the data and update the register */
+ auxConfiguration.als_channel_en = myCHANNEL_EN.configuration.als_channel_en;
+ aux = VEML6035_SetConfigurationRegister ( auxConfiguration );
+
+
+ return aux;
+}
+
+
+
+/**
+ * @brief VEML6035_GetChannelEnable ( VEML6035_data_t* )
+ *
+ * @details It gets the channel enable value.
+ *
+ * @param[in] N/A.
+ *
+ * @param[out] myCHANNEL_EN: Channel enable value.
+ *
+ *
+ * @return Status of VEML6035_GetChannelEnable.
+ *
+ *
+ * @author Manuel Caballero
+ * @date 26/March/2020
+ * @version 26/March/2020 The ORIGIN
+ * @pre N/A
+ * @warning N/A.
+ */
+VEML6035::VEML6035_status_t VEML6035::VEML6035_GetChannelEnable ( VEML6035_data_t* myCHANNEL_EN )
+{
+ VEML6035_configuration_register_t auxConfiguration;
+ VEML6035::VEML6035_status_t aux;
+
+
+ /* Read the register */
+ aux = VEML6035_GetConfigurationRegister ( &auxConfiguration );
+
+ /* Parse the data */
+ myCHANNEL_EN->configuration.als_channel_en = auxConfiguration.als_channel_en;
+
+
+ return aux;
+}
+
+
+
+/**
+ * @brief VEML6035_SetInterruptEnable ( VEML6035_data_t )
+ *
+ * @details It sets the interrupt enable value.
+ *
+ * @param[in] myINT_EN: Interrupt enable value.
+ *
+ * @param[out] N/A.
+ *
+ *
+ * @return Status of VEML6035_SetInterruptEnable.
+ *
+ *
+ * @author Manuel Caballero
+ * @date 26/March/2020
+ * @version 26/March/2020 The ORIGIN
+ * @pre N/A
+ * @warning N/A.
+ */
+VEML6035::VEML6035_status_t VEML6035::VEML6035_SetInterruptEnable ( VEML6035_data_t myINT_EN )
+{
+ VEML6035_configuration_register_t auxConfiguration;
+ VEML6035::VEML6035_status_t aux;
+
+
+ /* Read the register */
+ aux = VEML6035_GetConfigurationRegister ( &auxConfiguration );
+
+ /* Parse the data and update the register */
+ auxConfiguration.als_int_en = myINT_EN.configuration.als_int_en;
+ aux = VEML6035_SetConfigurationRegister ( auxConfiguration );
+
+
+ return aux;
+}
+
+
+
+/**
+ * @brief VEML6035_GetInterruptEnable ( VEML6035_data_t* )
+ *
+ * @details It gets the interrupt enable value.
+ *
+ * @param[in] N/A.
+ *
+ * @param[out] myINT_EN: Interrupt enable value.
+ *
+ *
+ * @return Status of VEML6035_GetInterruptEnable.
+ *
+ *
+ * @author Manuel Caballero
+ * @date 26/March/2020
+ * @version 26/March/2020 The ORIGIN
+ * @pre N/A
+ * @warning N/A.
+ */
+VEML6035::VEML6035_status_t VEML6035::VEML6035_GetInterruptEnable ( VEML6035_data_t* myINT_EN )
+{
+ VEML6035_configuration_register_t auxConfiguration;
+ VEML6035::VEML6035_status_t aux;
+
+
+ /* Read the register */
+ aux = VEML6035_GetConfigurationRegister ( &auxConfiguration );
+
+ /* Parse the data */
+ myINT_EN->configuration.als_int_en = auxConfiguration.als_int_en;
+
+
+ return aux;
+}
+
+
+
+/**
+ * @brief VEML6035_SetShutDownMode ( VEML6035_data_t )
+ *
+ * @details It sets the interrupt enable value.
+ *
+ * @param[in] mySD: Shutdown mode.
+ *
+ * @param[out] N/A.
+ *
+ *
+ * @return Status of VEML6035_SetShutDownMode.
+ *
+ *
+ * @author Manuel Caballero
+ * @date 26/March/2020
+ * @version 26/March/2020 The ORIGIN
+ * @pre N/A
+ * @warning N/A.
+ */
+VEML6035::VEML6035_status_t VEML6035::VEML6035_SetShutDownMode ( VEML6035_data_t mySD )
+{
+ VEML6035_configuration_register_t auxConfiguration;
+ VEML6035::VEML6035_status_t aux;
+
+
+ /* Read the register */
+ aux = VEML6035_GetConfigurationRegister ( &auxConfiguration );
+
+ /* Parse the data and update the register */
+ auxConfiguration.als_sd = mySD.configuration.als_sd;
+ aux = VEML6035_SetConfigurationRegister ( auxConfiguration );
+
+
+ return aux;
+}
+
+
+
+/**
+ * @brief VEML6035_GetShutDownMode ( VEML6035_data_t* )
+ *
+ * @details It gets the shutdown mode.
+ *
+ * @param[in] N/A.
+ *
+ * @param[out] mySD: Shutdown mode.
+ *
+ *
+ * @return Status of VEML6035_GetShutDownMode.
+ *
+ *
+ * @author Manuel Caballero
+ * @date 26/March/2020
+ * @version 26/March/2020 The ORIGIN
+ * @pre N/A
+ * @warning N/A.
+ */
+VEML6035::VEML6035_status_t VEML6035::VEML6035_GetShutDownMode ( VEML6035_data_t* mySD )
+{
+ VEML6035_configuration_register_t auxConfiguration;
+ VEML6035::VEML6035_status_t aux;
+
+
+ /* Read the register */
+ aux = VEML6035_GetConfigurationRegister ( &auxConfiguration );
+
+ /* Parse the data */
+ mySD->configuration.als_sd = auxConfiguration.als_sd;
+
+
+ return aux;
+}
+
+
+
+/**
+ * @brief VEML6035_SetHighThreshold ( VEML6035_data_t )
+ *
+ * @details It sets the high threshold value.
+ *
+ * @param[in] myHighThreshold: High threshold value.
+ *
+ * @param[out] N/A.
+ *
+ *
+ * @return Status of VEML6035_SetHighThreshold.
+ *
+ *
+ * @author Manuel Caballero
+ * @date 26/March/2020
+ * @version 26/March/2020 The ORIGIN
+ * @pre N/A
+ * @warning N/A.
+ */
+VEML6035::VEML6035_status_t VEML6035::VEML6035_SetHighThreshold ( VEML6035_data_t myHighThreshold )
+{
+ char cmd[3] = {0};
+ uint32_t aux;
+
+
+ /* Update the register */
+ cmd[0] = VEML6035_ALS_WH;
+ cmd[1] = (char)( myHighThreshold.int_th_high >> 8U );
+ cmd[2] = (char)( myHighThreshold.int_th_high );
+ aux = _i2c.write ( _VEML6035_Addr, &cmd[0], sizeof( cmd )/sizeof( cmd[0] ), false );
+
+
+
+ if ( aux == I2C_SUCCESS ) {
+ return VEML6035_SUCCESS;
+ } else {
+ return VEML6035_FAILURE;
+ }
+}
+
+
+
+/**
+ * @brief VEML6035_GetHighThreshold ( VEML6035_data_t* )
+ *
+ * @details It gets the high threshold value.
+ *
+ * @param[in] N/A.
+ *
+ * @param[out] myHighThreshold: High threshold value.
+ *
+ *
+ * @return Status of VEML6035_GetHighThreshold.
+ *
+ *
+ * @author Manuel Caballero
+ * @date 26/March/2020
+ * @version 26/March/2020 The ORIGIN
+ * @pre N/A
+ * @warning N/A.
+ */
+VEML6035::VEML6035_status_t VEML6035::VEML6035_GetHighThreshold ( VEML6035_data_t* myHighThreshold )
+{
+ char cmd[2] = {0};
+ uint16_t auxIntThHigh = 0U;
+ uint32_t aux;
+
+
+ /* Read the register */
+ cmd[0] = VEML6035_ALS_WH;
+ aux = _i2c.write ( _VEML6035_Addr, &cmd[0], 1U, true );
+ aux = _i2c.read ( _VEML6035_Addr, &cmd[0], sizeof( cmd )/sizeof( cmd[0] ) );
+
+ /* Parse the data */
+ auxIntThHigh = cmd[0];
+ auxIntThHigh <<= 8U;
+ auxIntThHigh |= cmd[1];
+
+ myHighThreshold->int_th_high = (VEML6035_als_int_int_th_high_t)auxIntThHigh;
+
+
+
+ if ( aux == I2C_SUCCESS ) {
+ return VEML6035_SUCCESS;
+ } else {
+ return VEML6035_FAILURE;
+ }
+}
+
+
+
+/**
+ * @brief VEML6035_SetLowThreshold ( VEML6035_data_t )
+ *
+ * @details It sets the low threshold value.
+ *
+ * @param[in] myLowThreshold: Low threshold value.
+ *
+ * @param[out] N/A.
+ *
+ *
+ * @return Status of VEML6035_SetLowThreshold.
+ *
+ *
+ * @author Manuel Caballero
+ * @date 26/March/2020
+ * @version 26/March/2020 The ORIGIN
+ * @pre N/A
+ * @warning N/A.
+ */
+VEML6035::VEML6035_status_t VEML6035::VEML6035_SetLowThreshold ( VEML6035_data_t myLowThreshold )
+{
+ char cmd[3] = {0};
+ uint32_t aux;
+
+
+ /* Update the register */
+ cmd[0] = VEML6035_ALS_WL;
+ cmd[1] = (char)( myLowThreshold.int_th_low >> 8U );
+ cmd[2] = (char)( myLowThreshold.int_th_low );
+ aux = _i2c.write ( _VEML6035_Addr, &cmd[0], sizeof( cmd )/sizeof( cmd[0] ), false );
+
+
+
+ if ( aux == I2C_SUCCESS ) {
+ return VEML6035_SUCCESS;
+ } else {
+ return VEML6035_FAILURE;
+ }
+}
+
+
+
+/**
+ * @brief VEML6035_GetLowThreshold ( VEML6035_data_t* )
+ *
+ * @details It gets the low threshold value.
+ *
+ * @param[in] N/A.
+ *
+ * @param[out] myLowThreshold: Low threshold value.
+ *
+ *
+ * @return Status of VEML6035_GetLowThreshold.
+ *
+ *
+ * @author Manuel Caballero
+ * @date 26/March/2020
+ * @version 26/March/2020 The ORIGIN
+ * @pre N/A
+ * @warning N/A.
+ */
+VEML6035::VEML6035_status_t VEML6035::VEML6035_GetLowThreshold ( VEML6035_data_t* myLowThreshold )
+{
+ char cmd[2] = {0};
+ uint16_t auxIntLow = 0U;
+ uint32_t aux;
+
+
+ /* Read the register */
+ cmd[0] = VEML6035_ALS_WL;
+ aux = _i2c.write ( _VEML6035_Addr, &cmd[0], 1U, true );
+ aux = _i2c.read ( _VEML6035_Addr, &cmd[0], sizeof( cmd )/sizeof( cmd[0] ) );
+
+ /* Parse the data */
+ auxIntLow = cmd[0];
+ auxIntLow <<= 8U;
+ auxIntLow |= cmd[1];
+
+ myLowThreshold->int_th_low = (VEML6035_als_int_int_th_low_t)auxIntLow;
+
+
+
+ if ( aux == I2C_SUCCESS ) {
+ return VEML6035_SUCCESS;
+ } else {
+ return VEML6035_FAILURE;
+ }
+}
+
+
+
+/**
+ * @brief VEML6035_SetPowerSafeMode ( VEML6035_data_t )
+ *
+ * @details It sets the power safe mode register.
+ *
+ * @param[in] myPowerSafeMode: PSM_WAIT and PSM_EN values.
+ *
+ * @param[out] N/A.
+ *
+ *
+ * @return Status of VEML6035_SetPowerSafeMode.
+ *
+ *
+ * @author Manuel Caballero
+ * @date 26/March/2020
+ * @version 26/March/2020 The ORIGIN
+ * @pre N/A
+ * @warning N/A.
+ */
+VEML6035::VEML6035_status_t VEML6035::VEML6035_SetPowerSafeMode ( VEML6035_data_t myPowerSafeMode )
+{
+ char cmd[3] = {0};
+ uint16_t auxPowerSafeMode = 0U;
+ uint32_t aux;
+
+
+ /* Read the register */
+ cmd[0] = VEML6035_POWER_SAVING;
+ aux = _i2c.write ( _VEML6035_Addr, &cmd[0], 1U, true );
+ aux |= _i2c.read ( _VEML6035_Addr, &cmd[1], 2U );
+
+
+ /* Update the register */
+ auxPowerSafeMode = cmd[1];
+ auxPowerSafeMode <<= 8U;
+ auxPowerSafeMode |= cmd[2];
+
+ auxPowerSafeMode &= ~( POWER_SAVING_PSM_EN_MASK | POWER_SAVING_PSM_WAIT_MASK );
+ auxPowerSafeMode |= ( myPowerSafeMode.psm_en | myPowerSafeMode.psm_wait );
+
+ cmd[1] = (char)( auxPowerSafeMode >> 8U );
+ cmd[2] = (char)( auxPowerSafeMode );
+ aux |= _i2c.write ( _VEML6035_Addr, &cmd[0], sizeof( cmd )/sizeof( cmd[0] ), false );
+
+
+
+ if ( aux == I2C_SUCCESS ) {
+ return VEML6035_SUCCESS;
+ } else {
+ return VEML6035_FAILURE;
+ }
+}
+
+
+
+/**
+ * @brief VEML6035_GetPowerSafeMode ( VEML6035_data_t* )
+ *
+ * @details It gets the power safe mode register value.
+ *
+ * @param[in] N/A.
+ *
+ * @param[out] myPowerSafeMode: PSM_WAIT and PSM_EN values.
+ *
+ *
+ * @return Status of VEML6035_GetPowerSafeMode.
+ *
+ *
+ * @author Manuel Caballero
+ * @date 26/March/2020
+ * @version 26/March/2020 The ORIGIN
+ * @pre N/A
+ * @warning N/A.
+ */
+VEML6035::VEML6035_status_t VEML6035::VEML6035_GetPowerSafeMode ( VEML6035_data_t* myPowerSafeMode )
+{
+ char cmd[2] = {0U};
+ uint16_t auxPowerSafeMode = 0U;
+ uint32_t aux;
+
+
+ /* Read the register */
+ cmd[0] = VEML6035_POWER_SAVING;
+ aux = _i2c.write ( _VEML6035_Addr, &cmd[0], 1U, true );
+ aux |= _i2c.read ( _VEML6035_Addr, &cmd[0], sizeof( cmd )/sizeof( cmd[0] ) );
+
+ /* Parse the data */
+ auxPowerSafeMode = cmd[0];
+ auxPowerSafeMode <<= 8U;
+ auxPowerSafeMode |= cmd[1];
+
+ myPowerSafeMode->psm_wait = (VEML6035_power_saving_psm_wait_t)( auxPowerSafeMode & POWER_SAVING_PSM_WAIT_MASK );
+ myPowerSafeMode->psm_en = (VEML6035_power_saving_psm_en_t)( auxPowerSafeMode & POWER_SAVING_PSM_EN_MASK );
+
+
+
+ if ( aux == I2C_SUCCESS ) {
+ return VEML6035_SUCCESS;
+ } else {
+ return VEML6035_FAILURE;
+ }
+}
+
+
+
+/**
+ * @brief VEML6035_GetALS_HighResOutputData ( VEML6035_data_t* )
+ *
+ * @details It gets the ALS high resolution output data ( raw data ).
+ *
+ * @param[in] N/A.
+ *
+ * @param[out] myALS: ALS high resolution output data ( raw data ).
+ *
+ *
+ * @return Status of VEML6035_GetALS_HighResOutputData.
+ *
+ *
+ * @author Manuel Caballero
+ * @date 26/March/2020
+ * @version 26/March/2020 The ORIGIN
+ * @pre N/A
+ * @warning N/A.
+ */
+VEML6035::VEML6035_status_t VEML6035::VEML6035_GetALS_HighResOutputData ( VEML6035_data_t* myALS )
+{
+ char cmd[2] = {0U};
+ uint32_t aux;
+
+
+ /* Read the register */
+ cmd[0] = VEML6035_ALS;
+ aux = _i2c.write ( _VEML6035_Addr, &cmd[0], 1U, true );
+ aux |= _i2c.read ( _VEML6035_Addr, &cmd[0], sizeof( cmd )/sizeof( cmd[0] ) );
+
+ /* Parse the data */
+ myALS->als_high_resolution_output_data = cmd[0];
+ myALS->als_high_resolution_output_data <<= 8U;
+ myALS->als_high_resolution_output_data |= cmd[1];
+
+
+
+ if ( aux == I2C_SUCCESS ) {
+ return VEML6035_SUCCESS;
+ } else {
+ return VEML6035_FAILURE;
+ }
+}
+
+
+
+/**
+ * @brief VEML6035_GetWhiteChannelOutputData ( VEML6035_data_t* )
+ *
+ * @details It gets the white channel output data ( raw data ).
+ *
+ * @param[in] N/A.
+ *
+ * @param[out] myWhite: White channel output data ( raw data ).
+ *
+ *
+ * @return Status of VEML6035_GetWhiteChannelOutputData.
+ *
+ *
+ * @author Manuel Caballero
+ * @date 26/March/2020
+ * @version 26/March/2020 The ORIGIN
+ * @pre N/A
+ * @warning N/A.
+ */
+VEML6035::VEML6035_status_t VEML6035::VEML6035_GetWhiteChannelOutputData ( VEML6035_data_t* myWhite )
+{
+ char cmd[2] = {0U};
+ uint32_t aux;
+
+
+ /* Read the register */
+ cmd[0] = VEML6035_WHITE;
+ aux = _i2c.write ( _VEML6035_Addr, &cmd[0], 1U, true );
+ aux |= _i2c.read ( _VEML6035_Addr, &cmd[0], sizeof( cmd )/sizeof( cmd[0] ) );
+
+ /* Parse the data */
+ myWhite->white_channel_output_data = cmd[0];
+ myWhite->white_channel_output_data <<= 8U;
+ myWhite->white_channel_output_data |= cmd[1];
+
+
+
+ if ( aux == I2C_SUCCESS ) {
+ return VEML6035_SUCCESS;
+ } else {
+ return VEML6035_FAILURE;
+ }
+}
+
+
+
+/**
+ * @brief VEML6035_GetInterruptStatus ( VEML6035_data_t* )
+ *
+ * @details It gets the interrupt status.
+ *
+ * @param[in] N/A.
+ *
+ * @param[out] myIF: IF_L and IF_H.
+ *
+ *
+ * @return Status of VEML6035_GetInterruptStatus.
+ *
+ *
+ * @author Manuel Caballero
+ * @date 26/March/2020
+ * @version 26/March/2020 The ORIGIN
+ * @pre N/A
+ * @warning N/A.
+ */
+VEML6035::VEML6035_status_t VEML6035::VEML6035_GetInterruptStatus ( VEML6035_data_t* myIF )
+{
+ char cmd[2] = {0U};
+ uint16_t auxIntTriggerEvent = 0U;
+ uint32_t aux;
+
+
+ /* Read the register */
+ cmd[0] = VEML6035_ALS_INT;
+ aux = _i2c.write ( _VEML6035_Addr, &cmd[0], 1U, true );
+ aux |= _i2c.read ( _VEML6035_Addr, &cmd[0], sizeof( cmd )/sizeof( cmd[0] ) );
+
+ /* Parse the data */
+ auxIntTriggerEvent = cmd[0];
+ auxIntTriggerEvent <<= 8U;
+ auxIntTriggerEvent |= cmd[1];
+
+ myIF->int_th_high = (VEML6035_als_int_int_th_high_t)( auxIntTriggerEvent & ALS_INT_INT_TH_HIGH_MASK );
+ myIF->int_th_low = (VEML6035_als_int_int_th_low_t)( auxIntTriggerEvent & ALS_INT_INT_TH_LOW_MASK );
+
+
+
+ if ( aux == I2C_SUCCESS ) {
+ return VEML6035_SUCCESS;
+ } else {
+ return VEML6035_FAILURE;
+ }
+}
+
+
+
+/**
+ * @brief VEML6035_CalculateLuxLevel ( VEML6035_data_t* )
+ *
+ * @details It calculates the lux level and the current resolution.
+ *
+ * @param[in] myLux; Configuration Parameter.
+ *
+ * @param[out] myLux: Lux value and current resolution.
+ *
+ *
+ * @return N/A.
+ *
+ *
+ * @author Manuel Caballero
+ * @date 20/March/2020
+ * @version 20/March/2020 The ORIGIN
+ * @pre N/A
+ * @warning The device VEML6035 must be configured properly before calling this function.
+ * @warning VEML6035_GetALS_HighResOutputData function must be called before calling this function.
+ */
+void VEML6035::VEML6035_CalculateLuxLevel ( VEML6035_data_t* myLux )
+{
+ uint8_t auxGain = 0U, auxSens = 0U, auxDG = 0U;
+ uint16_t auxIT = 0U;
+
+ /* 1. Identify the parameters */
+ /* Integration time */
+ switch ( myLux->configuration.als_it ) {
+ case ALS_CONF_ALS_IT_25MS:
+ auxIT = 25U;
+ break;
+
+ case ALS_CONF_ALS_IT_50MS:
+ auxIT = 50U;
+ break;
+
+ default:
+ case ALS_CONF_ALS_IT_100MS:
+ auxIT = 100U;
+ break;
+
+ case ALS_CONF_ALS_IT_200MS:
+ auxIT = 200;
+ break;
+
+ case ALS_CONF_ALS_IT_400MS:
+ auxIT = 400;
+ break;
+
+ case ALS_CONF_ALS_IT_800MS:
+ auxIT = 800;
+ break;
+ }
+
+ /* Digital gain ( DG ) */
+ if ( myLux->configuration.als_dg == ALS_CONF_DG_NORMAL ) {
+ auxDG = 1U;
+ } else {
+ auxDG = 2U;
+ }
+
+ /* Gain */
+ if ( myLux->configuration.als_gain == ALS_CONF_GAIN_NORMAL_SENSITIVITY ) {
+ auxGain = 1U;
+ } else {
+ auxGain = 2U;
+ }
+
+ /* Sensitivity */
+ if ( myLux->configuration.als_sens == ALS_CONF_SENS_HIGH_SENSITIVITY ) {
+ auxSens = 1U;
+ } else {
+ auxSens = 8U;
+ }
+
+ /* 2. Calculate the current resolution */
+ myLux->resolution = (float)(VEML6035_MAXIMUM_RESOLUTION*(800U/auxIT)*(2U/auxDG)*(2U/auxGain)*auxSens);
+
+ /* 3. Calculate the lux value */
+ myLux->light_level = (float)( myLux->resolution * myLux->als_high_resolution_output_data );
+}
\ No newline at end of file
diff -r 1cc877ffc661 -r cce3af41ab18 VEML6035.h
--- a/VEML6035.h Thu Mar 26 20:17:41 2020 +0000
+++ b/VEML6035.h Fri Mar 27 20:24:34 2020 +0000
@@ -22,7 +22,122 @@
/**
Example:
@code
+#include "mbed.h"
+#include "VEML6035.h"
+VEML6035 myVEML6035 ( I2C_SDA, I2C_SCL, VEML6035::VEML6035_ADDRESS, 400000 );
+Serial pc ( USBTX, USBRX );
+
+DigitalOut myled ( LED1 );
+Ticker newReading;
+
+
+//@brief Variables.
+uint32_t myState = 0;
+
+//@brief FUNCTION PROTOTYPES
+void changeDATA ( void );
+
+
+
+//@brief FUNCTION FOR APPLICATION MAIN ENTRY.
+int main()
+{
+ VEML6035::VEML6035_data_t myVEML6035_Data;
+ VEML6035::VEML6035_status_t aux;
+
+ pc.baud ( 115200 );
+
+ myled = 1;
+ wait(3);
+ myled = 0;
+
+ // Power off the device
+ myVEML6035_Data.configuration.als_sd = VEML6035::ALS_CONF_ALS_SD_SHUTDOWN;
+ aux = myVEML6035.VEML6035_SetShutDownMode ( myVEML6035_Data );
+
+ // Set sensitivity: low sensitivity ( 1/8x )
+ myVEML6035_Data.configuration.als_sens = VEML6035::ALS_CONF_SENS_LOW_SENSITIVITY;
+ aux = myVEML6035.VEML6035_SetSensitivity ( myVEML6035_Data );
+
+ // Set digital gain (DG): Normal
+ myVEML6035_Data.configuration.als_dg = VEML6035::ALS_CONF_DG_DOUBLE;
+ aux = myVEML6035.VEML6035_SetDG ( myVEML6035_Data );
+
+ // Set Gain: Normal sensitivity
+ myVEML6035_Data.configuration.als_gain = VEML6035::ALS_CONF_GAIN_DOUBLE_SENSITIVITY;
+ aux = myVEML6035.VEML6035_SetGain ( myVEML6035_Data );
+
+ // Set ALS integration time: Integration time 800ms
+ myVEML6035_Data.configuration.als_it = VEML6035::ALS_CONF_ALS_IT_100MS;
+ aux = myVEML6035.VEML6035_SetIntegrationTime ( myVEML6035_Data );
+
+ // Set Channel enable function: ALS and WHITE CH enable
+ myVEML6035_Data.configuration.als_channel_en = VEML6035::ALS_CONF_ALS_CHANNEL_EN_ALS_WHITE_CH;
+ aux = myVEML6035.VEML6035_SetChannelEnable ( myVEML6035_Data );
+
+ // Set Interrupt: INT disable
+ myVEML6035_Data.configuration.als_int_en = VEML6035::ALS_CONF_ALS_INT_EN_INT_DISABLE;
+ aux = myVEML6035.VEML6035_SetInterruptEnable ( myVEML6035_Data );
+
+ // Set Power safe mode: PSM_WAIT 0.8s | PSM enabled
+ myVEML6035_Data.psm_wait = VEML6035::POWER_SAVING_PSM_WAIT_0_8_S;
+ myVEML6035_Data.psm_en = VEML6035::POWER_SAVING_PSM_EN_ENABLE;
+ aux = myVEML6035.VEML6035_SetPowerSafeMode ( myVEML6035_Data );
+
+ // Power on the device
+ myVEML6035_Data.configuration.als_sd = VEML6035::ALS_CONF_ALS_SD_POWER_ON;
+ aux = myVEML6035.VEML6035_SetShutDownMode ( myVEML6035_Data );
+
+ newReading.attach( &changeDATA, 1 ); // the address of the function to be attached ( changeDATA ) and the interval ( 1s )
+
+ // Let the callbacks take care of everything
+ while(1) {
+ sleep();
+
+ myled = 1;
+
+ if ( myState == 1 ) {
+ // Get the raw light data
+ aux = myVEML6035.VEML6035_GetALS_HighResOutputData ( &myVEML6035_Data );
+
+ // Get the raw white channel output data
+ aux = myVEML6035.VEML6035_GetWhiteChannelOutputData ( &myVEML6035_Data );
+
+ // Calculate light data and resolution
+ myVEML6035.VEML6035_CalculateLuxLevel ( &myVEML6035_Data );
+
+ // Transmit result over the UART
+ pc.printf( "White counter: %d | Lux: %0.4f lx | Resolution: %0.4f\r\n", myVEML6035_Data.white_channel_output_data, myVEML6035_Data.light_level, myVEML6035_Data.resolution );
+
+ myState = 0; // Reset the variable
+ }
+
+ myled = 0;
+ }
+}
+
+// @brief changeDATA ( void )
+//
+// @details It changes myState variable
+//
+// @param[in] N/A
+//
+// @param[out] N/A.
+//
+//
+// @return N/A.
+//
+//
+// @author Manuel Caballero
+// @date 27/March/2020
+// @version 27/March/2020 The ORIGIN
+// @pre N/A
+// @warning N/A.
+void changeDATA ( void )
+{
+ myState = 1;
+}
@endcode
*/
@@ -211,7 +326,7 @@
/**
* @brief APPLICATION
*/
- const float VEML6035_MAXIMUM_RESOLUTION = 0.0004; /*!< Maximum resolution */
+#define VEML6035_MAXIMUM_RESOLUTION (float)0.0004 /*!< Maximum resolution */
@@ -333,7 +448,7 @@
/** It gets the interrupt persistence value.
*/
- VEML6035_status_t VEML6035_GetInterruptPersistence ( IVEML6035_data_t* myALS_PERS );
+ VEML6035_status_t VEML6035_GetInterruptPersistence ( VEML6035_data_t* myALS_PERS );
/** It sets the channel interrupt value.
*/