From dd7d8fd52d1524213d10f83c49ec803201f38f58 Mon Sep 17 00:00:00 2001 From: Kirk Benell Date: Thu, 10 Jul 2025 16:42:42 -0600 Subject: [PATCH 01/25] update to new version needs --- LICENSE.md | 40 ++----------------- library.properties | 3 +- .../sfDevVEML7700.cpp} | 0 3 files changed, 5 insertions(+), 38 deletions(-) rename src/{SparkFun_VEML7700_Arduino_Library.cpp => sfTk/sfDevVEML7700.cpp} (100%) diff --git a/LICENSE.md b/LICENSE.md index 91e99ef..f618c0e 100644 --- a/LICENSE.md +++ b/LICENSE.md @@ -1,40 +1,6 @@ -SparkFun License Information -============================ +MIT License -SparkFun uses two different licenses for our files — one for hardware and one for code. - -Hardware ---------- - -**SparkFun hardware is released under [Creative Commons Share-alike 4.0 International](http://creativecommons.org/licenses/by-sa/4.0/).** - -Note: This is a human-readable summary of (and not a substitute for) the [license](http://creativecommons.org/licenses/by-sa/4.0/legalcode). - -You are free to: - -Share — copy and redistribute the material in any medium or format -Adapt — remix, transform, and build upon the material -for any purpose, even commercially. -The licensor cannot revoke these freedoms as long as you follow the license terms. -Under the following terms: - -Attribution — You must give appropriate credit, provide a link to the license, and indicate if changes were made. You may do so in any reasonable manner, but not in any way that suggests the licensor endorses you or your use. -ShareAlike — If you remix, transform, or build upon the material, you must distribute your contributions under the same license as the original. -No additional restrictions — You may not apply legal terms or technological measures that legally restrict others from doing anything the license permits. -Notices: - -You do not have to comply with the license for elements of the material in the public domain or where your use is permitted by an applicable exception or limitation. -No warranties are given. The license may not give you all of the permissions necessary for your intended use. For example, other rights such as publicity, privacy, or moral rights may limit how you use the material. - - -Code --------- - -**SparkFun code, firmware, and software is released under the MIT License(http://opensource.org/licenses/MIT).** - -The MIT License (MIT) - -Copyright (c) 2021 SparkFun Electronics +Copyright (c) 2025 SparkFun Electronics Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal @@ -52,4 +18,4 @@ 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. \ No newline at end of file +SOFTWARE. diff --git a/library.properties b/library.properties index 0579c20..e97a3bb 100644 --- a/library.properties +++ b/library.properties @@ -1,5 +1,5 @@ name=SparkFun VEML7700 Arduino Library -version=1.0.0 +version=2.0.0 author=SparkFun Electronics maintainer=SparkFun Electronics sentence=Library for the VEML7700 Ambient Light Sensor @@ -7,3 +7,4 @@ paragraph=An Arduino Library for the VEML7700 ambient light sensor. This library category=Sensors url=https://github.com/sparkfun/SparkFun_VEML7700_Arduino_Library architectures=* +depends=SparkFun Toolkit (>=1.2.0) diff --git a/src/SparkFun_VEML7700_Arduino_Library.cpp b/src/sfTk/sfDevVEML7700.cpp similarity index 100% rename from src/SparkFun_VEML7700_Arduino_Library.cpp rename to src/sfTk/sfDevVEML7700.cpp From eec243e8870a17d2a9122a46b4067af266367ab2 Mon Sep 17 00:00:00 2001 From: Kirk Benell Date: Thu, 10 Jul 2025 16:43:38 -0600 Subject: [PATCH 02/25] initial refactor of the library - not tested, not even compiled --- src/SparkFun_VEML7700_Arduino_Library.h | 285 ++------ src/sfTk/sfDevVEML7700.cpp | 840 ++++++------------------ src/sfTk/sfDevVEML7700.h | 215 ++++++ 3 files changed, 480 insertions(+), 860 deletions(-) create mode 100644 src/sfTk/sfDevVEML7700.h diff --git a/src/SparkFun_VEML7700_Arduino_Library.h b/src/SparkFun_VEML7700_Arduino_Library.h index 4362c3e..525e3ee 100644 --- a/src/SparkFun_VEML7700_Arduino_Library.h +++ b/src/SparkFun_VEML7700_Arduino_Library.h @@ -1,252 +1,59 @@ -/*! +/****************************************************************************** * @file SparkFun_VEML7700_Arduino_Library.h + * @brief SparkFun VEML7700 Library header file * - * SparkFun VEML7700 Ambient Light Sensor Arduino Library + * This file implements the SparkFunVEML7700 class + * for use with the SparkFun VEML7700 sensor qwiic breakout board * - * This library facilitates communication with the VEML7700 over I2C. + * @author SparkFUn Electronics + * @date 2021-2025 + * @version 2.0.0 + * @copyright (c) 2021=2025 SparkFun Electronics Inc. This project is released under the MIT License. * - * Want to support open source hardware? Buy a board from SparkFun! - *
SparkX smôl Environmental Peripheral Board (SPX-18976): https://www.sparkfun.com/products/18976 + * SPDX-License-Identifier: MIT * - * This library was written by: - * Paul Clark - * SparkFun Electronics - * November 4th 2021 - * - * Please see LICENSE.md for the license information - * - */ - -#ifndef __SFE_SMOL_POWER_BOARD__ -#define __SFE_SMOL_POWER_BOARD__ - -#include -#include - -typedef uint16_t VEML7700_t; - -/** VEML7700 I2C address */ -#define VEML7700_I2C_ADDRESS 0x10 - -/** VEML7700 error code returns */ -typedef enum -{ - VEML7700_ERROR_READ = -4, - VEML7700_ERROR_WRITE = -3, - VEML7700_ERROR_INVALID_ADDRESS = -2, - VEML7700_ERROR_UNDEFINED = -1, - VEML7700_ERROR_SUCCESS = 1 -} VEML7700_error_t; -const VEML7700_error_t VEML7700_SUCCESS = VEML7700_ERROR_SUCCESS; - -/** Sensitivity mode selection */ -typedef enum -{ - VEML7700_SENSITIVITY_x1, - VEML7700_SENSITIVITY_x2, - VEML7700_SENSITIVITY_x1_8, - VEML7700_SENSITIVITY_x1_4, - VEML7700_SENSITIVITY_INVALID -} VEML7700_sensitivity_mode_t; - -/** ALS integration time setting - Note: these are defined here in simple sequential order. - The actual register settings are defined in VEML7700_config_integration_time_t */ -typedef enum -{ - VEML7700_INTEGRATION_25ms, - VEML7700_INTEGRATION_50ms, - VEML7700_INTEGRATION_100ms, - VEML7700_INTEGRATION_200ms, - VEML7700_INTEGRATION_400ms, - VEML7700_INTEGRATION_800ms, - VEML7700_INTEGRATION_INVALID -} VEML7700_integration_time_t; - -/** ALS persistence protect number setting */ -typedef enum -{ - VEML7700_PERSISTENCE_1, - VEML7700_PERSISTENCE_2, - VEML7700_PERSISTENCE_4, - VEML7700_PERSISTENCE_8, - VEML7700_PERSISTENCE_INVALID -} VEML7700_persistence_protect_t; - -/** ALS interrupt enable setting */ -typedef enum -{ - VEML7700_INT_DISABLE, - VEML7700_INT_ENABLE, - VEML7700_INT_INVALID -} VEML7700_interrupt_enable_t; - -/** ALS interrupt status, logical OR of the crossing low and high thrteshold INT triggers */ -typedef enum -{ - VEML7700_INT_STATUS_NONE, - VEML7700_INT_STATUS_HIGH, - VEML7700_INT_STATUS_LOW, - VEML7700_INT_STATUS_BOTH, - VEML7700_INT_STATUS_INVALID -} VEML7700_interrupt_status_t; - -/** ALS shut down setting */ -typedef enum -{ - VEML7700_POWER_ON, - VEML7700_SHUT_DOWN, - VEML7700_SHUTDOWN_INVALID -} VEML7700_shutdown_t; - -/** Communication interface for the VEML7700 */ -class VEML7700 -{ -public: - /** @brief Class to communicate with the VEML7700 */ - VEML7700(); - - /** Begin the VEML7700. Default to Wire */ - bool begin(TwoWire &wirePort = Wire); + ******************************************************************************/ - /** Enable debug messages. Default to Serial */ - void enableDebugging(Stream &debugPort = Serial); - void disableDebugging(); +#pragma once - bool isConnected(); +// helps to keep the Toolkit header before the tk calls +// clang-format off +#include +#include "sfTk/sfDevVEML7700.h" +// clang-format on - /** Configuration controls */ - - VEML7700_error_t setShutdown(VEML7700_shutdown_t); - VEML7700_error_t powerOn() { return setShutdown(VEML7700_POWER_ON); }; - VEML7700_error_t shutdown() { return setShutdown(VEML7700_SHUT_DOWN); }; - VEML7700_shutdown_t getShutdown(); - - VEML7700_error_t setInterruptEnable(VEML7700_interrupt_enable_t ie); - VEML7700_error_t getInterruptEnable(VEML7700_interrupt_enable_t *ie); - VEML7700_interrupt_enable_t getInterruptEnable(); - - VEML7700_error_t setPersistenceProtect(VEML7700_persistence_protect_t pp); - VEML7700_error_t getPersistenceProtect(VEML7700_persistence_protect_t *pp); - VEML7700_persistence_protect_t getPersistenceProtect(); - const char * getPersistenceProtectStr(); - - VEML7700_error_t setIntegrationTime(VEML7700_integration_time_t it); - VEML7700_error_t getIntegrationTime(VEML7700_integration_time_t *it); - VEML7700_integration_time_t getIntegrationTime(); - const char * getIntegrationTimeStr(); - - VEML7700_error_t setSensitivityMode(VEML7700_sensitivity_mode_t sm); - VEML7700_error_t getSensitivityMode(VEML7700_sensitivity_mode_t *sm); - VEML7700_sensitivity_mode_t getSensitivityMode(); - const char * getSensitivityModeStr(); - - VEML7700_error_t setHighThreshold(uint16_t threshold); - VEML7700_error_t getHighThreshold(uint16_t *threshold); - uint16_t getHighThreshold(); - - VEML7700_error_t setLowThreshold(uint16_t threshold); - VEML7700_error_t getLowThreshold(uint16_t *threshold); - uint16_t getLowThreshold(); - - /** Read the sensor data */ - - VEML7700_error_t getAmbientLight(uint16_t *ambient); - uint16_t getAmbientLight(); - - VEML7700_error_t getWhiteLevel(uint16_t *whiteLevel); - uint16_t getWhiteLevel(); - - VEML7700_error_t getLux(float *lux); - float getLux(); - - /** Note: reading the interrupt status register clears the interrupts. - So, we need to check both interrupt flags in a single read. */ - VEML7700_error_t getInterruptStatus(VEML7700_interrupt_status_t *status); - VEML7700_interrupt_status_t getInterruptStatus(); - -private: - - /** Provide bit field access to the configuration register */ - typedef struct - { - union - { - VEML7700_t all; - struct - { - VEML7700_t CONFIG_REG_SD : 1; // ALS shut down - VEML7700_t CONFIG_REG_INT_EN : 1; // ALS interrupt enable - VEML7700_t CONFIG_REG_RES1 : 2; // Reserved - VEML7700_t CONFIG_REG_PERS : 2; // ALS persistence protect number - VEML7700_t CONFIG_REG_IT : 4; // ALS integration time - VEML7700_t CONFIG_REG_RES2 : 1; // Reserved - VEML7700_t CONFIG_REG_SM : 2; // ALS sensitivity mode - VEML7700_t CONFIG_REG_RES3 : 3; // Reserved - }; - }; - } VEML7700_CONFIGURATION_REGISTER_t; - VEML7700_CONFIGURATION_REGISTER_t _configurationRegister; - - /** Provide bit field access to the interrupt status register - Note: reading the interrupt status register clears the interrupts. - So, we need to check both interrupt flags in a single read. */ - typedef struct - { - union +/** + * @brief Class for interfacing with the VMEL7700 sensor using I2C communication + * + * This class provides methods to initialize and communicate with the BMV080 sensor + * over an I2C bus. It inherits from the sfDevVEML7700 class and uses the SparkFun + * Toolkit for I2C communication. + * + * @see sfDevVEML7700 + */ +class SparkFunVEML7700 : public sfDevVEML7700 +{ + public: + /** + * @brief Begins the Device with I2C as the communication bus + * + * This method initializes the I2C bus and sets up communication with the VEML7700 sensor. + * + * @param address I2C device address to use for the sensor + * @param wirePort Wire port to use for I2C communication + * @return True if successful, false otherwise + */ + bool begin(const uint8_t address = SF_VEML7700_DEFAULT_ADDRESS, TwoWire &wirePort = Wire) { - VEML7700_t all; - struct - { - VEML7700_t INT_STATUS_REG_RES : 14; // Reserved - // Bit 14 indicates if the high threshold was exceeded - // Bit 15 indicates if the low threshold was exceeded - VEML7700_t INT_STATUS_REG_INT_FLAGS : 2; - }; - }; - } VEML7700_INTERRUPT_STATUS_REGISTER_t; - - /** VEML7700 Registers */ - typedef enum - { - VEML7700_CONFIGURATION_REGISTER, - VEML7700_HIGH_THRESHOLD, - VEML7700_LOW_THRESHOLD, - VEML7700_ALS_OUTPUT = 4, - VEML7700_WHITE_OUTPUT, - VEML7700_INTERRUPT_STATUS - } VEML7700_registers_t; - - /** ALS integration time setting */ - typedef enum - { - VEML7700_CONFIG_INTEGRATION_25ms = 0b1100, - VEML7700_CONFIG_INTEGRATION_50ms = 0b1000, - VEML7700_CONFIG_INTEGRATION_100ms = 0b0000, - VEML7700_CONFIG_INTEGRATION_200ms = 0b0001, - VEML7700_CONFIG_INTEGRATION_400ms = 0b0010, - VEML7700_CONFIG_INTEGRATION_800ms = 0b0011, - VEML7700_CONFIG_INTEGRATION_INVALID - } VEML7700_config_integration_time_t; + // Setup Arduino I2C bus + _theI2CBus.init(wirePort, address); - TwoWire *_i2cPort; - Stream *_debugPort; - uint8_t _deviceAddress; - bool _debugEnabled; + // Begin the sensor + sfTkError_t rc = sfDevVEML7700::begin(&_theI2CBus); - VEML7700_error_t _connected(void); - - /** I2C Read/Write */ - VEML7700_error_t readI2CBuffer(uint8_t *dest, VEML7700_registers_t startRegister, uint16_t len); - VEML7700_error_t writeI2CBuffer(uint8_t *src, VEML7700_registers_t startRegister, uint16_t len); - VEML7700_error_t readI2CRegister(VEML7700_t *dest, VEML7700_registers_t registerAddress); - VEML7700_error_t writeI2CRegister(VEML7700_t data, VEML7700_registers_t registerAddress); - - /** Convert the (sequential) integration time into the corresponding (non-sequential) configuration value */ - VEML7700_config_integration_time_t integrationTimeConfig(VEML7700_integration_time_t it); - /** Convert the (non-sequential) integration time config into the corresponding (sequential) integration time */ - VEML7700_integration_time_t integrationTimeFromConfig(VEML7700_config_integration_time_t it); + return rc == ksfTkErrOk ? isConnected() : false; + } + private: + sfTkArdI2C _theI2CBus; }; - -#endif \ No newline at end of file diff --git a/src/sfTk/sfDevVEML7700.cpp b/src/sfTk/sfDevVEML7700.cpp index 2138b3b..31d5434 100644 --- a/src/sfTk/sfDevVEML7700.cpp +++ b/src/sfTk/sfDevVEML7700.cpp @@ -2,193 +2,120 @@ * @file SparkFun_VEML7700_Arduino_Library.h * * @mainpage SparkFun VEML7700 Ambient Light Sensor Arduino Library - * + * * @section intro_sec Introduction - * + * * This library facilitates communication with the VEML7700 over I2C. - * + * * Want to support open source hardware? Buy a board from SparkFun! - *
SparkX smôl Environmental Peripheral Board (SPX-18976): https://www.sparkfun.com/products/18976 - * + * * @section author Author - * + * * This library was written by: * Paul Clark * SparkFun Electronics * November 4th 2021 - * - * @section license License - * - * MIT: please see LICENSE.md for the full license information - * - */ + * + * @author SparkFun Electronics + * @date 2021-2025 + * @copyright Copyright (c) 2021-2025, SparkFun Electronics Inc. This project is released under the MIT License. + * + * SPDX-License-Identifier: MIT -#include "SparkFun_VEML7700_Arduino_Library.h" + * + */ -#define VEML7700_REGISTER_LENGTH 2 // 2 bytes per register (16-bit) -#define VEML7700_NUM_INTEGRATION_TIMES 6 // Number of supported integration times -#define VEML7700_NUM_GAIN_SETTINGS 4 // Number of supported gain settings -#define VEML7700_NUM_PERSISTENCE_PROTECT 4 // Number of supported persistence protect settings +#include "sfDevVEML7700.h" /** The sensor resolution vs. gain and integration time. Taken from the VEML7700 Application Note. */ -const float VEML7700_LUX_RESOLUTION[VEML7700_NUM_GAIN_SETTINGS][VEML7700_NUM_INTEGRATION_TIMES] = -{ -// 25ms 50ms 100ms 200ms 400ms 800ms - {0.2304, 0.1152, 0.0576, 0.0288, 0.0144, 0.0072}, // Gain (sensitivity) 1 - {0.1152, 0.0576, 0.0288, 0.0144, 0.0072, 0.0036}, // Gain (sensitivity) 2 - {1.8432, 0.9216, 0.4608, 0.2304, 0.1152, 0.0576}, // Gain (sensitivity) 1/8 - {0.9216, 0.4608, 0.2304, 0.1152, 0.0576, 0.0288} // Gain (sensitivity) 1/4 +const float VEML7700_LUX_RESOLUTION[VEML7700_SENSITIVITY_INVALID][VEML7700_INTEGRATION_INVALID] = { + // 25ms 50ms 100ms 200ms 400ms 800ms + {0.2304, 0.1152, 0.0576, 0.0288, 0.0144, 0.0072}, // Gain (sensitivity) 1 + {0.1152, 0.0576, 0.0288, 0.0144, 0.0072, 0.0036}, // Gain (sensitivity) 2 + {1.8432, 0.9216, 0.4608, 0.2304, 0.1152, 0.0576}, // Gain (sensitivity) 1/8 + {0.9216, 0.4608, 0.2304, 0.1152, 0.0576, 0.0288} // Gain (sensitivity) 1/4 }; /** The VEML7700 gain (sensitivity) settings as text (string) */ -const char *VEML7700_GAIN_SETTINGS[VEML7700_NUM_GAIN_SETTINGS + 1] = -{ - // Note: these are in the order defined by ALS_SM and VEML7700_sensitivity_mode_t - "x1","x2","x1/8","x1/4","INVALID" -}; +// Note: these are in the order defined by ALS_SM and VEML7700_sensitivity_mode_t +const char *kVEML7700GainSettingsString[VEML7700_SENSITIVITY_INVALID + 1] = {"x1", "x2", "x1/8", "x1/4", "INVALID"}; -/** The VEML7700 integration time settings as text (strting) */ -const char *VEML7700_INTEGRATION_TIMES[VEML7700_NUM_INTEGRATION_TIMES + 1] = -{ - // Note: these are in ascending (VEML7700_integration_time_t) order - // _not_ in ALS_IT (VEML7700_config_integration_time_t) order - "25ms","50ms","100ms","200ms","400ms","800ms","INVALID" -}; +/** The VEML7700 integration time settings as text (string) */ +const char *kVEML7799IntegrationTimesString[VEML7700_INTEGRATION_INVALID + 1] = {"25ms", "50ms", "100ms", "200ms", + "400ms", "800ms", "INVALID"}; /** The VEML7700 persistence protect settings as text (string) */ -const char *VEML7700_PERSISTENCE_PROTECT_SETTINGS[VEML7700_NUM_PERSISTENCE_PROTECT + 1] = -{ - "1", "2", "4", "8", "INVALID" -}; +const char *kVEML7700PersistenceProtectStrings[VEML7700_PERSISTENCE_INVALID + 1] = {"1", "2", "4", "8", "INVALID"}; -VEML7700::VEML7700() +//-------------------------------------------------------------------------------------------------- +// Helpful method - used by a majority of methods +sfTkError_t sfDevVEML7700::updateConfiguration(sfDevVEML7700Config_t &config) { - _i2cPort = NULL; - _debugPort = NULL; - _deviceAddress = VEML7700_I2C_ADDRESS; - _debugEnabled = false; -} + if (_theBus == nullptr) + return ksfTkErrBusNotInit; // Not initialized -/**************************************************************************/ -/*! - @brief Begin communication with the VEML7700 - @param wirePort -
The TwoWire (I2C) port used to communicate with the sensor. -
Default is Wire. - @return True if communication with the VEML7700 was successful, otherwise false. -*/ -/**************************************************************************/ -bool VEML7700::begin(TwoWire &wirePort) + return _theBus->readRegister((VEML7700_CONFIGURATION_REGISTER, config.all); +} +//-------------------------------------------------------------------------------------------------- +sfTkError_t sfDevVEML7700::begin(sfTkIBus *theBus)) { - VEML7700_error_t err; - _i2cPort = &wirePort; + // Nullptr check + if (theBus == nullptr) + return ksfTkErrBusNotInit; - /** Write _configurationRegister into the VEML7700_CONFIGURATION_REGISTER. - This will place the device into a known state, in case it was configured previously - and remained powered on when the code was restarted. */ + // Set bus pointer + _theBus = theBus; - _configurationRegister.all = 0x0000; // Clear the reserved bits - _configurationRegister.CONFIG_REG_SD = VEML7700_POWER_ON; - _configurationRegister.CONFIG_REG_INT_EN = VEML7700_INT_DISABLE; - _configurationRegister.CONFIG_REG_PERS = VEML7700_PERSISTENCE_1; - _configurationRegister.CONFIG_REG_IT = (VEML7700_t)integrationTimeConfig(VEML7700_INTEGRATION_100ms); - _configurationRegister.CONFIG_REG_SM = VEML7700_SENSITIVITY_x1; + /** Write _configurationRegister into the VEML7700_CONFIGURATION_REGISTER. + This will place the device into a known state, in case it was configured previously + and remained powered on when the code was restarted. */ + sfDevVEML7700Config_t configurationRegister; + configurationRegister.all = 0x0000; // Clear the reserved bits + configurationRegister.CONFIG_REG_SD = VEML7700_POWER_ON; + configurationRegister.CONFIG_REG_INT_EN = VEML7700_INT_DISABLE; + configurationRegister.CONFIG_REG_PERS = VEML7700_PERSISTENCE_1; + configurationRegister.CONFIG_REG_IT = (VEML7700_t)integrationTimeConfig(VEML7700_INTEGRATION_100ms); + configurationRegister.CONFIG_REG_SM = VEML7700_SENSITIVITY_x1; - err = writeI2CRegister(_configurationRegister.all, VEML7700_CONFIGURATION_REGISTER); - - if (_debugEnabled) - { - _debugPort->print(F("VEML7700::begin: I2C error: ")); - _debugPort->println(err); - } - - return (err == VEML7700_ERROR_SUCCESS); -} - -/**************************************************************************/ -/*! - @brief Enable debug messages on the chosen Serial port (Stream) - @param debugPort -
The Serial port (Stream) the debug messages will be printed to. -
Default is Serial. -*/ -/**************************************************************************/ -void VEML7700::enableDebugging(Stream &debugPort) -{ - _debugPort = &debugPort; - _debugEnabled = true; -} - -/**************************************************************************/ -/*! - @brief Disable debug messages -*/ -/**************************************************************************/ -void VEML7700::disableDebugging() -{ - _debugEnabled = false; + return theBus->writeRegister(VEML7700_CONFIGURATION_REGISTER, configurationRegister.all); } +//-------------------------------------------------------------------------------------------------- /**************************************************************************/ /*! @brief Check that the VEML7700 is awake and communicating. @return True if communication with the VEML7700 was successful, otherwise false. */ /**************************************************************************/ -boolean VEML7700::isConnected() +bool sfDevVEML7700::isConnected(void) { - if (_connected() != VEML7700_ERROR_SUCCESS) - { - return false; - } - return true; -} - -VEML7700_error_t VEML7700::_connected() -{ - VEML7700_error_t err; - - err = readI2CRegister((VEML7700_t *)&_configurationRegister, VEML7700_CONFIGURATION_REGISTER); - - if (err != VEML7700_ERROR_SUCCESS) - { - if (_debugEnabled) - { - _debugPort->print(F("VEML7700::_connected: error: ")); - _debugPort->println(err); - } - return err; - } - - if (_debugEnabled) _debugPort->println("VEML7700::_connected: success!"); - - return VEML7700_ERROR_SUCCESS; + sfDevVEML7700Config_t config; + return updateConfiguration(config) == ksfTkErrSuccess; } /**************************************************************************/ /*! @brief Set the VEML7700's shut down setting (ALS_SD) - @param sd + @param shutdown
The shut down setting. Possible values are:
VEML7700_POWER_ON
VEML7700_SHUT_DOWN - @return VEML7700_SUCCESS (VEML7700_ERROR_SUCCESS) if successful + */ /**************************************************************************/ -VEML7700_error_t VEML7700::setShutdown(VEML7700_shutdown_t sd) +sfTkError_t sfDevVEML7700::setShutdown(bool shutdown) { - VEML7700_error_t err; - err = readI2CRegister((VEML7700_t *)&_configurationRegister, VEML7700_CONFIGURATION_REGISTER); - if (err != VEML7700_ERROR_SUCCESS) - { - return err; - } + sfDevVEML7700Config_t config; + sfTkError_t rc = updateConfiguration(config); + + if (rc != ksfTkErrSuccess) + return rc; // Error reading the configuration register - _configurationRegister.CONFIG_REG_SD = (VEML7700_t)sd; + config.CONFIG_REG_SD = shutdown ? VEML7700_SHUT_DOWN : VEML7700_POWER_ON; - return writeI2CRegister(_configurationRegister.all, VEML7700_CONFIGURATION_REGISTER); + return theBus->writeRegister(VEML7700_CONFIGURATION_REGISTER, config.all); } /**************************************************************************/ @@ -197,17 +124,15 @@ VEML7700_error_t VEML7700::setShutdown(VEML7700_shutdown_t sd) @return VEML7700_POWER_ON or VEML7700_SHUT_DOWN if successful, VEML7700_SHUTDOWN_INVALID otherwise */ /**************************************************************************/ -VEML7700_shutdown_t VEML7700::getShutdown() +bool sfDevVEML7700::isShutdown(void) { - VEML7700_error_t err; + sfDevVEML7700Config_t config; + sfTkError_t rc = updateConfiguration(config); - err = readI2CRegister((VEML7700_t *)&_configurationRegister, VEML7700_CONFIGURATION_REGISTER); - if (err != VEML7700_ERROR_SUCCESS) - { - return VEML7700_SHUTDOWN_INVALID; - } + if (rc != ksfTkErrSuccess) + return true; // Error reading the configuration register - return ((VEML7700_shutdown_t)_configurationRegister.CONFIG_REG_SD); + return (((VEML7700_shutdown_t)_configurationRegister.CONFIG_REG_SD) == VEML7700_SHUT_DOWN); } /**************************************************************************/ @@ -220,19 +145,18 @@ VEML7700_shutdown_t VEML7700::getShutdown() @return VEML7700_SUCCESS (VEML7700_ERROR_SUCCESS) if successful */ /**************************************************************************/ -VEML7700_error_t VEML7700::setInterruptEnable(VEML7700_interrupt_enable_t ie) +sfTkError_t sfDevVEML7700::enableInterrupt(bool bEnable) { - VEML7700_error_t err; - err = readI2CRegister((VEML7700_t *)&_configurationRegister, VEML7700_CONFIGURATION_REGISTER); - if (err != VEML7700_ERROR_SUCCESS) - { - return err; - } + sfDevVEML7700Config_t config; + sfTkError_t rc = updateConfiguration(config); + + if (rc != ksfTkErrSuccess) + return rc; // Error reading the configuration register - _configurationRegister.CONFIG_REG_INT_EN = (VEML7700_t)ie; + config.CONFIG_REG_INT_EN = (VEML7700_t)bEnable; - return writeI2CRegister(_configurationRegister.all, VEML7700_CONFIGURATION_REGISTER); + return theBus->writeRegister(VEML7700_CONFIGURATION_REGISTER, config.all); } /**************************************************************************/ @@ -243,41 +167,16 @@ VEML7700_error_t VEML7700::setInterruptEnable(VEML7700_interrupt_enable_t ie) @return VEML7700_SUCCESS (VEML7700_ERROR_SUCCESS) if successful */ /**************************************************************************/ -VEML7700_error_t VEML7700::getInterruptEnable(VEML7700_interrupt_enable_t *ie) +bool sfDevVEML7700::interruptEnabled(void) { - VEML7700_error_t err; - - err = readI2CRegister((VEML7700_t *)&_configurationRegister, VEML7700_CONFIGURATION_REGISTER); - - if (err == VEML7700_ERROR_SUCCESS) - { - *ie = (VEML7700_interrupt_enable_t)_configurationRegister.CONFIG_REG_INT_EN; - } - else - { - *ie = VEML7700_INT_INVALID; - } - - return (err); -} -/**************************************************************************/ -/*! - @brief Get the VEML7700's interrupt enable setting (ALS_INT_EN) - @return VEML7700_INT_DISABLE or VEML7700_INT_ENABLE if successful, VEML7700_INT_INVALID otherwise -*/ -/**************************************************************************/ -VEML7700_interrupt_enable_t VEML7700::getInterruptEnable() -{ - VEML7700_error_t err; + sfDevVEML7700Config_t config; + sfTkError_t rc = updateConfiguration(config); - err = readI2CRegister((VEML7700_t *)&_configurationRegister, VEML7700_CONFIGURATION_REGISTER); - if (err != VEML7700_ERROR_SUCCESS) - { - return VEML7700_INT_INVALID; - } + if (rc != ksfTkErrSuccess) + return false; // Error reading the configuration register - return ((VEML7700_interrupt_enable_t)_configurationRegister.CONFIG_REG_INT_EN); + return config.CONFIG_REG_INT_EN == VEML7700_INT_ENABLE; } /**************************************************************************/ @@ -292,19 +191,19 @@ VEML7700_interrupt_enable_t VEML7700::getInterruptEnable() @return VEML7700_SUCCESS (VEML7700_ERROR_SUCCESS) if successful */ /**************************************************************************/ -VEML7700_error_t VEML7700::setPersistenceProtect(VEML7700_persistence_protect_t pp) +sfTkError_t sfDevVEML7700::setPersistenceProtect(VEML7700_persistence_protect_t pp) { - VEML7700_error_t err; + if (pp >= VEML7700_PERSISTENCE_INVALID) + return ksfTkErrInvalidParam; - err = readI2CRegister((VEML7700_t *)&_configurationRegister, VEML7700_CONFIGURATION_REGISTER); - if (err != VEML7700_ERROR_SUCCESS) - { - return err; - } + sfDevVEML7700Config_t config; + sfTkError_t rc = updateConfiguration(config); - _configurationRegister.CONFIG_REG_PERS = (VEML7700_t)pp; + if (rc != ksfTkErrSuccess) + return rc; // Error reading the configuration register - return writeI2CRegister(_configurationRegister.all, VEML7700_CONFIGURATION_REGISTER); + config.CONFIG_REG_PERS = (VEML7700_t)pp; + return theBus->writeRegister(VEML7700_CONFIGURATION_REGISTER, config.all); } /**************************************************************************/ @@ -315,47 +214,15 @@ VEML7700_error_t VEML7700::setPersistenceProtect(VEML7700_persistence_protect_t @return VEML7700_SUCCESS (VEML7700_ERROR_SUCCESS) if successful */ /**************************************************************************/ -VEML7700_error_t VEML7700::getPersistenceProtect(VEML7700_persistence_protect_t *pp) +VEML7700_persistence_protect_t sfDevVEML7700::persistenceProtect(void) { - VEML7700_error_t err; - - err = readI2CRegister((VEML7700_t *)&_configurationRegister, VEML7700_CONFIGURATION_REGISTER); - - if (err == VEML7700_ERROR_SUCCESS) - { - *pp = (VEML7700_persistence_protect_t)_configurationRegister.CONFIG_REG_PERS; - } - else - { - *pp = VEML7700_PERSISTENCE_INVALID; - } - - return (err); -} + sfDevVEML7700Config_t config; + sfTkError_t rc = updateConfiguration(config); -/**************************************************************************/ -/*! - @brief Get the VEML7700's persistence protect number setting (ALS_PERS) - @return If successful: -
VEML7700_PERSISTENCE_1 -
VEML7700_PERSISTENCE_2 -
VEML7700_PERSISTENCE_4 -
VEML7700_PERSISTENCE_8 -
Otherwise: -
VEML7700_PERSISTENCE_INVALID -*/ -/**************************************************************************/ -VEML7700_persistence_protect_t VEML7700::getPersistenceProtect() -{ - VEML7700_error_t err; - - err = readI2CRegister((VEML7700_t *)&_configurationRegister, VEML7700_CONFIGURATION_REGISTER); - if (err != VEML7700_ERROR_SUCCESS) - { - return VEML7700_PERSISTENCE_INVALID; - } + if (rc != ksfTkErrSuccess) + return VEML7700_PERSISTENCE_INVALID; // Error reading the configuration register - return ((VEML7700_persistence_protect_t)_configurationRegister.CONFIG_REG_PERS); + return (VEML7700_persistence_protect_t)config.CONFIG_REG_PERS; } /**************************************************************************/ @@ -363,13 +230,14 @@ VEML7700_persistence_protect_t VEML7700::getPersistenceProtect() @brief Get the VEML7700's persistence protect number setting (ALS_PERS) as printable text */ /**************************************************************************/ -const char * VEML7700::getPersistenceProtectStr() +const char *sfDevVEML7700::persistenceProtectString(void) { - VEML7700_persistence_protect_t pp; + VEML7700_persistence_protect_t pp = persistenceProtect(); - getPersistenceProtect(&pp); + if (pp < VEML7700_PERSISTENCE_1 || pp >= VEML7700_PERSISTENCE_INVALID) + return "INVALID"; // Invalid persistence protect setting - return (VEML7700_PERSISTENCE_PROTECT_SETTINGS[pp]); + return kVEML7700PersistenceProtectStrings[pp]; } /**************************************************************************/ @@ -388,45 +256,20 @@ const char * VEML7700::getPersistenceProtectStr() @return VEML7700_SUCCESS (VEML7700_ERROR_SUCCESS) if successful */ /**************************************************************************/ -VEML7700_error_t VEML7700::setIntegrationTime(VEML7700_integration_time_t it) +sfTkError_t sfDevVEML7700::setIntegrationTime(VEML7700_integration_time_t it) { - VEML7700_error_t err; - err = readI2CRegister((VEML7700_t *)&_configurationRegister, VEML7700_CONFIGURATION_REGISTER); - if (err != VEML7700_ERROR_SUCCESS) - { - return err; - } + if (it >= VEML7700_INTEGRATION_INVALID) + return ksfTkErrInvalidParam; // Invalid integration time setting - _configurationRegister.CONFIG_REG_IT = (VEML7700_t)integrationTimeConfig(it); + sfDevVEML7700Config_t config; + sfTkError_t rc = updateConfiguration(config); - return writeI2CRegister(_configurationRegister.all, VEML7700_CONFIGURATION_REGISTER); -} + if (rc != ksfTkErrSuccess) + return rc; // Error reading the configuration register -/**************************************************************************/ -/*! - @brief Get the VEML7700's integration time setting (ALS_IT) - @param it -
Will be set to the intergration time setting on return - @return VEML7700_SUCCESS (VEML7700_ERROR_SUCCESS) if successful -*/ -/**************************************************************************/ -VEML7700_error_t VEML7700::getIntegrationTime(VEML7700_integration_time_t *it) -{ - VEML7700_error_t err; - - err = readI2CRegister((VEML7700_t *)&_configurationRegister, VEML7700_CONFIGURATION_REGISTER); - - if (err == VEML7700_ERROR_SUCCESS) - { - *it = (VEML7700_integration_time_t)integrationTimeFromConfig((VEML7700_config_integration_time_t)_configurationRegister.CONFIG_REG_IT); - } - else - { - *it = VEML7700_INTEGRATION_INVALID; - } - - return (err); + config.CONFIG_REG_IT = (VEML7700_t)integrationTimeConfig(it); + return theBus->writeRegister(VEML7700_CONFIGURATION_REGISTER, config.all); } /**************************************************************************/ @@ -443,17 +286,16 @@ VEML7700_error_t VEML7700::getIntegrationTime(VEML7700_integration_time_t *it)
VEML7700_INTEGRATION_INVALID */ /**************************************************************************/ -VEML7700_integration_time_t VEML7700::getIntegrationTime() +VEML7700_integration_time_t sfDevVEML7700::integrationTime(void) { - VEML7700_error_t err; + sfDevVEML7700Config_t config; + sfTkError_t rc = updateConfiguration(config); - err = readI2CRegister((VEML7700_t *)&_configurationRegister, VEML7700_CONFIGURATION_REGISTER); - if (err != VEML7700_ERROR_SUCCESS) - { - return VEML7700_INTEGRATION_INVALID; - } + if (rc != ksfTkErrSuccess) + return VEML7700_INTEGRATION_INVALID; // Error reading the configuration register - return ((VEML7700_integration_time_t)integrationTimeFromConfig((VEML7700_config_integration_time_t)_configurationRegister.CONFIG_REG_IT)); + return ((VEML7700_integration_time_t)integrationTimeFromConfig( + (VEML7700_config_integration_time_t)config.CONFIG_REG_IT)); } /**************************************************************************/ @@ -461,13 +303,14 @@ VEML7700_integration_time_t VEML7700::getIntegrationTime() @brief Get the VEML7700's integration time setting (ALS_IT) as printable text */ /**************************************************************************/ -const char * VEML7700::getIntegrationTimeStr() +const char *sfDevVEML7700::integrationTimeString(void) { - VEML7700_integration_time_t it; + VEML7700_integration_time_t it = integrationTime(); - getIntegrationTime(&it); + if (it < VEML7700_INTEGRATION_25ms || it >= VEML7700_INTEGRATION_INVALID) + return "INVALID"; // Invalid integration time setting - return (VEML7700_INTEGRATION_TIMES[it]); + return kVEML7799IntegrationTimesString[it]; } /**************************************************************************/ @@ -482,45 +325,19 @@ const char * VEML7700::getIntegrationTimeStr() @return VEML7700_SUCCESS (VEML7700_ERROR_SUCCESS) if successful */ /**************************************************************************/ -VEML7700_error_t VEML7700::setSensitivityMode(VEML7700_sensitivity_mode_t sm) +sfTkError_t sfDevVEML7700::setSensitivityMode(VEML7700_sensitivity_mode_t sm) { - VEML7700_error_t err; + if (sm >= VEML7700_SENSITIVITY_INVALID) + return ksfTkErrInvalidParam; - err = readI2CRegister((VEML7700_t *)&_configurationRegister, VEML7700_CONFIGURATION_REGISTER); - if (err != VEML7700_ERROR_SUCCESS) - { - return err; - } + sfDevVEML7700Config_t config; + sfTkError_t rc = updateConfiguration(config); - _configurationRegister.CONFIG_REG_SM = (VEML7700_t)sm; + if (rc != ksfTkErrSuccess) + return rc; // Error reading the configuration register - return writeI2CRegister(_configurationRegister.all, VEML7700_CONFIGURATION_REGISTER); -} - -/**************************************************************************/ -/*! - @brief Get the VEML7700's sensitivity mode selection (ALS_SM) - @param sm -
Will be set to the sensitivity mode selection on return - @return VEML7700_SUCCESS (VEML7700_ERROR_SUCCESS) if successful -*/ -/**************************************************************************/ -VEML7700_error_t VEML7700::getSensitivityMode(VEML7700_sensitivity_mode_t *sm) -{ - VEML7700_error_t err; - - err = readI2CRegister((VEML7700_t *)&_configurationRegister, VEML7700_CONFIGURATION_REGISTER); - - if (err == VEML7700_ERROR_SUCCESS) - { - *sm = (VEML7700_sensitivity_mode_t)_configurationRegister.CONFIG_REG_SM; - } - else - { - *sm = VEML7700_SENSITIVITY_INVALID; - } - - return (err); + config.CONFIG_REG_SM = (VEML7700_t)sm; + return theBus->writeRegister(VEML7700_CONFIGURATION_REGISTER, config.all); } /**************************************************************************/ @@ -535,17 +352,15 @@ VEML7700_error_t VEML7700::getSensitivityMode(VEML7700_sensitivity_mode_t *sm)
VEML7700_SENSITIVITY_INVALID */ /**************************************************************************/ -VEML7700_sensitivity_mode_t VEML7700::getSensitivityMode() +VEML7700_sensitivity_mode_t sfDevVEML7700::sensitivityMode() { - VEML7700_error_t err; + sfDevVEML7700Config_t config; + sfTkError_t rc = updateConfiguration(config); - err = readI2CRegister((VEML7700_t *)&_configurationRegister, VEML7700_CONFIGURATION_REGISTER); - if (err != VEML7700_ERROR_SUCCESS) - { - return VEML7700_SENSITIVITY_INVALID; - } + if (rc != ksfTkErrSuccess) + return VEML7700_SENSITIVITY_INVALID; // Error reading the configuration register - return ((VEML7700_sensitivity_mode_t)_configurationRegister.CONFIG_REG_SM); + return ((VEML7700_sensitivity_mode_t)config.CONFIG_REG_SM); } /**************************************************************************/ @@ -553,13 +368,15 @@ VEML7700_sensitivity_mode_t VEML7700::getSensitivityMode() @brief Get the VEML7700's sensitivity mode selection (ALS_SM) as printable text */ /**************************************************************************/ -const char * VEML7700::getSensitivityModeStr() +const char *sfDevVEML7700::sensitivityModeString() { - VEML7700_sensitivity_mode_t sm; + VEML7700_sensitivity_mode_t sm = sensitivityMode() - getSensitivityMode(&sm); + if (sm < VEML7700_SENSITIVITY_x1 || + sm >= VEML7700_SENSITIVITY_INVALID) return "INVALID"; // Invalid sensitivity mode setting + getSensitivityMode(&sm); - return (VEML7700_GAIN_SETTINGS[sm]); + return kVEML7700GainSettingsString[sm]; } /**************************************************************************/ @@ -570,35 +387,23 @@ const char * VEML7700::getSensitivityModeStr() @return VEML7700_SUCCESS (VEML7700_ERROR_SUCCESS) if successful */ /**************************************************************************/ -VEML7700_error_t VEML7700::setHighThreshold(uint16_t threshold) -{ - return (writeI2CRegister((VEML7700_t)threshold, VEML7700_HIGH_THRESHOLD)); -} - -/**************************************************************************/ -/*! - @brief Get the VEML7700's ALS high threshold window setting (ALS_WH) - @param threshold -
Will be set to the threshold setting on return - @return VEML7700_SUCCESS (VEML7700_ERROR_SUCCESS) if successful -*/ -/**************************************************************************/ -VEML7700_error_t VEML7700::getHighThreshold(uint16_t *threshold) +sfTkError_t sfDevVEML7700::setHighThreshold(uint16_t threshold) { - return (readI2CRegister((VEML7700_t *)threshold, VEML7700_HIGH_THRESHOLD)); + return theBus->writeRegister(VEML7700_HIGH_THRESHOLD, threshold); } /**************************************************************************/ /*! @brief Get the VEML7700's ALS high threshold window setting (ALS_WH) - @return The threshold setting + @return The threshold setting, or 0xFFFF on error */ /**************************************************************************/ -uint16_t VEML7700::getHighThreshold() +uint16_t sfDevVEML7700::highThreshold(void) { - uint16_t threshold; - getHighThreshold(&threshold); - return (threshold); + uint16_t threshold; + sfTkError_t rc =_theBus->readRegister((VEML7700_HIGH_THRESHOLD, threshold); + + return rc == ksfTkErrSuccess ? threshold : kVEML7700ValueError; // Return 0xFFFF on error } /**************************************************************************/ @@ -609,22 +414,9 @@ uint16_t VEML7700::getHighThreshold() @return VEML7700_SUCCESS (VEML7700_ERROR_SUCCESS) if successful */ /**************************************************************************/ -VEML7700_error_t VEML7700::setLowThreshold(uint16_t threshold) +sfTkError_t sfDevVEML7700::setLowThreshold(uint16_t threshold) { - return (writeI2CRegister((VEML7700_t)threshold, VEML7700_LOW_THRESHOLD)); -} - -/**************************************************************************/ -/*! - @brief Get the VEML7700's ALS low threshold window setting (ALS_WL) - @param threshold -
Will be set to the threshold setting on return - @return VEML7700_SUCCESS (VEML7700_ERROR_SUCCESS) if successful -*/ -/**************************************************************************/ -VEML7700_error_t VEML7700::getLowThreshold(uint16_t *threshold) -{ - return (readI2CRegister((VEML7700_t *)threshold, VEML7700_LOW_THRESHOLD)); + return theBus->writeRegister(VEML7700_LOW_THRESHOLD, threshold); } /**************************************************************************/ @@ -633,24 +425,12 @@ VEML7700_error_t VEML7700::getLowThreshold(uint16_t *threshold) @return The threshold setting */ /**************************************************************************/ -uint16_t VEML7700::getLowThreshold() +uint16_t sfDevVEML7700::lowThreshold(void) { - uint16_t threshold; - getLowThreshold(&threshold); - return (threshold); -} - -/**************************************************************************/ -/*! - @brief Get the VEML7700's ambient light sensor data (ALS) - @param ambient -
Will be set to the ambient level on return - @return VEML7700_SUCCESS (VEML7700_ERROR_SUCCESS) if successful -*/ -/**************************************************************************/ -VEML7700_error_t VEML7700::getAmbientLight(uint16_t *ambient) -{ - return (readI2CRegister((VEML7700_t *)ambient, VEML7700_ALS_OUTPUT)); + uint16_t threshold; + sfTkError_t rc =_theBus->readRegister((VEML7700_LOW_THRESHOLD, threshold); + + return rc == ksfTkErrSuccess ? threshold : kVEML7700ValueError; // Return 0xFFFF on error } /**************************************************************************/ @@ -659,24 +439,13 @@ VEML7700_error_t VEML7700::getAmbientLight(uint16_t *ambient) @return The ambient light reading */ /**************************************************************************/ -uint16_t VEML7700::getAmbientLight() +uint16_t sfDevVEML7700::readAmbientLight(void) { - uint16_t ambient; - getAmbientLight(&ambient); - return (ambient); -} -/**************************************************************************/ -/*! - @brief Get the VEML7700's white level data (WHITE) - @param whiteLevel -
Will be set to the white level on return - @return VEML7700_SUCCESS (VEML7700_ERROR_SUCCESS) if successful -*/ -/**************************************************************************/ -VEML7700_error_t VEML7700::getWhiteLevel(uint16_t *whiteLevel) -{ - return (readI2CRegister((VEML7700_t *)whiteLevel, VEML7700_WHITE_OUTPUT)); + uint16_t ambient; + sfTkError_t rc =_theBus->readRegister((VEML7700_ALS_OUTPUT, ambient); + + return rc == ksfTkErrSuccess ? ambient : kVEML7700ValueError; } /**************************************************************************/ @@ -685,11 +454,12 @@ VEML7700_error_t VEML7700::getWhiteLevel(uint16_t *whiteLevel) @return The white level reading */ /**************************************************************************/ -uint16_t VEML7700::getWhiteLevel() +uint16_t sfDevVEML7700::readWhiteLevel(void) { - uint16_t whiteLevel; - getWhiteLevel(&whiteLevel); - return (whiteLevel); + uint16_t whiteLevel; + sfTkError_t rc =_theBus->readRegister((VEML7700_WHITE_OUTPUT, whiteLevel); + + return rc == ksfTkErrSuccess ? whiteLevel : kVEML7700ValueError; } /**************************************************************************/ @@ -700,84 +470,30 @@ uint16_t VEML7700::getWhiteLevel() @return VEML7700_SUCCESS (VEML7700_ERROR_SUCCESS) if successful */ /**************************************************************************/ -VEML7700_error_t VEML7700::getLux(float *lux) +float sfDevVEML7700::readLux(void) { - /** First, we need to extract the correct resolution from the VEML7700_LUX_RESOLUTION - gain and integration time look up table. Let's begin by reading the gain - (sensitivity) and integration time. */ - - VEML7700_error_t err; - VEML7700_sensitivity_mode_t sm; - - err = getSensitivityMode(&sm); - - if (err != VEML7700_ERROR_SUCCESS) - return (err); - - if (_debugEnabled) - { - _debugPort->print(F("VEML7700::getLux: gain / sensitivity: ")); - _debugPort->println(VEML7700_GAIN_SETTINGS[sm]); - } - - VEML7700_integration_time_t it; - - err = getIntegrationTime(&it); - - if (err != VEML7700_ERROR_SUCCESS) - return (err); - - if (_debugEnabled) - { - _debugPort->print(F("VEML7700::getLux: integration time: ")); - _debugPort->println(VEML7700_INTEGRATION_TIMES[it]); - } + /** First, we need to extract the correct resolution from the VEML7700_LUX_RESOLUTION + gain and integration time look up table. Let's begin by reading the gain + (sensitivity) and integration time. */ - /** Now we can extract the correct resolution from the look up table. */ - float resolution = VEML7700_LUX_RESOLUTION[sm][it]; + VEML7700_sensitivity_mode_t senseMode = sensitivityMode(); - if (_debugEnabled) - { - _debugPort->print(F("VEML7700::getLux: resolution: ")); - _debugPort->println(resolution, 4); - } + if (senseMode == VEML7700_SENSITIVITY_INVALID) + return 0.0; - /** Now we read the ambient level and multiply it by the resolution */ - uint16_t ambient; + VEML7700_integration_time_t intTime = integrationTime(); - err = getAmbientLight(&ambient); + if (intTime == VEML7700_INTEGRATION_INVALID) + return 0.0; - if (err != VEML7700_ERROR_SUCCESS) - return (err); + /** Now we read the ambient level and multiply it by the resolution */ + uint16_t ambient = ambientLight(); - if (_debugEnabled) - { - _debugPort->print(F("VEML7700::getLux: ambient: ")); - _debugPort->println(ambient); - } + if (ambient == kVEML7700ValueError) + return 0.0; - *lux = (float)ambient * resolution; - - if (_debugEnabled) - { - _debugPort->print(F("VEML7700::getLux: lux: ")); - _debugPort->println(*lux, 4); - } - - return (VEML7700_ERROR_SUCCESS); -} - -/**************************************************************************/ -/*! - @brief Read the sensor data and calculate the lux - @return The lux -*/ -/**************************************************************************/ -float VEML7700::getLux() -{ - float lux = 0.0; - getLux(&lux); - return (lux); + // Apply the resolution to the ambient light reading + return (float)ambient * VEML7700_LUX_RESOLUTION[senseMode][intTime]; } /**************************************************************************/ @@ -797,171 +513,53 @@ float VEML7700::getLux() @return VEML7700_SUCCESS (VEML7700_ERROR_SUCCESS) if successful */ /**************************************************************************/ -VEML7700_error_t VEML7700::getInterruptStatus(VEML7700_interrupt_status_t *status) +VEML7700_interrupt_status_t sfDevVEML7700::interruptStatus(void) { - VEML7700_error_t err; - VEML7700_INTERRUPT_STATUS_REGISTER_t isr; - - err = readI2CRegister((VEML7700_t *)&isr, VEML7700_INTERRUPT_STATUS); + VEML7700_error_t err; + VEML7700_INTERRUPT_STATUS_REGISTER_t isr; - if (err == VEML7700_ERROR_SUCCESS) - { - *status = (VEML7700_interrupt_status_t)isr.INT_STATUS_REG_INT_FLAGS; - } - else - { - *status = VEML7700_INT_STATUS_INVALID; - } + uint16_t ambient; + sfTkError_t rc =_theBus->readRegister((VEML7700_INTERRUPT_STATUS, isr.all); - return (err); + return rc != ksfTkErrSuccess ? VEML7700_INT_STATUS_INVALID : (VEML7700_interrupt_status_t)isr.INT_STATUS_REG_INT_FLAGS; } -/**************************************************************************/ -/*! - @brief Read the VEML7700's interrupt status register -
Note: reading the interrupt status register clears the interrupts. -
So, we need to check both interrupt flags in a single read. - @return If successful: -
VEML7700_INT_STATUS_NONE -
VEML7700_INT_STATUS_HIGH -
VEML7700_INT_STATUS_LOW -
VEML7700_INT_STATUS_BOTH -
Otherwise: -
VEML7700_INT_STATUS_INVALID -*/ -/**************************************************************************/ -VEML7700_interrupt_status_t VEML7700::getInterruptStatus() +sfDevVEML7700::VEML7700_config_integration_time_t sfDevVEML7700::integrationTimeConfig(VEML7700_integration_time_t it) { - VEML7700_error_t err; - VEML7700_INTERRUPT_STATUS_REGISTER_t isr; - - err = readI2CRegister((VEML7700_t *)&isr, VEML7700_INTERRUPT_STATUS); + // since the value of integration time is defined in a simple sequential order, and the intput is typed, + // just use a translation table. + VEML7700_config_integration_time_t table[] = {VEML7700_CONFIG_INTEGRATION_25ms, VEML7700_CONFIG_INTEGRATION_50ms, + VEML7700_CONFIG_INTEGRATION_100ms, VEML7700_CONFIG_INTEGRATION_200ms, + VEML7700_CONFIG_INTEGRATION_400ms, VEML7700_CONFIG_INTEGRATION_800ms]; - if (err != VEML7700_ERROR_SUCCESS) - return (VEML7700_INT_STATUS_INVALID); - - return ((VEML7700_interrupt_status_t)isr.INT_STATUS_REG_INT_FLAGS); + return tt < VEML7700_INTEGRATION_INVALID ? table[tt] : VEML7700_CONFIG_INTEGRATION_INVALID; } -VEML7700_error_t VEML7700::readI2CBuffer(uint8_t *dest, VEML7700_registers_t startRegister, uint16_t len) +VEML7700_integration_time_t sfDevVEML7700::integrationTimeFromConfig( + sfDevVEML7700::VEML7700_config_integration_time_t it) { - _i2cPort->beginTransmission(_deviceAddress); - _i2cPort->write(startRegister); - if (_i2cPort->endTransmission(false) != 0) - { - if (_debugEnabled) _debugPort->println(F("VEML7700::readI2CBuffer: endTransmission error")); - return VEML7700_ERROR_READ; - } - - _i2cPort->requestFrom(_deviceAddress, (uint8_t)len); - if (_debugEnabled) - { - _debugPort->print(F("VEML7700::readI2CBuffer: register: 0x")); - _debugPort->println(startRegister, HEX); - _debugPort->print(F("VEML7700::readI2CBuffer: device returned:")); - } - for (uint16_t i = 0; i < len; i++) - { - dest[i] = _i2cPort->read(); - if (_debugEnabled) + switch (it) { - _debugPort->print(F(" 0x")); - _debugPort->print(dest[i], HEX); - } - } - if (_debugEnabled) _debugPort->println(F("")); - - return VEML7700_ERROR_SUCCESS; -} - -VEML7700_error_t VEML7700::writeI2CBuffer(uint8_t *src, VEML7700_registers_t startRegister, uint16_t len) -{ - _i2cPort->beginTransmission(_deviceAddress); - _i2cPort->write(startRegister); - for (uint16_t i = 0; i < len; i++) - { - _i2cPort->write(src[i]); - } - if (_i2cPort->endTransmission(true) != 0) - { - return VEML7700_ERROR_WRITE; - } - return VEML7700_ERROR_SUCCESS; -} - -VEML7700_error_t VEML7700::readI2CRegister(VEML7700_t *dest, VEML7700_registers_t registerAddress) -{ - VEML7700_error_t err; - uint8_t tempDest[2]; - err = readI2CBuffer(tempDest, registerAddress, VEML7700_REGISTER_LENGTH); - if (err == VEML7700_ERROR_SUCCESS) - { - *dest = (tempDest[0]) | ((VEML7700_t)tempDest[1] << 8); - } - return err; -} - -VEML7700_error_t VEML7700::writeI2CRegister(VEML7700_t data, VEML7700_registers_t registerAddress) -{ - uint8_t d[2]; - // Write LSB first - d[0] = (uint8_t)(data & 0x00FF); - d[1] = (uint8_t)((data & 0xFF00) >> 8); - return writeI2CBuffer(d, registerAddress, VEML7700_REGISTER_LENGTH); -} - -VEML7700::VEML7700_config_integration_time_t VEML7700::integrationTimeConfig(VEML7700_integration_time_t it) -{ - switch (it) - { - case VEML7700_INTEGRATION_25ms: - return (VEML7700_CONFIG_INTEGRATION_25ms); - break; - case VEML7700_INTEGRATION_50ms: - return (VEML7700_CONFIG_INTEGRATION_50ms); - break; - case VEML7700_INTEGRATION_100ms: - return (VEML7700_CONFIG_INTEGRATION_100ms); - break; - case VEML7700_INTEGRATION_200ms: - return (VEML7700_CONFIG_INTEGRATION_200ms); - break; - case VEML7700_INTEGRATION_400ms: - return (VEML7700_CONFIG_INTEGRATION_400ms); - break; - case VEML7700_INTEGRATION_800ms: - return (VEML7700_CONFIG_INTEGRATION_800ms); - break; - default: - break; - } - return (VEML7700_CONFIG_INTEGRATION_INVALID); -} - -VEML7700_integration_time_t VEML7700::integrationTimeFromConfig(VEML7700::VEML7700_config_integration_time_t it) -{ - switch (it) - { case VEML7700_CONFIG_INTEGRATION_25ms: - return (VEML7700_INTEGRATION_25ms); - break; + return (VEML7700_INTEGRATION_25ms); + break; case VEML7700_CONFIG_INTEGRATION_50ms: - return (VEML7700_INTEGRATION_50ms); - break; + return (VEML7700_INTEGRATION_50ms); + break; case VEML7700_CONFIG_INTEGRATION_100ms: - return (VEML7700_INTEGRATION_100ms); - break; + return (VEML7700_INTEGRATION_100ms); + break; case VEML7700_CONFIG_INTEGRATION_200ms: - return (VEML7700_INTEGRATION_200ms); - break; + return (VEML7700_INTEGRATION_200ms); + break; case VEML7700_CONFIG_INTEGRATION_400ms: - return (VEML7700_INTEGRATION_400ms); - break; + return (VEML7700_INTEGRATION_400ms); + break; case VEML7700_CONFIG_INTEGRATION_800ms: - return (VEML7700_INTEGRATION_800ms); - break; + return (VEML7700_INTEGRATION_800ms); + break; default: - break; - } - return (VEML7700_INTEGRATION_INVALID); + break; + } + return (VEML7700_INTEGRATION_INVALID); } diff --git a/src/sfTk/sfDevVEML7700.h b/src/sfTk/sfDevVEML7700.h new file mode 100644 index 0000000..487f427 --- /dev/null +++ b/src/sfTk/sfDevVEML7700.h @@ -0,0 +1,215 @@ +/*! + * @file SparkFun_VEML7700_Arduino_Library.h + * + * SparkFun VEML7700 Ambient Light Sensor Arduino Library + * + * This library facilitates communication with the VEML7700 over I2C. + * + * Want to support open source hardware? Buy a board from SparkFun! + * + * This library was written by: + * Paul Clark + * SparkFun Electronics + * November 4th 2021 + * + * @author SparkFun Electronics + * @date 2021-2025 + * @copyright Copyright (c) 2021-2025, SparkFun Electronics Inc. This project is released under the MIT License. + * + * SPDX-License-Identifier: MIT + */ + +#pragma once + +#include + +// include the sparkfun toolkit headers +#include + +// Bus interfaces +#include + +typedef uint16_t VEML7700_t; + +/** VEML7700 I2C address */ +#define SF_VEML7700_DEFAULT_ADDRESS 0x10 // Default I2C address for the VEML7700 sensor + +/** Sensitivity mode selection */ +typedef enum +{ + VEML7700_SENSITIVITY_x1, + VEML7700_SENSITIVITY_x2, + VEML7700_SENSITIVITY_x1_8, + VEML7700_SENSITIVITY_x1_4, + VEML7700_SENSITIVITY_INVALID +} VEML7700_sensitivity_mode_t; + +/** ALS integration time setting + Note: these are defined here in simple sequential order. + The actual register settings are defined in VEML7700_config_integration_time_t */ +typedef enum +{ + VEML7700_INTEGRATION_25ms, + VEML7700_INTEGRATION_50ms, + VEML7700_INTEGRATION_100ms, + VEML7700_INTEGRATION_200ms, + VEML7700_INTEGRATION_400ms, + VEML7700_INTEGRATION_800ms, + VEML7700_INTEGRATION_INVALID +} VEML7700_integration_time_t; + +/** ALS persistence protect number setting */ +typedef enum +{ + VEML7700_PERSISTENCE_1, + VEML7700_PERSISTENCE_2, + VEML7700_PERSISTENCE_4, + VEML7700_PERSISTENCE_8, + VEML7700_PERSISTENCE_INVALID +} VEML7700_persistence_protect_t; + +/** ALS interrupt status, logical OR of the crossing low and high threshold INT triggers */ +typedef enum +{ + VEML7700_INT_STATUS_NONE, + VEML7700_INT_STATUS_HIGH, + VEML7700_INT_STATUS_LOW, + VEML7700_INT_STATUS_BOTH, + VEML7700_INT_STATUS_INVALID +} VEML7700_interrupt_status_t; + +/** ALS shut down setting */ +typedef enum +{ + VEML7700_POWER_ON, + VEML7700_SHUT_DOWN, + VEML7700_SHUTDOWN_INVALID +} VEML7700_shutdown_t; + +const uint16_t kVEML7700ValueError = 0xFFFF; // Value returned when the VEML7700 is not connected or an error occurs + +/** Communication interface for the VEML7700 */ +class sfDevVEML7700 +{ + public: + sfDevVEML7700() : _theBus{nullptr} + { + } + + sfTkError_t begin(sfTkBus *theBus = nullptr); + + bool isConnected(); + + /** Configuration controls */ + + sfTkError_t setShutdown(bool); + sfTkError_t powerOn(void) + { + return setShutdown(false); + }; + sfTkError_t shutdown(void) + { + return setShutdown(true); + }; + bool isShutdown(void); + + sfTkError_t enableInterrupt(bool); + bool interruptEnabled(void); + + sfTkError_t setPersistenceProtect(VEML7700_persistence_protect_t pp); + VEML7700_persistence_protect_t persistenceProtect(void); + const char *persistenceProtectString(void); + + sfTkError_t setIntegrationTime(VEML7700_integration_time_t it); + VEML7700_integration_time_t integrationTime(void); + const char *integrationTimeString(void); + + sfTkError_t setSensitivityMode(VEML7700_sensitivity_mode_t sm); + VEML7700_sensitivity_mode_t sensitivityMode(void); + const char *sensitivityModeString(void); + + sfTkError_t setHighThreshold(uint16_t threshold); + uint16_t highThreshold(void); + + sfTkError_t setLowThreshold(uint16_t threshold); + uint16_t lowThreshold(void); + + /** Read the sensor data */ + + uint16_t readAmbientLight(void); + uint16_t readWhiteLevel(void); + float readLux(void); + + /** Note: reading the interrupt status register clears the interrupts. + So, we need to check both interrupt flags in a single read. */ + VEML7700_interrupt_status_t interruptStatus(void); + + private: + /** Provide bit field access to the configuration register */ + typedef struct + { + union { + VEML7700_t all; + struct + { + VEML7700_t CONFIG_REG_SD : 1; // ALS shut down + VEML7700_t CONFIG_REG_INT_EN : 1; // ALS interrupt enable + VEML7700_t CONFIG_REG_RES1 : 2; // Reserved + VEML7700_t CONFIG_REG_PERS : 2; // ALS persistence protect number + VEML7700_t CONFIG_REG_IT : 4; // ALS integration time + VEML7700_t CONFIG_REG_RES2 : 1; // Reserved + VEML7700_t CONFIG_REG_SM : 2; // ALS sensitivity mode + VEML7700_t CONFIG_REG_RES3 : 3; // Reserved + }; + }; + } sfDevVEML7700Config_t; + + /** Provide bit field access to the interrupt status register + Note: reading the interrupt status register clears the interrupts. + So, we need to check both interrupt flags in a single read. */ + typedef struct + { + union { + VEML7700_t all; + struct + { + VEML7700_t INT_STATUS_REG_RES : 14; // Reserved + // Bit 14 indicates if the high threshold was exceeded + // Bit 15 indicates if the low threshold was exceeded + VEML7700_t INT_STATUS_REG_INT_FLAGS : 2; + }; + }; + } VEML7700_INTERRUPT_STATUS_REGISTER_t; + + /** VEML7700 Registers */ + typedef enum + { + VEML7700_CONFIGURATION_REGISTER, + VEML7700_HIGH_THRESHOLD, + VEML7700_LOW_THRESHOLD, + VEML7700_ALS_OUTPUT = 4, + VEML7700_WHITE_OUTPUT, + VEML7700_INTERRUPT_STATUS + } VEML7700_registers_t; + + /** ALS integration time setting */ + typedef enum + { + VEML7700_CONFIG_INTEGRATION_25ms = 0b1100, + VEML7700_CONFIG_INTEGRATION_50ms = 0b1000, + VEML7700_CONFIG_INTEGRATION_100ms = 0b0000, + VEML7700_CONFIG_INTEGRATION_200ms = 0b0001, + VEML7700_CONFIG_INTEGRATION_400ms = 0b0010, + VEML7700_CONFIG_INTEGRATION_800ms = 0b0011, + VEML7700_CONFIG_INTEGRATION_INVALID + } VEML7700_config_integration_time_t; + + sfTkError_t updateConfiguration(sfDevVEML7700Config_t &config); + + /** Convert the (sequential) integration time into the corresponding (non-sequential) configuration value */ + VEML7700_config_integration_time_t integrationTimeConfig(VEML7700_integration_time_t it); + /** Convert the (non-sequential) integration time config into the corresponding (sequential) integration time */ + VEML7700_integration_time_t integrationTimeFromConfig(VEML7700_config_integration_time_t it); + + sfTkBus *_theBus; +}; From 5721ab4e50bda7b2d8881d745a88236a4c24c1f8 Mon Sep 17 00:00:00 2001 From: Kirk Benell Date: Fri, 11 Jul 2025 13:41:46 -0600 Subject: [PATCH 03/25] compiles and runs, but not valid yet --- examples/Example1_getLux/Example1_getLux.ino | 40 ++++---- src/sfTk/sfDevVEML7700.cpp | 101 ++++++++++--------- src/sfTk/sfDevVEML7700.h | 13 ++- 3 files changed, 86 insertions(+), 68 deletions(-) diff --git a/examples/Example1_getLux/Example1_getLux.ino b/examples/Example1_getLux/Example1_getLux.ino index 4c05d1a..a960a11 100644 --- a/examples/Example1_getLux/Example1_getLux.ino +++ b/examples/Example1_getLux/Example1_getLux.ino @@ -5,43 +5,43 @@ * Paul Clark * SparkFun Electronics * November 4th 2021 - * + * * This example demonstrates how to initialize the VEML7700 and then get the ambient light lux. - * + * * Want to support open source hardware? Buy a board from SparkFun! *
SparkX smôl Environmental Peripheral Board (SPX-18976): https://www.sparkfun.com/products/18976 - * + * * Please see LICENSE.md for the license information - * + * */ #include // Click here to get the library: http://librarymanager/All#SparkFun_VEML7700 -VEML7700 mySensor; // Create a VEML7700 object +SparkFunVEML7700 mySensor; // Create a VEML7700 object void setup() { - Serial.begin(115200); - Serial.println(F("SparkFun VEML7700 Example")); + Serial.begin(115200); + Serial.println(F("SparkFun VEML7700 Example")); - Wire.begin(); + Wire.begin(); - //mySensor.enableDebugging(); // Uncomment this line to enable helpful debug messages on Serial + // mySensor.enableDebugging(); // Uncomment this line to enable helpful debug messages on Serial - // Begin the VEML7700 using the Wire I2C port - // .begin will return true on success, or false on failure to communicate - if (mySensor.begin() == false) - { - Serial.println("Unable to communicate with the VEML7700. Please check the wiring. Freezing..."); - while (1) - ; - } + // Begin the VEML7700 using the Wire I2C port + // .begin will return true on success, or false on failure to communicate + if (mySensor.begin() == false) + { + Serial.println("Unable to communicate with the VEML7700. Please check the wiring. Freezing..."); + while (1) + ; + } - Serial.println(F("Lux:")); + Serial.println(F("Lux:")); } void loop() { - Serial.println(mySensor.getLux(), 4); // Read the lux from the sensor and print it - delay(250); + Serial.println(mySensor.readLux(), 4); // Read the lux from the sensor and print it + delay(250); } diff --git a/src/sfTk/sfDevVEML7700.cpp b/src/sfTk/sfDevVEML7700.cpp index 31d5434..2b641b1 100644 --- a/src/sfTk/sfDevVEML7700.cpp +++ b/src/sfTk/sfDevVEML7700.cpp @@ -26,6 +26,7 @@ */ #include "sfDevVEML7700.h" +#include "Arduino.h" /** The sensor resolution vs. gain and integration time. Taken from the VEML7700 Application Note. */ const float VEML7700_LUX_RESOLUTION[VEML7700_SENSITIVITY_INVALID][VEML7700_INTEGRATION_INVALID] = { @@ -54,10 +55,10 @@ sfTkError_t sfDevVEML7700::updateConfiguration(sfDevVEML7700Config_t &config) if (_theBus == nullptr) return ksfTkErrBusNotInit; // Not initialized - return _theBus->readRegister((VEML7700_CONFIGURATION_REGISTER, config.all); + return _theBus->readRegister(VEML7700_CONFIGURATION_REGISTER, config.all); } //-------------------------------------------------------------------------------------------------- -sfTkError_t sfDevVEML7700::begin(sfTkIBus *theBus)) +sfTkError_t sfDevVEML7700::begin(sfTkIBus *theBus) { // Nullptr check @@ -91,7 +92,7 @@ sfTkError_t sfDevVEML7700::begin(sfTkIBus *theBus)) bool sfDevVEML7700::isConnected(void) { sfDevVEML7700Config_t config; - return updateConfiguration(config) == ksfTkErrSuccess; + return updateConfiguration(config) == ksfTkErrOk; } /**************************************************************************/ @@ -110,12 +111,12 @@ sfTkError_t sfDevVEML7700::setShutdown(bool shutdown) sfDevVEML7700Config_t config; sfTkError_t rc = updateConfiguration(config); - if (rc != ksfTkErrSuccess) + if (rc != ksfTkErrOk) return rc; // Error reading the configuration register config.CONFIG_REG_SD = shutdown ? VEML7700_SHUT_DOWN : VEML7700_POWER_ON; - return theBus->writeRegister(VEML7700_CONFIGURATION_REGISTER, config.all); + return _theBus->writeRegister(VEML7700_CONFIGURATION_REGISTER, config.all); } /**************************************************************************/ @@ -129,10 +130,10 @@ bool sfDevVEML7700::isShutdown(void) sfDevVEML7700Config_t config; sfTkError_t rc = updateConfiguration(config); - if (rc != ksfTkErrSuccess) + if (rc != ksfTkErrOk) return true; // Error reading the configuration register - return (((VEML7700_shutdown_t)_configurationRegister.CONFIG_REG_SD) == VEML7700_SHUT_DOWN); + return (((VEML7700_shutdown_t)config.CONFIG_REG_SD) == VEML7700_SHUT_DOWN); } /**************************************************************************/ @@ -151,12 +152,12 @@ sfTkError_t sfDevVEML7700::enableInterrupt(bool bEnable) sfDevVEML7700Config_t config; sfTkError_t rc = updateConfiguration(config); - if (rc != ksfTkErrSuccess) + if (rc != ksfTkErrOk) return rc; // Error reading the configuration register config.CONFIG_REG_INT_EN = (VEML7700_t)bEnable; - return theBus->writeRegister(VEML7700_CONFIGURATION_REGISTER, config.all); + return _theBus->writeRegister(VEML7700_CONFIGURATION_REGISTER, config.all); } /**************************************************************************/ @@ -173,7 +174,7 @@ bool sfDevVEML7700::interruptEnabled(void) sfDevVEML7700Config_t config; sfTkError_t rc = updateConfiguration(config); - if (rc != ksfTkErrSuccess) + if (rc != ksfTkErrOk) return false; // Error reading the configuration register return config.CONFIG_REG_INT_EN == VEML7700_INT_ENABLE; @@ -199,11 +200,11 @@ sfTkError_t sfDevVEML7700::setPersistenceProtect(VEML7700_persistence_protect_t sfDevVEML7700Config_t config; sfTkError_t rc = updateConfiguration(config); - if (rc != ksfTkErrSuccess) + if (rc != ksfTkErrOk) return rc; // Error reading the configuration register config.CONFIG_REG_PERS = (VEML7700_t)pp; - return theBus->writeRegister(VEML7700_CONFIGURATION_REGISTER, config.all); + return _theBus->writeRegister(VEML7700_CONFIGURATION_REGISTER, config.all); } /**************************************************************************/ @@ -219,7 +220,7 @@ VEML7700_persistence_protect_t sfDevVEML7700::persistenceProtect(void) sfDevVEML7700Config_t config; sfTkError_t rc = updateConfiguration(config); - if (rc != ksfTkErrSuccess) + if (rc != ksfTkErrOk) return VEML7700_PERSISTENCE_INVALID; // Error reading the configuration register return (VEML7700_persistence_protect_t)config.CONFIG_REG_PERS; @@ -265,11 +266,11 @@ sfTkError_t sfDevVEML7700::setIntegrationTime(VEML7700_integration_time_t it) sfDevVEML7700Config_t config; sfTkError_t rc = updateConfiguration(config); - if (rc != ksfTkErrSuccess) + if (rc != ksfTkErrOk) return rc; // Error reading the configuration register config.CONFIG_REG_IT = (VEML7700_t)integrationTimeConfig(it); - return theBus->writeRegister(VEML7700_CONFIGURATION_REGISTER, config.all); + return _theBus->writeRegister(VEML7700_CONFIGURATION_REGISTER, config.all); } /**************************************************************************/ @@ -291,7 +292,7 @@ VEML7700_integration_time_t sfDevVEML7700::integrationTime(void) sfDevVEML7700Config_t config; sfTkError_t rc = updateConfiguration(config); - if (rc != ksfTkErrSuccess) + if (rc != ksfTkErrOk) return VEML7700_INTEGRATION_INVALID; // Error reading the configuration register return ((VEML7700_integration_time_t)integrationTimeFromConfig( @@ -333,11 +334,11 @@ sfTkError_t sfDevVEML7700::setSensitivityMode(VEML7700_sensitivity_mode_t sm) sfDevVEML7700Config_t config; sfTkError_t rc = updateConfiguration(config); - if (rc != ksfTkErrSuccess) + if (rc != ksfTkErrOk) return rc; // Error reading the configuration register config.CONFIG_REG_SM = (VEML7700_t)sm; - return theBus->writeRegister(VEML7700_CONFIGURATION_REGISTER, config.all); + return _theBus->writeRegister(VEML7700_CONFIGURATION_REGISTER, config.all); } /**************************************************************************/ @@ -357,7 +358,7 @@ VEML7700_sensitivity_mode_t sfDevVEML7700::sensitivityMode() sfDevVEML7700Config_t config; sfTkError_t rc = updateConfiguration(config); - if (rc != ksfTkErrSuccess) + if (rc != ksfTkErrOk) return VEML7700_SENSITIVITY_INVALID; // Error reading the configuration register return ((VEML7700_sensitivity_mode_t)config.CONFIG_REG_SM); @@ -370,11 +371,10 @@ VEML7700_sensitivity_mode_t sfDevVEML7700::sensitivityMode() /**************************************************************************/ const char *sfDevVEML7700::sensitivityModeString() { - VEML7700_sensitivity_mode_t sm = sensitivityMode() + VEML7700_sensitivity_mode_t sm = sensitivityMode(); - if (sm < VEML7700_SENSITIVITY_x1 || - sm >= VEML7700_SENSITIVITY_INVALID) return "INVALID"; // Invalid sensitivity mode setting - getSensitivityMode(&sm); + if (sm < VEML7700_SENSITIVITY_x1 || sm >= VEML7700_SENSITIVITY_INVALID) + return "INVALID"; // Invalid sensitivity mode setting return kVEML7700GainSettingsString[sm]; } @@ -389,7 +389,7 @@ const char *sfDevVEML7700::sensitivityModeString() /**************************************************************************/ sfTkError_t sfDevVEML7700::setHighThreshold(uint16_t threshold) { - return theBus->writeRegister(VEML7700_HIGH_THRESHOLD, threshold); + return _theBus->writeRegister(VEML7700_HIGH_THRESHOLD, threshold); } /**************************************************************************/ @@ -401,9 +401,9 @@ sfTkError_t sfDevVEML7700::setHighThreshold(uint16_t threshold) uint16_t sfDevVEML7700::highThreshold(void) { uint16_t threshold; - sfTkError_t rc =_theBus->readRegister((VEML7700_HIGH_THRESHOLD, threshold); - - return rc == ksfTkErrSuccess ? threshold : kVEML7700ValueError; // Return 0xFFFF on error + sfTkError_t rc = _theBus->readRegister(VEML7700_HIGH_THRESHOLD, threshold); + + return rc == ksfTkErrOk ? threshold : kVEML7700ValueError; // Return 0xFFFF on error } /**************************************************************************/ @@ -416,7 +416,7 @@ uint16_t sfDevVEML7700::highThreshold(void) /**************************************************************************/ sfTkError_t sfDevVEML7700::setLowThreshold(uint16_t threshold) { - return theBus->writeRegister(VEML7700_LOW_THRESHOLD, threshold); + return _theBus->writeRegister(VEML7700_LOW_THRESHOLD, threshold); } /**************************************************************************/ @@ -428,9 +428,9 @@ sfTkError_t sfDevVEML7700::setLowThreshold(uint16_t threshold) uint16_t sfDevVEML7700::lowThreshold(void) { uint16_t threshold; - sfTkError_t rc =_theBus->readRegister((VEML7700_LOW_THRESHOLD, threshold); - - return rc == ksfTkErrSuccess ? threshold : kVEML7700ValueError; // Return 0xFFFF on error + sfTkError_t rc = _theBus->readRegister(VEML7700_LOW_THRESHOLD, threshold); + + return rc == ksfTkErrOk ? threshold : kVEML7700ValueError; // Return 0xFFFF on error } /**************************************************************************/ @@ -443,9 +443,9 @@ uint16_t sfDevVEML7700::readAmbientLight(void) { uint16_t ambient; - sfTkError_t rc =_theBus->readRegister((VEML7700_ALS_OUTPUT, ambient); - - return rc == ksfTkErrSuccess ? ambient : kVEML7700ValueError; + sfTkError_t rc = _theBus->readRegister(VEML7700_ALS_OUTPUT, ambient); + + return rc == ksfTkErrOk ? ambient : kVEML7700ValueError; } /**************************************************************************/ @@ -457,9 +457,9 @@ uint16_t sfDevVEML7700::readAmbientLight(void) uint16_t sfDevVEML7700::readWhiteLevel(void) { uint16_t whiteLevel; - sfTkError_t rc =_theBus->readRegister((VEML7700_WHITE_OUTPUT, whiteLevel); - - return rc == ksfTkErrSuccess ? whiteLevel : kVEML7700ValueError; + sfTkError_t rc = _theBus->readRegister(VEML7700_WHITE_OUTPUT, whiteLevel); + + return rc == ksfTkErrOk ? whiteLevel : kVEML7700ValueError; } /**************************************************************************/ @@ -479,18 +479,29 @@ float sfDevVEML7700::readLux(void) VEML7700_sensitivity_mode_t senseMode = sensitivityMode(); if (senseMode == VEML7700_SENSITIVITY_INVALID) + { + Serial.println("Invalid sensitivity mode"); return 0.0; + } VEML7700_integration_time_t intTime = integrationTime(); if (intTime == VEML7700_INTEGRATION_INVALID) + { + Serial.println("Invalid integration time"); return 0.0; + } /** Now we read the ambient level and multiply it by the resolution */ - uint16_t ambient = ambientLight(); + uint16_t ambient = readAmbientLight(); if (ambient == kVEML7700ValueError) + { + Serial.println("Error reading ambient light"); return 0.0; + } + Serial.printf("sends: %d, intTime: %d, factor: %f, ambient: %d\n", senseMode, intTime, + VEML7700_LUX_RESOLUTION[senseMode][intTime], ambient); // Apply the resolution to the ambient light reading return (float)ambient * VEML7700_LUX_RESOLUTION[senseMode][intTime]; @@ -515,24 +526,24 @@ float sfDevVEML7700::readLux(void) /**************************************************************************/ VEML7700_interrupt_status_t sfDevVEML7700::interruptStatus(void) { - VEML7700_error_t err; + VEML7700_INTERRUPT_STATUS_REGISTER_t isr; uint16_t ambient; - sfTkError_t rc =_theBus->readRegister((VEML7700_INTERRUPT_STATUS, isr.all); + sfTkError_t rc = _theBus->readRegister(VEML7700_INTERRUPT_STATUS, isr.all); - return rc != ksfTkErrSuccess ? VEML7700_INT_STATUS_INVALID : (VEML7700_interrupt_status_t)isr.INT_STATUS_REG_INT_FLAGS; + return rc != ksfTkErrOk ? VEML7700_INT_STATUS_INVALID : (VEML7700_interrupt_status_t)isr.INT_STATUS_REG_INT_FLAGS; } sfDevVEML7700::VEML7700_config_integration_time_t sfDevVEML7700::integrationTimeConfig(VEML7700_integration_time_t it) { // since the value of integration time is defined in a simple sequential order, and the intput is typed, // just use a translation table. - VEML7700_config_integration_time_t table[] = {VEML7700_CONFIG_INTEGRATION_25ms, VEML7700_CONFIG_INTEGRATION_50ms, - VEML7700_CONFIG_INTEGRATION_100ms, VEML7700_CONFIG_INTEGRATION_200ms, - VEML7700_CONFIG_INTEGRATION_400ms, VEML7700_CONFIG_INTEGRATION_800ms]; + VEML7700_config_integration_time_t table[] = {VEML7700_CONFIG_INTEGRATION_25ms, VEML7700_CONFIG_INTEGRATION_50ms, + VEML7700_CONFIG_INTEGRATION_100ms, VEML7700_CONFIG_INTEGRATION_200ms, + VEML7700_CONFIG_INTEGRATION_400ms, VEML7700_CONFIG_INTEGRATION_800ms}; - return tt < VEML7700_INTEGRATION_INVALID ? table[tt] : VEML7700_CONFIG_INTEGRATION_INVALID; + return it < VEML7700_INTEGRATION_INVALID ? table[it] : VEML7700_CONFIG_INTEGRATION_INVALID; } VEML7700_integration_time_t sfDevVEML7700::integrationTimeFromConfig( diff --git a/src/sfTk/sfDevVEML7700.h b/src/sfTk/sfDevVEML7700.h index 487f427..330b0df 100644 --- a/src/sfTk/sfDevVEML7700.h +++ b/src/sfTk/sfDevVEML7700.h @@ -68,6 +68,13 @@ typedef enum VEML7700_PERSISTENCE_INVALID } VEML7700_persistence_protect_t; +/** ALS interrupt enable setting */ +typedef enum +{ + VEML7700_INT_DISABLE, + VEML7700_INT_ENABLE, + VEML7700_INT_INVALID +} VEML7700_interrupt_enable_t; /** ALS interrupt status, logical OR of the crossing low and high threshold INT triggers */ typedef enum { @@ -96,7 +103,7 @@ class sfDevVEML7700 { } - sfTkError_t begin(sfTkBus *theBus = nullptr); + sfTkError_t begin(sfTkIBus *theBus = nullptr); bool isConnected(); @@ -182,7 +189,7 @@ class sfDevVEML7700 } VEML7700_INTERRUPT_STATUS_REGISTER_t; /** VEML7700 Registers */ - typedef enum + typedef enum : uint8_t { VEML7700_CONFIGURATION_REGISTER, VEML7700_HIGH_THRESHOLD, @@ -211,5 +218,5 @@ class sfDevVEML7700 /** Convert the (non-sequential) integration time config into the corresponding (sequential) integration time */ VEML7700_integration_time_t integrationTimeFromConfig(VEML7700_config_integration_time_t it); - sfTkBus *_theBus; + sfTkIBus *_theBus; }; From 4e26ab2fb8385cb8168f65d43735e7aa8517c8bd Mon Sep 17 00:00:00 2001 From: Kirk Benell Date: Sat, 12 Jul 2025 08:36:13 -0600 Subject: [PATCH 04/25] I2C needed stop bit to false --- src/SparkFun_VEML7700_Arduino_Library.h | 1 + 1 file changed, 1 insertion(+) diff --git a/src/SparkFun_VEML7700_Arduino_Library.h b/src/SparkFun_VEML7700_Arduino_Library.h index 525e3ee..05b3aea 100644 --- a/src/SparkFun_VEML7700_Arduino_Library.h +++ b/src/SparkFun_VEML7700_Arduino_Library.h @@ -47,6 +47,7 @@ class SparkFunVEML7700 : public sfDevVEML7700 { // Setup Arduino I2C bus _theI2CBus.init(wirePort, address); + _theI2CBus.setStop(false); // Begin the sensor sfTkError_t rc = sfDevVEML7700::begin(&_theI2CBus); From 1b56a53024bee3803c756c461cf8e192c64a64e7 Mon Sep 17 00:00:00 2001 From: Kirk Benell Date: Sat, 12 Jul 2025 08:36:38 -0600 Subject: [PATCH 05/25] remove debug statements --- src/sfTk/sfDevVEML7700.cpp | 12 ------------ 1 file changed, 12 deletions(-) diff --git a/src/sfTk/sfDevVEML7700.cpp b/src/sfTk/sfDevVEML7700.cpp index 2b641b1..97bffa7 100644 --- a/src/sfTk/sfDevVEML7700.cpp +++ b/src/sfTk/sfDevVEML7700.cpp @@ -479,29 +479,18 @@ float sfDevVEML7700::readLux(void) VEML7700_sensitivity_mode_t senseMode = sensitivityMode(); if (senseMode == VEML7700_SENSITIVITY_INVALID) - { - Serial.println("Invalid sensitivity mode"); return 0.0; - } VEML7700_integration_time_t intTime = integrationTime(); if (intTime == VEML7700_INTEGRATION_INVALID) - { - Serial.println("Invalid integration time"); return 0.0; - } /** Now we read the ambient level and multiply it by the resolution */ uint16_t ambient = readAmbientLight(); if (ambient == kVEML7700ValueError) - { - Serial.println("Error reading ambient light"); return 0.0; - } - Serial.printf("sends: %d, intTime: %d, factor: %f, ambient: %d\n", senseMode, intTime, - VEML7700_LUX_RESOLUTION[senseMode][intTime], ambient); // Apply the resolution to the ambient light reading return (float)ambient * VEML7700_LUX_RESOLUTION[senseMode][intTime]; @@ -529,7 +518,6 @@ VEML7700_interrupt_status_t sfDevVEML7700::interruptStatus(void) VEML7700_INTERRUPT_STATUS_REGISTER_t isr; - uint16_t ambient; sfTkError_t rc = _theBus->readRegister(VEML7700_INTERRUPT_STATUS, isr.all); return rc != ksfTkErrOk ? VEML7700_INT_STATUS_INVALID : (VEML7700_interrupt_status_t)isr.INT_STATUS_REG_INT_FLAGS; From 03de90283dc35aa88fa81d8234e7c63b0db97fc2 Mon Sep 17 00:00:00 2001 From: Kirk Benell Date: Sat, 12 Jul 2025 09:53:09 -0600 Subject: [PATCH 06/25] cleanup, move to doxygen comments for methods --- src/sfTk/sfDevVEML7700.cpp | 510 ++++++++++++++++++++----------------- src/sfTk/sfDevVEML7700.h | 350 ++++++++++++++++++++++++- 2 files changed, 612 insertions(+), 248 deletions(-) diff --git a/src/sfTk/sfDevVEML7700.cpp b/src/sfTk/sfDevVEML7700.cpp index 97bffa7..9974ae9 100644 --- a/src/sfTk/sfDevVEML7700.cpp +++ b/src/sfTk/sfDevVEML7700.cpp @@ -1,5 +1,5 @@ /*! - * @file SparkFun_VEML7700_Arduino_Library.h + * @file sfDevVEML7700.cpp * * @mainpage SparkFun VEML7700 Ambient Light Sensor Arduino Library * @@ -28,7 +28,29 @@ #include "sfDevVEML7700.h" #include "Arduino.h" -/** The sensor resolution vs. gain and integration time. Taken from the VEML7700 Application Note. */ +/** + * @brief Lookup table for VEML7700 lux resolution values. + * + * This 2D array provides the lux resolution (in lux/count) for different gain (sensitivity) and integration time + * settings of the VEML7700 ambient light sensor. The first dimension corresponds to the gain setting, and the second + * dimension corresponds to the integration time setting. + * + * Gain (sensitivity) indices: + * 0: Gain 1 + * 1: Gain 2 + * 2: Gain 1/8 + * 3: Gain 1/4 + * + * Integration time indices: + * 0: 25ms + * 1: 50ms + * 2: 100ms + * 3: 200ms + * 4: 400ms + * 5: 800ms + * + * Each element [gain][integration_time] gives the corresponding lux resolution for that configuration. + */ const float VEML7700_LUX_RESOLUTION[VEML7700_SENSITIVITY_INVALID][VEML7700_INTEGRATION_INVALID] = { // 25ms 50ms 100ms 200ms 400ms 800ms {0.2304, 0.1152, 0.0576, 0.0288, 0.0144, 0.0072}, // Gain (sensitivity) 1 @@ -37,19 +59,58 @@ const float VEML7700_LUX_RESOLUTION[VEML7700_SENSITIVITY_INVALID][VEML7700_INTEG {0.9216, 0.4608, 0.2304, 0.1152, 0.0576, 0.0288} // Gain (sensitivity) 1/4 }; -/** The VEML7700 gain (sensitivity) settings as text (string) */ -// Note: these are in the order defined by ALS_SM and VEML7700_sensitivity_mode_t +/** + * @brief Array of string representations for VEML7700 gain (sensitivity) settings. + * + * This array maps each gain setting constant to its corresponding string value: + * - "x1" : Gain setting x1 + * - "x2" : Gain setting x2 + * - "x1/8" : Gain setting x1/8 + * - "x1/4" : Gain setting x1/4 + * - "INVALID": Invalid gain setting + * + * The array size is determined by VEML7700_SENSITIVITY_INVALID + 1 to include all possible gain settings. + * + * @note The array is indexed by the VEML7700_sensitivity_mode_t enum values. + */ const char *kVEML7700GainSettingsString[VEML7700_SENSITIVITY_INVALID + 1] = {"x1", "x2", "x1/8", "x1/4", "INVALID"}; -/** The VEML7700 integration time settings as text (string) */ +/** + * @brief Array of string representations for VEML7700 sensor integration times. + * + * Each element corresponds to a specific integration time setting for the VEML7700 sensor. + * The last element "INVALID" represents an invalid or unsupported integration time. + * + * Index mapping: + * 0 - "25ms" + * 1 - "50ms" + * 2 - "100ms" + * 3 - "200ms" + * 4 - "400ms" + * 5 - "800ms" + * 6 - "INVALID" + */ const char *kVEML7799IntegrationTimesString[VEML7700_INTEGRATION_INVALID + 1] = {"25ms", "50ms", "100ms", "200ms", "400ms", "800ms", "INVALID"}; -/** The VEML7700 persistence protect settings as text (string) */ +/** + * @brief String representations for VEML7700 persistence protection settings. + * + * This array maps the persistence protection enumeration values to their corresponding string representations. + * The strings represent the number of persistence events required before an interrupt is triggered. + * The last entry "INVALID" corresponds to an invalid persistence setting. + * + * Index mapping: + * 0: "1" - 1 persistence event + * 1: "2" - 2 persistence events + * 2: "4" - 4 persistence events + * 3: "8" - 8 persistence events + * 4: "INVALID" - Invalid persistence setting + */ const char *kVEML7700PersistenceProtectStrings[VEML7700_PERSISTENCE_INVALID + 1] = {"1", "2", "4", "8", "INVALID"}; //-------------------------------------------------------------------------------------------------- -// Helpful method - used by a majority of methods +// Helpful method - used by a majority of methods - reads the configuration register sfTkError_t sfDevVEML7700::updateConfiguration(sfDevVEML7700Config_t &config) { if (_theBus == nullptr) @@ -58,9 +119,10 @@ sfTkError_t sfDevVEML7700::updateConfiguration(sfDevVEML7700Config_t &config) return _theBus->readRegister(VEML7700_CONFIGURATION_REGISTER, config.all); } //-------------------------------------------------------------------------------------------------- +// Begin the VEML7700 device. Requires a bus object to communicate with the device. +// sfTkError_t sfDevVEML7700::begin(sfTkIBus *theBus) { - // Nullptr check if (theBus == nullptr) return ksfTkErrBusNotInit; @@ -83,28 +145,17 @@ sfTkError_t sfDevVEML7700::begin(sfTkIBus *theBus) } //-------------------------------------------------------------------------------------------------- -/**************************************************************************/ -/*! - @brief Check that the VEML7700 is awake and communicating. - @return True if communication with the VEML7700 was successful, otherwise false. -*/ -/**************************************************************************/ +// Check if the VEML7700 is connected by reading the configuration register. +// bool sfDevVEML7700::isConnected(void) { sfDevVEML7700Config_t config; return updateConfiguration(config) == ksfTkErrOk; } -/**************************************************************************/ -/*! - @brief Set the VEML7700's shut down setting (ALS_SD) - @param shutdown -
The shut down setting. Possible values are: -
VEML7700_POWER_ON -
VEML7700_SHUT_DOWN - -*/ -/**************************************************************************/ +//-------------------------------------------------------------------------------------------------- +// Set the VEML7700's shut down setting. This will power down the device if shutdown is true +// sfTkError_t sfDevVEML7700::setShutdown(bool shutdown) { @@ -119,12 +170,10 @@ sfTkError_t sfDevVEML7700::setShutdown(bool shutdown) return _theBus->writeRegister(VEML7700_CONFIGURATION_REGISTER, config.all); } -/**************************************************************************/ -/*! - @brief Get the VEML7700's shut down setting (ALS_SD) - @return VEML7700_POWER_ON or VEML7700_SHUT_DOWN if successful, VEML7700_SHUTDOWN_INVALID otherwise -*/ -/**************************************************************************/ +//-------------------------------------------------------------------------------------------------- +// Is the VEML7700 in shut down mode? +// Return true if the device is in shut down mode, false otherwise. +// bool sfDevVEML7700::isShutdown(void) { sfDevVEML7700Config_t config; @@ -136,16 +185,9 @@ bool sfDevVEML7700::isShutdown(void) return (((VEML7700_shutdown_t)config.CONFIG_REG_SD) == VEML7700_SHUT_DOWN); } -/**************************************************************************/ -/*! - @brief Set the VEML7700's interrupt enable setting (ALS_INT_EN) - @param ie -
The interrupt enable setting. Possible values are: -
VEML7700_INT_DISABLE -
VEML7700_INT_ENABLE - @return VEML7700_SUCCESS (VEML7700_ERROR_SUCCESS) if successful -*/ -/**************************************************************************/ +//-------------------------------------------------------------------------------------------------- +// Set the VEML7700's interrupt enable setting. +// sfTkError_t sfDevVEML7700::enableInterrupt(bool bEnable) { @@ -159,15 +201,10 @@ sfTkError_t sfDevVEML7700::enableInterrupt(bool bEnable) return _theBus->writeRegister(VEML7700_CONFIGURATION_REGISTER, config.all); } +//-------------------------------------------------------------------------------------------------- +// Get the interrupt enable setting. +// -/**************************************************************************/ -/*! - @brief Get the VEML7700's interrupt enable setting (ALS_INT_EN) - @param ie -
Will be set to the interrupt enable setting on return - @return VEML7700_SUCCESS (VEML7700_ERROR_SUCCESS) if successful -*/ -/**************************************************************************/ bool sfDevVEML7700::interruptEnabled(void) { @@ -180,18 +217,10 @@ bool sfDevVEML7700::interruptEnabled(void) return config.CONFIG_REG_INT_EN == VEML7700_INT_ENABLE; } -/**************************************************************************/ -/*! - @brief Set the VEML7700's persistence protect number setting (ALS_PERS) - @param pp -
The persistence protect setting. Possible values are: -
VEML7700_PERSISTENCE_1 -
VEML7700_PERSISTENCE_2 -
VEML7700_PERSISTENCE_4 -
VEML7700_PERSISTENCE_8 - @return VEML7700_SUCCESS (VEML7700_ERROR_SUCCESS) if successful -*/ -/**************************************************************************/ +//-------------------------------------------------------------------------------------------------- +// Set the VEML7700's Persistence Protect Number setting +// + sfTkError_t sfDevVEML7700::setPersistenceProtect(VEML7700_persistence_protect_t pp) { if (pp >= VEML7700_PERSISTENCE_INVALID) @@ -206,31 +235,36 @@ sfTkError_t sfDevVEML7700::setPersistenceProtect(VEML7700_persistence_protect_t config.CONFIG_REG_PERS = (VEML7700_t)pp; return _theBus->writeRegister(VEML7700_CONFIGURATION_REGISTER, config.all); } +//-------------------------------------------------------------------------------------------------- +// Get the VEML7700's Persistence Protect Number setting +// Method provides an error code as well as the value of the persistence protect number +// -/**************************************************************************/ -/*! - @brief Get the VEML7700's persistence protect number setting (ALS_PERS) - @param pp -
Will be set to the persistence protect number on return - @return VEML7700_SUCCESS (VEML7700_ERROR_SUCCESS) if successful -*/ -/**************************************************************************/ -VEML7700_persistence_protect_t sfDevVEML7700::persistenceProtect(void) +sfTkError_t sfDevVEML7700::getPersistenceProtect(VEML7700_persistence_protect_t &pp) { + pp = VEML7700_PERSISTENCE_INVALID; // Default to invalid + sfDevVEML7700Config_t config; sfTkError_t rc = updateConfiguration(config); - if (rc != ksfTkErrOk) - return VEML7700_PERSISTENCE_INVALID; // Error reading the configuration register + if (rc == ksfTkErrOk) + pp = (VEML7700_persistence_protect_t)config.CONFIG_REG_PERS; - return (VEML7700_persistence_protect_t)config.CONFIG_REG_PERS; + return rc; } -/**************************************************************************/ -/*! - @brief Get the VEML7700's persistence protect number setting (ALS_PERS) as printable text -*/ -/**************************************************************************/ +//-------------------------------------------------------------------------------------------------- +// Get the VEML7700's Persistence Protect Number setting +// +VEML7700_persistence_protect_t sfDevVEML7700::persistenceProtect(void) +{ + VEML7700_persistence_protect_t pp; + sfTkError_t rc = getPersistenceProtect(pp); + return rc == ksfTkErrOk ? pp : VEML7700_PERSISTENCE_INVALID; +} +//-------------------------------------------------------------------------------------------------- +// Return the string representation of the VEML7700's Persistence Protect Number setting +// const char *sfDevVEML7700::persistenceProtectString(void) { VEML7700_persistence_protect_t pp = persistenceProtect(); @@ -241,22 +275,9 @@ const char *sfDevVEML7700::persistenceProtectString(void) return kVEML7700PersistenceProtectStrings[pp]; } -/**************************************************************************/ -/*! - @brief Set the VEML7700's integration time setting (ALS_IT) -
Note: these are defined here in simple sequential order -
The actual register settings are defined in VEML7700_config_integration_time_t - @param it -
The integration time setting. Possible values are: -
VEML7700_INTEGRATION_25ms -
VEML7700_INTEGRATION_50ms -
VEML7700_INTEGRATION_100ms -
VEML7700_INTEGRATION_200ms -
VEML7700_INTEGRATION_400ms -
VEML7700_INTEGRATION_800ms - @return VEML7700_SUCCESS (VEML7700_ERROR_SUCCESS) if successful -*/ -/**************************************************************************/ +//-------------------------------------------------------------------------------------------------- +// Set the VEML7700's integration time setting +// sfTkError_t sfDevVEML7700::setIntegrationTime(VEML7700_integration_time_t it) { @@ -273,37 +294,36 @@ sfTkError_t sfDevVEML7700::setIntegrationTime(VEML7700_integration_time_t it) return _theBus->writeRegister(VEML7700_CONFIGURATION_REGISTER, config.all); } -/**************************************************************************/ -/*! - @brief Get the VEML7700's integration time setting (ALS_IT) - @return If successful: -
VEML7700_INTEGRATION_25ms -
VEML7700_INTEGRATION_50ms -
VEML7700_INTEGRATION_100ms -
VEML7700_INTEGRATION_200ms -
VEML7700_INTEGRATION_400ms -
VEML7700_INTEGRATION_800ms -
Otherwise: -
VEML7700_INTEGRATION_INVALID -*/ -/**************************************************************************/ -VEML7700_integration_time_t sfDevVEML7700::integrationTime(void) +//-------------------------------------------------------------------------------------------------- +// Get the VEML7700's integration time setting - returning an error code as well as the value +// +sfTkError_t sfDevVEML7700::getIntegrationTime(VEML7700_integration_time_t &it) { + it = VEML7700_INTEGRATION_INVALID; // Default to invalid + sfDevVEML7700Config_t config; sfTkError_t rc = updateConfiguration(config); - if (rc != ksfTkErrOk) - return VEML7700_INTEGRATION_INVALID; // Error reading the configuration register + if (rc == ksfTkErrOk) + it = integrationTimeFromConfig((VEML7700_config_integration_time_t)config.CONFIG_REG_IT); - return ((VEML7700_integration_time_t)integrationTimeFromConfig( - (VEML7700_config_integration_time_t)config.CONFIG_REG_IT)); + return rc; } -/**************************************************************************/ -/*! - @brief Get the VEML7700's integration time setting (ALS_IT) as printable text -*/ -/**************************************************************************/ +//-------------------------------------------------------------------------------------------------- +// Get the VEML7700's integration time setting +// +VEML7700_integration_time_t sfDevVEML7700::integrationTime(void) +{ + VEML7700_integration_time_t it; + + sfTkError_t rc = getIntegrationTime(it); + + return rc == ksfTkErrOk ? it : VEML7700_INTEGRATION_INVALID; // Return invalid on error +} +//-------------------------------------------------------------------------------------------------- +// Get the VEML7700's integration time setting as a string +// const char *sfDevVEML7700::integrationTimeString(void) { VEML7700_integration_time_t it = integrationTime(); @@ -314,18 +334,9 @@ const char *sfDevVEML7700::integrationTimeString(void) return kVEML7799IntegrationTimesString[it]; } -/**************************************************************************/ -/*! - @brief Set the VEML7700's sensitivity mode selection (ALS_SM) - @param it -
The sensitivity mode selection. Possible values are: -
VEML7700_SENSITIVITY_x1 -
VEML7700_SENSITIVITY_x2 -
VEML7700_SENSITIVITY_x1_8 -
VEML7700_SENSITIVITY_x1_4 - @return VEML7700_SUCCESS (VEML7700_ERROR_SUCCESS) if successful -*/ -/**************************************************************************/ +//-------------------------------------------------------------------------------------------------- +// Set the VEML7700's sensitivity mode setting (ALS_SM) +// sfTkError_t sfDevVEML7700::setSensitivityMode(VEML7700_sensitivity_mode_t sm) { if (sm >= VEML7700_SENSITIVITY_INVALID) @@ -341,34 +352,36 @@ sfTkError_t sfDevVEML7700::setSensitivityMode(VEML7700_sensitivity_mode_t sm) return _theBus->writeRegister(VEML7700_CONFIGURATION_REGISTER, config.all); } -/**************************************************************************/ -/*! - @brief Get the VEML7700's sensitivity mode selection (ALS_SM) - @return If successful: -
VEML7700_SENSITIVITY_x1 -
VEML7700_SENSITIVITY_x2 -
VEML7700_SENSITIVITY_x1_8 -
VEML7700_SENSITIVITY_x1_4 -
Otherwise: -
VEML7700_SENSITIVITY_INVALID -*/ -/**************************************************************************/ -VEML7700_sensitivity_mode_t sfDevVEML7700::sensitivityMode() +//-------------------------------------------------------------------------------------------------- +// Get the VEML7700's sensitivity mode setting (ALS_SM) - returning an error code as well as the value +// +sfTkError_t sfDevVEML7700::getSensitivityMode(VEML7700_sensitivity_mode_t &sm) { + sm = VEML7700_SENSITIVITY_INVALID; // Default to invalid sfDevVEML7700Config_t config; sfTkError_t rc = updateConfiguration(config); - if (rc != ksfTkErrOk) - return VEML7700_SENSITIVITY_INVALID; // Error reading the configuration register + if (rc == ksfTkErrOk) + sm = (VEML7700_sensitivity_mode_t)config.CONFIG_REG_SM; - return ((VEML7700_sensitivity_mode_t)config.CONFIG_REG_SM); + return rc; } -/**************************************************************************/ -/*! - @brief Get the VEML7700's sensitivity mode selection (ALS_SM) as printable text -*/ -/**************************************************************************/ +//-------------------------------------------------------------------------------------------------- +// Get the VEML7700's sensitivity mode setting (ALS_SM) +VEML7700_sensitivity_mode_t sfDevVEML7700::sensitivityMode() +{ + VEML7700_sensitivity_mode_t sm; + + sfTkError_t rc = getSensitivityMode(sm); + + return rc == ksfTkErrOk ? sm : VEML7700_SENSITIVITY_INVALID; // Return invalid on error +} + +//-------------------------------------------------------------------------------------------------- +// Get the VEML7700's sensitivity mode setting (ALS_SM) as a string +// + const char *sfDevVEML7700::sensitivityModeString() { VEML7700_sensitivity_mode_t sm = sensitivityMode(); @@ -379,143 +392,158 @@ const char *sfDevVEML7700::sensitivityModeString() return kVEML7700GainSettingsString[sm]; } -/**************************************************************************/ -/*! - @brief Set the VEML7700's ALS high threshold window setting (ALS_WH) - @param threshold -
The threshold setting: 0x0000 to 0xFFFF - @return VEML7700_SUCCESS (VEML7700_ERROR_SUCCESS) if successful -*/ -/**************************************************************************/ +//-------------------------------------------------------------------------------------------------- +// Set the VEML7700's ALS high threshold window setting (ALS_WH) +// sfTkError_t sfDevVEML7700::setHighThreshold(uint16_t threshold) { return _theBus->writeRegister(VEML7700_HIGH_THRESHOLD, threshold); } -/**************************************************************************/ -/*! - @brief Get the VEML7700's ALS high threshold window setting (ALS_WH) - @return The threshold setting, or 0xFFFF on error -*/ -/**************************************************************************/ +//-------------------------------------------------------------------------------------------------- +// Get the VEML7700's ALS high threshold window setting (ALS_WH) - returning an error code as well as the value +// + +sfTkError_t sfDevVEML7700::getHighThreshold(uint16_t &threshold) +{ + return _theBus->readRegister(VEML7700_HIGH_THRESHOLD, threshold); +} +//-------------------------------------------------------------------------------------------------- +// Get the VEML7700's ALS high threshold window setting (ALS_WH) +// uint16_t sfDevVEML7700::highThreshold(void) { uint16_t threshold; - sfTkError_t rc = _theBus->readRegister(VEML7700_HIGH_THRESHOLD, threshold); + sfTkError_t rc = getHighThreshold(threshold); return rc == ksfTkErrOk ? threshold : kVEML7700ValueError; // Return 0xFFFF on error } -/**************************************************************************/ -/*! - @brief Set the VEML7700's ALS low threshold window setting (ALS_WL) - @param threshold -
The threshold setting: 0x0000 to 0xFFFF - @return VEML7700_SUCCESS (VEML7700_ERROR_SUCCESS) if successful -*/ -/**************************************************************************/ +//--------------------------------------------------------------------------------------------------- +// Set the VEML7700's ALS low threshold window setting (ALS_WL) +// sfTkError_t sfDevVEML7700::setLowThreshold(uint16_t threshold) { return _theBus->writeRegister(VEML7700_LOW_THRESHOLD, threshold); } -/**************************************************************************/ -/*! - @brief Get the VEML7700's ALS low threshold window setting (ALS_WL) - @return The threshold setting -*/ -/**************************************************************************/ +//--------------------------------------------------------------------------------------------------- +// Get the VEML7700's ALS low threshold window setting (ALS_WL) - returning an error code as well as the value +// +sfTkError_t sfDevVEML7700::getLowThreshold(uint16_t &threshold) +{ + return _theBus->readRegister(VEML7700_LOW_THRESHOLD, threshold); +} + +//--------------------------------------------------------------------------------------------------- +// Get the VEML7700's ALS low threshold window setting (ALS_WL) +// uint16_t sfDevVEML7700::lowThreshold(void) { uint16_t threshold; - sfTkError_t rc = _theBus->readRegister(VEML7700_LOW_THRESHOLD, threshold); + sfTkError_t rc = getLowThreshold(threshold); return rc == ksfTkErrOk ? threshold : kVEML7700ValueError; // Return 0xFFFF on error } -/**************************************************************************/ -/*! - @brief Get the VEML7700's ambient light sensor data (ALS) - @return The ambient light reading -*/ -/**************************************************************************/ -uint16_t sfDevVEML7700::readAmbientLight(void) +//---------------------------------------------------------------------------------------------------- +// Read the ambient ligth sensor data (ALS) - also return an error code +// +sfTkError_t sfDevVEML7700::getAmbientLight(uint16_t &ambient) +{ + return _theBus->readRegister(VEML7700_ALS_OUTPUT, ambient); +} + +//---------------------------------------------------------------------------------------------------- +// Read the ambient light sensor data (ALS) +// +uint16_t sfDevVEML7700::getAmbientLight(void) { uint16_t ambient; - sfTkError_t rc = _theBus->readRegister(VEML7700_ALS_OUTPUT, ambient); + sfTkError_t rc = getAmbientLight(ambient); return rc == ksfTkErrOk ? ambient : kVEML7700ValueError; } -/**************************************************************************/ -/*! - @brief Get the VEML7700's white level data (WHITE) - @return The white level reading -*/ -/**************************************************************************/ -uint16_t sfDevVEML7700::readWhiteLevel(void) +//---------------------------------------------------------------------------------------------------- +// Read the VEML7700's white level data (WHITE) - also return an error code +// +sfTkError_t sfDevVEML7700::getWhiteLevel(uint16_t &whiteLevel) +{ + return _theBus->readRegister(VEML7700_WHITE_OUTPUT, whiteLevel); +} + +//---------------------------------------------------------------------------------------------------- +// Read the VEML7700's white level data (WHITE) +// +uint16_t sfDevVEML7700::getWhiteLevel(void) { uint16_t whiteLevel; - sfTkError_t rc = _theBus->readRegister(VEML7700_WHITE_OUTPUT, whiteLevel); + sfTkError_t rc = getWhiteLevel(whiteLevel); return rc == ksfTkErrOk ? whiteLevel : kVEML7700ValueError; } -/**************************************************************************/ -/*! - @brief Read the sensor data and calculate the lux - @param lux -
Will be set to the lux on return - @return VEML7700_SUCCESS (VEML7700_ERROR_SUCCESS) if successful -*/ -/**************************************************************************/ -float sfDevVEML7700::readLux(void) +//---------------------------------------------------------------------------------------------------- +// Calculate the lux from the ambient light sensor data (ALS) +// This method also returns an error code +// +sfTkError_t sfDevVEML7700::getLux(float &lux) + { - /** First, we need to extract the correct resolution from the VEML7700_LUX_RESOLUTION - gain and integration time look up table. Let's begin by reading the gain - (sensitivity) and integration time. */ + lux = 0.0f; // Default to 0.0f - VEML7700_sensitivity_mode_t senseMode = sensitivityMode(); + // First, we need to extract the correct resolution from the VEML7700_LUX_RESOLUTION + // gain and integration time look up table. Let's begin by reading the gain + // (sensitivity) and integration time. - if (senseMode == VEML7700_SENSITIVITY_INVALID) - return 0.0; + sfTkError_t rc; - VEML7700_integration_time_t intTime = integrationTime(); + VEML7700_sensitivity_mode_t senseMode; + rc = getSensitivityMode(senseMode); - if (intTime == VEML7700_INTEGRATION_INVALID) - return 0.0; + if (rc != ksfTkErrOk) + return rc; + + VEML7700_integration_time_t intTime; + rc = getIntegrationTime(intTime); - /** Now we read the ambient level and multiply it by the resolution */ - uint16_t ambient = readAmbientLight(); + if (rc != ksfTkErrOk) + return rc; - if (ambient == kVEML7700ValueError) - return 0.0; + // Now we read the ambient level and multiply it by the resolution + uint16_t ambient; + rc = getAmbientLight(ambient); + + if (rc != ksfTkErrOk) + return rc; // Error reading the ambient light // Apply the resolution to the ambient light reading - return (float)ambient * VEML7700_LUX_RESOLUTION[senseMode][intTime]; + lux = ambient * VEML7700_LUX_RESOLUTION[senseMode][intTime]; + + return ksfTkErrOk; // Return success } -/**************************************************************************/ -/*! - @brief Read the VEML7700's interrupt status register -
Note: reading the interrupt status register clears the interrupts. -
So, we need to check both interrupt flags in a single read. - @param status -
Will be set to the logical OR of ALS_IF_L and ALS_IF_H on return -
Possible values are: -
VEML7700_INT_STATUS_NONE -
VEML7700_INT_STATUS_HIGH -
VEML7700_INT_STATUS_LOW -
VEML7700_INT_STATUS_BOTH -
If an I2C error occurred, status will be: -
VEML7700_INT_STATUS_INVALID - @return VEML7700_SUCCESS (VEML7700_ERROR_SUCCESS) if successful -*/ -/**************************************************************************/ -VEML7700_interrupt_status_t sfDevVEML7700::interruptStatus(void) +//---------------------------------------------------------------------------------------------------- +// Read the lux from the ambient light sensor data (ALS) +// +float sfDevVEML7700::getLux(void) { + float lux; + sfTkError_t rc = getLux(lux); + + return rc == ksfTkErrOk ? lux : kVEML7700ValueError; // Return 0.0f on error +} +//---------------------------------------------------------------------------------------------------- +// Read the VEML7700's interrupt status register +// +// Note: reading the interrupt status register clears the interrupts. +// So, we need to check both interrupt flags in a single read. +// +VEML7700_interrupt_status_t sfDevVEML7700::interruptStatus(void) +{ VEML7700_INTERRUPT_STATUS_REGISTER_t isr; sfTkError_t rc = _theBus->readRegister(VEML7700_INTERRUPT_STATUS, isr.all); @@ -523,9 +551,12 @@ VEML7700_interrupt_status_t sfDevVEML7700::interruptStatus(void) return rc != ksfTkErrOk ? VEML7700_INT_STATUS_INVALID : (VEML7700_interrupt_status_t)isr.INT_STATUS_REG_INT_FLAGS; } +//---------------------------------------------------------------------------------------------------- +// Convert the VEML7700_integration_time_t to a VEML7700_config_integration_time_t +// sfDevVEML7700::VEML7700_config_integration_time_t sfDevVEML7700::integrationTimeConfig(VEML7700_integration_time_t it) { - // since the value of integration time is defined in a simple sequential order, and the intput is typed, + // since the value of integration time is defined in a simple sequential enum order, and the intput is typed, // just use a translation table. VEML7700_config_integration_time_t table[] = {VEML7700_CONFIG_INTEGRATION_25ms, VEML7700_CONFIG_INTEGRATION_50ms, VEML7700_CONFIG_INTEGRATION_100ms, VEML7700_CONFIG_INTEGRATION_200ms, @@ -534,6 +565,9 @@ sfDevVEML7700::VEML7700_config_integration_time_t sfDevVEML7700::integrationTime return it < VEML7700_INTEGRATION_INVALID ? table[it] : VEML7700_CONFIG_INTEGRATION_INVALID; } +//---------------------------------------------------------------------------------------------------- +// Convert the VEML7700_config_integration_time_t to a VEML7700_integration_time_t +// VEML7700_integration_time_t sfDevVEML7700::integrationTimeFromConfig( sfDevVEML7700::VEML7700_config_integration_time_t it) { diff --git a/src/sfTk/sfDevVEML7700.h b/src/sfTk/sfDevVEML7700.h index 330b0df..9d1d850 100644 --- a/src/sfTk/sfDevVEML7700.h +++ b/src/sfTk/sfDevVEML7700.h @@ -96,6 +96,21 @@ typedef enum const uint16_t kVEML7700ValueError = 0xFFFF; // Value returned when the VEML7700 is not connected or an error occurs /** Communication interface for the VEML7700 */ +/** + * @class sfDevVEML7700 + * @brief Driver class for the VEML7700 ambient light sensor. + * + * This class provides an interface to configure and read data from the VEML7700 sensor. + * It supports sensor initialization, configuration of operational parameters, threshold settings, + * interrupt management, and reading ambient light and white level measurements. + * + * Usage: + * - Call begin() to initialize the sensor with an optional I2C bus. + * - Use configuration methods to set shutdown, interrupt, persistence, integration time, sensitivity, and thresholds. + * - Use data reading methods to obtain ambient light, white level, and lux values. + * - Interrupt status can be checked and cleared via interruptStatus(). + * + */ class sfDevVEML7700 { public: @@ -103,52 +118,344 @@ class sfDevVEML7700 { } + /** + * @brief Initializes the VEML7700 device on the specified bus. + * + * This function sets up communication with the VEML7700 sensor using the provided bus interface. + * If no bus is specified, the method will fail and return an error. + * + * @param theBus Pointer to the bus interface (sfTkIBus) to use for communication. Defaults to nullptr. + * @return sfTkError_t Error code indicating the result of the initialization. + */ sfTkError_t begin(sfTkIBus *theBus = nullptr); + /** + * @brief Checks if the VEML7700 sensor is connected and responding. + * + * @return true if the sensor is detected and communication is successful, false otherwise. + */ bool isConnected(); /** Configuration controls */ + /** + * @brief Sets the shutdown mode of the VEML7700 device. + * + * This function enables or disables the shutdown mode of the sensor. + * When shutdown mode is enabled, the device enters a low-power state. + * + * @param shutdown If true, the device will enter shutdown mode; if false, it will operate normally. + * @return sfTkError_t Error code indicating the result of the operation. + */ sfTkError_t setShutdown(bool); + /** + * @brief Powers on the VEML7700 device by clearing the shutdown mode. + * + * This function calls setShutdown(false) to enable the device's operation. + * + * @return sfTkError_t Error code indicating the result of the operation. + */ sfTkError_t powerOn(void) { return setShutdown(false); }; + /** + * @brief Puts the VEML7700 device into shutdown mode. + * + * This function calls setShutdown(true) to transition the device into a low-power state. + * + * @return sfTkError_t Error code indicating the result of the shutdown operation. + */ sfTkError_t shutdown(void) { return setShutdown(true); }; + /** + * @brief Checks if the VEML7700 device is currently in shutdown mode. + * + * This function returns true if the device is in shutdown mode, meaning it is not actively measuring. + * Otherwise, it returns false. + * + * @return true if the device is shut down, false otherwise. + */ bool isShutdown(void); + /** + * @brief Enables or disables the interrupt functionality of the VEML7700 device. + * + * When enabled, the device will generate an interrupt signal based on its configuration. + * + * @param enable Set to true to enable interrupts, false to disable. + * @return sfTkError_t Error code indicating success or failure of the operation. + */ sfTkError_t enableInterrupt(bool); + /** + * @brief Checks if the interrupt feature is enabled on the VEML7700 device. + * + * @return true if the interrupt is enabled, false otherwise. + */ bool interruptEnabled(void); + /** + * @brief Sets the persistence protection mode for the VEML7700 sensor. + * + * This function configures the persistence protection setting, which determines + * how many consecutive out-of-threshold events are required before an interrupt is triggered. + * + * @param pp The persistence protection mode to set. This should be a value of type VEML7700_persistence_protect_t. + * Valid values are: + * VEML7700_PERSISTENCE_1 + * VEML7700_PERSISTENCE_2 + * VEML7700_PERSISTENCE_4 + * VEML7700_PERSISTENCE_8 + * @return sfTkError_t Returns an error code indicating the success or failure of the operation. + */ sfTkError_t setPersistenceProtect(VEML7700_persistence_protect_t pp); + + /** + * @brief Retrieves the current persistence protection setting from the VEML7700 sensor. + * + * This function queries the sensor for its persistence protection configuration, + * which determines how many consecutive out-of-threshold measurements are required + * before an interrupt is triggered. + * + * @param[out] pp Reference to a VEML7700_persistence_protect_t variable where the persistence protection value will + * be stored. + * @return sfTkError_t Error code indicating success or failure of the operation. + */ + sfTkError_t getPersistenceProtect(VEML7700_persistence_protect_t &pp); + + /** + * @brief Gets the current persistence protection setting of the VEML7700 sensor. + * + * This function returns the persistence protection configuration, which determines + * how many consecutive out-of-range measurements are required before an interrupt is triggered. + * + * @return VEML7700_persistence_protect_t The current persistence protection setting. + */ VEML7700_persistence_protect_t persistenceProtect(void); + /** + * @brief Returns a string representation of the current persistence protection setting. + * + * This function provides a human-readable string that describes the current persistence protection mode. + * + * @return const char* A string representing the persistence protection setting. + */ const char *persistenceProtectString(void); + /** + * @brief Sets the integration time for the VEML7700 sensor. + * + * This function configures the integration time, which determines the duration + * over which the sensor accumulates light before taking a measurement. Adjusting + * the integration time can affect the sensitivity and range of the sensor readings. + * + * @param it The desired integration time, specified as a value of the + * VEML7700_integration_time_t enumeration. + * @return sfTkError_t Returns an error code indicating success or failure of the operation. + */ sfTkError_t setIntegrationTime(VEML7700_integration_time_t it); + + /** + * @brief Retrieves the current integration time setting from the VEML7700 sensor. + * + * This function reads the sensor's configuration to determine the currently set integration time. + * + * @param[out] it Reference to a VEML7700_integration_time_t variable where the integration time will be stored. + * @return sfTkError_t Error code indicating success or failure of the operation. + */ + sfTkError_t getIntegrationTime(VEML7700_integration_time_t &it); + + /** + * @brief Gets the current integration time setting of the VEML7700 sensor. + * + * This function retrieves the integration time that is currently configured for the sensor. + * + * @return VEML7700_integration_time_t The current integration time setting. + */ VEML7700_integration_time_t integrationTime(void); + + /** + * @brief Returns a string representation of the current integration time setting. + * + * This function provides a human-readable string that describes the current integration time. + * + * @return const char* A string representing the integration time setting. + */ const char *integrationTimeString(void); + /** + * @brief Sets the sensitivity mode for the VEML7700 sensor. + * + * This function configures the sensor's sensitivity mode, which affects + * the measurement range and resolution. The sensitivity mode should be + * selected based on the application's lighting conditions. + * + * @param sm The desired sensitivity mode, specified as a VEML7700_sensitivity_mode_t enum value. + * @return sfTkError_t Returns an error code indicating success or failure of the operation. + */ sfTkError_t setSensitivityMode(VEML7700_sensitivity_mode_t sm); + + /** + * @brief Retrieves the current sensitivity mode setting from the VEML7700 sensor. + * + * This function reads the sensor's configuration to determine the currently set sensitivity mode. + * + * @param[out] sm Reference to a VEML7700_sensitivity_mode_t variable where the sensitivity mode will be stored. + * @return sfTkError_t Error code indicating success or failure of the operation. + */ + sfTkError_t getSensitivityMode(VEML7700_sensitivity_mode_t &sm); + + /** + * @brief Gets the current sensitivity mode setting of the VEML7700 sensor. + * + * This function retrieves the sensitivity mode that is currently configured for the sensor. + * + * @return VEML7700_sensitivity_mode_t The current sensitivity mode setting. + */ VEML7700_sensitivity_mode_t sensitivityMode(void); + + /** + * @brief Returns a string representation of the current sensitivity mode setting. + * + * This function provides a human-readable string that describes the current sensitivity mode. + * + * @return const char* A string representing the sensitivity mode setting. + */ const char *sensitivityModeString(void); + /** + * @brief Sets the high threshold value for the VEML7700 sensor. + * + * This function configures the high threshold for the sensor's interrupt. + * When the measured value exceeds this threshold, an interrupt will be triggered. + * + * @param threshold The high threshold value to set (16-bit unsigned integer): 0x0000 to 0xFFFF + * @return sfTkError_t Error code indicating success or failure of the operation. + */ sfTkError_t setHighThreshold(uint16_t threshold); + + /** + * @brief Retrieves the current high threshold value from the VEML7700 sensor. + * + * This function reads the sensor's configuration to obtain the currently set high threshold value. + * + * @param[out] threshold Reference to a uint16_t variable where the high threshold will be stored. + * @return sfTkError_t Error code indicating success or failure of the operation. + */ + sfTkError_t getHighThreshold(uint16_t &threshold); + + /** + * @brief Gets the current high threshold value of the VEML7700 sensor. + * + * This function retrieves the high threshold that is currently configured for the sensor. + * + * @return uint16_t The current high threshold value (16-bit unsigned integer): 0x0000 to 0xFFFF + */ uint16_t highThreshold(void); + /** + * @brief Sets the low threshold value for the VEML7700 sensor. + * + * This function configures the sensor to trigger an interrupt or event when the measured value + * falls below the specified threshold. + * + * @param threshold The low threshold value to set (16-bit unsigned integer): 0x0000 to 0xFFFF + * @return sfTkError_t Error code indicating success or failure of the operation. + */ sfTkError_t setLowThreshold(uint16_t threshold); + + /** + * @brief Retrieves the current low threshold value from the VEML7700 sensor. + * + * This function reads the sensor's configuration to obtain the currently set low threshold value. + * + * @param[out] threshold Reference to a uint16_t variable where the low threshold will be stored. + * @return sfTkError_t Error code indicating success or failure of the operation. + */ + sfTkError_t getLowThreshold(uint16_t &threshold); + + /** + * @brief Gets the current low threshold value of the VEML7700 sensor. + * + * This function retrieves the low threshold that is currently configured for the sensor. + * + * @return uint16_t The current low threshold value (16-bit unsigned integer): 0x0000 to 0xFFFF + */ uint16_t lowThreshold(void); /** Read the sensor data */ - uint16_t readAmbientLight(void); - uint16_t readWhiteLevel(void); - float readLux(void); - - /** Note: reading the interrupt status register clears the interrupts. - So, we need to check both interrupt flags in a single read. */ + /** + * @brief Retrieves the ambient light measurement from the VEML7700 sensor. + * + * This function reads the current ambient light value and stores it in the provided reference variable. + * + * @param[out] ambient Reference to a uint16_t variable where the ambient light value will be stored. + * @return sfTkError_t Error code indicating the status of the operation. + */ + sfTkError_t getAmbientLight(uint16_t &ambient); + /** + * @brief Reads the ambient light measurement from the VEML7700 sensor. + * + * This function retrieves the current ambient light value. + * + * @return uint16_t The ambient light value (16-bit unsigned integer): 0x0000 to 0xFFFF + */ + uint16_t getAmbientLight(void); + + /** + * @brief Retrieves the current white light level measured by the VEML7700 sensor. + * + * This function reads the white channel value from the sensor and stores it in the provided reference variable. + * + * @param[out] whiteLevel Reference to a uint16_t variable where the white light level will be stored. + * @return sfTkError_t Error code indicating the status of the operation. + */ + sfTkError_t getWhiteLevel(uint16_t &whiteLevel); + /** + * @brief Reads the current white light level from the VEML7700 sensor. + * + * This function retrieves the white channel value measured by the sensor. + * + * @return uint16_t The white light level (16-bit unsigned integer): 0x0000 to 0xFFFF + */ + uint16_t getWhiteLevel(void); + + /** + * @brief Retrieves the current ambient light level in lux. + * + * This function reads the sensor and calculates the ambient light intensity, + * storing the result in the provided reference variable. + * + * @param lux Reference to a float variable where the measured lux value will be stored. + * @return sfTkError_t Error code indicating success or type of failure. + */ + sfTkError_t getLux(float &lux); + + /** + * @brief Reads the current ambient light level in lux. + * + * This function calculates the lux value based on the sensor's ambient light measurement. + * + * @return float The calculated lux value, or kVEML7700ValueError if an error occurs. + */ + float getLux(void); + + /** + * @brief Retrieves the current interrupt status from the VEML7700 sensor. + * + * This function queries the VEML7700 sensor for its interrupt status, + * indicating whether a threshold event has occurred (such as crossing + * high or low limits). The returned status can be used to determine if + * further action is required, such as reading sensor data or clearing + * the interrupt. + * + * @return VEML7700_interrupt_status_t The current interrupt status of the sensor. + * + * @note Reading the interrupt status register clears the interrupts. + So, it is important to check both interrupt flags in a single read. + */ VEML7700_interrupt_status_t interruptStatus(void); private: @@ -188,7 +495,7 @@ class sfDevVEML7700 }; } VEML7700_INTERRUPT_STATUS_REGISTER_t; - /** VEML7700 Registers */ + // VEML7700 Registers - note types are uint8_t to match the I2C register size typedef enum : uint8_t { VEML7700_CONFIGURATION_REGISTER, @@ -199,7 +506,7 @@ class sfDevVEML7700 VEML7700_INTERRUPT_STATUS } VEML7700_registers_t; - /** ALS integration time setting */ + // ALS integration time setting typedef enum { VEML7700_CONFIG_INTEGRATION_25ms = 0b1100, @@ -211,12 +518,35 @@ class sfDevVEML7700 VEML7700_CONFIG_INTEGRATION_INVALID } VEML7700_config_integration_time_t; + /** + * @brief Updates the device configuration with the provided settings. + * + * This function applies the configuration specified in the given + * sfDevVEML7700Config_t structure to the VEML7700 device. It updates + * the device registers according to the new configuration values. + * + * @param config Reference to a sfDevVEML7700Config_t structure containing + * the desired configuration settings. + * @return sfTkError_t Error code indicating the result of the operation. + * Returns sfTkError_t::SFTK_OK on success, or an appropriate error code + * if the update fails. + */ sfTkError_t updateConfiguration(sfDevVEML7700Config_t &config); - /** Convert the (sequential) integration time into the corresponding (non-sequential) configuration value */ + /** + * @breif Convert the (sequential) integration time into the corresponding (non-sequential) configuration value + * + */ VEML7700_config_integration_time_t integrationTimeConfig(VEML7700_integration_time_t it); - /** Convert the (non-sequential) integration time config into the corresponding (sequential) integration time */ + + /** + * @breif Convert the (non-sequential) integration time config into the corresponding (sequential) integration time + * + */ VEML7700_integration_time_t integrationTimeFromConfig(VEML7700_config_integration_time_t it); + /** + * Pointer to the I2C bus interface used for communication with the VEML7700 sensor. + */ sfTkIBus *_theBus; }; From 74538271b9fb5786769546b6a151d77a9b9da4e4 Mon Sep 17 00:00:00 2001 From: Kirk Benell Date: Sat, 12 Jul 2025 09:53:35 -0600 Subject: [PATCH 07/25] update method call --- examples/Example1_getLux/Example1_getLux.ino | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/examples/Example1_getLux/Example1_getLux.ino b/examples/Example1_getLux/Example1_getLux.ino index a960a11..c969dce 100644 --- a/examples/Example1_getLux/Example1_getLux.ino +++ b/examples/Example1_getLux/Example1_getLux.ino @@ -42,6 +42,6 @@ void setup() void loop() { - Serial.println(mySensor.readLux(), 4); // Read the lux from the sensor and print it + Serial.println(mySensor.getLux(), 4); // Read the lux from the sensor and print it delay(250); } From a7ab46c813fe64aeff5cf1b945ea2d7951e09750 Mon Sep 17 00:00:00 2001 From: Kirk Benell Date: Sat, 12 Jul 2025 09:54:36 -0600 Subject: [PATCH 08/25] cleanup - comments --- src/SparkFun_VEML7700_Arduino_Library.h | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/SparkFun_VEML7700_Arduino_Library.h b/src/SparkFun_VEML7700_Arduino_Library.h index 05b3aea..834ac5e 100644 --- a/src/SparkFun_VEML7700_Arduino_Library.h +++ b/src/SparkFun_VEML7700_Arduino_Library.h @@ -8,7 +8,7 @@ * @author SparkFUn Electronics * @date 2021-2025 * @version 2.0.0 - * @copyright (c) 2021=2025 SparkFun Electronics Inc. This project is released under the MIT License. + * @copyright (c) 2021-2025 SparkFun Electronics Inc. This project is released under the MIT License. * * SPDX-License-Identifier: MIT * @@ -47,7 +47,7 @@ class SparkFunVEML7700 : public sfDevVEML7700 { // Setup Arduino I2C bus _theI2CBus.init(wirePort, address); - _theI2CBus.setStop(false); + _theI2CBus.setStop(false); // Do not send a stop condition after each read/write // Begin the sensor sfTkError_t rc = sfDevVEML7700::begin(&_theI2CBus); From 57e69a95636fa01c3ceb5e2e41572f36332a47d3 Mon Sep 17 00:00:00 2001 From: Kirk Benell Date: Sat, 12 Jul 2025 13:00:48 -0600 Subject: [PATCH 09/25] add standard suite of actions for our library - compile, docs, post a bug --- .github/workflows/add_issue_to_project.yml | 18 +++ .github/workflows/build-deploy-ghpages.yml | 64 +++++++++++ .github/workflows/compile-sketch.yml | 126 +++++++++++++++++++++ 3 files changed, 208 insertions(+) create mode 100644 .github/workflows/add_issue_to_project.yml create mode 100644 .github/workflows/build-deploy-ghpages.yml create mode 100644 .github/workflows/compile-sketch.yml diff --git a/.github/workflows/add_issue_to_project.yml b/.github/workflows/add_issue_to_project.yml new file mode 100644 index 0000000..6b60cc3 --- /dev/null +++ b/.github/workflows/add_issue_to_project.yml @@ -0,0 +1,18 @@ +name: Add new issue to our main project + +on: + issues: + types: + - opened + +jobs: + add-to-project: + name: Add issue to project + runs-on: ubuntu-latest + steps: + - uses: actions/add-to-project@main + with: + # You can target a project in a different organization + # to the issue + project-url: https://github.com/orgs/sparkfun/projects/19 + github-token: ${{ secrets.DEFECT_ADD_TO_PROJECT }} diff --git a/.github/workflows/build-deploy-ghpages.yml b/.github/workflows/build-deploy-ghpages.yml new file mode 100644 index 0000000..b69a484 --- /dev/null +++ b/.github/workflows/build-deploy-ghpages.yml @@ -0,0 +1,64 @@ +name: Build Documentation and Deploy + +on: + push: + branches: + - main + workflow_dispatch: + +permissions: + contents: read + id-token: write + pages: write + +concurrency: + group: "pages" + cancel-in-progress: true + +jobs: + # Build job + build: + runs-on: ubuntu-latest + steps: + # Checkout the repository + - name: Checkout repository + uses: actions/checkout@v2 + with: + fetch-depth: 0 + submodules: "true" + + - name: Set Version + run: echo "PROJECT_NUMBER = `git describe --tags`" >> ./docs/doxygen/doxygen-config + + - name: Build Documentation + uses: mattnotmitt/doxygen-action@v1.9.5 + with: + doxyfile-path: "./docs/doxygen/doxygen-config" + + # Upload the documentation as an artifact + - name: Upload documentation + uses: actions/upload-pages-artifact@v3.0.1 + with: + path: ./docs/html + + # Deploy job + deploy: + # Add a dependency to the build job + needs: build + + # Grant GITHUB_TOKEN the permissions required to make a Pages deployment + permissions: + pages: write # to deploy to Pages + id-token: write # to verify the deployment originates from an appropriate source + + # Deploy to the github-pages environment + environment: + name: github-pages + url: ${{ steps.deployment.outputs.page_url }} + + # Specify runner + deployment step + runs-on: ubuntu-latest + steps: + - name: Deploy to GitHub Pages + id: deployment + uses: actions/deploy-pages@v4 # or specific "vX.X.X" version tag for this action diff --git a/.github/workflows/compile-sketch.yml b/.github/workflows/compile-sketch.yml new file mode 100644 index 0000000..469a865 --- /dev/null +++ b/.github/workflows/compile-sketch.yml @@ -0,0 +1,126 @@ +name: Cross-compilation + +on: + push: + branches: + - main + workflow_dispatch: + +jobs: + compile-sketch: + runs-on: ubuntu-latest + + strategy: + fail-fast: false + + matrix: + board: + # Uno + # https://github.com/arduino/ArduinoCore-avr/blob/master/boards.txt + - fqbn: arduino:avr:mega + # platforms: | + name: arduino:avr + source-url: https://downloads.arduino.cc/packages/package_index.json + + # ESP32 + # https://github.com/espressif/arduino-esp32/blob/master/boards.txt + - fqbn: esp32:esp32:esp32 + # platforms: | + name: esp32:esp32 + source-url: https://raw.githubusercontent.com/espressif/arduino-esp32/gh-pages/package_esp32_index.json + + # ESP32-S2 + # https://github.com/espressif/arduino-esp32/blob/master/boards.txt + - fqbn: esp32:esp32:esp32s2 + # platforms: | + name: esp32:esp32 + source-url: https://raw.githubusercontent.com/espressif/arduino-esp32/gh-pages/package_esp32_index.json + + # ESP32-C3 + # https://github.com/espressif/arduino-esp32/blob/master/boards.txt + - fqbn: esp32:esp32:esp32c3 + # platforms: | + name: esp32:esp32 + source-url: https://raw.githubusercontent.com/espressif/arduino-esp32/gh-pages/package_esp32_index.json + + # Artemis / Apollo3 + # https://github.com/sparkfun/Arduino_Apollo3/blob/main/boards.txt + - fqbn: SparkFun:apollo3:sfe_artemis_atp + # platforms: | + name: SparkFun:apollo3 + source-url: https://raw.githubusercontent.com/sparkfun/Arduino_Apollo3/master/package_sparkfun_apollo3_index.json + + # ESP8266 + # https://github.com/esp8266/Arduino/blob/master/boards.txt + - fqbn: esp8266:esp8266:thingdev + # platforms: | + name: esp8266:esp8266 + source-url: https://arduino.esp8266.com/stable/package_esp8266com_index.json + + # SAMD21 + # https://github.com/arduino/ArduinoCore-samd/blob/master/boards.txt + - fqbn: arduino:samd:mkr1000 + # platforms: | + name: arduino:samd + source-url: https://downloads.arduino.cc/packages/package_index.json + + # Nano BLE 33 / nRF52840 + # https://github.com/arduino/ArduinoCore-mbed/blob/master/boards.txt + - fqbn: arduino:mbed:nano33ble + # platforms: | + name: arduino:mbed + source-url: https://downloads.arduino.cc/packages/package_index.json + + # RP2040 + # https://github.com/arduino/ArduinoCore-mbed/blob/master/boards.txt + - fqbn: rp2040:rp2040:sparkfun_promicrorp2040 + # platforms: | + name: rp2040:rp2040 + source-url: https://github.com/earlephilhower/arduino-pico/releases/download/global/package_rp2040_index.json + + # RP2350 + # https://github.com/arduino/ArduinoCore-mbed/blob/master/boards.txt + - fqbn: rp2040:rp2040:sparkfun_promicrorp2350 + # platforms: | + name: rp2040:rp2040 + source-url: https://github.com/earlephilhower/arduino-pico/releases/download/global/package_rp2040_index.json + + # STM32 + # https://github.com/arduino/ArduinoCore-mbed/blob/master/boards.txt + - fqbn: STMicroelectronics:stm32:GenF4 + # platforms: | + name: STMicroelectronics:stm32 + source-url: https://github.com/stm32duino/BoardManagerFiles/raw/main/package_stmicroelectronics_index.json + + steps: + - name: Checkout + uses: actions/checkout@v3 + + - name: Branch name + run: + echo running on branch ${GITHUB_REF##*/} + + # Setup Arduino command line - install esp32 and all the libs flux needs + - name: Arduino - Install and setup the Arduino CLI + uses: arduino/setup-arduino-cli@v2 + + - name: Arduino - Start config file + run: arduino-cli config init --additional-urls ${{ matrix.board.source-url}} + + - name: Arduino - Update index + run: arduino-cli core update-index + + - name: Arduino - Install platform + run: arduino-cli core install ${{ matrix.board.name}} + + - name: Arduino - Install libraries + run: | + arduino-cli config set library.enable_unsafe_install true + arduino-cli version + arduino-cli lib install 'SparkFun Toolkit' + + - name: Compile Sketch + run: arduino-cli compile --fqbn ${{ matrix.board.fqbn }} examples/Example1_getLux --library . + + # outputs: + # report-artifact-name: ${{ steps.report-artifact-name.outputs.report-artifact-name }} From 6f9cd15a1c443ea98abbe648f6b0b5d6db488538 Mon Sep 17 00:00:00 2001 From: Kirk Benell Date: Sat, 12 Jul 2025 13:01:59 -0600 Subject: [PATCH 10/25] moving to our updated doxygen schema --- ...___v_e_m_l7700___arduino___library_8h.html | 305 --- ...m_l7700___arduino___library_8h_source.html | 317 --- docs/annotated.html | 79 - docs/bc_s.png | Bin 676 -> 0 bytes docs/bdwn.png | Bin 147 -> 0 bytes docs/class_v_e_m_l7700-members.html | 115 -- docs/class_v_e_m_l7700.html | 1055 ---------- docs/classes.html | 80 - docs/closed.png | Bin 132 -> 0 bytes .../dir_68267d1309a1af8e8297ef4c3efbcdba.html | 84 - docs/doc.png | Bin 746 -> 0 bytes docs/doxygen.css | 1793 ----------------- docs/doxygen.svg | 26 - docs/dynsections.js | 121 -- docs/files.html | 80 - docs/folderclosed.png | Bin 616 -> 0 bytes docs/folderopen.png | Bin 597 -> 0 bytes docs/functions.html | 176 -- docs/functions_func.html | 176 -- docs/globals.html | 96 - docs/globals_defs.html | 75 - docs/globals_enum.html | 93 - docs/index.html | 86 - docs/jquery.js | 35 - docs/menu.js | 51 - docs/menudata.js | 52 - docs/nav_f.png | Bin 153 -> 0 bytes docs/nav_g.png | Bin 95 -> 0 bytes docs/nav_h.png | Bin 98 -> 0 bytes docs/open.png | Bin 123 -> 0 bytes docs/search/all_0.html | 37 - docs/search/all_0.js | 4 - docs/search/all_1.html | 37 - docs/search/all_1.js | 4 - docs/search/all_2.html | 37 - docs/search/all_2.js | 4 - docs/search/all_3.html | 37 - docs/search/all_3.js | 17 - docs/search/all_4.html | 37 - docs/search/all_4.js | 4 - docs/search/all_5.html | 37 - docs/search/all_5.js | 12 - docs/search/all_6.html | 37 - docs/search/all_6.js | 12 - docs/search/classes_0.html | 37 - docs/search/classes_0.js | 4 - docs/search/close.svg | 31 - docs/search/defines_0.html | 37 - docs/search/defines_0.js | 4 - docs/search/enums_0.html | 37 - docs/search/enums_0.js | 10 - docs/search/files_0.html | 37 - docs/search/files_0.js | 4 - docs/search/functions_0.html | 37 - docs/search/functions_0.js | 4 - docs/search/functions_1.html | 37 - docs/search/functions_1.js | 4 - docs/search/functions_2.html | 37 - docs/search/functions_2.js | 4 - docs/search/functions_3.html | 37 - docs/search/functions_3.js | 17 - docs/search/functions_4.html | 37 - docs/search/functions_4.js | 4 - docs/search/functions_5.html | 37 - docs/search/functions_5.js | 10 - docs/search/functions_6.html | 37 - docs/search/functions_6.js | 4 - docs/search/mag_sel.svg | 74 - docs/search/nomatches.html | 13 - docs/search/pages_0.html | 37 - docs/search/pages_0.js | 4 - docs/search/search.css | 257 --- docs/search/search.js | 816 -------- docs/search/search_l.png | Bin 567 -> 0 bytes docs/search/search_m.png | Bin 158 -> 0 bytes docs/search/search_r.png | Bin 553 -> 0 bytes docs/search/searchdata.js | 33 - docs/splitbar.png | Bin 314 -> 0 bytes docs/sync_off.png | Bin 853 -> 0 bytes docs/sync_on.png | Bin 845 -> 0 bytes docs/tab_a.png | Bin 142 -> 0 bytes docs/tab_b.png | Bin 169 -> 0 bytes docs/tab_h.png | Bin 177 -> 0 bytes docs/tab_s.png | Bin 184 -> 0 bytes docs/tabs.css | 1 - 85 files changed, 6953 deletions(-) delete mode 100644 docs/_spark_fun___v_e_m_l7700___arduino___library_8h.html delete mode 100644 docs/_spark_fun___v_e_m_l7700___arduino___library_8h_source.html delete mode 100644 docs/annotated.html delete mode 100644 docs/bc_s.png delete mode 100644 docs/bdwn.png delete mode 100644 docs/class_v_e_m_l7700-members.html delete mode 100644 docs/class_v_e_m_l7700.html delete mode 100644 docs/classes.html delete mode 100644 docs/closed.png delete mode 100644 docs/dir_68267d1309a1af8e8297ef4c3efbcdba.html delete mode 100644 docs/doc.png delete mode 100644 docs/doxygen.css delete mode 100644 docs/doxygen.svg delete mode 100644 docs/dynsections.js delete mode 100644 docs/files.html delete mode 100644 docs/folderclosed.png delete mode 100644 docs/folderopen.png delete mode 100644 docs/functions.html delete mode 100644 docs/functions_func.html delete mode 100644 docs/globals.html delete mode 100644 docs/globals_defs.html delete mode 100644 docs/globals_enum.html delete mode 100644 docs/index.html delete mode 100644 docs/jquery.js delete mode 100644 docs/menu.js delete mode 100644 docs/menudata.js delete mode 100644 docs/nav_f.png delete mode 100644 docs/nav_g.png delete mode 100644 docs/nav_h.png delete mode 100644 docs/open.png delete mode 100644 docs/search/all_0.html delete mode 100644 docs/search/all_0.js delete mode 100644 docs/search/all_1.html delete mode 100644 docs/search/all_1.js delete mode 100644 docs/search/all_2.html delete mode 100644 docs/search/all_2.js delete mode 100644 docs/search/all_3.html delete mode 100644 docs/search/all_3.js delete mode 100644 docs/search/all_4.html delete mode 100644 docs/search/all_4.js delete mode 100644 docs/search/all_5.html delete mode 100644 docs/search/all_5.js delete mode 100644 docs/search/all_6.html delete mode 100644 docs/search/all_6.js delete mode 100644 docs/search/classes_0.html delete mode 100644 docs/search/classes_0.js delete mode 100644 docs/search/close.svg delete mode 100644 docs/search/defines_0.html delete mode 100644 docs/search/defines_0.js delete mode 100644 docs/search/enums_0.html delete mode 100644 docs/search/enums_0.js delete mode 100644 docs/search/files_0.html delete mode 100644 docs/search/files_0.js delete mode 100644 docs/search/functions_0.html delete mode 100644 docs/search/functions_0.js delete mode 100644 docs/search/functions_1.html delete mode 100644 docs/search/functions_1.js delete mode 100644 docs/search/functions_2.html delete mode 100644 docs/search/functions_2.js delete mode 100644 docs/search/functions_3.html delete mode 100644 docs/search/functions_3.js delete mode 100644 docs/search/functions_4.html delete mode 100644 docs/search/functions_4.js delete mode 100644 docs/search/functions_5.html delete mode 100644 docs/search/functions_5.js delete mode 100644 docs/search/functions_6.html delete mode 100644 docs/search/functions_6.js delete mode 100644 docs/search/mag_sel.svg delete mode 100644 docs/search/nomatches.html delete mode 100644 docs/search/pages_0.html delete mode 100644 docs/search/pages_0.js delete mode 100644 docs/search/search.css delete mode 100644 docs/search/search.js delete mode 100644 docs/search/search_l.png delete mode 100644 docs/search/search_m.png delete mode 100644 docs/search/search_r.png delete mode 100644 docs/search/searchdata.js delete mode 100644 docs/splitbar.png delete mode 100644 docs/sync_off.png delete mode 100644 docs/sync_on.png delete mode 100644 docs/tab_a.png delete mode 100644 docs/tab_b.png delete mode 100644 docs/tab_h.png delete mode 100644 docs/tab_s.png delete mode 100644 docs/tabs.css diff --git a/docs/_spark_fun___v_e_m_l7700___arduino___library_8h.html b/docs/_spark_fun___v_e_m_l7700___arduino___library_8h.html deleted file mode 100644 index e07d1b4..0000000 --- a/docs/_spark_fun___v_e_m_l7700___arduino___library_8h.html +++ /dev/null @@ -1,305 +0,0 @@ - - - - - - - -SparkFun_VEML7700_Arduino_Library: src/SparkFun_VEML7700_Arduino_Library.h File Reference - - - - - - - - - -
-
- - - - - - -
-
SparkFun_VEML7700_Arduino_Library -
-
-
- - - - - - - - -
-
- - -
- -
- - -
-
-
-Classes | -Macros | -Typedefs | -Enumerations | -Variables
-
-
SparkFun_VEML7700_Arduino_Library.h File Reference
-
-
-
#include <Arduino.h>
-#include <Wire.h>
-
-

Go to the source code of this file.

- - - - -

-Classes

class  VEML7700
 
- - - -

-Macros

#define VEML7700_I2C_ADDRESS   0x10
 
- - - -

-Typedefs

-typedef uint16_t VEML7700_t
 
- - - - - - - - - - - - - - - -

-Enumerations

enum  VEML7700_error_t {
-  VEML7700_ERROR_READ = -4 -, VEML7700_ERROR_WRITE = -3 -, VEML7700_ERROR_INVALID_ADDRESS = -2 -, VEML7700_ERROR_UNDEFINED = -1 -,
-  VEML7700_ERROR_SUCCESS = 1 -
- }
 
enum  VEML7700_sensitivity_mode_t {
-  VEML7700_SENSITIVITY_x1 -, VEML7700_SENSITIVITY_x2 -, VEML7700_SENSITIVITY_x1_8 -, VEML7700_SENSITIVITY_x1_4 -,
-  VEML7700_SENSITIVITY_INVALID -
- }
 
enum  VEML7700_integration_time_t {
-  VEML7700_INTEGRATION_25ms -, VEML7700_INTEGRATION_50ms -, VEML7700_INTEGRATION_100ms -, VEML7700_INTEGRATION_200ms -,
-  VEML7700_INTEGRATION_400ms -, VEML7700_INTEGRATION_800ms -, VEML7700_INTEGRATION_INVALID -
- }
 
enum  VEML7700_persistence_protect_t {
-  VEML7700_PERSISTENCE_1 -, VEML7700_PERSISTENCE_2 -, VEML7700_PERSISTENCE_4 -, VEML7700_PERSISTENCE_8 -,
-  VEML7700_PERSISTENCE_INVALID -
- }
 
enum  VEML7700_interrupt_enable_t { VEML7700_INT_DISABLE -, VEML7700_INT_ENABLE -, VEML7700_INT_INVALID - }
 
enum  VEML7700_interrupt_status_t {
-  VEML7700_INT_STATUS_NONE -, VEML7700_INT_STATUS_HIGH -, VEML7700_INT_STATUS_LOW -, VEML7700_INT_STATUS_BOTH -,
-  VEML7700_INT_STATUS_INVALID -
- }
 
enum  VEML7700_shutdown_t { VEML7700_POWER_ON -, VEML7700_SHUT_DOWN -, VEML7700_SHUTDOWN_INVALID - }
 
- - - -

-Variables

-const VEML7700_error_t VEML7700_SUCCESS = VEML7700_ERROR_SUCCESS
 
-

Detailed Description

-

SparkFun VEML7700 Ambient Light Sensor Arduino Library

-

This library facilitates communication with the VEML7700 over I2C.

-

Want to support open source hardware? Buy a board from SparkFun!
-SparkX smôl Environmental Peripheral Board (SPX-18976): https://www.sparkfun.com/products/18976

-

This library was written by: Paul Clark SparkFun Electronics November 4th 2021

-

Please see LICENSE.md for the license information

-

Macro Definition Documentation

- -

◆ VEML7700_I2C_ADDRESS

- -
-
- - - - -
#define VEML7700_I2C_ADDRESS   0x10
-
-

VEML7700 I2C address

- -
-
-

Enumeration Type Documentation

- -

◆ VEML7700_error_t

- -
-
- - - - -
enum VEML7700_error_t
-
-

VEML7700 error code returns

- -
-
- -

◆ VEML7700_integration_time_t

- -
-
- - - - -
enum VEML7700_integration_time_t
-
-

ALS integration time setting Note: these are defined here in simple sequential order. The actual register settings are defined in VEML7700_config_integration_time_t

- -
-
- -

◆ VEML7700_interrupt_enable_t

- -
-
- - - - -
enum VEML7700_interrupt_enable_t
-
-

ALS interrupt enable setting

- -
-
- -

◆ VEML7700_interrupt_status_t

- -
-
- - - - -
enum VEML7700_interrupt_status_t
-
-

ALS interrupt status, logical OR of the crossing low and high thrteshold INT triggers

- -
-
- -

◆ VEML7700_persistence_protect_t

- -
-
- - - - -
enum VEML7700_persistence_protect_t
-
-

ALS persistence protect number setting

- -
-
- -

◆ VEML7700_sensitivity_mode_t

- -
-
- - - - -
enum VEML7700_sensitivity_mode_t
-
-

Sensitivity mode selection

- -
-
- -

◆ VEML7700_shutdown_t

- -
-
- - - - -
enum VEML7700_shutdown_t
-
-

ALS shut down setting

- -
-
-
- -
-Generated by doxygen 1.9.1 -
- - diff --git a/docs/_spark_fun___v_e_m_l7700___arduino___library_8h_source.html b/docs/_spark_fun___v_e_m_l7700___arduino___library_8h_source.html deleted file mode 100644 index 1261d35..0000000 --- a/docs/_spark_fun___v_e_m_l7700___arduino___library_8h_source.html +++ /dev/null @@ -1,317 +0,0 @@ - - - - - - - -SparkFun_VEML7700_Arduino_Library: src/SparkFun_VEML7700_Arduino_Library.h Source File - - - - - - - - - -
-
- - - - - - -
-
SparkFun_VEML7700_Arduino_Library -
-
-
- - - - - - - - -
-
- - -
- -
- - -
-
-
-
SparkFun_VEML7700_Arduino_Library.h
-
-
-Go to the documentation of this file.
1 
-
20 #ifndef __SFE_SMOL_POWER_BOARD__
-
21 #define __SFE_SMOL_POWER_BOARD__
-
22 
-
23 #include <Arduino.h>
-
24 #include <Wire.h>
-
25 
-
26 typedef uint16_t VEML7700_t;
-
27 
-
29 #define VEML7700_I2C_ADDRESS 0x10
-
30 
-
32 typedef enum
-
33 {
-
34  VEML7700_ERROR_READ = -4,
-
35  VEML7700_ERROR_WRITE = -3,
-
36  VEML7700_ERROR_INVALID_ADDRESS = -2,
-
37  VEML7700_ERROR_UNDEFINED = -1,
-
38  VEML7700_ERROR_SUCCESS = 1
-
39 } VEML7700_error_t;
-
40 const VEML7700_error_t VEML7700_SUCCESS = VEML7700_ERROR_SUCCESS;
-
41 
-
43 typedef enum
-
44 {
-
45  VEML7700_SENSITIVITY_x1,
-
46  VEML7700_SENSITIVITY_x2,
-
47  VEML7700_SENSITIVITY_x1_8,
-
48  VEML7700_SENSITIVITY_x1_4,
-
49  VEML7700_SENSITIVITY_INVALID
-
50 } VEML7700_sensitivity_mode_t;
-
51 
-
55 typedef enum
-
56 {
-
57  VEML7700_INTEGRATION_25ms,
-
58  VEML7700_INTEGRATION_50ms,
-
59  VEML7700_INTEGRATION_100ms,
-
60  VEML7700_INTEGRATION_200ms,
-
61  VEML7700_INTEGRATION_400ms,
-
62  VEML7700_INTEGRATION_800ms,
-
63  VEML7700_INTEGRATION_INVALID
-
64 } VEML7700_integration_time_t;
-
65 
-
67 typedef enum
-
68 {
-
69  VEML7700_PERSISTENCE_1,
-
70  VEML7700_PERSISTENCE_2,
-
71  VEML7700_PERSISTENCE_4,
-
72  VEML7700_PERSISTENCE_8,
-
73  VEML7700_PERSISTENCE_INVALID
-
74 } VEML7700_persistence_protect_t;
-
75 
-
77 typedef enum
-
78 {
-
79  VEML7700_INT_DISABLE,
-
80  VEML7700_INT_ENABLE,
-
81  VEML7700_INT_INVALID
-
82 } VEML7700_interrupt_enable_t;
-
83 
-
85 typedef enum
-
86 {
-
87  VEML7700_INT_STATUS_NONE,
-
88  VEML7700_INT_STATUS_HIGH,
-
89  VEML7700_INT_STATUS_LOW,
-
90  VEML7700_INT_STATUS_BOTH,
-
91  VEML7700_INT_STATUS_INVALID
-
92 } VEML7700_interrupt_status_t;
-
93 
-
95 typedef enum
-
96 {
-
97  VEML7700_POWER_ON,
-
98  VEML7700_SHUT_DOWN,
-
99  VEML7700_SHUTDOWN_INVALID
-
100 } VEML7700_shutdown_t;
-
101 
-
103 class VEML7700
-
104 {
-
105 public:
-
107  VEML7700();
-
108 
-
110  bool begin(TwoWire &wirePort = Wire);
-
111 
-
113  void enableDebugging(Stream &debugPort = Serial);
-
114  void disableDebugging();
-
115 
-
116  bool isConnected();
-
117 
-
120  VEML7700_error_t setShutdown(VEML7700_shutdown_t);
-
121  VEML7700_error_t powerOn() { return setShutdown(VEML7700_POWER_ON); };
-
122  VEML7700_error_t shutdown() { return setShutdown(VEML7700_SHUT_DOWN); };
-
123  VEML7700_shutdown_t getShutdown();
-
124 
-
125  VEML7700_error_t setInterruptEnable(VEML7700_interrupt_enable_t ie);
-
126  VEML7700_error_t getInterruptEnable(VEML7700_interrupt_enable_t *ie);
-
127  VEML7700_interrupt_enable_t getInterruptEnable();
-
128 
-
129  VEML7700_error_t setPersistenceProtect(VEML7700_persistence_protect_t pp);
-
130  VEML7700_error_t getPersistenceProtect(VEML7700_persistence_protect_t *pp);
-
131  VEML7700_persistence_protect_t getPersistenceProtect();
-
132  const char * getPersistenceProtectStr();
-
133 
-
134  VEML7700_error_t setIntegrationTime(VEML7700_integration_time_t it);
-
135  VEML7700_error_t getIntegrationTime(VEML7700_integration_time_t *it);
-
136  VEML7700_integration_time_t getIntegrationTime();
-
137  const char * getIntegrationTimeStr();
-
138 
-
139  VEML7700_error_t setSensitivityMode(VEML7700_sensitivity_mode_t sm);
-
140  VEML7700_error_t getSensitivityMode(VEML7700_sensitivity_mode_t *sm);
-
141  VEML7700_sensitivity_mode_t getSensitivityMode();
-
142  const char * getSensitivityModeStr();
-
143 
-
144  VEML7700_error_t setHighThreshold(uint16_t threshold);
-
145  VEML7700_error_t getHighThreshold(uint16_t *threshold);
-
146  uint16_t getHighThreshold();
-
147 
-
148  VEML7700_error_t setLowThreshold(uint16_t threshold);
-
149  VEML7700_error_t getLowThreshold(uint16_t *threshold);
-
150  uint16_t getLowThreshold();
-
151 
-
154  VEML7700_error_t getAmbientLight(uint16_t *ambient);
-
155  uint16_t getAmbientLight();
-
156 
-
157  VEML7700_error_t getWhiteLevel(uint16_t *whiteLevel);
-
158  uint16_t getWhiteLevel();
-
159 
-
160  VEML7700_error_t getLux(float *lux);
-
161  float getLux();
-
162 
-
165  VEML7700_error_t getInterruptStatus(VEML7700_interrupt_status_t *status);
-
166  VEML7700_interrupt_status_t getInterruptStatus();
-
167 
-
168 private:
-
169 
-
171  typedef struct
-
172  {
-
173  union
-
174  {
-
175  VEML7700_t all;
-
176  struct
-
177  {
-
178  VEML7700_t CONFIG_REG_SD : 1; // ALS shut down
-
179  VEML7700_t CONFIG_REG_INT_EN : 1; // ALS interrupt enable
-
180  VEML7700_t CONFIG_REG_RES1 : 2; // Reserved
-
181  VEML7700_t CONFIG_REG_PERS : 2; // ALS persistence protect number
-
182  VEML7700_t CONFIG_REG_IT : 4; // ALS integration time
-
183  VEML7700_t CONFIG_REG_RES2 : 1; // Reserved
-
184  VEML7700_t CONFIG_REG_SM : 2; // ALS sensitivity mode
-
185  VEML7700_t CONFIG_REG_RES3 : 3; // Reserved
-
186  };
-
187  };
-
188  } VEML7700_CONFIGURATION_REGISTER_t;
-
189  VEML7700_CONFIGURATION_REGISTER_t _configurationRegister;
-
190 
-
194  typedef struct
-
195  {
-
196  union
-
197  {
-
198  VEML7700_t all;
-
199  struct
-
200  {
-
201  VEML7700_t INT_STATUS_REG_RES : 14; // Reserved
-
202  // Bit 14 indicates if the high threshold was exceeded
-
203  // Bit 15 indicates if the low threshold was exceeded
-
204  VEML7700_t INT_STATUS_REG_INT_FLAGS : 2;
-
205  };
-
206  };
-
207  } VEML7700_INTERRUPT_STATUS_REGISTER_t;
-
208 
-
210  typedef enum
-
211  {
-
212  VEML7700_CONFIGURATION_REGISTER,
-
213  VEML7700_HIGH_THRESHOLD,
-
214  VEML7700_LOW_THRESHOLD,
-
215  VEML7700_ALS_OUTPUT = 4,
-
216  VEML7700_WHITE_OUTPUT,
-
217  VEML7700_INTERRUPT_STATUS
-
218  } VEML7700_registers_t;
-
219 
-
221  typedef enum
-
222  {
-
223  VEML7700_CONFIG_INTEGRATION_25ms = 0b1100,
-
224  VEML7700_CONFIG_INTEGRATION_50ms = 0b1000,
-
225  VEML7700_CONFIG_INTEGRATION_100ms = 0b0000,
-
226  VEML7700_CONFIG_INTEGRATION_200ms = 0b0001,
-
227  VEML7700_CONFIG_INTEGRATION_400ms = 0b0010,
-
228  VEML7700_CONFIG_INTEGRATION_800ms = 0b0011,
-
229  VEML7700_CONFIG_INTEGRATION_INVALID
-
230  } VEML7700_config_integration_time_t;
-
231 
-
232  TwoWire *_i2cPort;
-
233  Stream *_debugPort;
-
234  uint8_t _deviceAddress;
-
235  bool _debugEnabled;
-
236 
-
237  VEML7700_error_t _connected(void);
-
238 
-
240  VEML7700_error_t readI2CBuffer(uint8_t *dest, VEML7700_registers_t startRegister, uint16_t len);
-
241  VEML7700_error_t writeI2CBuffer(uint8_t *src, VEML7700_registers_t startRegister, uint16_t len);
-
242  VEML7700_error_t readI2CRegister(VEML7700_t *dest, VEML7700_registers_t registerAddress);
-
243  VEML7700_error_t writeI2CRegister(VEML7700_t data, VEML7700_registers_t registerAddress);
-
244 
-
246  VEML7700_config_integration_time_t integrationTimeConfig(VEML7700_integration_time_t it);
-
248  VEML7700_integration_time_t integrationTimeFromConfig(VEML7700_config_integration_time_t it);
-
249 
-
250 };
-
251 
-
252 #endif
-
VEML7700_interrupt_enable_t
VEML7700_interrupt_enable_t
Definition: SparkFun_VEML7700_Arduino_Library.h:78
-
VEML7700_integration_time_t
VEML7700_integration_time_t
Definition: SparkFun_VEML7700_Arduino_Library.h:56
-
VEML7700_shutdown_t
VEML7700_shutdown_t
Definition: SparkFun_VEML7700_Arduino_Library.h:96
-
VEML7700_error_t
VEML7700_error_t
Definition: SparkFun_VEML7700_Arduino_Library.h:33
-
VEML7700_interrupt_status_t
VEML7700_interrupt_status_t
Definition: SparkFun_VEML7700_Arduino_Library.h:86
-
VEML7700_sensitivity_mode_t
VEML7700_sensitivity_mode_t
Definition: SparkFun_VEML7700_Arduino_Library.h:44
-
VEML7700_persistence_protect_t
VEML7700_persistence_protect_t
Definition: SparkFun_VEML7700_Arduino_Library.h:68
-
VEML7700
Definition: SparkFun_VEML7700_Arduino_Library.h:104
-
VEML7700::getPersistenceProtectStr
const char * getPersistenceProtectStr()
Get the VEML7700's persistence protect number setting (ALS_PERS) as printable text.
Definition: SparkFun_VEML7700_Arduino_Library.cpp:366
-
VEML7700::setInterruptEnable
VEML7700_error_t setInterruptEnable(VEML7700_interrupt_enable_t ie)
Set the VEML7700's interrupt enable setting (ALS_INT_EN)
Definition: SparkFun_VEML7700_Arduino_Library.cpp:223
-
VEML7700::getInterruptEnable
VEML7700_interrupt_enable_t getInterruptEnable()
Get the VEML7700's interrupt enable setting (ALS_INT_EN)
Definition: SparkFun_VEML7700_Arduino_Library.cpp:270
-
VEML7700::setShutdown
VEML7700_error_t setShutdown(VEML7700_shutdown_t)
Set the VEML7700's shut down setting (ALS_SD)
Definition: SparkFun_VEML7700_Arduino_Library.cpp:179
-
VEML7700::enableDebugging
void enableDebugging(Stream &debugPort=Serial)
Enable debug messages on the chosen Serial port (Stream)
Definition: SparkFun_VEML7700_Arduino_Library.cpp:117
-
VEML7700::setLowThreshold
VEML7700_error_t setLowThreshold(uint16_t threshold)
Set the VEML7700's ALS low threshold window setting (ALS_WL)
Definition: SparkFun_VEML7700_Arduino_Library.cpp:612
-
VEML7700::getLowThreshold
uint16_t getLowThreshold()
Get the VEML7700's ALS low threshold window setting (ALS_WL)
Definition: SparkFun_VEML7700_Arduino_Library.cpp:636
-
VEML7700::VEML7700
VEML7700()
Class to communicate with the VEML7700.
Definition: SparkFun_VEML7700_Arduino_Library.cpp:64
-
VEML7700::setHighThreshold
VEML7700_error_t setHighThreshold(uint16_t threshold)
Set the VEML7700's ALS high threshold window setting (ALS_WH)
Definition: SparkFun_VEML7700_Arduino_Library.cpp:573
-
VEML7700::getInterruptStatus
VEML7700_interrupt_status_t getInterruptStatus()
Read the VEML7700's interrupt status register Note: reading the interrupt status register clears the...
Definition: SparkFun_VEML7700_Arduino_Library.cpp:833
-
VEML7700::setIntegrationTime
VEML7700_error_t setIntegrationTime(VEML7700_integration_time_t it)
Set the VEML7700's integration time setting (ALS_IT) Note: these are defined here in simple sequenti...
Definition: SparkFun_VEML7700_Arduino_Library.cpp:391
-
VEML7700::getAmbientLight
uint16_t getAmbientLight()
Get the VEML7700's ambient light sensor data (ALS)
Definition: SparkFun_VEML7700_Arduino_Library.cpp:662
-
VEML7700::getIntegrationTime
VEML7700_integration_time_t getIntegrationTime()
Get the VEML7700's integration time setting (ALS_IT)
Definition: SparkFun_VEML7700_Arduino_Library.cpp:446
-
VEML7700::getIntegrationTimeStr
const char * getIntegrationTimeStr()
Get the VEML7700's integration time setting (ALS_IT) as printable text.
Definition: SparkFun_VEML7700_Arduino_Library.cpp:464
-
VEML7700::getSensitivityModeStr
const char * getSensitivityModeStr()
Get the VEML7700's sensitivity mode selection (ALS_SM) as printable text.
Definition: SparkFun_VEML7700_Arduino_Library.cpp:556
-
VEML7700::isConnected
bool isConnected()
Check that the VEML7700 is awake and communicating.
Definition: SparkFun_VEML7700_Arduino_Library.cpp:139
-
VEML7700::getSensitivityMode
VEML7700_sensitivity_mode_t getSensitivityMode()
Get the VEML7700's sensitivity mode selection (ALS_SM)
Definition: SparkFun_VEML7700_Arduino_Library.cpp:538
-
VEML7700::disableDebugging
void disableDebugging()
Disable debug messages.
Definition: SparkFun_VEML7700_Arduino_Library.cpp:128
-
VEML7700::getWhiteLevel
uint16_t getWhiteLevel()
Get the VEML7700's white level data (WHITE)
Definition: SparkFun_VEML7700_Arduino_Library.cpp:688
-
VEML7700::getHighThreshold
uint16_t getHighThreshold()
Get the VEML7700's ALS high threshold window setting (ALS_WH)
Definition: SparkFun_VEML7700_Arduino_Library.cpp:597
-
VEML7700::getLux
float getLux()
Read the sensor data and calculate the lux.
Definition: SparkFun_VEML7700_Arduino_Library.cpp:776
-
VEML7700::setPersistenceProtect
VEML7700_error_t setPersistenceProtect(VEML7700_persistence_protect_t pp)
Set the VEML7700's persistence protect number setting (ALS_PERS)
Definition: SparkFun_VEML7700_Arduino_Library.cpp:295
-
VEML7700::setSensitivityMode
VEML7700_error_t setSensitivityMode(VEML7700_sensitivity_mode_t sm)
Set the VEML7700's sensitivity mode selection (ALS_SM)
Definition: SparkFun_VEML7700_Arduino_Library.cpp:485
-
VEML7700::getPersistenceProtect
VEML7700_persistence_protect_t getPersistenceProtect()
Get the VEML7700's persistence protect number setting (ALS_PERS)
Definition: SparkFun_VEML7700_Arduino_Library.cpp:348
-
VEML7700::getShutdown
VEML7700_shutdown_t getShutdown()
Get the VEML7700's shut down setting (ALS_SD)
Definition: SparkFun_VEML7700_Arduino_Library.cpp:200
-
VEML7700::begin
bool begin(TwoWire &wirePort=Wire)
Begin communication with the VEML7700.
Definition: SparkFun_VEML7700_Arduino_Library.cpp:81
-
- -
-Generated by doxygen 1.9.1 -
- - diff --git a/docs/annotated.html b/docs/annotated.html deleted file mode 100644 index 1c73ad0..0000000 --- a/docs/annotated.html +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - - -SparkFun_VEML7700_Arduino_Library: Class List - - - - - - - - - -
-
- - - - - - -
-
SparkFun_VEML7700_Arduino_Library -
-
-
- - - - - - - -
- -
-
- - -
- -
- -
-
-
Class List
-
-
-
Here are the classes, structs, unions and interfaces with brief descriptions:
- - -
 CVEML7700
-
-
- -
-Generated by doxygen 1.9.1 -
- - diff --git a/docs/bc_s.png b/docs/bc_s.png deleted file mode 100644 index 224b29aa9847d5a4b3902efd602b7ddf7d33e6c2..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 676 zcmV;V0$crwP)y__>=_9%My z{n931IS})GlGUF8K#6VIbs%684A^L3@%PlP2>_sk`UWPq@f;rU*V%rPy_ekbhXT&s z(GN{DxFv}*vZp`F>S!r||M`I*nOwwKX+BC~3P5N3-)Y{65c;ywYiAh-1*hZcToLHK ztpl1xomJ+Yb}K(cfbJr2=GNOnT!UFA7Vy~fBz8?J>XHsbZoDad^8PxfSa0GDgENZS zuLCEqzb*xWX2CG*b&5IiO#NzrW*;`VC9455M`o1NBh+(k8~`XCEEoC1Ybwf;vr4K3 zg|EB<07?SOqHp9DhLpS&bzgo70I+ghB_#)K7H%AMU3v}xuyQq9&Bm~++VYhF09a+U zl7>n7Jjm$K#b*FONz~fj;I->Bf;ule1prFN9FovcDGBkpg>)O*-}eLnC{6oZHZ$o% zXKW$;0_{8hxHQ>l;_*HATI(`7t#^{$(zLe}h*mqwOc*nRY9=?Sx4OOeVIfI|0V(V2 zBrW#G7Ss9wvzr@>H*`r>zE z+e8bOBgqIgldUJlG(YUDviMB`9+DH8n-s9SXRLyJHO1!=wY^79WYZMTa(wiZ!zP66 zA~!21vmF3H2{ngD;+`6j#~6j;$*f*G_2ZD1E;9(yaw7d-QnSCpK(cR1zU3qU0000< KMNUMnLSTYoA~SLT diff --git a/docs/bdwn.png b/docs/bdwn.png deleted file mode 100644 index 940a0b950443a0bb1b216ac03c45b8a16c955452..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 147 zcmeAS@N?(olHy`uVBq!ia0vp^>_E)H!3HEvS)PKZC{Gv1kP61Pb5HX&C2wk~_T - - - - - - -SparkFun_VEML7700_Arduino_Library: Member List - - - - - - - - - -
-
- - - - - - -
-
SparkFun_VEML7700_Arduino_Library -
-
-
- - - - - - - - -
-
- - -
- -
- -
-
-
-
VEML7700 Member List
-
-
- -

This is the complete list of members for VEML7700, including all inherited members.

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
begin(TwoWire &wirePort=Wire)VEML7700
disableDebugging()VEML7700
enableDebugging(Stream &debugPort=Serial)VEML7700
getAmbientLight(uint16_t *ambient)VEML7700
getAmbientLight()VEML7700
getHighThreshold(uint16_t *threshold)VEML7700
getHighThreshold()VEML7700
getIntegrationTime(VEML7700_integration_time_t *it)VEML7700
getIntegrationTime()VEML7700
getIntegrationTimeStr()VEML7700
getInterruptEnable(VEML7700_interrupt_enable_t *ie)VEML7700
getInterruptEnable()VEML7700
getInterruptStatus(VEML7700_interrupt_status_t *status)VEML7700
getInterruptStatus()VEML7700
getLowThreshold(uint16_t *threshold)VEML7700
getLowThreshold()VEML7700
getLux(float *lux)VEML7700
getLux()VEML7700
getPersistenceProtect(VEML7700_persistence_protect_t *pp)VEML7700
getPersistenceProtect()VEML7700
getPersistenceProtectStr()VEML7700
getSensitivityMode(VEML7700_sensitivity_mode_t *sm)VEML7700
getSensitivityMode()VEML7700
getSensitivityModeStr()VEML7700
getShutdown()VEML7700
getWhiteLevel(uint16_t *whiteLevel)VEML7700
getWhiteLevel()VEML7700
isConnected()VEML7700
powerOn() (defined in VEML7700)VEML7700inline
setHighThreshold(uint16_t threshold)VEML7700
setIntegrationTime(VEML7700_integration_time_t it)VEML7700
setInterruptEnable(VEML7700_interrupt_enable_t ie)VEML7700
setLowThreshold(uint16_t threshold)VEML7700
setPersistenceProtect(VEML7700_persistence_protect_t pp)VEML7700
setSensitivityMode(VEML7700_sensitivity_mode_t sm)VEML7700
setShutdown(VEML7700_shutdown_t)VEML7700
shutdown() (defined in VEML7700)VEML7700inline
VEML7700()VEML7700
- -
-Generated by doxygen 1.9.1 -
- - diff --git a/docs/class_v_e_m_l7700.html b/docs/class_v_e_m_l7700.html deleted file mode 100644 index fa7ad94..0000000 --- a/docs/class_v_e_m_l7700.html +++ /dev/null @@ -1,1055 +0,0 @@ - - - - - - - -SparkFun_VEML7700_Arduino_Library: VEML7700 Class Reference - - - - - - - - - -
-
- - - - - - -
-
SparkFun_VEML7700_Arduino_Library -
-
-
- - - - - - - - -
-
- - -
- -
- -
-
-
-Classes | -Public Member Functions | -List of all members
-
-
VEML7700 Class Reference
-
-
- -

#include <SparkFun_VEML7700_Arduino_Library.h>

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

-Public Member Functions

- VEML7700 ()
 Class to communicate with the VEML7700.
 
bool begin (TwoWire &wirePort=Wire)
 Begin communication with the VEML7700. More...
 
void enableDebugging (Stream &debugPort=Serial)
 Enable debug messages on the chosen Serial port (Stream) More...
 
-void disableDebugging ()
 Disable debug messages.
 
bool isConnected ()
 Check that the VEML7700 is awake and communicating. More...
 
VEML7700_error_t setShutdown (VEML7700_shutdown_t)
 Set the VEML7700's shut down setting (ALS_SD) More...
 
-VEML7700_error_t powerOn ()
 
-VEML7700_error_t shutdown ()
 
VEML7700_shutdown_t getShutdown ()
 Get the VEML7700's shut down setting (ALS_SD) More...
 
VEML7700_error_t setInterruptEnable (VEML7700_interrupt_enable_t ie)
 Set the VEML7700's interrupt enable setting (ALS_INT_EN) More...
 
VEML7700_error_t getInterruptEnable (VEML7700_interrupt_enable_t *ie)
 Get the VEML7700's interrupt enable setting (ALS_INT_EN) More...
 
VEML7700_interrupt_enable_t getInterruptEnable ()
 Get the VEML7700's interrupt enable setting (ALS_INT_EN) More...
 
VEML7700_error_t setPersistenceProtect (VEML7700_persistence_protect_t pp)
 Set the VEML7700's persistence protect number setting (ALS_PERS) More...
 
VEML7700_error_t getPersistenceProtect (VEML7700_persistence_protect_t *pp)
 Get the VEML7700's persistence protect number setting (ALS_PERS) More...
 
VEML7700_persistence_protect_t getPersistenceProtect ()
 Get the VEML7700's persistence protect number setting (ALS_PERS) More...
 
-const char * getPersistenceProtectStr ()
 Get the VEML7700's persistence protect number setting (ALS_PERS) as printable text.
 
VEML7700_error_t setIntegrationTime (VEML7700_integration_time_t it)
 Set the VEML7700's integration time setting (ALS_IT)
-Note: these are defined here in simple sequential order
-The actual register settings are defined in VEML7700_config_integration_time_t. More...
 
VEML7700_error_t getIntegrationTime (VEML7700_integration_time_t *it)
 Get the VEML7700's integration time setting (ALS_IT) More...
 
VEML7700_integration_time_t getIntegrationTime ()
 Get the VEML7700's integration time setting (ALS_IT) More...
 
-const char * getIntegrationTimeStr ()
 Get the VEML7700's integration time setting (ALS_IT) as printable text.
 
VEML7700_error_t setSensitivityMode (VEML7700_sensitivity_mode_t sm)
 Set the VEML7700's sensitivity mode selection (ALS_SM) More...
 
VEML7700_error_t getSensitivityMode (VEML7700_sensitivity_mode_t *sm)
 Get the VEML7700's sensitivity mode selection (ALS_SM) More...
 
VEML7700_sensitivity_mode_t getSensitivityMode ()
 Get the VEML7700's sensitivity mode selection (ALS_SM) More...
 
-const char * getSensitivityModeStr ()
 Get the VEML7700's sensitivity mode selection (ALS_SM) as printable text.
 
VEML7700_error_t setHighThreshold (uint16_t threshold)
 Set the VEML7700's ALS high threshold window setting (ALS_WH) More...
 
VEML7700_error_t getHighThreshold (uint16_t *threshold)
 Get the VEML7700's ALS high threshold window setting (ALS_WH) More...
 
uint16_t getHighThreshold ()
 Get the VEML7700's ALS high threshold window setting (ALS_WH) More...
 
VEML7700_error_t setLowThreshold (uint16_t threshold)
 Set the VEML7700's ALS low threshold window setting (ALS_WL) More...
 
VEML7700_error_t getLowThreshold (uint16_t *threshold)
 Get the VEML7700's ALS low threshold window setting (ALS_WL) More...
 
uint16_t getLowThreshold ()
 Get the VEML7700's ALS low threshold window setting (ALS_WL) More...
 
VEML7700_error_t getAmbientLight (uint16_t *ambient)
 Get the VEML7700's ambient light sensor data (ALS) More...
 
uint16_t getAmbientLight ()
 Get the VEML7700's ambient light sensor data (ALS) More...
 
VEML7700_error_t getWhiteLevel (uint16_t *whiteLevel)
 Get the VEML7700's white level data (WHITE) More...
 
uint16_t getWhiteLevel ()
 Get the VEML7700's white level data (WHITE) More...
 
VEML7700_error_t getLux (float *lux)
 Read the sensor data and calculate the lux. More...
 
float getLux ()
 Read the sensor data and calculate the lux. More...
 
VEML7700_error_t getInterruptStatus (VEML7700_interrupt_status_t *status)
 Read the VEML7700's interrupt status register
-Note: reading the interrupt status register clears the interrupts.
- So, we need to check both interrupt flags in a single read. More...
 
VEML7700_interrupt_status_t getInterruptStatus ()
 Read the VEML7700's interrupt status register
-Note: reading the interrupt status register clears the interrupts.
- So, we need to check both interrupt flags in a single read. More...
 
-

Detailed Description

-

Communication interface for the VEML7700

-

Member Function Documentation

- -

◆ begin()

- -
-
- - - - - - - - -
bool VEML7700::begin (TwoWire & wirePort = Wire)
-
- -

Begin communication with the VEML7700.

-

Begin the VEML7700. Default to Wire

-
Parameters
- - -
wirePort
-The TwoWire (I2C) port used to communicate with the sensor.
-Default is Wire.
-
-
-
Returns
True if communication with the VEML7700 was successful, otherwise false.
-

Write _configurationRegister into the VEML7700_CONFIGURATION_REGISTER. This will place the device into a known state, in case it was configured previously and remained powered on when the code was restarted.

- -
-
- -

◆ enableDebugging()

- -
-
- - - - - - - - -
void VEML7700::enableDebugging (Stream & debugPort = Serial)
-
- -

Enable debug messages on the chosen Serial port (Stream)

-

Enable debug messages. Default to Serial

-
Parameters
- - -
debugPort
-The Serial port (Stream) the debug messages will be printed to.
-Default is Serial.
-
-
- -
-
- -

◆ getAmbientLight() [1/2]

- -
-
- - - - - - - -
uint16_t VEML7700::getAmbientLight ()
-
- -

Get the VEML7700's ambient light sensor data (ALS)

-
Returns
The ambient light reading
- -
-
- -

◆ getAmbientLight() [2/2]

- -
-
- - - - - - - - -
VEML7700_error_t VEML7700::getAmbientLight (uint16_t * ambient)
-
- -

Get the VEML7700's ambient light sensor data (ALS)

-

Read the sensor data

-
Parameters
- - -
ambient
-Will be set to the ambient level on return
-
-
-
Returns
VEML7700_SUCCESS (VEML7700_ERROR_SUCCESS) if successful
- -
-
- -

◆ getHighThreshold() [1/2]

- -
-
- - - - - - - -
uint16_t VEML7700::getHighThreshold ()
-
- -

Get the VEML7700's ALS high threshold window setting (ALS_WH)

-
Returns
The threshold setting
- -
-
- -

◆ getHighThreshold() [2/2]

- -
-
- - - - - - - - -
VEML7700_error_t VEML7700::getHighThreshold (uint16_t * threshold)
-
- -

Get the VEML7700's ALS high threshold window setting (ALS_WH)

-
Parameters
- - -
threshold
-Will be set to the threshold setting on return
-
-
-
Returns
VEML7700_SUCCESS (VEML7700_ERROR_SUCCESS) if successful
- -
-
- -

◆ getIntegrationTime() [1/2]

- -
-
- - - - - - - -
VEML7700_integration_time_t VEML7700::getIntegrationTime ()
-
- -

Get the VEML7700's integration time setting (ALS_IT)

-
Returns
If successful:
-VEML7700_INTEGRATION_25ms
-VEML7700_INTEGRATION_50ms
-VEML7700_INTEGRATION_100ms
-VEML7700_INTEGRATION_200ms
-VEML7700_INTEGRATION_400ms
-VEML7700_INTEGRATION_800ms
-Otherwise:
-VEML7700_INTEGRATION_INVALID
- -
-
- -

◆ getIntegrationTime() [2/2]

- -
-
- - - - - - - - -
VEML7700_error_t VEML7700::getIntegrationTime (VEML7700_integration_time_t * it)
-
- -

Get the VEML7700's integration time setting (ALS_IT)

-
Parameters
- - -
it
-Will be set to the intergration time setting on return
-
-
-
Returns
VEML7700_SUCCESS (VEML7700_ERROR_SUCCESS) if successful
- -
-
- -

◆ getInterruptEnable() [1/2]

- -
-
- - - - - - - -
VEML7700_interrupt_enable_t VEML7700::getInterruptEnable ()
-
- -

Get the VEML7700's interrupt enable setting (ALS_INT_EN)

-
Returns
VEML7700_INT_DISABLE or VEML7700_INT_ENABLE if successful, VEML7700_INT_INVALID otherwise
- -
-
- -

◆ getInterruptEnable() [2/2]

- -
-
- - - - - - - - -
VEML7700_error_t VEML7700::getInterruptEnable (VEML7700_interrupt_enable_t * ie)
-
- -

Get the VEML7700's interrupt enable setting (ALS_INT_EN)

-
Parameters
- - -
ie
-Will be set to the interrupt enable setting on return
-
-
-
Returns
VEML7700_SUCCESS (VEML7700_ERROR_SUCCESS) if successful
- -
-
- -

◆ getInterruptStatus() [1/2]

- -
-
- - - - - - - -
VEML7700_interrupt_status_t VEML7700::getInterruptStatus ()
-
- -

Read the VEML7700's interrupt status register
-Note: reading the interrupt status register clears the interrupts.
- So, we need to check both interrupt flags in a single read.

-
Returns
If successful:
-VEML7700_INT_STATUS_NONE
-VEML7700_INT_STATUS_HIGH
-VEML7700_INT_STATUS_LOW
-VEML7700_INT_STATUS_BOTH
-Otherwise:
-VEML7700_INT_STATUS_INVALID
- -
-
- -

◆ getInterruptStatus() [2/2]

- -
-
- - - - - - - - -
VEML7700_error_t VEML7700::getInterruptStatus (VEML7700_interrupt_status_t * status)
-
- -

Read the VEML7700's interrupt status register
-Note: reading the interrupt status register clears the interrupts.
- So, we need to check both interrupt flags in a single read.

-

Note: reading the interrupt status register clears the interrupts. So, we need to check both interrupt flags in a single read.

-
Parameters
- - -
status
-Will be set to the logical OR of ALS_IF_L and ALS_IF_H on return
-Possible values are:
-VEML7700_INT_STATUS_NONE
-VEML7700_INT_STATUS_HIGH
-VEML7700_INT_STATUS_LOW
-VEML7700_INT_STATUS_BOTH
-If an I2C error occurred, status will be:
-VEML7700_INT_STATUS_INVALID
-
-
-
Returns
VEML7700_SUCCESS (VEML7700_ERROR_SUCCESS) if successful
- -
-
- -

◆ getLowThreshold() [1/2]

- -
-
- - - - - - - -
uint16_t VEML7700::getLowThreshold ()
-
- -

Get the VEML7700's ALS low threshold window setting (ALS_WL)

-
Returns
The threshold setting
- -
-
- -

◆ getLowThreshold() [2/2]

- -
-
- - - - - - - - -
VEML7700_error_t VEML7700::getLowThreshold (uint16_t * threshold)
-
- -

Get the VEML7700's ALS low threshold window setting (ALS_WL)

-
Parameters
- - -
threshold
-Will be set to the threshold setting on return
-
-
-
Returns
VEML7700_SUCCESS (VEML7700_ERROR_SUCCESS) if successful
- -
-
- -

◆ getLux() [1/2]

- -
-
- - - - - - - -
float VEML7700::getLux ()
-
- -

Read the sensor data and calculate the lux.

-
Returns
The lux
- -
-
- -

◆ getLux() [2/2]

- -
-
- - - - - - - - -
VEML7700_error_t VEML7700::getLux (float * lux)
-
- -

Read the sensor data and calculate the lux.

-
Parameters
- - -
lux
-Will be set to the lux on return
-
-
-
Returns
VEML7700_SUCCESS (VEML7700_ERROR_SUCCESS) if successful
-

First, we need to extract the correct resolution from the VEML7700_LUX_RESOLUTION gain and integration time look up table. Let's begin by reading the gain (sensitivity) and integration time.

-

Now we can extract the correct resolution from the look up table.

-

Now we read the ambient level and multiply it by the resolution

- -
-
- -

◆ getPersistenceProtect() [1/2]

- -
-
- - - - - - - -
VEML7700_persistence_protect_t VEML7700::getPersistenceProtect ()
-
- -

Get the VEML7700's persistence protect number setting (ALS_PERS)

-
Returns
If successful:
-VEML7700_PERSISTENCE_1
-VEML7700_PERSISTENCE_2
-VEML7700_PERSISTENCE_4
-VEML7700_PERSISTENCE_8
-Otherwise:
-VEML7700_PERSISTENCE_INVALID
- -
-
- -

◆ getPersistenceProtect() [2/2]

- -
-
- - - - - - - - -
VEML7700_error_t VEML7700::getPersistenceProtect (VEML7700_persistence_protect_t * pp)
-
- -

Get the VEML7700's persistence protect number setting (ALS_PERS)

-
Parameters
- - -
pp
-Will be set to the persistence protect number on return
-
-
-
Returns
VEML7700_SUCCESS (VEML7700_ERROR_SUCCESS) if successful
- -
-
- -

◆ getSensitivityMode() [1/2]

- -
-
- - - - - - - -
VEML7700_sensitivity_mode_t VEML7700::getSensitivityMode ()
-
- -

Get the VEML7700's sensitivity mode selection (ALS_SM)

-
Returns
If successful:
-VEML7700_SENSITIVITY_x1
-VEML7700_SENSITIVITY_x2
-VEML7700_SENSITIVITY_x1_8
-VEML7700_SENSITIVITY_x1_4
-Otherwise:
-VEML7700_SENSITIVITY_INVALID
- -
-
- -

◆ getSensitivityMode() [2/2]

- -
-
- - - - - - - - -
VEML7700_error_t VEML7700::getSensitivityMode (VEML7700_sensitivity_mode_t * sm)
-
- -

Get the VEML7700's sensitivity mode selection (ALS_SM)

-
Parameters
- - -
sm
-Will be set to the sensitivity mode selection on return
-
-
-
Returns
VEML7700_SUCCESS (VEML7700_ERROR_SUCCESS) if successful
- -
-
- -

◆ getShutdown()

- -
-
- - - - - - - -
VEML7700_shutdown_t VEML7700::getShutdown ()
-
- -

Get the VEML7700's shut down setting (ALS_SD)

-
Returns
VEML7700_POWER_ON or VEML7700_SHUT_DOWN if successful, VEML7700_SHUTDOWN_INVALID otherwise
- -
-
- -

◆ getWhiteLevel() [1/2]

- -
-
- - - - - - - -
uint16_t VEML7700::getWhiteLevel ()
-
- -

Get the VEML7700's white level data (WHITE)

-
Returns
The white level reading
- -
-
- -

◆ getWhiteLevel() [2/2]

- -
-
- - - - - - - - -
VEML7700_error_t VEML7700::getWhiteLevel (uint16_t * whiteLevel)
-
- -

Get the VEML7700's white level data (WHITE)

-
Parameters
- - -
whiteLevel
-Will be set to the white level on return
-
-
-
Returns
VEML7700_SUCCESS (VEML7700_ERROR_SUCCESS) if successful
- -
-
- -

◆ isConnected()

- -
-
- - - - - - - -
boolean VEML7700::isConnected ()
-
- -

Check that the VEML7700 is awake and communicating.

-
Returns
True if communication with the VEML7700 was successful, otherwise false.
- -
-
- -

◆ setHighThreshold()

- -
-
- - - - - - - - -
VEML7700_error_t VEML7700::setHighThreshold (uint16_t threshold)
-
- -

Set the VEML7700's ALS high threshold window setting (ALS_WH)

-
Parameters
- - -
threshold
-The threshold setting: 0x0000 to 0xFFFF
-
-
-
Returns
VEML7700_SUCCESS (VEML7700_ERROR_SUCCESS) if successful
- -
-
- -

◆ setIntegrationTime()

- -
-
- - - - - - - - -
VEML7700_error_t VEML7700::setIntegrationTime (VEML7700_integration_time_t it)
-
- -

Set the VEML7700's integration time setting (ALS_IT)
-Note: these are defined here in simple sequential order
-The actual register settings are defined in VEML7700_config_integration_time_t.

-
Parameters
- - -
it
-The integration time setting. Possible values are:
-VEML7700_INTEGRATION_25ms
-VEML7700_INTEGRATION_50ms
-VEML7700_INTEGRATION_100ms
-VEML7700_INTEGRATION_200ms
-VEML7700_INTEGRATION_400ms
-VEML7700_INTEGRATION_800ms
-
-
-
Returns
VEML7700_SUCCESS (VEML7700_ERROR_SUCCESS) if successful
- -
-
- -

◆ setInterruptEnable()

- -
-
- - - - - - - - -
VEML7700_error_t VEML7700::setInterruptEnable (VEML7700_interrupt_enable_t ie)
-
- -

Set the VEML7700's interrupt enable setting (ALS_INT_EN)

-
Parameters
- - -
ie
-The interrupt enable setting. Possible values are:
-VEML7700_INT_DISABLE
-VEML7700_INT_ENABLE
-
-
-
Returns
VEML7700_SUCCESS (VEML7700_ERROR_SUCCESS) if successful
- -
-
- -

◆ setLowThreshold()

- -
-
- - - - - - - - -
VEML7700_error_t VEML7700::setLowThreshold (uint16_t threshold)
-
- -

Set the VEML7700's ALS low threshold window setting (ALS_WL)

-
Parameters
- - -
threshold
-The threshold setting: 0x0000 to 0xFFFF
-
-
-
Returns
VEML7700_SUCCESS (VEML7700_ERROR_SUCCESS) if successful
- -
-
- -

◆ setPersistenceProtect()

- -
-
- - - - - - - - -
VEML7700_error_t VEML7700::setPersistenceProtect (VEML7700_persistence_protect_t pp)
-
- -

Set the VEML7700's persistence protect number setting (ALS_PERS)

-
Parameters
- - -
pp
-The persistence protect setting. Possible values are:
-VEML7700_PERSISTENCE_1
-VEML7700_PERSISTENCE_2
-VEML7700_PERSISTENCE_4
-VEML7700_PERSISTENCE_8
-
-
-
Returns
VEML7700_SUCCESS (VEML7700_ERROR_SUCCESS) if successful
- -
-
- -

◆ setSensitivityMode()

- -
-
- - - - - - - - -
VEML7700_error_t VEML7700::setSensitivityMode (VEML7700_sensitivity_mode_t sm)
-
- -

Set the VEML7700's sensitivity mode selection (ALS_SM)

-
Parameters
- - -
it
-The sensitivity mode selection. Possible values are:
-VEML7700_SENSITIVITY_x1
-VEML7700_SENSITIVITY_x2
-VEML7700_SENSITIVITY_x1_8
-VEML7700_SENSITIVITY_x1_4
-
-
-
Returns
VEML7700_SUCCESS (VEML7700_ERROR_SUCCESS) if successful
- -
-
- -

◆ setShutdown()

- -
-
- - - - - - - - -
VEML7700_error_t VEML7700::setShutdown (VEML7700_shutdown_t sd)
-
- -

Set the VEML7700's shut down setting (ALS_SD)

-

Configuration controls

-
Parameters
- - -
sd
-The shut down setting. Possible values are:
-VEML7700_POWER_ON
-VEML7700_SHUT_DOWN
-
-
-
Returns
VEML7700_SUCCESS (VEML7700_ERROR_SUCCESS) if successful
- -
-
-
The documentation for this class was generated from the following files: -
- -
-Generated by doxygen 1.9.1 -
- - diff --git a/docs/classes.html b/docs/classes.html deleted file mode 100644 index 6479e6a..0000000 --- a/docs/classes.html +++ /dev/null @@ -1,80 +0,0 @@ - - - - - - - -SparkFun_VEML7700_Arduino_Library: Class Index - - - - - - - - - -
-
- - - - - - -
-
SparkFun_VEML7700_Arduino_Library -
-
-
- - - - - - - -
- -
-
- - -
- -
- -
-
-
Class Index
-
-
-
V
-
-
-
V
-
VEML7700
-
-
- -
-Generated by doxygen 1.9.1 -
- - diff --git a/docs/closed.png b/docs/closed.png deleted file mode 100644 index 98cc2c909da37a6df914fbf67780eebd99c597f5..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 132 zcmeAS@N?(olHy`uVBq!ia0vp^oFL4>1|%O$WD@{V-kvUwAr*{o@8{^CZMh(5KoB^r_<4^zF@3)Cp&&t3hdujKf f*?bjBoY!V+E))@{xMcbjXe@)LtDnm{r-UW|*e5JT diff --git a/docs/dir_68267d1309a1af8e8297ef4c3efbcdba.html b/docs/dir_68267d1309a1af8e8297ef4c3efbcdba.html deleted file mode 100644 index 8992e8d..0000000 --- a/docs/dir_68267d1309a1af8e8297ef4c3efbcdba.html +++ /dev/null @@ -1,84 +0,0 @@ - - - - - - - -SparkFun_VEML7700_Arduino_Library: src Directory Reference - - - - - - - - - -
-
- - - - - - -
-
SparkFun_VEML7700_Arduino_Library -
-
-
- - - - - - - - -
-
- - -
- -
- - -
-
-
-
src Directory Reference
-
-
- - - - -

-Files

file  SparkFun_VEML7700_Arduino_Library.h [code]
 
-
- -
-Generated by doxygen 1.9.1 -
- - diff --git a/docs/doc.png b/docs/doc.png deleted file mode 100644 index 17edabff95f7b8da13c9516a04efe05493c29501..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 746 zcmV7=@pnbNXRFEm&G8P!&WHG=d)>K?YZ1bzou)2{$)) zumDct!>4SyxL;zgaG>wy`^Hv*+}0kUfCrz~BCOViSb$_*&;{TGGn2^x9K*!Sf0=lV zpP=7O;GA0*Jm*tTYj$IoXvimpnV4S1Z5f$p*f$Db2iq2zrVGQUz~yq`ahn7ck(|CE z7Gz;%OP~J6)tEZWDzjhL9h2hdfoU2)Nd%T<5Kt;Y0XLt&<@6pQx!nw*5`@bq#?l*?3z{Hlzoc=Pr>oB5(9i6~_&-}A(4{Q$>c>%rV&E|a(r&;?i5cQB=} zYSDU5nXG)NS4HEs0it2AHe2>shCyr7`6@4*6{r@8fXRbTA?=IFVWAQJL&H5H{)DpM#{W(GL+Idzf^)uRV@oB8u$ z8v{MfJbTiiRg4bza<41NAzrl{=3fl_D+$t+^!xlQ8S}{UtY`e z;;&9UhyZqQRN%2pot{*Ei0*4~hSF_3AH2@fKU!$NSflS>{@tZpDT4`M2WRTTVH+D? z)GFlEGGHe?koB}i|1w45!BF}N_q&^HJ&-tyR{(afC6H7|aml|tBBbv}55C5DNP8p3 z)~jLEO4Z&2hZmP^i-e%(@d!(E|KRafiU8Q5u(wU((j8un3OR*Hvj+t diff --git a/docs/doxygen.css b/docs/doxygen.css deleted file mode 100644 index ffbff02..0000000 --- a/docs/doxygen.css +++ /dev/null @@ -1,1793 +0,0 @@ -/* The standard CSS for doxygen 1.9.1 */ - -body, table, div, p, dl { - font: 400 14px/22px Roboto,sans-serif; -} - -p.reference, p.definition { - font: 400 14px/22px Roboto,sans-serif; -} - -/* @group Heading Levels */ - -h1.groupheader { - font-size: 150%; -} - -.title { - font: 400 14px/28px Roboto,sans-serif; - font-size: 150%; - font-weight: bold; - margin: 10px 2px; -} - -h2.groupheader { - border-bottom: 1px solid #879ECB; - color: #354C7B; - font-size: 150%; - font-weight: normal; - margin-top: 1.75em; - padding-top: 8px; - padding-bottom: 4px; - width: 100%; -} - -h3.groupheader { - font-size: 100%; -} - -h1, h2, h3, h4, h5, h6 { - -webkit-transition: text-shadow 0.5s linear; - -moz-transition: text-shadow 0.5s linear; - -ms-transition: text-shadow 0.5s linear; - -o-transition: text-shadow 0.5s linear; - transition: text-shadow 0.5s linear; - margin-right: 15px; -} - -h1.glow, h2.glow, h3.glow, h4.glow, h5.glow, h6.glow { - text-shadow: 0 0 15px cyan; -} - -dt { - font-weight: bold; -} - -ul.multicol { - -moz-column-gap: 1em; - -webkit-column-gap: 1em; - column-gap: 1em; - -moz-column-count: 3; - -webkit-column-count: 3; - column-count: 3; -} - -p.startli, p.startdd { - margin-top: 2px; -} - -th p.starttd, th p.intertd, th p.endtd { - font-size: 100%; - font-weight: 700; -} - -p.starttd { - margin-top: 0px; -} - -p.endli { - margin-bottom: 0px; -} - -p.enddd { - margin-bottom: 4px; -} - -p.endtd { - margin-bottom: 2px; -} - -p.interli { -} - -p.interdd { -} - -p.intertd { -} - -/* @end */ - -caption { - font-weight: bold; -} - -span.legend { - font-size: 70%; - text-align: center; -} - -h3.version { - font-size: 90%; - text-align: center; -} - -div.navtab { - border-right: 1px solid #A3B4D7; - padding-right: 15px; - text-align: right; - line-height: 110%; -} - -div.navtab table { - border-spacing: 0; -} - -td.navtab { - padding-right: 6px; - padding-left: 6px; -} -td.navtabHL { - background-image: url('tab_a.png'); - background-repeat:repeat-x; - padding-right: 6px; - padding-left: 6px; -} - -td.navtabHL a, td.navtabHL a:visited { - color: #fff; - text-shadow: 0px 1px 1px rgba(0, 0, 0, 1.0); -} - -a.navtab { - font-weight: bold; -} - -div.qindex{ - text-align: center; - width: 100%; - line-height: 140%; - font-size: 130%; - color: #A0A0A0; -} - -dt.alphachar{ - font-size: 180%; - font-weight: bold; -} - -.alphachar a{ - color: black; -} - -.alphachar a:hover, .alphachar a:visited{ - text-decoration: none; -} - -.classindex dl { - padding: 25px; - column-count:1 -} - -.classindex dd { - display:inline-block; - margin-left: 50px; - width: 90%; - line-height: 1.15em; -} - -.classindex dl.odd { - background-color: #F8F9FC; -} - -@media(min-width: 1120px) { - .classindex dl { - column-count:2 - } -} - -@media(min-width: 1320px) { - .classindex dl { - column-count:3 - } -} - - -/* @group Link Styling */ - -a { - color: #3D578C; - font-weight: normal; - text-decoration: none; -} - -.contents a:visited { - color: #4665A2; -} - -a:hover { - text-decoration: underline; -} - -.contents a.qindexHL:visited { - color: #FFFFFF; -} - -a.el { - font-weight: bold; -} - -a.elRef { -} - -a.code, a.code:visited, a.line, a.line:visited { - color: #4665A2; -} - -a.codeRef, a.codeRef:visited, a.lineRef, a.lineRef:visited { - color: #4665A2; -} - -/* @end */ - -dl.el { - margin-left: -1cm; -} - -ul { - overflow: hidden; /*Fixed: list item bullets overlap floating elements*/ -} - -#side-nav ul { - overflow: visible; /* reset ul rule for scroll bar in GENERATE_TREEVIEW window */ -} - -#main-nav ul { - overflow: visible; /* reset ul rule for the navigation bar drop down lists */ -} - -.fragment { - text-align: left; - direction: ltr; - overflow-x: auto; /*Fixed: fragment lines overlap floating elements*/ - overflow-y: hidden; -} - -pre.fragment { - border: 1px solid #C4CFE5; - background-color: #FBFCFD; - padding: 4px 6px; - margin: 4px 8px 4px 2px; - overflow: auto; - word-wrap: break-word; - font-size: 9pt; - line-height: 125%; - font-family: monospace, fixed; - font-size: 105%; -} - -div.fragment { - padding: 0 0 1px 0; /*Fixed: last line underline overlap border*/ - margin: 4px 8px 4px 2px; - background-color: #FBFCFD; - border: 1px solid #C4CFE5; -} - -div.line { - font-family: monospace, fixed; - font-size: 13px; - min-height: 13px; - line-height: 1.0; - text-wrap: unrestricted; - white-space: -moz-pre-wrap; /* Moz */ - white-space: -pre-wrap; /* Opera 4-6 */ - white-space: -o-pre-wrap; /* Opera 7 */ - white-space: pre-wrap; /* CSS3 */ - word-wrap: break-word; /* IE 5.5+ */ - text-indent: -53px; - padding-left: 53px; - padding-bottom: 0px; - margin: 0px; - -webkit-transition-property: background-color, box-shadow; - -webkit-transition-duration: 0.5s; - -moz-transition-property: background-color, box-shadow; - -moz-transition-duration: 0.5s; - -ms-transition-property: background-color, box-shadow; - -ms-transition-duration: 0.5s; - -o-transition-property: background-color, box-shadow; - -o-transition-duration: 0.5s; - transition-property: background-color, box-shadow; - transition-duration: 0.5s; -} - -div.line:after { - content:"\000A"; - white-space: pre; -} - -div.line.glow { - background-color: cyan; - box-shadow: 0 0 10px cyan; -} - - -span.lineno { - padding-right: 4px; - text-align: right; - border-right: 2px solid #0F0; - background-color: #E8E8E8; - white-space: pre; -} -span.lineno a { - background-color: #D8D8D8; -} - -span.lineno a:hover { - background-color: #C8C8C8; -} - -.lineno { - -webkit-touch-callout: none; - -webkit-user-select: none; - -khtml-user-select: none; - -moz-user-select: none; - -ms-user-select: none; - user-select: none; -} - -div.ah, span.ah { - background-color: black; - font-weight: bold; - color: #FFFFFF; - margin-bottom: 3px; - margin-top: 3px; - padding: 0.2em; - border: solid thin #333; - border-radius: 0.5em; - -webkit-border-radius: .5em; - -moz-border-radius: .5em; - box-shadow: 2px 2px 3px #999; - -webkit-box-shadow: 2px 2px 3px #999; - -moz-box-shadow: rgba(0, 0, 0, 0.15) 2px 2px 2px; - background-image: -webkit-gradient(linear, left top, left bottom, from(#eee), to(#000),color-stop(0.3, #444)); - background-image: -moz-linear-gradient(center top, #eee 0%, #444 40%, #000 110%); -} - -div.classindex ul { - list-style: none; - padding-left: 0; -} - -div.classindex span.ai { - display: inline-block; -} - -div.groupHeader { - margin-left: 16px; - margin-top: 12px; - font-weight: bold; -} - -div.groupText { - margin-left: 16px; - font-style: italic; -} - -body { - background-color: white; - color: black; - margin: 0; -} - -div.contents { - margin-top: 10px; - margin-left: 12px; - margin-right: 8px; -} - -td.indexkey { - background-color: #EBEFF6; - font-weight: bold; - border: 1px solid #C4CFE5; - margin: 2px 0px 2px 0; - padding: 2px 10px; - white-space: nowrap; - vertical-align: top; -} - -td.indexvalue { - background-color: #EBEFF6; - border: 1px solid #C4CFE5; - padding: 2px 10px; - margin: 2px 0px; -} - -tr.memlist { - background-color: #EEF1F7; -} - -p.formulaDsp { - text-align: center; -} - -img.formulaDsp { - -} - -img.formulaInl, img.inline { - vertical-align: middle; -} - -div.center { - text-align: center; - margin-top: 0px; - margin-bottom: 0px; - padding: 0px; -} - -div.center img { - border: 0px; -} - -address.footer { - text-align: right; - padding-right: 12px; -} - -img.footer { - border: 0px; - vertical-align: middle; -} - -/* @group Code Colorization */ - -span.keyword { - color: #008000 -} - -span.keywordtype { - color: #604020 -} - -span.keywordflow { - color: #e08000 -} - -span.comment { - color: #800000 -} - -span.preprocessor { - color: #806020 -} - -span.stringliteral { - color: #002080 -} - -span.charliteral { - color: #008080 -} - -span.vhdldigit { - color: #ff00ff -} - -span.vhdlchar { - color: #000000 -} - -span.vhdlkeyword { - color: #700070 -} - -span.vhdllogic { - color: #ff0000 -} - -blockquote { - background-color: #F7F8FB; - border-left: 2px solid #9CAFD4; - margin: 0 24px 0 4px; - padding: 0 12px 0 16px; -} - -blockquote.DocNodeRTL { - border-left: 0; - border-right: 2px solid #9CAFD4; - margin: 0 4px 0 24px; - padding: 0 16px 0 12px; -} - -/* @end */ - -/* -.search { - color: #003399; - font-weight: bold; -} - -form.search { - margin-bottom: 0px; - margin-top: 0px; -} - -input.search { - font-size: 75%; - color: #000080; - font-weight: normal; - background-color: #e8eef2; -} -*/ - -td.tiny { - font-size: 75%; -} - -.dirtab { - padding: 4px; - border-collapse: collapse; - border: 1px solid #A3B4D7; -} - -th.dirtab { - background: #EBEFF6; - font-weight: bold; -} - -hr { - height: 0px; - border: none; - border-top: 1px solid #4A6AAA; -} - -hr.footer { - height: 1px; -} - -/* @group Member Descriptions */ - -table.memberdecls { - border-spacing: 0px; - padding: 0px; -} - -.memberdecls td, .fieldtable tr { - -webkit-transition-property: background-color, box-shadow; - -webkit-transition-duration: 0.5s; - -moz-transition-property: background-color, box-shadow; - -moz-transition-duration: 0.5s; - -ms-transition-property: background-color, box-shadow; - -ms-transition-duration: 0.5s; - -o-transition-property: background-color, box-shadow; - -o-transition-duration: 0.5s; - transition-property: background-color, box-shadow; - transition-duration: 0.5s; -} - -.memberdecls td.glow, .fieldtable tr.glow { - background-color: cyan; - box-shadow: 0 0 15px cyan; -} - -.mdescLeft, .mdescRight, -.memItemLeft, .memItemRight, -.memTemplItemLeft, .memTemplItemRight, .memTemplParams { - background-color: #F9FAFC; - border: none; - margin: 4px; - padding: 1px 0 0 8px; -} - -.mdescLeft, .mdescRight { - padding: 0px 8px 4px 8px; - color: #555; -} - -.memSeparator { - border-bottom: 1px solid #DEE4F0; - line-height: 1px; - margin: 0px; - padding: 0px; -} - -.memItemLeft, .memTemplItemLeft { - white-space: nowrap; -} - -.memItemRight, .memTemplItemRight { - width: 100%; -} - -.memTemplParams { - color: #4665A2; - white-space: nowrap; - font-size: 80%; -} - -/* @end */ - -/* @group Member Details */ - -/* Styles for detailed member documentation */ - -.memtitle { - padding: 8px; - border-top: 1px solid #A8B8D9; - border-left: 1px solid #A8B8D9; - border-right: 1px solid #A8B8D9; - border-top-right-radius: 4px; - border-top-left-radius: 4px; - margin-bottom: -1px; - background-image: url('nav_f.png'); - background-repeat: repeat-x; - background-color: #E2E8F2; - line-height: 1.25; - font-weight: 300; - float:left; -} - -.permalink -{ - font-size: 65%; - display: inline-block; - vertical-align: middle; -} - -.memtemplate { - font-size: 80%; - color: #4665A2; - font-weight: normal; - margin-left: 9px; -} - -.memnav { - background-color: #EBEFF6; - border: 1px solid #A3B4D7; - text-align: center; - margin: 2px; - margin-right: 15px; - padding: 2px; -} - -.mempage { - width: 100%; -} - -.memitem { - padding: 0; - margin-bottom: 10px; - margin-right: 5px; - -webkit-transition: box-shadow 0.5s linear; - -moz-transition: box-shadow 0.5s linear; - -ms-transition: box-shadow 0.5s linear; - -o-transition: box-shadow 0.5s linear; - transition: box-shadow 0.5s linear; - display: table !important; - width: 100%; -} - -.memitem.glow { - box-shadow: 0 0 15px cyan; -} - -.memname { - font-weight: 400; - margin-left: 6px; -} - -.memname td { - vertical-align: bottom; -} - -.memproto, dl.reflist dt { - border-top: 1px solid #A8B8D9; - border-left: 1px solid #A8B8D9; - border-right: 1px solid #A8B8D9; - padding: 6px 0px 6px 0px; - color: #253555; - font-weight: bold; - text-shadow: 0px 1px 1px rgba(255, 255, 255, 0.9); - background-color: #DFE5F1; - /* opera specific markup */ - box-shadow: 5px 5px 5px rgba(0, 0, 0, 0.15); - border-top-right-radius: 4px; - /* firefox specific markup */ - -moz-box-shadow: rgba(0, 0, 0, 0.15) 5px 5px 5px; - -moz-border-radius-topright: 4px; - /* webkit specific markup */ - -webkit-box-shadow: 5px 5px 5px rgba(0, 0, 0, 0.15); - -webkit-border-top-right-radius: 4px; - -} - -.overload { - font-family: "courier new",courier,monospace; - font-size: 65%; -} - -.memdoc, dl.reflist dd { - border-bottom: 1px solid #A8B8D9; - border-left: 1px solid #A8B8D9; - border-right: 1px solid #A8B8D9; - padding: 6px 10px 2px 10px; - background-color: #FBFCFD; - border-top-width: 0; - background-image:url('nav_g.png'); - background-repeat:repeat-x; - background-color: #FFFFFF; - /* opera specific markup */ - border-bottom-left-radius: 4px; - border-bottom-right-radius: 4px; - box-shadow: 5px 5px 5px rgba(0, 0, 0, 0.15); - /* firefox specific markup */ - -moz-border-radius-bottomleft: 4px; - -moz-border-radius-bottomright: 4px; - -moz-box-shadow: rgba(0, 0, 0, 0.15) 5px 5px 5px; - /* webkit specific markup */ - -webkit-border-bottom-left-radius: 4px; - -webkit-border-bottom-right-radius: 4px; - -webkit-box-shadow: 5px 5px 5px rgba(0, 0, 0, 0.15); -} - -dl.reflist dt { - padding: 5px; -} - -dl.reflist dd { - margin: 0px 0px 10px 0px; - padding: 5px; -} - -.paramkey { - text-align: right; -} - -.paramtype { - white-space: nowrap; -} - -.paramname { - color: #602020; - white-space: nowrap; -} -.paramname em { - font-style: normal; -} -.paramname code { - line-height: 14px; -} - -.params, .retval, .exception, .tparams { - margin-left: 0px; - padding-left: 0px; -} - -.params .paramname, .retval .paramname, .tparams .paramname, .exception .paramname { - font-weight: bold; - vertical-align: top; -} - -.params .paramtype, .tparams .paramtype { - font-style: italic; - vertical-align: top; -} - -.params .paramdir, .tparams .paramdir { - font-family: "courier new",courier,monospace; - vertical-align: top; -} - -table.mlabels { - border-spacing: 0px; -} - -td.mlabels-left { - width: 100%; - padding: 0px; -} - -td.mlabels-right { - vertical-align: bottom; - padding: 0px; - white-space: nowrap; -} - -span.mlabels { - margin-left: 8px; -} - -span.mlabel { - background-color: #728DC1; - border-top:1px solid #5373B4; - border-left:1px solid #5373B4; - border-right:1px solid #C4CFE5; - border-bottom:1px solid #C4CFE5; - text-shadow: none; - color: white; - margin-right: 4px; - padding: 2px 3px; - border-radius: 3px; - font-size: 7pt; - white-space: nowrap; - vertical-align: middle; -} - - - -/* @end */ - -/* these are for tree view inside a (index) page */ - -div.directory { - margin: 10px 0px; - border-top: 1px solid #9CAFD4; - border-bottom: 1px solid #9CAFD4; - width: 100%; -} - -.directory table { - border-collapse:collapse; -} - -.directory td { - margin: 0px; - padding: 0px; - vertical-align: top; -} - -.directory td.entry { - white-space: nowrap; - padding-right: 6px; - padding-top: 3px; -} - -.directory td.entry a { - outline:none; -} - -.directory td.entry a img { - border: none; -} - -.directory td.desc { - width: 100%; - padding-left: 6px; - padding-right: 6px; - padding-top: 3px; - border-left: 1px solid rgba(0,0,0,0.05); -} - -.directory tr.even { - padding-left: 6px; - background-color: #F7F8FB; -} - -.directory img { - vertical-align: -30%; -} - -.directory .levels { - white-space: nowrap; - width: 100%; - text-align: right; - font-size: 9pt; -} - -.directory .levels span { - cursor: pointer; - padding-left: 2px; - padding-right: 2px; - color: #3D578C; -} - -.arrow { - color: #9CAFD4; - -webkit-user-select: none; - -khtml-user-select: none; - -moz-user-select: none; - -ms-user-select: none; - user-select: none; - cursor: pointer; - font-size: 80%; - display: inline-block; - width: 16px; - height: 22px; -} - -.icon { - font-family: Arial, Helvetica; - font-weight: bold; - font-size: 12px; - height: 14px; - width: 16px; - display: inline-block; - background-color: #728DC1; - color: white; - text-align: center; - border-radius: 4px; - margin-left: 2px; - margin-right: 2px; -} - -.icona { - width: 24px; - height: 22px; - display: inline-block; -} - -.iconfopen { - width: 24px; - height: 18px; - margin-bottom: 4px; - background-image:url('folderopen.png'); - background-position: 0px -4px; - background-repeat: repeat-y; - vertical-align:top; - display: inline-block; -} - -.iconfclosed { - width: 24px; - height: 18px; - margin-bottom: 4px; - background-image:url('folderclosed.png'); - background-position: 0px -4px; - background-repeat: repeat-y; - vertical-align:top; - display: inline-block; -} - -.icondoc { - width: 24px; - height: 18px; - margin-bottom: 4px; - background-image:url('doc.png'); - background-position: 0px -4px; - background-repeat: repeat-y; - vertical-align:top; - display: inline-block; -} - -table.directory { - font: 400 14px Roboto,sans-serif; -} - -/* @end */ - -div.dynheader { - margin-top: 8px; - -webkit-touch-callout: none; - -webkit-user-select: none; - -khtml-user-select: none; - -moz-user-select: none; - -ms-user-select: none; - user-select: none; -} - -address { - font-style: normal; - color: #2A3D61; -} - -table.doxtable caption { - caption-side: top; -} - -table.doxtable { - border-collapse:collapse; - margin-top: 4px; - margin-bottom: 4px; -} - -table.doxtable td, table.doxtable th { - border: 1px solid #2D4068; - padding: 3px 7px 2px; -} - -table.doxtable th { - background-color: #374F7F; - color: #FFFFFF; - font-size: 110%; - padding-bottom: 4px; - padding-top: 5px; -} - -table.fieldtable { - /*width: 100%;*/ - margin-bottom: 10px; - border: 1px solid #A8B8D9; - border-spacing: 0px; - -moz-border-radius: 4px; - -webkit-border-radius: 4px; - border-radius: 4px; - -moz-box-shadow: rgba(0, 0, 0, 0.15) 2px 2px 2px; - -webkit-box-shadow: 2px 2px 2px rgba(0, 0, 0, 0.15); - box-shadow: 2px 2px 2px rgba(0, 0, 0, 0.15); -} - -.fieldtable td, .fieldtable th { - padding: 3px 7px 2px; -} - -.fieldtable td.fieldtype, .fieldtable td.fieldname { - white-space: nowrap; - border-right: 1px solid #A8B8D9; - border-bottom: 1px solid #A8B8D9; - vertical-align: top; -} - -.fieldtable td.fieldname { - padding-top: 3px; -} - -.fieldtable td.fielddoc { - border-bottom: 1px solid #A8B8D9; - /*width: 100%;*/ -} - -.fieldtable td.fielddoc p:first-child { - margin-top: 0px; -} - -.fieldtable td.fielddoc p:last-child { - margin-bottom: 2px; -} - -.fieldtable tr:last-child td { - border-bottom: none; -} - -.fieldtable th { - background-image:url('nav_f.png'); - background-repeat:repeat-x; - background-color: #E2E8F2; - font-size: 90%; - color: #253555; - padding-bottom: 4px; - padding-top: 5px; - text-align:left; - font-weight: 400; - -moz-border-radius-topleft: 4px; - -moz-border-radius-topright: 4px; - -webkit-border-top-left-radius: 4px; - -webkit-border-top-right-radius: 4px; - border-top-left-radius: 4px; - border-top-right-radius: 4px; - border-bottom: 1px solid #A8B8D9; -} - - -.tabsearch { - top: 0px; - left: 10px; - height: 36px; - background-image: url('tab_b.png'); - z-index: 101; - overflow: hidden; - font-size: 13px; -} - -.navpath ul -{ - font-size: 11px; - background-image:url('tab_b.png'); - background-repeat:repeat-x; - background-position: 0 -5px; - height:30px; - line-height:30px; - color:#8AA0CC; - border:solid 1px #C2CDE4; - overflow:hidden; - margin:0px; - padding:0px; -} - -.navpath li -{ - list-style-type:none; - float:left; - padding-left:10px; - padding-right:15px; - background-image:url('bc_s.png'); - background-repeat:no-repeat; - background-position:right; - color:#364D7C; -} - -.navpath li.navelem a -{ - height:32px; - display:block; - text-decoration: none; - outline: none; - color: #283A5D; - font-family: 'Lucida Grande',Geneva,Helvetica,Arial,sans-serif; - text-shadow: 0px 1px 1px rgba(255, 255, 255, 0.9); - text-decoration: none; -} - -.navpath li.navelem a:hover -{ - color:#6884BD; -} - -.navpath li.footer -{ - list-style-type:none; - float:right; - padding-left:10px; - padding-right:15px; - background-image:none; - background-repeat:no-repeat; - background-position:right; - color:#364D7C; - font-size: 8pt; -} - - -div.summary -{ - float: right; - font-size: 8pt; - padding-right: 5px; - width: 50%; - text-align: right; -} - -div.summary a -{ - white-space: nowrap; -} - -table.classindex -{ - margin: 10px; - white-space: nowrap; - margin-left: 3%; - margin-right: 3%; - width: 94%; - border: 0; - border-spacing: 0; - padding: 0; -} - -div.ingroups -{ - font-size: 8pt; - width: 50%; - text-align: left; -} - -div.ingroups a -{ - white-space: nowrap; -} - -div.header -{ - background-image:url('nav_h.png'); - background-repeat:repeat-x; - background-color: #F9FAFC; - margin: 0px; - border-bottom: 1px solid #C4CFE5; -} - -div.headertitle -{ - padding: 5px 5px 5px 10px; -} - -.PageDocRTL-title div.headertitle { - text-align: right; - direction: rtl; -} - -dl { - padding: 0 0 0 0; -} - -/* dl.note, dl.warning, dl.attention, dl.pre, dl.post, dl.invariant, dl.deprecated, dl.todo, dl.test, dl.bug, dl.examples */ -dl.section { - margin-left: 0px; - padding-left: 0px; -} - -dl.section.DocNodeRTL { - margin-right: 0px; - padding-right: 0px; -} - -dl.note { - margin-left: -7px; - padding-left: 3px; - border-left: 4px solid; - border-color: #D0C000; -} - -dl.note.DocNodeRTL { - margin-left: 0; - padding-left: 0; - border-left: 0; - margin-right: -7px; - padding-right: 3px; - border-right: 4px solid; - border-color: #D0C000; -} - -dl.warning, dl.attention { - margin-left: -7px; - padding-left: 3px; - border-left: 4px solid; - border-color: #FF0000; -} - -dl.warning.DocNodeRTL, dl.attention.DocNodeRTL { - margin-left: 0; - padding-left: 0; - border-left: 0; - margin-right: -7px; - padding-right: 3px; - border-right: 4px solid; - border-color: #FF0000; -} - -dl.pre, dl.post, dl.invariant { - margin-left: -7px; - padding-left: 3px; - border-left: 4px solid; - border-color: #00D000; -} - -dl.pre.DocNodeRTL, dl.post.DocNodeRTL, dl.invariant.DocNodeRTL { - margin-left: 0; - padding-left: 0; - border-left: 0; - margin-right: -7px; - padding-right: 3px; - border-right: 4px solid; - border-color: #00D000; -} - -dl.deprecated { - margin-left: -7px; - padding-left: 3px; - border-left: 4px solid; - border-color: #505050; -} - -dl.deprecated.DocNodeRTL { - margin-left: 0; - padding-left: 0; - border-left: 0; - margin-right: -7px; - padding-right: 3px; - border-right: 4px solid; - border-color: #505050; -} - -dl.todo { - margin-left: -7px; - padding-left: 3px; - border-left: 4px solid; - border-color: #00C0E0; -} - -dl.todo.DocNodeRTL { - margin-left: 0; - padding-left: 0; - border-left: 0; - margin-right: -7px; - padding-right: 3px; - border-right: 4px solid; - border-color: #00C0E0; -} - -dl.test { - margin-left: -7px; - padding-left: 3px; - border-left: 4px solid; - border-color: #3030E0; -} - -dl.test.DocNodeRTL { - margin-left: 0; - padding-left: 0; - border-left: 0; - margin-right: -7px; - padding-right: 3px; - border-right: 4px solid; - border-color: #3030E0; -} - -dl.bug { - margin-left: -7px; - padding-left: 3px; - border-left: 4px solid; - border-color: #C08050; -} - -dl.bug.DocNodeRTL { - margin-left: 0; - padding-left: 0; - border-left: 0; - margin-right: -7px; - padding-right: 3px; - border-right: 4px solid; - border-color: #C08050; -} - -dl.section dd { - margin-bottom: 6px; -} - - -#projectlogo -{ - text-align: center; - vertical-align: bottom; - border-collapse: separate; -} - -#projectlogo img -{ - border: 0px none; -} - -#projectalign -{ - vertical-align: middle; -} - -#projectname -{ - font: 300% Tahoma, Arial,sans-serif; - margin: 0px; - padding: 2px 0px; -} - -#projectbrief -{ - font: 120% Tahoma, Arial,sans-serif; - margin: 0px; - padding: 0px; -} - -#projectnumber -{ - font: 50% Tahoma, Arial,sans-serif; - margin: 0px; - padding: 0px; -} - -#titlearea -{ - padding: 0px; - margin: 0px; - width: 100%; - border-bottom: 1px solid #5373B4; -} - -.image -{ - text-align: center; -} - -.dotgraph -{ - text-align: center; -} - -.mscgraph -{ - text-align: center; -} - -.plantumlgraph -{ - text-align: center; -} - -.diagraph -{ - text-align: center; -} - -.caption -{ - font-weight: bold; -} - -div.zoom -{ - border: 1px solid #90A5CE; -} - -dl.citelist { - margin-bottom:50px; -} - -dl.citelist dt { - color:#334975; - float:left; - font-weight:bold; - margin-right:10px; - padding:5px; - text-align:right; - width:52px; -} - -dl.citelist dd { - margin:2px 0 2px 72px; - padding:5px 0; -} - -div.toc { - padding: 14px 25px; - background-color: #F4F6FA; - border: 1px solid #D8DFEE; - border-radius: 7px 7px 7px 7px; - float: right; - height: auto; - margin: 0 8px 10px 10px; - width: 200px; -} - -.PageDocRTL-title div.toc { - float: left !important; - text-align: right; -} - -div.toc li { - background: url("bdwn.png") no-repeat scroll 0 5px transparent; - font: 10px/1.2 Verdana,DejaVu Sans,Geneva,sans-serif; - margin-top: 5px; - padding-left: 10px; - padding-top: 2px; -} - -.PageDocRTL-title div.toc li { - background-position-x: right !important; - padding-left: 0 !important; - padding-right: 10px; -} - -div.toc h3 { - font: bold 12px/1.2 Arial,FreeSans,sans-serif; - color: #4665A2; - border-bottom: 0 none; - margin: 0; -} - -div.toc ul { - list-style: none outside none; - border: medium none; - padding: 0px; -} - -div.toc li.level1 { - margin-left: 0px; -} - -div.toc li.level2 { - margin-left: 15px; -} - -div.toc li.level3 { - margin-left: 30px; -} - -div.toc li.level4 { - margin-left: 45px; -} - -span.emoji { - /* font family used at the site: https://unicode.org/emoji/charts/full-emoji-list.html - * font-family: "Noto Color Emoji", "Apple Color Emoji", "Segoe UI Emoji", Times, Symbola, Aegyptus, Code2000, Code2001, Code2002, Musica, serif, LastResort; - */ -} - -.PageDocRTL-title div.toc li.level1 { - margin-left: 0 !important; - margin-right: 0; -} - -.PageDocRTL-title div.toc li.level2 { - margin-left: 0 !important; - margin-right: 15px; -} - -.PageDocRTL-title div.toc li.level3 { - margin-left: 0 !important; - margin-right: 30px; -} - -.PageDocRTL-title div.toc li.level4 { - margin-left: 0 !important; - margin-right: 45px; -} - -.inherit_header { - font-weight: bold; - color: gray; - cursor: pointer; - -webkit-touch-callout: none; - -webkit-user-select: none; - -khtml-user-select: none; - -moz-user-select: none; - -ms-user-select: none; - user-select: none; -} - -.inherit_header td { - padding: 6px 0px 2px 5px; -} - -.inherit { - display: none; -} - -tr.heading h2 { - margin-top: 12px; - margin-bottom: 4px; -} - -/* tooltip related style info */ - -.ttc { - position: absolute; - display: none; -} - -#powerTip { - cursor: default; - white-space: nowrap; - background-color: white; - border: 1px solid gray; - border-radius: 4px 4px 4px 4px; - box-shadow: 1px 1px 7px gray; - display: none; - font-size: smaller; - max-width: 80%; - opacity: 0.9; - padding: 1ex 1em 1em; - position: absolute; - z-index: 2147483647; -} - -#powerTip div.ttdoc { - color: grey; - font-style: italic; -} - -#powerTip div.ttname a { - font-weight: bold; -} - -#powerTip div.ttname { - font-weight: bold; -} - -#powerTip div.ttdeci { - color: #006318; -} - -#powerTip div { - margin: 0px; - padding: 0px; - font: 12px/16px Roboto,sans-serif; -} - -#powerTip:before, #powerTip:after { - content: ""; - position: absolute; - margin: 0px; -} - -#powerTip.n:after, #powerTip.n:before, -#powerTip.s:after, #powerTip.s:before, -#powerTip.w:after, #powerTip.w:before, -#powerTip.e:after, #powerTip.e:before, -#powerTip.ne:after, #powerTip.ne:before, -#powerTip.se:after, #powerTip.se:before, -#powerTip.nw:after, #powerTip.nw:before, -#powerTip.sw:after, #powerTip.sw:before { - border: solid transparent; - content: " "; - height: 0; - width: 0; - position: absolute; -} - -#powerTip.n:after, #powerTip.s:after, -#powerTip.w:after, #powerTip.e:after, -#powerTip.nw:after, #powerTip.ne:after, -#powerTip.sw:after, #powerTip.se:after { - border-color: rgba(255, 255, 255, 0); -} - -#powerTip.n:before, #powerTip.s:before, -#powerTip.w:before, #powerTip.e:before, -#powerTip.nw:before, #powerTip.ne:before, -#powerTip.sw:before, #powerTip.se:before { - border-color: rgba(128, 128, 128, 0); -} - -#powerTip.n:after, #powerTip.n:before, -#powerTip.ne:after, #powerTip.ne:before, -#powerTip.nw:after, #powerTip.nw:before { - top: 100%; -} - -#powerTip.n:after, #powerTip.ne:after, #powerTip.nw:after { - border-top-color: #FFFFFF; - border-width: 10px; - margin: 0px -10px; -} -#powerTip.n:before { - border-top-color: #808080; - border-width: 11px; - margin: 0px -11px; -} -#powerTip.n:after, #powerTip.n:before { - left: 50%; -} - -#powerTip.nw:after, #powerTip.nw:before { - right: 14px; -} - -#powerTip.ne:after, #powerTip.ne:before { - left: 14px; -} - -#powerTip.s:after, #powerTip.s:before, -#powerTip.se:after, #powerTip.se:before, -#powerTip.sw:after, #powerTip.sw:before { - bottom: 100%; -} - -#powerTip.s:after, #powerTip.se:after, #powerTip.sw:after { - border-bottom-color: #FFFFFF; - border-width: 10px; - margin: 0px -10px; -} - -#powerTip.s:before, #powerTip.se:before, #powerTip.sw:before { - border-bottom-color: #808080; - border-width: 11px; - margin: 0px -11px; -} - -#powerTip.s:after, #powerTip.s:before { - left: 50%; -} - -#powerTip.sw:after, #powerTip.sw:before { - right: 14px; -} - -#powerTip.se:after, #powerTip.se:before { - left: 14px; -} - -#powerTip.e:after, #powerTip.e:before { - left: 100%; -} -#powerTip.e:after { - border-left-color: #FFFFFF; - border-width: 10px; - top: 50%; - margin-top: -10px; -} -#powerTip.e:before { - border-left-color: #808080; - border-width: 11px; - top: 50%; - margin-top: -11px; -} - -#powerTip.w:after, #powerTip.w:before { - right: 100%; -} -#powerTip.w:after { - border-right-color: #FFFFFF; - border-width: 10px; - top: 50%; - margin-top: -10px; -} -#powerTip.w:before { - border-right-color: #808080; - border-width: 11px; - top: 50%; - margin-top: -11px; -} - -@media print -{ - #top { display: none; } - #side-nav { display: none; } - #nav-path { display: none; } - body { overflow:visible; } - h1, h2, h3, h4, h5, h6 { page-break-after: avoid; } - .summary { display: none; } - .memitem { page-break-inside: avoid; } - #doc-content - { - margin-left:0 !important; - height:auto !important; - width:auto !important; - overflow:inherit; - display:inline; - } -} - -/* @group Markdown */ - -table.markdownTable { - border-collapse:collapse; - margin-top: 4px; - margin-bottom: 4px; -} - -table.markdownTable td, table.markdownTable th { - border: 1px solid #2D4068; - padding: 3px 7px 2px; -} - -table.markdownTable tr { -} - -th.markdownTableHeadLeft, th.markdownTableHeadRight, th.markdownTableHeadCenter, th.markdownTableHeadNone { - background-color: #374F7F; - color: #FFFFFF; - font-size: 110%; - padding-bottom: 4px; - padding-top: 5px; -} - -th.markdownTableHeadLeft, td.markdownTableBodyLeft { - text-align: left -} - -th.markdownTableHeadRight, td.markdownTableBodyRight { - text-align: right -} - -th.markdownTableHeadCenter, td.markdownTableBodyCenter { - text-align: center -} - -.DocNodeRTL { - text-align: right; - direction: rtl; -} - -.DocNodeLTR { - text-align: left; - direction: ltr; -} - -table.DocNodeRTL { - width: auto; - margin-right: 0; - margin-left: auto; -} - -table.DocNodeLTR { - width: auto; - margin-right: auto; - margin-left: 0; -} - -tt, code, kbd, samp -{ - display: inline-block; - direction:ltr; -} -/* @end */ - -u { - text-decoration: underline; -} - diff --git a/docs/doxygen.svg b/docs/doxygen.svg deleted file mode 100644 index d42dad5..0000000 --- a/docs/doxygen.svg +++ /dev/null @@ -1,26 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/docs/dynsections.js b/docs/dynsections.js deleted file mode 100644 index 3174bd7..0000000 --- a/docs/dynsections.js +++ /dev/null @@ -1,121 +0,0 @@ -/* - @licstart The following is the entire license notice for the JavaScript code in this file. - - The MIT License (MIT) - - Copyright (C) 1997-2020 by Dimitri van Heesch - - 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. - - @licend The above is the entire license notice for the JavaScript code in this file - */ -function toggleVisibility(linkObj) -{ - var base = $(linkObj).attr('id'); - var summary = $('#'+base+'-summary'); - var content = $('#'+base+'-content'); - var trigger = $('#'+base+'-trigger'); - var src=$(trigger).attr('src'); - if (content.is(':visible')===true) { - content.hide(); - summary.show(); - $(linkObj).addClass('closed').removeClass('opened'); - $(trigger).attr('src',src.substring(0,src.length-8)+'closed.png'); - } else { - content.show(); - summary.hide(); - $(linkObj).removeClass('closed').addClass('opened'); - $(trigger).attr('src',src.substring(0,src.length-10)+'open.png'); - } - return false; -} - -function updateStripes() -{ - $('table.directory tr'). - removeClass('even').filter(':visible:even').addClass('even'); -} - -function toggleLevel(level) -{ - $('table.directory tr').each(function() { - var l = this.id.split('_').length-1; - var i = $('#img'+this.id.substring(3)); - var a = $('#arr'+this.id.substring(3)); - if (l - - - - - - -SparkFun_VEML7700_Arduino_Library: File List - - - - - - - - - -
-
- - - - - - -
-
SparkFun_VEML7700_Arduino_Library -
-
-
- - - - - - - -
- -
-
- - -
- -
- -
-
-
File List
-
-
-
Here is a list of all documented files with brief descriptions:
-
[detail level 12]
- - -
 ▼ src
 SparkFun_VEML7700_Arduino_Library.h
-
-
- -
-Generated by doxygen 1.9.1 -
- - diff --git a/docs/folderclosed.png b/docs/folderclosed.png deleted file mode 100644 index bb8ab35edce8e97554e360005ee9fc5bffb36e66..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 616 zcmV-u0+;=XP)a9#ETzayK)T~Jw&MMH>OIr#&;dC}is*2Mqdf&akCc=O@`qC+4i z5Iu3w#1M@KqXCz8TIZd1wli&kkl2HVcAiZ8PUn5z_kG@-y;?yK06=cA0U%H0PH+kU zl6dp}OR(|r8-RG+YLu`zbI}5TlOU6ToR41{9=uz^?dGTNL;wIMf|V3`d1Wj3y!#6` zBLZ?xpKR~^2x}?~zA(_NUu3IaDB$tKma*XUdOZN~c=dLt_h_k!dbxm_*ibDM zlFX`g{k$X}yIe%$N)cn1LNu=q9_CS)*>A zsX_mM4L@`(cSNQKMFc$RtYbx{79#j-J7hk*>*+ZZhM4Hw?I?rsXCi#mRWJ=-0LGV5a-WR0Qgt<|Nqf)C-@80`5gIz45^_20000IqP)X=#(TiCT&PiIIVc55T}TU}EUh*{q$|`3@{d>{Tc9Bo>e= zfmF3!f>fbI9#GoEHh0f`i5)wkLpva0ztf%HpZneK?w-7AK@b4Itw{y|Zd3k!fH?q2 zlhckHd_V2M_X7+)U&_Xcfvtw60l;--DgZmLSw-Y?S>)zIqMyJ1#FwLU*%bl38ok+! zh78H87n`ZTS;uhzAR$M`zZ`bVhq=+%u9^$5jDplgxd44}9;IRqUH1YHH|@6oFe%z( zo4)_>E$F&^P-f(#)>(TrnbE>Pefs9~@iN=|)Rz|V`sGfHNrJ)0gJb8xx+SBmRf@1l zvuzt=vGfI)<-F9!o&3l?>9~0QbUDT(wFdnQPv%xdD)m*g%!20>Bc9iYmGAp<9YAa( z0QgYgTWqf1qN++Gqp z8@AYPTB3E|6s=WLG?xw0tm|U!o=&zd+H0oRYE;Dbx+Na9s^STqX|Gnq%H8s(nGDGJ j8vwW|`Ts`)fSK|Kx=IK@RG@g200000NkvXXu0mjfauFEA diff --git a/docs/functions.html b/docs/functions.html deleted file mode 100644 index 5ed1ae8..0000000 --- a/docs/functions.html +++ /dev/null @@ -1,176 +0,0 @@ - - - - - - - -SparkFun_VEML7700_Arduino_Library: Class Members - - - - - - - - - -
-
- - - - - - -
-
SparkFun_VEML7700_Arduino_Library -
-
-
- - - - - - - -
- -
-
- - -
- -
- -
-
Here is a list of all documented class members with links to the class documentation for each member:
- -

- b -

- - -

- d -

- - -

- e -

- - -

- g -

- - -

- i -

- - -

- s -

- - -

- v -

-
- -
-Generated by doxygen 1.9.1 -
- - diff --git a/docs/functions_func.html b/docs/functions_func.html deleted file mode 100644 index 690f0e3..0000000 --- a/docs/functions_func.html +++ /dev/null @@ -1,176 +0,0 @@ - - - - - - - -SparkFun_VEML7700_Arduino_Library: Class Members - Functions - - - - - - - - - -
-
- - - - - - -
-
SparkFun_VEML7700_Arduino_Library -
-
-
- - - - - - - -
- -
-
- - -
- -
- -
-  - -

- b -

- - -

- d -

- - -

- e -

- - -

- g -

- - -

- i -

- - -

- s -

- - -

- v -

-
- -
-Generated by doxygen 1.9.1 -
- - diff --git a/docs/globals.html b/docs/globals.html deleted file mode 100644 index daec7f7..0000000 --- a/docs/globals.html +++ /dev/null @@ -1,96 +0,0 @@ - - - - - - - -SparkFun_VEML7700_Arduino_Library: File Members - - - - - - - - - -
-
- - - - - - -
-
SparkFun_VEML7700_Arduino_Library -
-
-
- - - - - - - -
- -
-
- - -
- -
- -
-
Here is a list of all documented file members with links to the documentation:
-
- -
-Generated by doxygen 1.9.1 -
- - diff --git a/docs/globals_defs.html b/docs/globals_defs.html deleted file mode 100644 index c48cb0b..0000000 --- a/docs/globals_defs.html +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - - -SparkFun_VEML7700_Arduino_Library: File Members - - - - - - - - - -
-
- - - - - - -
-
SparkFun_VEML7700_Arduino_Library -
-
-
- - - - - - - -
- -
-
- - -
- -
- -
-  -
- -
-Generated by doxygen 1.9.1 -
- - diff --git a/docs/globals_enum.html b/docs/globals_enum.html deleted file mode 100644 index 4a21e50..0000000 --- a/docs/globals_enum.html +++ /dev/null @@ -1,93 +0,0 @@ - - - - - - - -SparkFun_VEML7700_Arduino_Library: File Members - - - - - - - - - -
-
- - - - - - -
-
SparkFun_VEML7700_Arduino_Library -
-
-
- - - - - - - -
- -
-
- - -
- -
- -
-  -
- -
-Generated by doxygen 1.9.1 -
- - diff --git a/docs/index.html b/docs/index.html deleted file mode 100644 index cca939d..0000000 --- a/docs/index.html +++ /dev/null @@ -1,86 +0,0 @@ - - - - - - - -SparkFun_VEML7700_Arduino_Library: SparkFun VEML7700 Ambient Light Sensor Arduino Library - - - - - - - - - -
-
- - - - - - -
-
SparkFun_VEML7700_Arduino_Library -
-
-
- - - - - - - -
- -
-
- - -
- -
- -
-
-
SparkFun VEML7700 Ambient Light Sensor Arduino Library
-
-
-

-Introduction

-

This library facilitates communication with the VEML7700 over I2C.

-

Want to support open source hardware? Buy a board from SparkFun!
-SparkX smôl Environmental Peripheral Board (SPX-18976): https://www.sparkfun.com/products/18976

-

-Author

-

This library was written by: Paul Clark SparkFun Electronics November 4th 2021

-

-License

-

MIT: please see LICENSE.md for the full license information

-
-
- -
-Generated by doxygen 1.9.1 -
- - diff --git a/docs/jquery.js b/docs/jquery.js deleted file mode 100644 index 103c32d..0000000 --- a/docs/jquery.js +++ /dev/null @@ -1,35 +0,0 @@ -/*! jQuery v3.4.1 | (c) JS Foundation and other contributors | jquery.org/license */ -!function(e,t){"use strict";"object"==typeof module&&"object"==typeof module.exports?module.exports=e.document?t(e,!0):function(e){if(!e.document)throw new Error("jQuery requires a window with a document");return t(e)}:t(e)}("undefined"!=typeof window?window:this,function(C,e){"use strict";var t=[],E=C.document,r=Object.getPrototypeOf,s=t.slice,g=t.concat,u=t.push,i=t.indexOf,n={},o=n.toString,v=n.hasOwnProperty,a=v.toString,l=a.call(Object),y={},m=function(e){return"function"==typeof e&&"number"!=typeof e.nodeType},x=function(e){return null!=e&&e===e.window},c={type:!0,src:!0,nonce:!0,noModule:!0};function b(e,t,n){var r,i,o=(n=n||E).createElement("script");if(o.text=e,t)for(r in c)(i=t[r]||t.getAttribute&&t.getAttribute(r))&&o.setAttribute(r,i);n.head.appendChild(o).parentNode.removeChild(o)}function w(e){return null==e?e+"":"object"==typeof e||"function"==typeof e?n[o.call(e)]||"object":typeof e}var f="3.4.1",k=function(e,t){return new k.fn.init(e,t)},p=/^[\s\uFEFF\xA0]+|[\s\uFEFF\xA0]+$/g;function d(e){var t=!!e&&"length"in e&&e.length,n=w(e);return!m(e)&&!x(e)&&("array"===n||0===t||"number"==typeof t&&0+~]|"+M+")"+M+"*"),U=new RegExp(M+"|>"),X=new RegExp($),V=new RegExp("^"+I+"$"),G={ID:new RegExp("^#("+I+")"),CLASS:new RegExp("^\\.("+I+")"),TAG:new RegExp("^("+I+"|[*])"),ATTR:new RegExp("^"+W),PSEUDO:new RegExp("^"+$),CHILD:new RegExp("^:(only|first|last|nth|nth-last)-(child|of-type)(?:\\("+M+"*(even|odd|(([+-]|)(\\d*)n|)"+M+"*(?:([+-]|)"+M+"*(\\d+)|))"+M+"*\\)|)","i"),bool:new RegExp("^(?:"+R+")$","i"),needsContext:new RegExp("^"+M+"*[>+~]|:(even|odd|eq|gt|lt|nth|first|last)(?:\\("+M+"*((?:-\\d)?\\d*)"+M+"*\\)|)(?=[^-]|$)","i")},Y=/HTML$/i,Q=/^(?:input|select|textarea|button)$/i,J=/^h\d$/i,K=/^[^{]+\{\s*\[native \w/,Z=/^(?:#([\w-]+)|(\w+)|\.([\w-]+))$/,ee=/[+~]/,te=new RegExp("\\\\([\\da-f]{1,6}"+M+"?|("+M+")|.)","ig"),ne=function(e,t,n){var r="0x"+t-65536;return r!=r||n?t:r<0?String.fromCharCode(r+65536):String.fromCharCode(r>>10|55296,1023&r|56320)},re=/([\0-\x1f\x7f]|^-?\d)|^-$|[^\0-\x1f\x7f-\uFFFF\w-]/g,ie=function(e,t){return t?"\0"===e?"\ufffd":e.slice(0,-1)+"\\"+e.charCodeAt(e.length-1).toString(16)+" ":"\\"+e},oe=function(){T()},ae=be(function(e){return!0===e.disabled&&"fieldset"===e.nodeName.toLowerCase()},{dir:"parentNode",next:"legend"});try{H.apply(t=O.call(m.childNodes),m.childNodes),t[m.childNodes.length].nodeType}catch(e){H={apply:t.length?function(e,t){L.apply(e,O.call(t))}:function(e,t){var n=e.length,r=0;while(e[n++]=t[r++]);e.length=n-1}}}function se(t,e,n,r){var i,o,a,s,u,l,c,f=e&&e.ownerDocument,p=e?e.nodeType:9;if(n=n||[],"string"!=typeof t||!t||1!==p&&9!==p&&11!==p)return n;if(!r&&((e?e.ownerDocument||e:m)!==C&&T(e),e=e||C,E)){if(11!==p&&(u=Z.exec(t)))if(i=u[1]){if(9===p){if(!(a=e.getElementById(i)))return n;if(a.id===i)return n.push(a),n}else if(f&&(a=f.getElementById(i))&&y(e,a)&&a.id===i)return n.push(a),n}else{if(u[2])return H.apply(n,e.getElementsByTagName(t)),n;if((i=u[3])&&d.getElementsByClassName&&e.getElementsByClassName)return H.apply(n,e.getElementsByClassName(i)),n}if(d.qsa&&!A[t+" "]&&(!v||!v.test(t))&&(1!==p||"object"!==e.nodeName.toLowerCase())){if(c=t,f=e,1===p&&U.test(t)){(s=e.getAttribute("id"))?s=s.replace(re,ie):e.setAttribute("id",s=k),o=(l=h(t)).length;while(o--)l[o]="#"+s+" "+xe(l[o]);c=l.join(","),f=ee.test(t)&&ye(e.parentNode)||e}try{return H.apply(n,f.querySelectorAll(c)),n}catch(e){A(t,!0)}finally{s===k&&e.removeAttribute("id")}}}return g(t.replace(B,"$1"),e,n,r)}function ue(){var r=[];return function e(t,n){return r.push(t+" ")>b.cacheLength&&delete e[r.shift()],e[t+" "]=n}}function le(e){return e[k]=!0,e}function ce(e){var t=C.createElement("fieldset");try{return!!e(t)}catch(e){return!1}finally{t.parentNode&&t.parentNode.removeChild(t),t=null}}function fe(e,t){var n=e.split("|"),r=n.length;while(r--)b.attrHandle[n[r]]=t}function pe(e,t){var n=t&&e,r=n&&1===e.nodeType&&1===t.nodeType&&e.sourceIndex-t.sourceIndex;if(r)return r;if(n)while(n=n.nextSibling)if(n===t)return-1;return e?1:-1}function de(t){return function(e){return"input"===e.nodeName.toLowerCase()&&e.type===t}}function he(n){return function(e){var t=e.nodeName.toLowerCase();return("input"===t||"button"===t)&&e.type===n}}function ge(t){return function(e){return"form"in e?e.parentNode&&!1===e.disabled?"label"in e?"label"in e.parentNode?e.parentNode.disabled===t:e.disabled===t:e.isDisabled===t||e.isDisabled!==!t&&ae(e)===t:e.disabled===t:"label"in e&&e.disabled===t}}function ve(a){return le(function(o){return o=+o,le(function(e,t){var n,r=a([],e.length,o),i=r.length;while(i--)e[n=r[i]]&&(e[n]=!(t[n]=e[n]))})})}function ye(e){return e&&"undefined"!=typeof e.getElementsByTagName&&e}for(e in d=se.support={},i=se.isXML=function(e){var t=e.namespaceURI,n=(e.ownerDocument||e).documentElement;return!Y.test(t||n&&n.nodeName||"HTML")},T=se.setDocument=function(e){var t,n,r=e?e.ownerDocument||e:m;return r!==C&&9===r.nodeType&&r.documentElement&&(a=(C=r).documentElement,E=!i(C),m!==C&&(n=C.defaultView)&&n.top!==n&&(n.addEventListener?n.addEventListener("unload",oe,!1):n.attachEvent&&n.attachEvent("onunload",oe)),d.attributes=ce(function(e){return e.className="i",!e.getAttribute("className")}),d.getElementsByTagName=ce(function(e){return e.appendChild(C.createComment("")),!e.getElementsByTagName("*").length}),d.getElementsByClassName=K.test(C.getElementsByClassName),d.getById=ce(function(e){return a.appendChild(e).id=k,!C.getElementsByName||!C.getElementsByName(k).length}),d.getById?(b.filter.ID=function(e){var t=e.replace(te,ne);return function(e){return e.getAttribute("id")===t}},b.find.ID=function(e,t){if("undefined"!=typeof t.getElementById&&E){var n=t.getElementById(e);return n?[n]:[]}}):(b.filter.ID=function(e){var n=e.replace(te,ne);return function(e){var t="undefined"!=typeof e.getAttributeNode&&e.getAttributeNode("id");return t&&t.value===n}},b.find.ID=function(e,t){if("undefined"!=typeof t.getElementById&&E){var n,r,i,o=t.getElementById(e);if(o){if((n=o.getAttributeNode("id"))&&n.value===e)return[o];i=t.getElementsByName(e),r=0;while(o=i[r++])if((n=o.getAttributeNode("id"))&&n.value===e)return[o]}return[]}}),b.find.TAG=d.getElementsByTagName?function(e,t){return"undefined"!=typeof t.getElementsByTagName?t.getElementsByTagName(e):d.qsa?t.querySelectorAll(e):void 0}:function(e,t){var n,r=[],i=0,o=t.getElementsByTagName(e);if("*"===e){while(n=o[i++])1===n.nodeType&&r.push(n);return r}return o},b.find.CLASS=d.getElementsByClassName&&function(e,t){if("undefined"!=typeof t.getElementsByClassName&&E)return t.getElementsByClassName(e)},s=[],v=[],(d.qsa=K.test(C.querySelectorAll))&&(ce(function(e){a.appendChild(e).innerHTML="",e.querySelectorAll("[msallowcapture^='']").length&&v.push("[*^$]="+M+"*(?:''|\"\")"),e.querySelectorAll("[selected]").length||v.push("\\["+M+"*(?:value|"+R+")"),e.querySelectorAll("[id~="+k+"-]").length||v.push("~="),e.querySelectorAll(":checked").length||v.push(":checked"),e.querySelectorAll("a#"+k+"+*").length||v.push(".#.+[+~]")}),ce(function(e){e.innerHTML="";var t=C.createElement("input");t.setAttribute("type","hidden"),e.appendChild(t).setAttribute("name","D"),e.querySelectorAll("[name=d]").length&&v.push("name"+M+"*[*^$|!~]?="),2!==e.querySelectorAll(":enabled").length&&v.push(":enabled",":disabled"),a.appendChild(e).disabled=!0,2!==e.querySelectorAll(":disabled").length&&v.push(":enabled",":disabled"),e.querySelectorAll("*,:x"),v.push(",.*:")})),(d.matchesSelector=K.test(c=a.matches||a.webkitMatchesSelector||a.mozMatchesSelector||a.oMatchesSelector||a.msMatchesSelector))&&ce(function(e){d.disconnectedMatch=c.call(e,"*"),c.call(e,"[s!='']:x"),s.push("!=",$)}),v=v.length&&new RegExp(v.join("|")),s=s.length&&new RegExp(s.join("|")),t=K.test(a.compareDocumentPosition),y=t||K.test(a.contains)?function(e,t){var n=9===e.nodeType?e.documentElement:e,r=t&&t.parentNode;return e===r||!(!r||1!==r.nodeType||!(n.contains?n.contains(r):e.compareDocumentPosition&&16&e.compareDocumentPosition(r)))}:function(e,t){if(t)while(t=t.parentNode)if(t===e)return!0;return!1},D=t?function(e,t){if(e===t)return l=!0,0;var n=!e.compareDocumentPosition-!t.compareDocumentPosition;return n||(1&(n=(e.ownerDocument||e)===(t.ownerDocument||t)?e.compareDocumentPosition(t):1)||!d.sortDetached&&t.compareDocumentPosition(e)===n?e===C||e.ownerDocument===m&&y(m,e)?-1:t===C||t.ownerDocument===m&&y(m,t)?1:u?P(u,e)-P(u,t):0:4&n?-1:1)}:function(e,t){if(e===t)return l=!0,0;var n,r=0,i=e.parentNode,o=t.parentNode,a=[e],s=[t];if(!i||!o)return e===C?-1:t===C?1:i?-1:o?1:u?P(u,e)-P(u,t):0;if(i===o)return pe(e,t);n=e;while(n=n.parentNode)a.unshift(n);n=t;while(n=n.parentNode)s.unshift(n);while(a[r]===s[r])r++;return r?pe(a[r],s[r]):a[r]===m?-1:s[r]===m?1:0}),C},se.matches=function(e,t){return se(e,null,null,t)},se.matchesSelector=function(e,t){if((e.ownerDocument||e)!==C&&T(e),d.matchesSelector&&E&&!A[t+" "]&&(!s||!s.test(t))&&(!v||!v.test(t)))try{var n=c.call(e,t);if(n||d.disconnectedMatch||e.document&&11!==e.document.nodeType)return n}catch(e){A(t,!0)}return 0":{dir:"parentNode",first:!0}," ":{dir:"parentNode"},"+":{dir:"previousSibling",first:!0},"~":{dir:"previousSibling"}},preFilter:{ATTR:function(e){return e[1]=e[1].replace(te,ne),e[3]=(e[3]||e[4]||e[5]||"").replace(te,ne),"~="===e[2]&&(e[3]=" "+e[3]+" "),e.slice(0,4)},CHILD:function(e){return e[1]=e[1].toLowerCase(),"nth"===e[1].slice(0,3)?(e[3]||se.error(e[0]),e[4]=+(e[4]?e[5]+(e[6]||1):2*("even"===e[3]||"odd"===e[3])),e[5]=+(e[7]+e[8]||"odd"===e[3])):e[3]&&se.error(e[0]),e},PSEUDO:function(e){var t,n=!e[6]&&e[2];return G.CHILD.test(e[0])?null:(e[3]?e[2]=e[4]||e[5]||"":n&&X.test(n)&&(t=h(n,!0))&&(t=n.indexOf(")",n.length-t)-n.length)&&(e[0]=e[0].slice(0,t),e[2]=n.slice(0,t)),e.slice(0,3))}},filter:{TAG:function(e){var t=e.replace(te,ne).toLowerCase();return"*"===e?function(){return!0}:function(e){return e.nodeName&&e.nodeName.toLowerCase()===t}},CLASS:function(e){var t=p[e+" "];return t||(t=new RegExp("(^|"+M+")"+e+"("+M+"|$)"))&&p(e,function(e){return t.test("string"==typeof e.className&&e.className||"undefined"!=typeof e.getAttribute&&e.getAttribute("class")||"")})},ATTR:function(n,r,i){return function(e){var t=se.attr(e,n);return null==t?"!="===r:!r||(t+="","="===r?t===i:"!="===r?t!==i:"^="===r?i&&0===t.indexOf(i):"*="===r?i&&-1:\x20\t\r\n\f]*)[\x20\t\r\n\f]*\/?>(?:<\/\1>|)$/i;function j(e,n,r){return m(n)?k.grep(e,function(e,t){return!!n.call(e,t,e)!==r}):n.nodeType?k.grep(e,function(e){return e===n!==r}):"string"!=typeof n?k.grep(e,function(e){return-1)[^>]*|#([\w-]+))$/;(k.fn.init=function(e,t,n){var r,i;if(!e)return this;if(n=n||q,"string"==typeof e){if(!(r="<"===e[0]&&">"===e[e.length-1]&&3<=e.length?[null,e,null]:L.exec(e))||!r[1]&&t)return!t||t.jquery?(t||n).find(e):this.constructor(t).find(e);if(r[1]){if(t=t instanceof k?t[0]:t,k.merge(this,k.parseHTML(r[1],t&&t.nodeType?t.ownerDocument||t:E,!0)),D.test(r[1])&&k.isPlainObject(t))for(r in t)m(this[r])?this[r](t[r]):this.attr(r,t[r]);return this}return(i=E.getElementById(r[2]))&&(this[0]=i,this.length=1),this}return e.nodeType?(this[0]=e,this.length=1,this):m(e)?void 0!==n.ready?n.ready(e):e(k):k.makeArray(e,this)}).prototype=k.fn,q=k(E);var H=/^(?:parents|prev(?:Until|All))/,O={children:!0,contents:!0,next:!0,prev:!0};function P(e,t){while((e=e[t])&&1!==e.nodeType);return e}k.fn.extend({has:function(e){var t=k(e,this),n=t.length;return this.filter(function(){for(var e=0;e\x20\t\r\n\f]*)/i,he=/^$|^module$|\/(?:java|ecma)script/i,ge={option:[1,""],thead:[1,"","
"],col:[2,"","
"],tr:[2,"","
"],td:[3,"","
"],_default:[0,"",""]};function ve(e,t){var n;return n="undefined"!=typeof e.getElementsByTagName?e.getElementsByTagName(t||"*"):"undefined"!=typeof e.querySelectorAll?e.querySelectorAll(t||"*"):[],void 0===t||t&&A(e,t)?k.merge([e],n):n}function ye(e,t){for(var n=0,r=e.length;nx",y.noCloneChecked=!!me.cloneNode(!0).lastChild.defaultValue;var Te=/^key/,Ce=/^(?:mouse|pointer|contextmenu|drag|drop)|click/,Ee=/^([^.]*)(?:\.(.+)|)/;function ke(){return!0}function Se(){return!1}function Ne(e,t){return e===function(){try{return E.activeElement}catch(e){}}()==("focus"===t)}function Ae(e,t,n,r,i,o){var a,s;if("object"==typeof t){for(s in"string"!=typeof n&&(r=r||n,n=void 0),t)Ae(e,s,n,r,t[s],o);return e}if(null==r&&null==i?(i=n,r=n=void 0):null==i&&("string"==typeof n?(i=r,r=void 0):(i=r,r=n,n=void 0)),!1===i)i=Se;else if(!i)return e;return 1===o&&(a=i,(i=function(e){return k().off(e),a.apply(this,arguments)}).guid=a.guid||(a.guid=k.guid++)),e.each(function(){k.event.add(this,t,i,r,n)})}function De(e,i,o){o?(Q.set(e,i,!1),k.event.add(e,i,{namespace:!1,handler:function(e){var t,n,r=Q.get(this,i);if(1&e.isTrigger&&this[i]){if(r.length)(k.event.special[i]||{}).delegateType&&e.stopPropagation();else if(r=s.call(arguments),Q.set(this,i,r),t=o(this,i),this[i](),r!==(n=Q.get(this,i))||t?Q.set(this,i,!1):n={},r!==n)return e.stopImmediatePropagation(),e.preventDefault(),n.value}else r.length&&(Q.set(this,i,{value:k.event.trigger(k.extend(r[0],k.Event.prototype),r.slice(1),this)}),e.stopImmediatePropagation())}})):void 0===Q.get(e,i)&&k.event.add(e,i,ke)}k.event={global:{},add:function(t,e,n,r,i){var o,a,s,u,l,c,f,p,d,h,g,v=Q.get(t);if(v){n.handler&&(n=(o=n).handler,i=o.selector),i&&k.find.matchesSelector(ie,i),n.guid||(n.guid=k.guid++),(u=v.events)||(u=v.events={}),(a=v.handle)||(a=v.handle=function(e){return"undefined"!=typeof k&&k.event.triggered!==e.type?k.event.dispatch.apply(t,arguments):void 0}),l=(e=(e||"").match(R)||[""]).length;while(l--)d=g=(s=Ee.exec(e[l])||[])[1],h=(s[2]||"").split(".").sort(),d&&(f=k.event.special[d]||{},d=(i?f.delegateType:f.bindType)||d,f=k.event.special[d]||{},c=k.extend({type:d,origType:g,data:r,handler:n,guid:n.guid,selector:i,needsContext:i&&k.expr.match.needsContext.test(i),namespace:h.join(".")},o),(p=u[d])||((p=u[d]=[]).delegateCount=0,f.setup&&!1!==f.setup.call(t,r,h,a)||t.addEventListener&&t.addEventListener(d,a)),f.add&&(f.add.call(t,c),c.handler.guid||(c.handler.guid=n.guid)),i?p.splice(p.delegateCount++,0,c):p.push(c),k.event.global[d]=!0)}},remove:function(e,t,n,r,i){var o,a,s,u,l,c,f,p,d,h,g,v=Q.hasData(e)&&Q.get(e);if(v&&(u=v.events)){l=(t=(t||"").match(R)||[""]).length;while(l--)if(d=g=(s=Ee.exec(t[l])||[])[1],h=(s[2]||"").split(".").sort(),d){f=k.event.special[d]||{},p=u[d=(r?f.delegateType:f.bindType)||d]||[],s=s[2]&&new RegExp("(^|\\.)"+h.join("\\.(?:.*\\.|)")+"(\\.|$)"),a=o=p.length;while(o--)c=p[o],!i&&g!==c.origType||n&&n.guid!==c.guid||s&&!s.test(c.namespace)||r&&r!==c.selector&&("**"!==r||!c.selector)||(p.splice(o,1),c.selector&&p.delegateCount--,f.remove&&f.remove.call(e,c));a&&!p.length&&(f.teardown&&!1!==f.teardown.call(e,h,v.handle)||k.removeEvent(e,d,v.handle),delete u[d])}else for(d in u)k.event.remove(e,d+t[l],n,r,!0);k.isEmptyObject(u)&&Q.remove(e,"handle events")}},dispatch:function(e){var t,n,r,i,o,a,s=k.event.fix(e),u=new Array(arguments.length),l=(Q.get(this,"events")||{})[s.type]||[],c=k.event.special[s.type]||{};for(u[0]=s,t=1;t\x20\t\r\n\f]*)[^>]*)\/>/gi,qe=/\s*$/g;function Oe(e,t){return A(e,"table")&&A(11!==t.nodeType?t:t.firstChild,"tr")&&k(e).children("tbody")[0]||e}function Pe(e){return e.type=(null!==e.getAttribute("type"))+"/"+e.type,e}function Re(e){return"true/"===(e.type||"").slice(0,5)?e.type=e.type.slice(5):e.removeAttribute("type"),e}function Me(e,t){var n,r,i,o,a,s,u,l;if(1===t.nodeType){if(Q.hasData(e)&&(o=Q.access(e),a=Q.set(t,o),l=o.events))for(i in delete a.handle,a.events={},l)for(n=0,r=l[i].length;n")},clone:function(e,t,n){var r,i,o,a,s,u,l,c=e.cloneNode(!0),f=oe(e);if(!(y.noCloneChecked||1!==e.nodeType&&11!==e.nodeType||k.isXMLDoc(e)))for(a=ve(c),r=0,i=(o=ve(e)).length;r").attr(n.scriptAttrs||{}).prop({charset:n.scriptCharset,src:n.url}).on("load error",i=function(e){r.remove(),i=null,e&&t("error"===e.type?404:200,e.type)}),E.head.appendChild(r[0])},abort:function(){i&&i()}}});var Vt,Gt=[],Yt=/(=)\?(?=&|$)|\?\?/;k.ajaxSetup({jsonp:"callback",jsonpCallback:function(){var e=Gt.pop()||k.expando+"_"+kt++;return this[e]=!0,e}}),k.ajaxPrefilter("json jsonp",function(e,t,n){var r,i,o,a=!1!==e.jsonp&&(Yt.test(e.url)?"url":"string"==typeof e.data&&0===(e.contentType||"").indexOf("application/x-www-form-urlencoded")&&Yt.test(e.data)&&"data");if(a||"jsonp"===e.dataTypes[0])return r=e.jsonpCallback=m(e.jsonpCallback)?e.jsonpCallback():e.jsonpCallback,a?e[a]=e[a].replace(Yt,"$1"+r):!1!==e.jsonp&&(e.url+=(St.test(e.url)?"&":"?")+e.jsonp+"="+r),e.converters["script json"]=function(){return o||k.error(r+" was not called"),o[0]},e.dataTypes[0]="json",i=C[r],C[r]=function(){o=arguments},n.always(function(){void 0===i?k(C).removeProp(r):C[r]=i,e[r]&&(e.jsonpCallback=t.jsonpCallback,Gt.push(r)),o&&m(i)&&i(o[0]),o=i=void 0}),"script"}),y.createHTMLDocument=((Vt=E.implementation.createHTMLDocument("").body).innerHTML="
",2===Vt.childNodes.length),k.parseHTML=function(e,t,n){return"string"!=typeof e?[]:("boolean"==typeof t&&(n=t,t=!1),t||(y.createHTMLDocument?((r=(t=E.implementation.createHTMLDocument("")).createElement("base")).href=E.location.href,t.head.appendChild(r)):t=E),o=!n&&[],(i=D.exec(e))?[t.createElement(i[1])]:(i=we([e],t,o),o&&o.length&&k(o).remove(),k.merge([],i.childNodes)));var r,i,o},k.fn.load=function(e,t,n){var r,i,o,a=this,s=e.indexOf(" ");return-1").append(k.parseHTML(e)).find(r):e)}).always(n&&function(e,t){a.each(function(){n.apply(this,o||[e.responseText,t,e])})}),this},k.each(["ajaxStart","ajaxStop","ajaxComplete","ajaxError","ajaxSuccess","ajaxSend"],function(e,t){k.fn[t]=function(e){return this.on(t,e)}}),k.expr.pseudos.animated=function(t){return k.grep(k.timers,function(e){return t===e.elem}).length},k.offset={setOffset:function(e,t,n){var r,i,o,a,s,u,l=k.css(e,"position"),c=k(e),f={};"static"===l&&(e.style.position="relative"),s=c.offset(),o=k.css(e,"top"),u=k.css(e,"left"),("absolute"===l||"fixed"===l)&&-1<(o+u).indexOf("auto")?(a=(r=c.position()).top,i=r.left):(a=parseFloat(o)||0,i=parseFloat(u)||0),m(t)&&(t=t.call(e,n,k.extend({},s))),null!=t.top&&(f.top=t.top-s.top+a),null!=t.left&&(f.left=t.left-s.left+i),"using"in t?t.using.call(e,f):c.css(f)}},k.fn.extend({offset:function(t){if(arguments.length)return void 0===t?this:this.each(function(e){k.offset.setOffset(this,t,e)});var e,n,r=this[0];return r?r.getClientRects().length?(e=r.getBoundingClientRect(),n=r.ownerDocument.defaultView,{top:e.top+n.pageYOffset,left:e.left+n.pageXOffset}):{top:0,left:0}:void 0},position:function(){if(this[0]){var e,t,n,r=this[0],i={top:0,left:0};if("fixed"===k.css(r,"position"))t=r.getBoundingClientRect();else{t=this.offset(),n=r.ownerDocument,e=r.offsetParent||n.documentElement;while(e&&(e===n.body||e===n.documentElement)&&"static"===k.css(e,"position"))e=e.parentNode;e&&e!==r&&1===e.nodeType&&((i=k(e).offset()).top+=k.css(e,"borderTopWidth",!0),i.left+=k.css(e,"borderLeftWidth",!0))}return{top:t.top-i.top-k.css(r,"marginTop",!0),left:t.left-i.left-k.css(r,"marginLeft",!0)}}},offsetParent:function(){return this.map(function(){var e=this.offsetParent;while(e&&"static"===k.css(e,"position"))e=e.offsetParent;return e||ie})}}),k.each({scrollLeft:"pageXOffset",scrollTop:"pageYOffset"},function(t,i){var o="pageYOffset"===i;k.fn[t]=function(e){return _(this,function(e,t,n){var r;if(x(e)?r=e:9===e.nodeType&&(r=e.defaultView),void 0===n)return r?r[i]:e[t];r?r.scrollTo(o?r.pageXOffset:n,o?n:r.pageYOffset):e[t]=n},t,e,arguments.length)}}),k.each(["top","left"],function(e,n){k.cssHooks[n]=ze(y.pixelPosition,function(e,t){if(t)return t=_e(e,n),$e.test(t)?k(e).position()[n]+"px":t})}),k.each({Height:"height",Width:"width"},function(a,s){k.each({padding:"inner"+a,content:s,"":"outer"+a},function(r,o){k.fn[o]=function(e,t){var n=arguments.length&&(r||"boolean"!=typeof e),i=r||(!0===e||!0===t?"margin":"border");return _(this,function(e,t,n){var r;return x(e)?0===o.indexOf("outer")?e["inner"+a]:e.document.documentElement["client"+a]:9===e.nodeType?(r=e.documentElement,Math.max(e.body["scroll"+a],r["scroll"+a],e.body["offset"+a],r["offset"+a],r["client"+a])):void 0===n?k.css(e,t,i):k.style(e,t,n,i)},s,n?e:void 0,n)}})}),k.each("blur focus focusin focusout resize scroll click dblclick mousedown mouseup mousemove mouseover mouseout mouseenter mouseleave change select submit keydown keypress keyup contextmenu".split(" "),function(e,n){k.fn[n]=function(e,t){return 0a;a++)for(i in o[a])n=o[a][i],o[a].hasOwnProperty(i)&&void 0!==n&&(e[i]=t.isPlainObject(n)?t.isPlainObject(e[i])?t.widget.extend({},e[i],n):t.widget.extend({},n):n);return e},t.widget.bridge=function(e,i){var n=i.prototype.widgetFullName||e;t.fn[e]=function(o){var a="string"==typeof o,r=s.call(arguments,1),h=this;return a?this.length||"instance"!==o?this.each(function(){var i,s=t.data(this,n);return"instance"===o?(h=s,!1):s?t.isFunction(s[o])&&"_"!==o.charAt(0)?(i=s[o].apply(s,r),i!==s&&void 0!==i?(h=i&&i.jquery?h.pushStack(i.get()):i,!1):void 0):t.error("no such method '"+o+"' for "+e+" widget instance"):t.error("cannot call methods on "+e+" prior to initialization; "+"attempted to call method '"+o+"'")}):h=void 0:(r.length&&(o=t.widget.extend.apply(null,[o].concat(r))),this.each(function(){var e=t.data(this,n);e?(e.option(o||{}),e._init&&e._init()):t.data(this,n,new i(o,this))})),h}},t.Widget=function(){},t.Widget._childConstructors=[],t.Widget.prototype={widgetName:"widget",widgetEventPrefix:"",defaultElement:"
",options:{classes:{},disabled:!1,create:null},_createWidget:function(e,s){s=t(s||this.defaultElement||this)[0],this.element=t(s),this.uuid=i++,this.eventNamespace="."+this.widgetName+this.uuid,this.bindings=t(),this.hoverable=t(),this.focusable=t(),this.classesElementLookup={},s!==this&&(t.data(s,this.widgetFullName,this),this._on(!0,this.element,{remove:function(t){t.target===s&&this.destroy()}}),this.document=t(s.style?s.ownerDocument:s.document||s),this.window=t(this.document[0].defaultView||this.document[0].parentWindow)),this.options=t.widget.extend({},this.options,this._getCreateOptions(),e),this._create(),this.options.disabled&&this._setOptionDisabled(this.options.disabled),this._trigger("create",null,this._getCreateEventData()),this._init()},_getCreateOptions:function(){return{}},_getCreateEventData:t.noop,_create:t.noop,_init:t.noop,destroy:function(){var e=this;this._destroy(),t.each(this.classesElementLookup,function(t,i){e._removeClass(i,t)}),this.element.off(this.eventNamespace).removeData(this.widgetFullName),this.widget().off(this.eventNamespace).removeAttr("aria-disabled"),this.bindings.off(this.eventNamespace)},_destroy:t.noop,widget:function(){return this.element},option:function(e,i){var s,n,o,a=e;if(0===arguments.length)return t.widget.extend({},this.options);if("string"==typeof e)if(a={},s=e.split("."),e=s.shift(),s.length){for(n=a[e]=t.widget.extend({},this.options[e]),o=0;s.length-1>o;o++)n[s[o]]=n[s[o]]||{},n=n[s[o]];if(e=s.pop(),1===arguments.length)return void 0===n[e]?null:n[e];n[e]=i}else{if(1===arguments.length)return void 0===this.options[e]?null:this.options[e];a[e]=i}return this._setOptions(a),this},_setOptions:function(t){var e;for(e in t)this._setOption(e,t[e]);return this},_setOption:function(t,e){return"classes"===t&&this._setOptionClasses(e),this.options[t]=e,"disabled"===t&&this._setOptionDisabled(e),this},_setOptionClasses:function(e){var i,s,n;for(i in e)n=this.classesElementLookup[i],e[i]!==this.options.classes[i]&&n&&n.length&&(s=t(n.get()),this._removeClass(n,i),s.addClass(this._classes({element:s,keys:i,classes:e,add:!0})))},_setOptionDisabled:function(t){this._toggleClass(this.widget(),this.widgetFullName+"-disabled",null,!!t),t&&(this._removeClass(this.hoverable,null,"ui-state-hover"),this._removeClass(this.focusable,null,"ui-state-focus"))},enable:function(){return this._setOptions({disabled:!1})},disable:function(){return this._setOptions({disabled:!0})},_classes:function(e){function i(i,o){var a,r;for(r=0;i.length>r;r++)a=n.classesElementLookup[i[r]]||t(),a=e.add?t(t.unique(a.get().concat(e.element.get()))):t(a.not(e.element).get()),n.classesElementLookup[i[r]]=a,s.push(i[r]),o&&e.classes[i[r]]&&s.push(e.classes[i[r]])}var s=[],n=this;return e=t.extend({element:this.element,classes:this.options.classes||{}},e),this._on(e.element,{remove:"_untrackClassesElement"}),e.keys&&i(e.keys.match(/\S+/g)||[],!0),e.extra&&i(e.extra.match(/\S+/g)||[]),s.join(" ")},_untrackClassesElement:function(e){var i=this;t.each(i.classesElementLookup,function(s,n){-1!==t.inArray(e.target,n)&&(i.classesElementLookup[s]=t(n.not(e.target).get()))})},_removeClass:function(t,e,i){return this._toggleClass(t,e,i,!1)},_addClass:function(t,e,i){return this._toggleClass(t,e,i,!0)},_toggleClass:function(t,e,i,s){s="boolean"==typeof s?s:i;var n="string"==typeof t||null===t,o={extra:n?e:i,keys:n?t:e,element:n?this.element:t,add:s};return o.element.toggleClass(this._classes(o),s),this},_on:function(e,i,s){var n,o=this;"boolean"!=typeof e&&(s=i,i=e,e=!1),s?(i=n=t(i),this.bindings=this.bindings.add(i)):(s=i,i=this.element,n=this.widget()),t.each(s,function(s,a){function r(){return e||o.options.disabled!==!0&&!t(this).hasClass("ui-state-disabled")?("string"==typeof a?o[a]:a).apply(o,arguments):void 0}"string"!=typeof a&&(r.guid=a.guid=a.guid||r.guid||t.guid++);var h=s.match(/^([\w:-]*)\s*(.*)$/),l=h[1]+o.eventNamespace,c=h[2];c?n.on(l,c,r):i.on(l,r)})},_off:function(e,i){i=(i||"").split(" ").join(this.eventNamespace+" ")+this.eventNamespace,e.off(i).off(i),this.bindings=t(this.bindings.not(e).get()),this.focusable=t(this.focusable.not(e).get()),this.hoverable=t(this.hoverable.not(e).get())},_delay:function(t,e){function i(){return("string"==typeof t?s[t]:t).apply(s,arguments)}var s=this;return setTimeout(i,e||0)},_hoverable:function(e){this.hoverable=this.hoverable.add(e),this._on(e,{mouseenter:function(e){this._addClass(t(e.currentTarget),null,"ui-state-hover")},mouseleave:function(e){this._removeClass(t(e.currentTarget),null,"ui-state-hover")}})},_focusable:function(e){this.focusable=this.focusable.add(e),this._on(e,{focusin:function(e){this._addClass(t(e.currentTarget),null,"ui-state-focus")},focusout:function(e){this._removeClass(t(e.currentTarget),null,"ui-state-focus")}})},_trigger:function(e,i,s){var n,o,a=this.options[e];if(s=s||{},i=t.Event(i),i.type=(e===this.widgetEventPrefix?e:this.widgetEventPrefix+e).toLowerCase(),i.target=this.element[0],o=i.originalEvent)for(n in o)n in i||(i[n]=o[n]);return this.element.trigger(i,s),!(t.isFunction(a)&&a.apply(this.element[0],[i].concat(s))===!1||i.isDefaultPrevented())}},t.each({show:"fadeIn",hide:"fadeOut"},function(e,i){t.Widget.prototype["_"+e]=function(s,n,o){"string"==typeof n&&(n={effect:n});var a,r=n?n===!0||"number"==typeof n?i:n.effect||i:e;n=n||{},"number"==typeof n&&(n={duration:n}),a=!t.isEmptyObject(n),n.complete=o,n.delay&&s.delay(n.delay),a&&t.effects&&t.effects.effect[r]?s[e](n):r!==e&&s[r]?s[r](n.duration,n.easing,o):s.queue(function(i){t(this)[e](),o&&o.call(s[0]),i()})}}),t.widget,function(){function e(t,e,i){return[parseFloat(t[0])*(u.test(t[0])?e/100:1),parseFloat(t[1])*(u.test(t[1])?i/100:1)]}function i(e,i){return parseInt(t.css(e,i),10)||0}function s(e){var i=e[0];return 9===i.nodeType?{width:e.width(),height:e.height(),offset:{top:0,left:0}}:t.isWindow(i)?{width:e.width(),height:e.height(),offset:{top:e.scrollTop(),left:e.scrollLeft()}}:i.preventDefault?{width:0,height:0,offset:{top:i.pageY,left:i.pageX}}:{width:e.outerWidth(),height:e.outerHeight(),offset:e.offset()}}var n,o=Math.max,a=Math.abs,r=/left|center|right/,h=/top|center|bottom/,l=/[\+\-]\d+(\.[\d]+)?%?/,c=/^\w+/,u=/%$/,d=t.fn.position;t.position={scrollbarWidth:function(){if(void 0!==n)return n;var e,i,s=t("
"),o=s.children()[0];return t("body").append(s),e=o.offsetWidth,s.css("overflow","scroll"),i=o.offsetWidth,e===i&&(i=s[0].clientWidth),s.remove(),n=e-i},getScrollInfo:function(e){var i=e.isWindow||e.isDocument?"":e.element.css("overflow-x"),s=e.isWindow||e.isDocument?"":e.element.css("overflow-y"),n="scroll"===i||"auto"===i&&e.widthi?"left":e>0?"right":"center",vertical:0>r?"top":s>0?"bottom":"middle"};l>p&&p>a(e+i)&&(u.horizontal="center"),c>f&&f>a(s+r)&&(u.vertical="middle"),u.important=o(a(e),a(i))>o(a(s),a(r))?"horizontal":"vertical",n.using.call(this,t,u)}),h.offset(t.extend(D,{using:r}))})},t.ui.position={fit:{left:function(t,e){var i,s=e.within,n=s.isWindow?s.scrollLeft:s.offset.left,a=s.width,r=t.left-e.collisionPosition.marginLeft,h=n-r,l=r+e.collisionWidth-a-n;e.collisionWidth>a?h>0&&0>=l?(i=t.left+h+e.collisionWidth-a-n,t.left+=h-i):t.left=l>0&&0>=h?n:h>l?n+a-e.collisionWidth:n:h>0?t.left+=h:l>0?t.left-=l:t.left=o(t.left-r,t.left)},top:function(t,e){var i,s=e.within,n=s.isWindow?s.scrollTop:s.offset.top,a=e.within.height,r=t.top-e.collisionPosition.marginTop,h=n-r,l=r+e.collisionHeight-a-n;e.collisionHeight>a?h>0&&0>=l?(i=t.top+h+e.collisionHeight-a-n,t.top+=h-i):t.top=l>0&&0>=h?n:h>l?n+a-e.collisionHeight:n:h>0?t.top+=h:l>0?t.top-=l:t.top=o(t.top-r,t.top)}},flip:{left:function(t,e){var i,s,n=e.within,o=n.offset.left+n.scrollLeft,r=n.width,h=n.isWindow?n.scrollLeft:n.offset.left,l=t.left-e.collisionPosition.marginLeft,c=l-h,u=l+e.collisionWidth-r-h,d="left"===e.my[0]?-e.elemWidth:"right"===e.my[0]?e.elemWidth:0,p="left"===e.at[0]?e.targetWidth:"right"===e.at[0]?-e.targetWidth:0,f=-2*e.offset[0];0>c?(i=t.left+d+p+f+e.collisionWidth-r-o,(0>i||a(c)>i)&&(t.left+=d+p+f)):u>0&&(s=t.left-e.collisionPosition.marginLeft+d+p+f-h,(s>0||u>a(s))&&(t.left+=d+p+f))},top:function(t,e){var i,s,n=e.within,o=n.offset.top+n.scrollTop,r=n.height,h=n.isWindow?n.scrollTop:n.offset.top,l=t.top-e.collisionPosition.marginTop,c=l-h,u=l+e.collisionHeight-r-h,d="top"===e.my[1],p=d?-e.elemHeight:"bottom"===e.my[1]?e.elemHeight:0,f="top"===e.at[1]?e.targetHeight:"bottom"===e.at[1]?-e.targetHeight:0,m=-2*e.offset[1];0>c?(s=t.top+p+f+m+e.collisionHeight-r-o,(0>s||a(c)>s)&&(t.top+=p+f+m)):u>0&&(i=t.top-e.collisionPosition.marginTop+p+f+m-h,(i>0||u>a(i))&&(t.top+=p+f+m))}},flipfit:{left:function(){t.ui.position.flip.left.apply(this,arguments),t.ui.position.fit.left.apply(this,arguments)},top:function(){t.ui.position.flip.top.apply(this,arguments),t.ui.position.fit.top.apply(this,arguments)}}}}(),t.ui.position,t.extend(t.expr[":"],{data:t.expr.createPseudo?t.expr.createPseudo(function(e){return function(i){return!!t.data(i,e)}}):function(e,i,s){return!!t.data(e,s[3])}}),t.fn.extend({disableSelection:function(){var t="onselectstart"in document.createElement("div")?"selectstart":"mousedown";return function(){return this.on(t+".ui-disableSelection",function(t){t.preventDefault()})}}(),enableSelection:function(){return this.off(".ui-disableSelection")}}),t.ui.focusable=function(i,s){var n,o,a,r,h,l=i.nodeName.toLowerCase();return"area"===l?(n=i.parentNode,o=n.name,i.href&&o&&"map"===n.nodeName.toLowerCase()?(a=t("img[usemap='#"+o+"']"),a.length>0&&a.is(":visible")):!1):(/^(input|select|textarea|button|object)$/.test(l)?(r=!i.disabled,r&&(h=t(i).closest("fieldset")[0],h&&(r=!h.disabled))):r="a"===l?i.href||s:s,r&&t(i).is(":visible")&&e(t(i)))},t.extend(t.expr[":"],{focusable:function(e){return t.ui.focusable(e,null!=t.attr(e,"tabindex"))}}),t.ui.focusable,t.fn.form=function(){return"string"==typeof this[0].form?this.closest("form"):t(this[0].form)},t.ui.formResetMixin={_formResetHandler:function(){var e=t(this);setTimeout(function(){var i=e.data("ui-form-reset-instances");t.each(i,function(){this.refresh()})})},_bindFormResetHandler:function(){if(this.form=this.element.form(),this.form.length){var t=this.form.data("ui-form-reset-instances")||[];t.length||this.form.on("reset.ui-form-reset",this._formResetHandler),t.push(this),this.form.data("ui-form-reset-instances",t)}},_unbindFormResetHandler:function(){if(this.form.length){var e=this.form.data("ui-form-reset-instances");e.splice(t.inArray(this,e),1),e.length?this.form.data("ui-form-reset-instances",e):this.form.removeData("ui-form-reset-instances").off("reset.ui-form-reset")}}},"1.7"===t.fn.jquery.substring(0,3)&&(t.each(["Width","Height"],function(e,i){function s(e,i,s,o){return t.each(n,function(){i-=parseFloat(t.css(e,"padding"+this))||0,s&&(i-=parseFloat(t.css(e,"border"+this+"Width"))||0),o&&(i-=parseFloat(t.css(e,"margin"+this))||0)}),i}var n="Width"===i?["Left","Right"]:["Top","Bottom"],o=i.toLowerCase(),a={innerWidth:t.fn.innerWidth,innerHeight:t.fn.innerHeight,outerWidth:t.fn.outerWidth,outerHeight:t.fn.outerHeight};t.fn["inner"+i]=function(e){return void 0===e?a["inner"+i].call(this):this.each(function(){t(this).css(o,s(this,e)+"px")})},t.fn["outer"+i]=function(e,n){return"number"!=typeof e?a["outer"+i].call(this,e):this.each(function(){t(this).css(o,s(this,e,!0,n)+"px")})}}),t.fn.addBack=function(t){return this.add(null==t?this.prevObject:this.prevObject.filter(t))}),t.ui.keyCode={BACKSPACE:8,COMMA:188,DELETE:46,DOWN:40,END:35,ENTER:13,ESCAPE:27,HOME:36,LEFT:37,PAGE_DOWN:34,PAGE_UP:33,PERIOD:190,RIGHT:39,SPACE:32,TAB:9,UP:38},t.ui.escapeSelector=function(){var t=/([!"#$%&'()*+,./:;<=>?@[\]^`{|}~])/g;return function(e){return e.replace(t,"\\$1")}}(),t.fn.labels=function(){var e,i,s,n,o;return this[0].labels&&this[0].labels.length?this.pushStack(this[0].labels):(n=this.eq(0).parents("label"),s=this.attr("id"),s&&(e=this.eq(0).parents().last(),o=e.add(e.length?e.siblings():this.siblings()),i="label[for='"+t.ui.escapeSelector(s)+"']",n=n.add(o.find(i).addBack(i))),this.pushStack(n))},t.fn.scrollParent=function(e){var i=this.css("position"),s="absolute"===i,n=e?/(auto|scroll|hidden)/:/(auto|scroll)/,o=this.parents().filter(function(){var e=t(this);return s&&"static"===e.css("position")?!1:n.test(e.css("overflow")+e.css("overflow-y")+e.css("overflow-x"))}).eq(0);return"fixed"!==i&&o.length?o:t(this[0].ownerDocument||document)},t.extend(t.expr[":"],{tabbable:function(e){var i=t.attr(e,"tabindex"),s=null!=i;return(!s||i>=0)&&t.ui.focusable(e,s)}}),t.fn.extend({uniqueId:function(){var t=0;return function(){return this.each(function(){this.id||(this.id="ui-id-"+ ++t)})}}(),removeUniqueId:function(){return this.each(function(){/^ui-id-\d+$/.test(this.id)&&t(this).removeAttr("id")})}}),t.ui.ie=!!/msie [\w.]+/.exec(navigator.userAgent.toLowerCase());var n=!1;t(document).on("mouseup",function(){n=!1}),t.widget("ui.mouse",{version:"1.12.1",options:{cancel:"input, textarea, button, select, option",distance:1,delay:0},_mouseInit:function(){var e=this;this.element.on("mousedown."+this.widgetName,function(t){return e._mouseDown(t)}).on("click."+this.widgetName,function(i){return!0===t.data(i.target,e.widgetName+".preventClickEvent")?(t.removeData(i.target,e.widgetName+".preventClickEvent"),i.stopImmediatePropagation(),!1):void 0}),this.started=!1},_mouseDestroy:function(){this.element.off("."+this.widgetName),this._mouseMoveDelegate&&this.document.off("mousemove."+this.widgetName,this._mouseMoveDelegate).off("mouseup."+this.widgetName,this._mouseUpDelegate)},_mouseDown:function(e){if(!n){this._mouseMoved=!1,this._mouseStarted&&this._mouseUp(e),this._mouseDownEvent=e;var i=this,s=1===e.which,o="string"==typeof this.options.cancel&&e.target.nodeName?t(e.target).closest(this.options.cancel).length:!1;return s&&!o&&this._mouseCapture(e)?(this.mouseDelayMet=!this.options.delay,this.mouseDelayMet||(this._mouseDelayTimer=setTimeout(function(){i.mouseDelayMet=!0},this.options.delay)),this._mouseDistanceMet(e)&&this._mouseDelayMet(e)&&(this._mouseStarted=this._mouseStart(e)!==!1,!this._mouseStarted)?(e.preventDefault(),!0):(!0===t.data(e.target,this.widgetName+".preventClickEvent")&&t.removeData(e.target,this.widgetName+".preventClickEvent"),this._mouseMoveDelegate=function(t){return i._mouseMove(t)},this._mouseUpDelegate=function(t){return i._mouseUp(t)},this.document.on("mousemove."+this.widgetName,this._mouseMoveDelegate).on("mouseup."+this.widgetName,this._mouseUpDelegate),e.preventDefault(),n=!0,!0)):!0}},_mouseMove:function(e){if(this._mouseMoved){if(t.ui.ie&&(!document.documentMode||9>document.documentMode)&&!e.button)return this._mouseUp(e);if(!e.which)if(e.originalEvent.altKey||e.originalEvent.ctrlKey||e.originalEvent.metaKey||e.originalEvent.shiftKey)this.ignoreMissingWhich=!0;else if(!this.ignoreMissingWhich)return this._mouseUp(e)}return(e.which||e.button)&&(this._mouseMoved=!0),this._mouseStarted?(this._mouseDrag(e),e.preventDefault()):(this._mouseDistanceMet(e)&&this._mouseDelayMet(e)&&(this._mouseStarted=this._mouseStart(this._mouseDownEvent,e)!==!1,this._mouseStarted?this._mouseDrag(e):this._mouseUp(e)),!this._mouseStarted)},_mouseUp:function(e){this.document.off("mousemove."+this.widgetName,this._mouseMoveDelegate).off("mouseup."+this.widgetName,this._mouseUpDelegate),this._mouseStarted&&(this._mouseStarted=!1,e.target===this._mouseDownEvent.target&&t.data(e.target,this.widgetName+".preventClickEvent",!0),this._mouseStop(e)),this._mouseDelayTimer&&(clearTimeout(this._mouseDelayTimer),delete this._mouseDelayTimer),this.ignoreMissingWhich=!1,n=!1,e.preventDefault()},_mouseDistanceMet:function(t){return Math.max(Math.abs(this._mouseDownEvent.pageX-t.pageX),Math.abs(this._mouseDownEvent.pageY-t.pageY))>=this.options.distance},_mouseDelayMet:function(){return this.mouseDelayMet},_mouseStart:function(){},_mouseDrag:function(){},_mouseStop:function(){},_mouseCapture:function(){return!0}}),t.ui.plugin={add:function(e,i,s){var n,o=t.ui[e].prototype;for(n in s)o.plugins[n]=o.plugins[n]||[],o.plugins[n].push([i,s[n]])},call:function(t,e,i,s){var n,o=t.plugins[e];if(o&&(s||t.element[0].parentNode&&11!==t.element[0].parentNode.nodeType))for(n=0;o.length>n;n++)t.options[o[n][0]]&&o[n][1].apply(t.element,i)}},t.widget("ui.resizable",t.ui.mouse,{version:"1.12.1",widgetEventPrefix:"resize",options:{alsoResize:!1,animate:!1,animateDuration:"slow",animateEasing:"swing",aspectRatio:!1,autoHide:!1,classes:{"ui-resizable-se":"ui-icon ui-icon-gripsmall-diagonal-se"},containment:!1,ghost:!1,grid:!1,handles:"e,s,se",helper:!1,maxHeight:null,maxWidth:null,minHeight:10,minWidth:10,zIndex:90,resize:null,start:null,stop:null},_num:function(t){return parseFloat(t)||0},_isNumber:function(t){return!isNaN(parseFloat(t))},_hasScroll:function(e,i){if("hidden"===t(e).css("overflow"))return!1;var s=i&&"left"===i?"scrollLeft":"scrollTop",n=!1;return e[s]>0?!0:(e[s]=1,n=e[s]>0,e[s]=0,n)},_create:function(){var e,i=this.options,s=this;this._addClass("ui-resizable"),t.extend(this,{_aspectRatio:!!i.aspectRatio,aspectRatio:i.aspectRatio,originalElement:this.element,_proportionallyResizeElements:[],_helper:i.helper||i.ghost||i.animate?i.helper||"ui-resizable-helper":null}),this.element[0].nodeName.match(/^(canvas|textarea|input|select|button|img)$/i)&&(this.element.wrap(t("
").css({position:this.element.css("position"),width:this.element.outerWidth(),height:this.element.outerHeight(),top:this.element.css("top"),left:this.element.css("left")})),this.element=this.element.parent().data("ui-resizable",this.element.resizable("instance")),this.elementIsWrapper=!0,e={marginTop:this.originalElement.css("marginTop"),marginRight:this.originalElement.css("marginRight"),marginBottom:this.originalElement.css("marginBottom"),marginLeft:this.originalElement.css("marginLeft")},this.element.css(e),this.originalElement.css("margin",0),this.originalResizeStyle=this.originalElement.css("resize"),this.originalElement.css("resize","none"),this._proportionallyResizeElements.push(this.originalElement.css({position:"static",zoom:1,display:"block"})),this.originalElement.css(e),this._proportionallyResize()),this._setupHandles(),i.autoHide&&t(this.element).on("mouseenter",function(){i.disabled||(s._removeClass("ui-resizable-autohide"),s._handles.show())}).on("mouseleave",function(){i.disabled||s.resizing||(s._addClass("ui-resizable-autohide"),s._handles.hide())}),this._mouseInit()},_destroy:function(){this._mouseDestroy();var e,i=function(e){t(e).removeData("resizable").removeData("ui-resizable").off(".resizable").find(".ui-resizable-handle").remove()};return this.elementIsWrapper&&(i(this.element),e=this.element,this.originalElement.css({position:e.css("position"),width:e.outerWidth(),height:e.outerHeight(),top:e.css("top"),left:e.css("left")}).insertAfter(e),e.remove()),this.originalElement.css("resize",this.originalResizeStyle),i(this.originalElement),this},_setOption:function(t,e){switch(this._super(t,e),t){case"handles":this._removeHandles(),this._setupHandles();break;default:}},_setupHandles:function(){var e,i,s,n,o,a=this.options,r=this;if(this.handles=a.handles||(t(".ui-resizable-handle",this.element).length?{n:".ui-resizable-n",e:".ui-resizable-e",s:".ui-resizable-s",w:".ui-resizable-w",se:".ui-resizable-se",sw:".ui-resizable-sw",ne:".ui-resizable-ne",nw:".ui-resizable-nw"}:"e,s,se"),this._handles=t(),this.handles.constructor===String)for("all"===this.handles&&(this.handles="n,e,s,w,se,sw,ne,nw"),s=this.handles.split(","),this.handles={},i=0;s.length>i;i++)e=t.trim(s[i]),n="ui-resizable-"+e,o=t("
"),this._addClass(o,"ui-resizable-handle "+n),o.css({zIndex:a.zIndex}),this.handles[e]=".ui-resizable-"+e,this.element.append(o);this._renderAxis=function(e){var i,s,n,o;e=e||this.element;for(i in this.handles)this.handles[i].constructor===String?this.handles[i]=this.element.children(this.handles[i]).first().show():(this.handles[i].jquery||this.handles[i].nodeType)&&(this.handles[i]=t(this.handles[i]),this._on(this.handles[i],{mousedown:r._mouseDown})),this.elementIsWrapper&&this.originalElement[0].nodeName.match(/^(textarea|input|select|button)$/i)&&(s=t(this.handles[i],this.element),o=/sw|ne|nw|se|n|s/.test(i)?s.outerHeight():s.outerWidth(),n=["padding",/ne|nw|n/.test(i)?"Top":/se|sw|s/.test(i)?"Bottom":/^e$/.test(i)?"Right":"Left"].join(""),e.css(n,o),this._proportionallyResize()),this._handles=this._handles.add(this.handles[i])},this._renderAxis(this.element),this._handles=this._handles.add(this.element.find(".ui-resizable-handle")),this._handles.disableSelection(),this._handles.on("mouseover",function(){r.resizing||(this.className&&(o=this.className.match(/ui-resizable-(se|sw|ne|nw|n|e|s|w)/i)),r.axis=o&&o[1]?o[1]:"se")}),a.autoHide&&(this._handles.hide(),this._addClass("ui-resizable-autohide"))},_removeHandles:function(){this._handles.remove()},_mouseCapture:function(e){var i,s,n=!1;for(i in this.handles)s=t(this.handles[i])[0],(s===e.target||t.contains(s,e.target))&&(n=!0);return!this.options.disabled&&n},_mouseStart:function(e){var i,s,n,o=this.options,a=this.element;return this.resizing=!0,this._renderProxy(),i=this._num(this.helper.css("left")),s=this._num(this.helper.css("top")),o.containment&&(i+=t(o.containment).scrollLeft()||0,s+=t(o.containment).scrollTop()||0),this.offset=this.helper.offset(),this.position={left:i,top:s},this.size=this._helper?{width:this.helper.width(),height:this.helper.height()}:{width:a.width(),height:a.height()},this.originalSize=this._helper?{width:a.outerWidth(),height:a.outerHeight()}:{width:a.width(),height:a.height()},this.sizeDiff={width:a.outerWidth()-a.width(),height:a.outerHeight()-a.height()},this.originalPosition={left:i,top:s},this.originalMousePosition={left:e.pageX,top:e.pageY},this.aspectRatio="number"==typeof o.aspectRatio?o.aspectRatio:this.originalSize.width/this.originalSize.height||1,n=t(".ui-resizable-"+this.axis).css("cursor"),t("body").css("cursor","auto"===n?this.axis+"-resize":n),this._addClass("ui-resizable-resizing"),this._propagate("start",e),!0},_mouseDrag:function(e){var i,s,n=this.originalMousePosition,o=this.axis,a=e.pageX-n.left||0,r=e.pageY-n.top||0,h=this._change[o];return this._updatePrevProperties(),h?(i=h.apply(this,[e,a,r]),this._updateVirtualBoundaries(e.shiftKey),(this._aspectRatio||e.shiftKey)&&(i=this._updateRatio(i,e)),i=this._respectSize(i,e),this._updateCache(i),this._propagate("resize",e),s=this._applyChanges(),!this._helper&&this._proportionallyResizeElements.length&&this._proportionallyResize(),t.isEmptyObject(s)||(this._updatePrevProperties(),this._trigger("resize",e,this.ui()),this._applyChanges()),!1):!1},_mouseStop:function(e){this.resizing=!1;var i,s,n,o,a,r,h,l=this.options,c=this;return this._helper&&(i=this._proportionallyResizeElements,s=i.length&&/textarea/i.test(i[0].nodeName),n=s&&this._hasScroll(i[0],"left")?0:c.sizeDiff.height,o=s?0:c.sizeDiff.width,a={width:c.helper.width()-o,height:c.helper.height()-n},r=parseFloat(c.element.css("left"))+(c.position.left-c.originalPosition.left)||null,h=parseFloat(c.element.css("top"))+(c.position.top-c.originalPosition.top)||null,l.animate||this.element.css(t.extend(a,{top:h,left:r})),c.helper.height(c.size.height),c.helper.width(c.size.width),this._helper&&!l.animate&&this._proportionallyResize()),t("body").css("cursor","auto"),this._removeClass("ui-resizable-resizing"),this._propagate("stop",e),this._helper&&this.helper.remove(),!1},_updatePrevProperties:function(){this.prevPosition={top:this.position.top,left:this.position.left},this.prevSize={width:this.size.width,height:this.size.height}},_applyChanges:function(){var t={};return this.position.top!==this.prevPosition.top&&(t.top=this.position.top+"px"),this.position.left!==this.prevPosition.left&&(t.left=this.position.left+"px"),this.size.width!==this.prevSize.width&&(t.width=this.size.width+"px"),this.size.height!==this.prevSize.height&&(t.height=this.size.height+"px"),this.helper.css(t),t},_updateVirtualBoundaries:function(t){var e,i,s,n,o,a=this.options;o={minWidth:this._isNumber(a.minWidth)?a.minWidth:0,maxWidth:this._isNumber(a.maxWidth)?a.maxWidth:1/0,minHeight:this._isNumber(a.minHeight)?a.minHeight:0,maxHeight:this._isNumber(a.maxHeight)?a.maxHeight:1/0},(this._aspectRatio||t)&&(e=o.minHeight*this.aspectRatio,s=o.minWidth/this.aspectRatio,i=o.maxHeight*this.aspectRatio,n=o.maxWidth/this.aspectRatio,e>o.minWidth&&(o.minWidth=e),s>o.minHeight&&(o.minHeight=s),o.maxWidth>i&&(o.maxWidth=i),o.maxHeight>n&&(o.maxHeight=n)),this._vBoundaries=o},_updateCache:function(t){this.offset=this.helper.offset(),this._isNumber(t.left)&&(this.position.left=t.left),this._isNumber(t.top)&&(this.position.top=t.top),this._isNumber(t.height)&&(this.size.height=t.height),this._isNumber(t.width)&&(this.size.width=t.width)},_updateRatio:function(t){var e=this.position,i=this.size,s=this.axis;return this._isNumber(t.height)?t.width=t.height*this.aspectRatio:this._isNumber(t.width)&&(t.height=t.width/this.aspectRatio),"sw"===s&&(t.left=e.left+(i.width-t.width),t.top=null),"nw"===s&&(t.top=e.top+(i.height-t.height),t.left=e.left+(i.width-t.width)),t},_respectSize:function(t){var e=this._vBoundaries,i=this.axis,s=this._isNumber(t.width)&&e.maxWidth&&e.maxWidtht.width,a=this._isNumber(t.height)&&e.minHeight&&e.minHeight>t.height,r=this.originalPosition.left+this.originalSize.width,h=this.originalPosition.top+this.originalSize.height,l=/sw|nw|w/.test(i),c=/nw|ne|n/.test(i);return o&&(t.width=e.minWidth),a&&(t.height=e.minHeight),s&&(t.width=e.maxWidth),n&&(t.height=e.maxHeight),o&&l&&(t.left=r-e.minWidth),s&&l&&(t.left=r-e.maxWidth),a&&c&&(t.top=h-e.minHeight),n&&c&&(t.top=h-e.maxHeight),t.width||t.height||t.left||!t.top?t.width||t.height||t.top||!t.left||(t.left=null):t.top=null,t},_getPaddingPlusBorderDimensions:function(t){for(var e=0,i=[],s=[t.css("borderTopWidth"),t.css("borderRightWidth"),t.css("borderBottomWidth"),t.css("borderLeftWidth")],n=[t.css("paddingTop"),t.css("paddingRight"),t.css("paddingBottom"),t.css("paddingLeft")];4>e;e++)i[e]=parseFloat(s[e])||0,i[e]+=parseFloat(n[e])||0;return{height:i[0]+i[2],width:i[1]+i[3]}},_proportionallyResize:function(){if(this._proportionallyResizeElements.length)for(var t,e=0,i=this.helper||this.element;this._proportionallyResizeElements.length>e;e++)t=this._proportionallyResizeElements[e],this.outerDimensions||(this.outerDimensions=this._getPaddingPlusBorderDimensions(t)),t.css({height:i.height()-this.outerDimensions.height||0,width:i.width()-this.outerDimensions.width||0})},_renderProxy:function(){var e=this.element,i=this.options;this.elementOffset=e.offset(),this._helper?(this.helper=this.helper||t("
"),this._addClass(this.helper,this._helper),this.helper.css({width:this.element.outerWidth(),height:this.element.outerHeight(),position:"absolute",left:this.elementOffset.left+"px",top:this.elementOffset.top+"px",zIndex:++i.zIndex}),this.helper.appendTo("body").disableSelection()):this.helper=this.element -},_change:{e:function(t,e){return{width:this.originalSize.width+e}},w:function(t,e){var i=this.originalSize,s=this.originalPosition;return{left:s.left+e,width:i.width-e}},n:function(t,e,i){var s=this.originalSize,n=this.originalPosition;return{top:n.top+i,height:s.height-i}},s:function(t,e,i){return{height:this.originalSize.height+i}},se:function(e,i,s){return t.extend(this._change.s.apply(this,arguments),this._change.e.apply(this,[e,i,s]))},sw:function(e,i,s){return t.extend(this._change.s.apply(this,arguments),this._change.w.apply(this,[e,i,s]))},ne:function(e,i,s){return t.extend(this._change.n.apply(this,arguments),this._change.e.apply(this,[e,i,s]))},nw:function(e,i,s){return t.extend(this._change.n.apply(this,arguments),this._change.w.apply(this,[e,i,s]))}},_propagate:function(e,i){t.ui.plugin.call(this,e,[i,this.ui()]),"resize"!==e&&this._trigger(e,i,this.ui())},plugins:{},ui:function(){return{originalElement:this.originalElement,element:this.element,helper:this.helper,position:this.position,size:this.size,originalSize:this.originalSize,originalPosition:this.originalPosition}}}),t.ui.plugin.add("resizable","animate",{stop:function(e){var i=t(this).resizable("instance"),s=i.options,n=i._proportionallyResizeElements,o=n.length&&/textarea/i.test(n[0].nodeName),a=o&&i._hasScroll(n[0],"left")?0:i.sizeDiff.height,r=o?0:i.sizeDiff.width,h={width:i.size.width-r,height:i.size.height-a},l=parseFloat(i.element.css("left"))+(i.position.left-i.originalPosition.left)||null,c=parseFloat(i.element.css("top"))+(i.position.top-i.originalPosition.top)||null;i.element.animate(t.extend(h,c&&l?{top:c,left:l}:{}),{duration:s.animateDuration,easing:s.animateEasing,step:function(){var s={width:parseFloat(i.element.css("width")),height:parseFloat(i.element.css("height")),top:parseFloat(i.element.css("top")),left:parseFloat(i.element.css("left"))};n&&n.length&&t(n[0]).css({width:s.width,height:s.height}),i._updateCache(s),i._propagate("resize",e)}})}}),t.ui.plugin.add("resizable","containment",{start:function(){var e,i,s,n,o,a,r,h=t(this).resizable("instance"),l=h.options,c=h.element,u=l.containment,d=u instanceof t?u.get(0):/parent/.test(u)?c.parent().get(0):u;d&&(h.containerElement=t(d),/document/.test(u)||u===document?(h.containerOffset={left:0,top:0},h.containerPosition={left:0,top:0},h.parentData={element:t(document),left:0,top:0,width:t(document).width(),height:t(document).height()||document.body.parentNode.scrollHeight}):(e=t(d),i=[],t(["Top","Right","Left","Bottom"]).each(function(t,s){i[t]=h._num(e.css("padding"+s))}),h.containerOffset=e.offset(),h.containerPosition=e.position(),h.containerSize={height:e.innerHeight()-i[3],width:e.innerWidth()-i[1]},s=h.containerOffset,n=h.containerSize.height,o=h.containerSize.width,a=h._hasScroll(d,"left")?d.scrollWidth:o,r=h._hasScroll(d)?d.scrollHeight:n,h.parentData={element:d,left:s.left,top:s.top,width:a,height:r}))},resize:function(e){var i,s,n,o,a=t(this).resizable("instance"),r=a.options,h=a.containerOffset,l=a.position,c=a._aspectRatio||e.shiftKey,u={top:0,left:0},d=a.containerElement,p=!0;d[0]!==document&&/static/.test(d.css("position"))&&(u=h),l.left<(a._helper?h.left:0)&&(a.size.width=a.size.width+(a._helper?a.position.left-h.left:a.position.left-u.left),c&&(a.size.height=a.size.width/a.aspectRatio,p=!1),a.position.left=r.helper?h.left:0),l.top<(a._helper?h.top:0)&&(a.size.height=a.size.height+(a._helper?a.position.top-h.top:a.position.top),c&&(a.size.width=a.size.height*a.aspectRatio,p=!1),a.position.top=a._helper?h.top:0),n=a.containerElement.get(0)===a.element.parent().get(0),o=/relative|absolute/.test(a.containerElement.css("position")),n&&o?(a.offset.left=a.parentData.left+a.position.left,a.offset.top=a.parentData.top+a.position.top):(a.offset.left=a.element.offset().left,a.offset.top=a.element.offset().top),i=Math.abs(a.sizeDiff.width+(a._helper?a.offset.left-u.left:a.offset.left-h.left)),s=Math.abs(a.sizeDiff.height+(a._helper?a.offset.top-u.top:a.offset.top-h.top)),i+a.size.width>=a.parentData.width&&(a.size.width=a.parentData.width-i,c&&(a.size.height=a.size.width/a.aspectRatio,p=!1)),s+a.size.height>=a.parentData.height&&(a.size.height=a.parentData.height-s,c&&(a.size.width=a.size.height*a.aspectRatio,p=!1)),p||(a.position.left=a.prevPosition.left,a.position.top=a.prevPosition.top,a.size.width=a.prevSize.width,a.size.height=a.prevSize.height)},stop:function(){var e=t(this).resizable("instance"),i=e.options,s=e.containerOffset,n=e.containerPosition,o=e.containerElement,a=t(e.helper),r=a.offset(),h=a.outerWidth()-e.sizeDiff.width,l=a.outerHeight()-e.sizeDiff.height;e._helper&&!i.animate&&/relative/.test(o.css("position"))&&t(this).css({left:r.left-n.left-s.left,width:h,height:l}),e._helper&&!i.animate&&/static/.test(o.css("position"))&&t(this).css({left:r.left-n.left-s.left,width:h,height:l})}}),t.ui.plugin.add("resizable","alsoResize",{start:function(){var e=t(this).resizable("instance"),i=e.options;t(i.alsoResize).each(function(){var e=t(this);e.data("ui-resizable-alsoresize",{width:parseFloat(e.width()),height:parseFloat(e.height()),left:parseFloat(e.css("left")),top:parseFloat(e.css("top"))})})},resize:function(e,i){var s=t(this).resizable("instance"),n=s.options,o=s.originalSize,a=s.originalPosition,r={height:s.size.height-o.height||0,width:s.size.width-o.width||0,top:s.position.top-a.top||0,left:s.position.left-a.left||0};t(n.alsoResize).each(function(){var e=t(this),s=t(this).data("ui-resizable-alsoresize"),n={},o=e.parents(i.originalElement[0]).length?["width","height"]:["width","height","top","left"];t.each(o,function(t,e){var i=(s[e]||0)+(r[e]||0);i&&i>=0&&(n[e]=i||null)}),e.css(n)})},stop:function(){t(this).removeData("ui-resizable-alsoresize")}}),t.ui.plugin.add("resizable","ghost",{start:function(){var e=t(this).resizable("instance"),i=e.size;e.ghost=e.originalElement.clone(),e.ghost.css({opacity:.25,display:"block",position:"relative",height:i.height,width:i.width,margin:0,left:0,top:0}),e._addClass(e.ghost,"ui-resizable-ghost"),t.uiBackCompat!==!1&&"string"==typeof e.options.ghost&&e.ghost.addClass(this.options.ghost),e.ghost.appendTo(e.helper)},resize:function(){var e=t(this).resizable("instance");e.ghost&&e.ghost.css({position:"relative",height:e.size.height,width:e.size.width})},stop:function(){var e=t(this).resizable("instance");e.ghost&&e.helper&&e.helper.get(0).removeChild(e.ghost.get(0))}}),t.ui.plugin.add("resizable","grid",{resize:function(){var e,i=t(this).resizable("instance"),s=i.options,n=i.size,o=i.originalSize,a=i.originalPosition,r=i.axis,h="number"==typeof s.grid?[s.grid,s.grid]:s.grid,l=h[0]||1,c=h[1]||1,u=Math.round((n.width-o.width)/l)*l,d=Math.round((n.height-o.height)/c)*c,p=o.width+u,f=o.height+d,m=s.maxWidth&&p>s.maxWidth,g=s.maxHeight&&f>s.maxHeight,_=s.minWidth&&s.minWidth>p,v=s.minHeight&&s.minHeight>f;s.grid=h,_&&(p+=l),v&&(f+=c),m&&(p-=l),g&&(f-=c),/^(se|s|e)$/.test(r)?(i.size.width=p,i.size.height=f):/^(ne)$/.test(r)?(i.size.width=p,i.size.height=f,i.position.top=a.top-d):/^(sw)$/.test(r)?(i.size.width=p,i.size.height=f,i.position.left=a.left-u):((0>=f-c||0>=p-l)&&(e=i._getPaddingPlusBorderDimensions(this)),f-c>0?(i.size.height=f,i.position.top=a.top-d):(f=c-e.height,i.size.height=f,i.position.top=a.top+o.height-f),p-l>0?(i.size.width=p,i.position.left=a.left-u):(p=l-e.width,i.size.width=p,i.position.left=a.left+o.width-p))}}),t.ui.resizable});/** - * Copyright (c) 2007 Ariel Flesler - aflesler ○ gmail • com | https://github.com/flesler - * Licensed under MIT - * @author Ariel Flesler - * @version 2.1.2 - */ -;(function(f){"use strict";"function"===typeof define&&define.amd?define(["jquery"],f):"undefined"!==typeof module&&module.exports?module.exports=f(require("jquery")):f(jQuery)})(function($){"use strict";function n(a){return!a.nodeName||-1!==$.inArray(a.nodeName.toLowerCase(),["iframe","#document","html","body"])}function h(a){return $.isFunction(a)||$.isPlainObject(a)?a:{top:a,left:a}}var p=$.scrollTo=function(a,d,b){return $(window).scrollTo(a,d,b)};p.defaults={axis:"xy",duration:0,limit:!0};$.fn.scrollTo=function(a,d,b){"object"=== typeof d&&(b=d,d=0);"function"===typeof b&&(b={onAfter:b});"max"===a&&(a=9E9);b=$.extend({},p.defaults,b);d=d||b.duration;var u=b.queue&&1=f[g]?0:Math.min(f[g],n));!a&&1-1){targetElements.on(evt+EVENT_NAMESPACE,function elementToggle(event){$.powerTip.toggle(this,event)})}else{targetElements.on(evt+EVENT_NAMESPACE,function elementOpen(event){$.powerTip.show(this,event)})}});$.each(options.closeEvents,function(idx,evt){if($.inArray(evt,options.openEvents)<0){targetElements.on(evt+EVENT_NAMESPACE,function elementClose(event){$.powerTip.hide(this,!isMouseEvent(event))})}});targetElements.on("keydown"+EVENT_NAMESPACE,function elementKeyDown(event){if(event.keyCode===27){$.powerTip.hide(this,true)}})}return targetElements};$.fn.powerTip.defaults={fadeInTime:200,fadeOutTime:100,followMouse:false,popupId:"powerTip",popupClass:null,intentSensitivity:7,intentPollInterval:100,closeDelay:100,placement:"n",smartPlacement:false,offset:10,mouseOnToPopup:false,manual:false,openEvents:["mouseenter","focus"],closeEvents:["mouseleave","blur"]};$.fn.powerTip.smartPlacementLists={n:["n","ne","nw","s"],e:["e","ne","se","w","nw","sw","n","s","e"],s:["s","se","sw","n"],w:["w","nw","sw","e","ne","se","n","s","w"],nw:["nw","w","sw","n","s","se","nw"],ne:["ne","e","se","n","s","sw","ne"],sw:["sw","w","nw","s","n","ne","sw"],se:["se","e","ne","s","n","nw","se"],"nw-alt":["nw-alt","n","ne-alt","sw-alt","s","se-alt","w","e"],"ne-alt":["ne-alt","n","nw-alt","se-alt","s","sw-alt","e","w"],"sw-alt":["sw-alt","s","se-alt","nw-alt","n","ne-alt","w","e"],"se-alt":["se-alt","s","sw-alt","ne-alt","n","nw-alt","e","w"]};$.powerTip={show:function apiShowTip(element,event){if(isMouseEvent(event)){trackMouse(event);session.previousX=event.pageX;session.previousY=event.pageY;$(element).data(DATA_DISPLAYCONTROLLER).show()}else{$(element).first().data(DATA_DISPLAYCONTROLLER).show(true,true)}return element},reposition:function apiResetPosition(element){$(element).first().data(DATA_DISPLAYCONTROLLER).resetPosition();return element},hide:function apiCloseTip(element,immediate){var displayController;immediate=element?immediate:true;if(element){displayController=$(element).first().data(DATA_DISPLAYCONTROLLER)}else if(session.activeHover){displayController=session.activeHover.data(DATA_DISPLAYCONTROLLER)}if(displayController){displayController.hide(immediate)}return element},toggle:function apiToggle(element,event){if(session.activeHover&&session.activeHover.is(element)){$.powerTip.hide(element,!isMouseEvent(event))}else{$.powerTip.show(element,event)}return element}};$.powerTip.showTip=$.powerTip.show;$.powerTip.closeTip=$.powerTip.hide;function CSSCoordinates(){var me=this;me.top="auto";me.left="auto";me.right="auto";me.bottom="auto";me.set=function(property,value){if($.isNumeric(value)){me[property]=Math.round(value)}}}function DisplayController(element,options,tipController){var hoverTimer=null,myCloseDelay=null;function openTooltip(immediate,forceOpen){cancelTimer();if(!element.data(DATA_HASACTIVEHOVER)){if(!immediate){session.tipOpenImminent=true;hoverTimer=setTimeout(function intentDelay(){hoverTimer=null;checkForIntent()},options.intentPollInterval)}else{if(forceOpen){element.data(DATA_FORCEDOPEN,true)}closeAnyDelayed();tipController.showTip(element)}}else{cancelClose()}}function closeTooltip(disableDelay){if(myCloseDelay){myCloseDelay=session.closeDelayTimeout=clearTimeout(myCloseDelay);session.delayInProgress=false}cancelTimer();session.tipOpenImminent=false;if(element.data(DATA_HASACTIVEHOVER)){element.data(DATA_FORCEDOPEN,false);if(!disableDelay){session.delayInProgress=true;session.closeDelayTimeout=setTimeout(function closeDelay(){session.closeDelayTimeout=null;tipController.hideTip(element);session.delayInProgress=false;myCloseDelay=null},options.closeDelay);myCloseDelay=session.closeDelayTimeout}else{tipController.hideTip(element)}}}function checkForIntent(){var xDifference=Math.abs(session.previousX-session.currentX),yDifference=Math.abs(session.previousY-session.currentY),totalDifference=xDifference+yDifference;if(totalDifference",{id:options.popupId});if($body.length===0){$body=$("body")}$body.append(tipElement);session.tooltips=session.tooltips?session.tooltips.add(tipElement):tipElement}if(options.followMouse){if(!tipElement.data(DATA_HASMOUSEMOVE)){$document.on("mousemove"+EVENT_NAMESPACE,positionTipOnCursor);$window.on("scroll"+EVENT_NAMESPACE,positionTipOnCursor);tipElement.data(DATA_HASMOUSEMOVE,true)}}function beginShowTip(element){element.data(DATA_HASACTIVEHOVER,true);tipElement.queue(function queueTipInit(next){showTip(element);next()})}function showTip(element){var tipContent;if(!element.data(DATA_HASACTIVEHOVER)){return}if(session.isTipOpen){if(!session.isClosing){hideTip(session.activeHover)}tipElement.delay(100).queue(function queueTipAgain(next){showTip(element);next()});return}element.trigger("powerTipPreRender");tipContent=getTooltipContent(element);if(tipContent){tipElement.empty().append(tipContent)}else{return}element.trigger("powerTipRender");session.activeHover=element;session.isTipOpen=true;tipElement.data(DATA_MOUSEONTOTIP,options.mouseOnToPopup);tipElement.addClass(options.popupClass);if(!options.followMouse||element.data(DATA_FORCEDOPEN)){positionTipOnElement(element);session.isFixedTipOpen=true}else{positionTipOnCursor()}if(!element.data(DATA_FORCEDOPEN)&&!options.followMouse){$document.on("click"+EVENT_NAMESPACE,function documentClick(event){var target=event.target;if(target!==element[0]){if(options.mouseOnToPopup){if(target!==tipElement[0]&&!$.contains(tipElement[0],target)){$.powerTip.hide()}}else{$.powerTip.hide()}}})}if(options.mouseOnToPopup&&!options.manual){tipElement.on("mouseenter"+EVENT_NAMESPACE,function tipMouseEnter(){if(session.activeHover){session.activeHover.data(DATA_DISPLAYCONTROLLER).cancel()}});tipElement.on("mouseleave"+EVENT_NAMESPACE,function tipMouseLeave(){if(session.activeHover){session.activeHover.data(DATA_DISPLAYCONTROLLER).hide()}})}tipElement.fadeIn(options.fadeInTime,function fadeInCallback(){if(!session.desyncTimeout){session.desyncTimeout=setInterval(closeDesyncedTip,500)}element.trigger("powerTipOpen")})}function hideTip(element){session.isClosing=true;session.isTipOpen=false;session.desyncTimeout=clearInterval(session.desyncTimeout);element.data(DATA_HASACTIVEHOVER,false);element.data(DATA_FORCEDOPEN,false);$document.off("click"+EVENT_NAMESPACE);tipElement.off(EVENT_NAMESPACE);tipElement.fadeOut(options.fadeOutTime,function fadeOutCallback(){var coords=new CSSCoordinates;session.activeHover=null;session.isClosing=false;session.isFixedTipOpen=false;tipElement.removeClass();coords.set("top",session.currentY+options.offset);coords.set("left",session.currentX+options.offset);tipElement.css(coords);element.trigger("powerTipClose")})}function positionTipOnCursor(){var tipWidth,tipHeight,coords,collisions,collisionCount;if(!session.isFixedTipOpen&&(session.isTipOpen||session.tipOpenImminent&&tipElement.data(DATA_HASMOUSEMOVE))){tipWidth=tipElement.outerWidth();tipHeight=tipElement.outerHeight();coords=new CSSCoordinates;coords.set("top",session.currentY+options.offset);coords.set("left",session.currentX+options.offset);collisions=getViewportCollisions(coords,tipWidth,tipHeight);if(collisions!==Collision.none){collisionCount=countFlags(collisions);if(collisionCount===1){if(collisions===Collision.right){coords.set("left",session.scrollLeft+session.windowWidth-tipWidth)}else if(collisions===Collision.bottom){coords.set("top",session.scrollTop+session.windowHeight-tipHeight)}}else{coords.set("left",session.currentX-tipWidth-options.offset);coords.set("top",session.currentY-tipHeight-options.offset)}}tipElement.css(coords)}}function positionTipOnElement(element){var priorityList,finalPlacement;if(options.smartPlacement||options.followMouse&&element.data(DATA_FORCEDOPEN)){priorityList=$.fn.powerTip.smartPlacementLists[options.placement];$.each(priorityList,function(idx,pos){var collisions=getViewportCollisions(placeTooltip(element,pos),tipElement.outerWidth(),tipElement.outerHeight());finalPlacement=pos;return collisions!==Collision.none})}else{placeTooltip(element,options.placement);finalPlacement=options.placement}tipElement.removeClass("w nw sw e ne se n s w se-alt sw-alt ne-alt nw-alt");tipElement.addClass(finalPlacement)}function placeTooltip(element,placement){var iterationCount=0,tipWidth,tipHeight,coords=new CSSCoordinates;coords.set("top",0);coords.set("left",0);tipElement.css(coords);do{tipWidth=tipElement.outerWidth();tipHeight=tipElement.outerHeight();coords=placementCalculator.compute(element,placement,tipWidth,tipHeight,options.offset);tipElement.css(coords)}while(++iterationCount<=5&&(tipWidth!==tipElement.outerWidth()||tipHeight!==tipElement.outerHeight()));return coords}function closeDesyncedTip(){var isDesynced=false,hasDesyncableCloseEvent=$.grep(["mouseleave","mouseout","blur","focusout"],function(eventType){return $.inArray(eventType,options.closeEvents)!==-1}).length>0;if(session.isTipOpen&&!session.isClosing&&!session.delayInProgress&&hasDesyncableCloseEvent){if(session.activeHover.data(DATA_HASACTIVEHOVER)===false||session.activeHover.is(":disabled")){isDesynced=true}else if(!isMouseOver(session.activeHover)&&!session.activeHover.is(":focus")&&!session.activeHover.data(DATA_FORCEDOPEN)){if(tipElement.data(DATA_MOUSEONTOTIP)){if(!isMouseOver(tipElement)){isDesynced=true}}else{isDesynced=true}}if(isDesynced){hideTip(session.activeHover)}}}this.showTip=beginShowTip;this.hideTip=hideTip;this.resetPosition=positionTipOnElement}function isSvgElement(element){return Boolean(window.SVGElement&&element[0]instanceof SVGElement)}function isMouseEvent(event){return Boolean(event&&$.inArray(event.type,MOUSE_EVENTS)>-1&&typeof event.pageX==="number")}function initTracking(){if(!session.mouseTrackingActive){session.mouseTrackingActive=true;getViewportDimensions();$(getViewportDimensions);$document.on("mousemove"+EVENT_NAMESPACE,trackMouse);$window.on("resize"+EVENT_NAMESPACE,trackResize);$window.on("scroll"+EVENT_NAMESPACE,trackScroll)}}function getViewportDimensions(){session.scrollLeft=$window.scrollLeft();session.scrollTop=$window.scrollTop();session.windowWidth=$window.width();session.windowHeight=$window.height()}function trackResize(){session.windowWidth=$window.width();session.windowHeight=$window.height()}function trackScroll(){var x=$window.scrollLeft(),y=$window.scrollTop();if(x!==session.scrollLeft){session.currentX+=x-session.scrollLeft;session.scrollLeft=x}if(y!==session.scrollTop){session.currentY+=y-session.scrollTop;session.scrollTop=y}}function trackMouse(event){session.currentX=event.pageX;session.currentY=event.pageY}function isMouseOver(element){var elementPosition=element.offset(),elementBox=element[0].getBoundingClientRect(),elementWidth=elementBox.right-elementBox.left,elementHeight=elementBox.bottom-elementBox.top;return session.currentX>=elementPosition.left&&session.currentX<=elementPosition.left+elementWidth&&session.currentY>=elementPosition.top&&session.currentY<=elementPosition.top+elementHeight}function getTooltipContent(element){var tipText=element.data(DATA_POWERTIP),tipObject=element.data(DATA_POWERTIPJQ),tipTarget=element.data(DATA_POWERTIPTARGET),targetElement,content;if(tipText){if($.isFunction(tipText)){tipText=tipText.call(element[0])}content=tipText}else if(tipObject){if($.isFunction(tipObject)){tipObject=tipObject.call(element[0])}if(tipObject.length>0){content=tipObject.clone(true,true)}}else if(tipTarget){targetElement=$("#"+tipTarget);if(targetElement.length>0){content=targetElement.html()}}return content}function getViewportCollisions(coords,elementWidth,elementHeight){var viewportTop=session.scrollTop,viewportLeft=session.scrollLeft,viewportBottom=viewportTop+session.windowHeight,viewportRight=viewportLeft+session.windowWidth,collisions=Collision.none;if(coords.topviewportBottom||Math.abs(coords.bottom-session.windowHeight)>viewportBottom){collisions|=Collision.bottom}if(coords.leftviewportRight){collisions|=Collision.left}if(coords.left+elementWidth>viewportRight||coords.right1)){a.preventDefault();var c=a.originalEvent.changedTouches[0],d=document.createEvent("MouseEvents");d.initMouseEvent(b,!0,!0,window,1,c.screenX,c.screenY,c.clientX,c.clientY,!1,!1,!1,!1,0,null),a.target.dispatchEvent(d)}}if(a.support.touch="ontouchend"in document,a.support.touch){var e,b=a.ui.mouse.prototype,c=b._mouseInit,d=b._mouseDestroy;b._touchStart=function(a){var b=this;!e&&b._mouseCapture(a.originalEvent.changedTouches[0])&&(e=!0,b._touchMoved=!1,f(a,"mouseover"),f(a,"mousemove"),f(a,"mousedown"))},b._touchMove=function(a){e&&(this._touchMoved=!0,f(a,"mousemove"))},b._touchEnd=function(a){e&&(f(a,"mouseup"),f(a,"mouseout"),this._touchMoved||f(a,"click"),e=!1)},b._mouseInit=function(){var b=this;b.element.bind({touchstart:a.proxy(b,"_touchStart"),touchmove:a.proxy(b,"_touchMove"),touchend:a.proxy(b,"_touchEnd")}),c.call(b)},b._mouseDestroy=function(){var b=this;b.element.unbind({touchstart:a.proxy(b,"_touchStart"),touchmove:a.proxy(b,"_touchMove"),touchend:a.proxy(b,"_touchEnd")}),d.call(b)}}}(jQuery);/*! SmartMenus jQuery Plugin - v1.1.0 - September 17, 2017 - * http://www.smartmenus.org/ - * Copyright Vasil Dinkov, Vadikom Web Ltd. http://vadikom.com; Licensed MIT */(function(t){"function"==typeof define&&define.amd?define(["jquery"],t):"object"==typeof module&&"object"==typeof module.exports?module.exports=t(require("jquery")):t(jQuery)})(function($){function initMouseDetection(t){var e=".smartmenus_mouse";if(mouseDetectionEnabled||t)mouseDetectionEnabled&&t&&($(document).off(e),mouseDetectionEnabled=!1);else{var i=!0,s=null,o={mousemove:function(t){var e={x:t.pageX,y:t.pageY,timeStamp:(new Date).getTime()};if(s){var o=Math.abs(s.x-e.x),a=Math.abs(s.y-e.y);if((o>0||a>0)&&2>=o&&2>=a&&300>=e.timeStamp-s.timeStamp&&(mouse=!0,i)){var n=$(t.target).closest("a");n.is("a")&&$.each(menuTrees,function(){return $.contains(this.$root[0],n[0])?(this.itemEnter({currentTarget:n[0]}),!1):void 0}),i=!1}}s=e}};o[touchEvents?"touchstart":"pointerover pointermove pointerout MSPointerOver MSPointerMove MSPointerOut"]=function(t){isTouchEvent(t.originalEvent)&&(mouse=!1)},$(document).on(getEventsNS(o,e)),mouseDetectionEnabled=!0}}function isTouchEvent(t){return!/^(4|mouse)$/.test(t.pointerType)}function getEventsNS(t,e){e||(e="");var i={};for(var s in t)i[s.split(" ").join(e+" ")+e]=t[s];return i}var menuTrees=[],mouse=!1,touchEvents="ontouchstart"in window,mouseDetectionEnabled=!1,requestAnimationFrame=window.requestAnimationFrame||function(t){return setTimeout(t,1e3/60)},cancelAnimationFrame=window.cancelAnimationFrame||function(t){clearTimeout(t)},canAnimate=!!$.fn.animate;return $.SmartMenus=function(t,e){this.$root=$(t),this.opts=e,this.rootId="",this.accessIdPrefix="",this.$subArrow=null,this.activatedItems=[],this.visibleSubMenus=[],this.showTimeout=0,this.hideTimeout=0,this.scrollTimeout=0,this.clickActivated=!1,this.focusActivated=!1,this.zIndexInc=0,this.idInc=0,this.$firstLink=null,this.$firstSub=null,this.disabled=!1,this.$disableOverlay=null,this.$touchScrollingSub=null,this.cssTransforms3d="perspective"in t.style||"webkitPerspective"in t.style,this.wasCollapsible=!1,this.init()},$.extend($.SmartMenus,{hideAll:function(){$.each(menuTrees,function(){this.menuHideAll()})},destroy:function(){for(;menuTrees.length;)menuTrees[0].destroy();initMouseDetection(!0)},prototype:{init:function(t){var e=this;if(!t){menuTrees.push(this),this.rootId=((new Date).getTime()+Math.random()+"").replace(/\D/g,""),this.accessIdPrefix="sm-"+this.rootId+"-",this.$root.hasClass("sm-rtl")&&(this.opts.rightToLeftSubMenus=!0);var i=".smartmenus";this.$root.data("smartmenus",this).attr("data-smartmenus-id",this.rootId).dataSM("level",1).on(getEventsNS({"mouseover focusin":$.proxy(this.rootOver,this),"mouseout focusout":$.proxy(this.rootOut,this),keydown:$.proxy(this.rootKeyDown,this)},i)).on(getEventsNS({mouseenter:$.proxy(this.itemEnter,this),mouseleave:$.proxy(this.itemLeave,this),mousedown:$.proxy(this.itemDown,this),focus:$.proxy(this.itemFocus,this),blur:$.proxy(this.itemBlur,this),click:$.proxy(this.itemClick,this)},i),"a"),i+=this.rootId,this.opts.hideOnClick&&$(document).on(getEventsNS({touchstart:$.proxy(this.docTouchStart,this),touchmove:$.proxy(this.docTouchMove,this),touchend:$.proxy(this.docTouchEnd,this),click:$.proxy(this.docClick,this)},i)),$(window).on(getEventsNS({"resize orientationchange":$.proxy(this.winResize,this)},i)),this.opts.subIndicators&&(this.$subArrow=$("").addClass("sub-arrow"),this.opts.subIndicatorsText&&this.$subArrow.html(this.opts.subIndicatorsText)),initMouseDetection()}if(this.$firstSub=this.$root.find("ul").each(function(){e.menuInit($(this))}).eq(0),this.$firstLink=this.$root.find("a").eq(0),this.opts.markCurrentItem){var s=/(index|default)\.[^#\?\/]*/i,o=/#.*/,a=window.location.href.replace(s,""),n=a.replace(o,"");this.$root.find("a").each(function(){var t=this.href.replace(s,""),i=$(this);(t==a||t==n)&&(i.addClass("current"),e.opts.markCurrentTree&&i.parentsUntil("[data-smartmenus-id]","ul").each(function(){$(this).dataSM("parent-a").addClass("current")}))})}this.wasCollapsible=this.isCollapsible()},destroy:function(t){if(!t){var e=".smartmenus";this.$root.removeData("smartmenus").removeAttr("data-smartmenus-id").removeDataSM("level").off(e),e+=this.rootId,$(document).off(e),$(window).off(e),this.opts.subIndicators&&(this.$subArrow=null)}this.menuHideAll();var i=this;this.$root.find("ul").each(function(){var t=$(this);t.dataSM("scroll-arrows")&&t.dataSM("scroll-arrows").remove(),t.dataSM("shown-before")&&((i.opts.subMenusMinWidth||i.opts.subMenusMaxWidth)&&t.css({width:"",minWidth:"",maxWidth:""}).removeClass("sm-nowrap"),t.dataSM("scroll-arrows")&&t.dataSM("scroll-arrows").remove(),t.css({zIndex:"",top:"",left:"",marginLeft:"",marginTop:"",display:""})),0==(t.attr("id")||"").indexOf(i.accessIdPrefix)&&t.removeAttr("id")}).removeDataSM("in-mega").removeDataSM("shown-before").removeDataSM("scroll-arrows").removeDataSM("parent-a").removeDataSM("level").removeDataSM("beforefirstshowfired").removeAttr("role").removeAttr("aria-hidden").removeAttr("aria-labelledby").removeAttr("aria-expanded"),this.$root.find("a.has-submenu").each(function(){var t=$(this);0==t.attr("id").indexOf(i.accessIdPrefix)&&t.removeAttr("id")}).removeClass("has-submenu").removeDataSM("sub").removeAttr("aria-haspopup").removeAttr("aria-controls").removeAttr("aria-expanded").closest("li").removeDataSM("sub"),this.opts.subIndicators&&this.$root.find("span.sub-arrow").remove(),this.opts.markCurrentItem&&this.$root.find("a.current").removeClass("current"),t||(this.$root=null,this.$firstLink=null,this.$firstSub=null,this.$disableOverlay&&(this.$disableOverlay.remove(),this.$disableOverlay=null),menuTrees.splice($.inArray(this,menuTrees),1))},disable:function(t){if(!this.disabled){if(this.menuHideAll(),!t&&!this.opts.isPopup&&this.$root.is(":visible")){var e=this.$root.offset();this.$disableOverlay=$('
').css({position:"absolute",top:e.top,left:e.left,width:this.$root.outerWidth(),height:this.$root.outerHeight(),zIndex:this.getStartZIndex(!0),opacity:0}).appendTo(document.body)}this.disabled=!0}},docClick:function(t){return this.$touchScrollingSub?(this.$touchScrollingSub=null,void 0):((this.visibleSubMenus.length&&!$.contains(this.$root[0],t.target)||$(t.target).closest("a").length)&&this.menuHideAll(),void 0)},docTouchEnd:function(){if(this.lastTouch){if(!(!this.visibleSubMenus.length||void 0!==this.lastTouch.x2&&this.lastTouch.x1!=this.lastTouch.x2||void 0!==this.lastTouch.y2&&this.lastTouch.y1!=this.lastTouch.y2||this.lastTouch.target&&$.contains(this.$root[0],this.lastTouch.target))){this.hideTimeout&&(clearTimeout(this.hideTimeout),this.hideTimeout=0);var t=this;this.hideTimeout=setTimeout(function(){t.menuHideAll()},350)}this.lastTouch=null}},docTouchMove:function(t){if(this.lastTouch){var e=t.originalEvent.touches[0];this.lastTouch.x2=e.pageX,this.lastTouch.y2=e.pageY}},docTouchStart:function(t){var e=t.originalEvent.touches[0];this.lastTouch={x1:e.pageX,y1:e.pageY,target:e.target}},enable:function(){this.disabled&&(this.$disableOverlay&&(this.$disableOverlay.remove(),this.$disableOverlay=null),this.disabled=!1)},getClosestMenu:function(t){for(var e=$(t).closest("ul");e.dataSM("in-mega");)e=e.parent().closest("ul");return e[0]||null},getHeight:function(t){return this.getOffset(t,!0)},getOffset:function(t,e){var i;"none"==t.css("display")&&(i={position:t[0].style.position,visibility:t[0].style.visibility},t.css({position:"absolute",visibility:"hidden"}).show());var s=t[0].getBoundingClientRect&&t[0].getBoundingClientRect(),o=s&&(e?s.height||s.bottom-s.top:s.width||s.right-s.left);return o||0===o||(o=e?t[0].offsetHeight:t[0].offsetWidth),i&&t.hide().css(i),o},getStartZIndex:function(t){var e=parseInt(this[t?"$root":"$firstSub"].css("z-index"));return!t&&isNaN(e)&&(e=parseInt(this.$root.css("z-index"))),isNaN(e)?1:e},getTouchPoint:function(t){return t.touches&&t.touches[0]||t.changedTouches&&t.changedTouches[0]||t},getViewport:function(t){var e=t?"Height":"Width",i=document.documentElement["client"+e],s=window["inner"+e];return s&&(i=Math.min(i,s)),i},getViewportHeight:function(){return this.getViewport(!0)},getViewportWidth:function(){return this.getViewport()},getWidth:function(t){return this.getOffset(t)},handleEvents:function(){return!this.disabled&&this.isCSSOn()},handleItemEvents:function(t){return this.handleEvents()&&!this.isLinkInMegaMenu(t)},isCollapsible:function(){return"static"==this.$firstSub.css("position")},isCSSOn:function(){return"inline"!=this.$firstLink.css("display")},isFixed:function(){var t="fixed"==this.$root.css("position");return t||this.$root.parentsUntil("body").each(function(){return"fixed"==$(this).css("position")?(t=!0,!1):void 0}),t},isLinkInMegaMenu:function(t){return $(this.getClosestMenu(t[0])).hasClass("mega-menu")},isTouchMode:function(){return!mouse||this.opts.noMouseOver||this.isCollapsible()},itemActivate:function(t,e){var i=t.closest("ul"),s=i.dataSM("level");if(s>1&&(!this.activatedItems[s-2]||this.activatedItems[s-2][0]!=i.dataSM("parent-a")[0])){var o=this;$(i.parentsUntil("[data-smartmenus-id]","ul").get().reverse()).add(i).each(function(){o.itemActivate($(this).dataSM("parent-a"))})}if((!this.isCollapsible()||e)&&this.menuHideSubMenus(this.activatedItems[s-1]&&this.activatedItems[s-1][0]==t[0]?s:s-1),this.activatedItems[s-1]=t,this.$root.triggerHandler("activate.smapi",t[0])!==!1){var a=t.dataSM("sub");a&&(this.isTouchMode()||!this.opts.showOnClick||this.clickActivated)&&this.menuShow(a)}},itemBlur:function(t){var e=$(t.currentTarget);this.handleItemEvents(e)&&this.$root.triggerHandler("blur.smapi",e[0])},itemClick:function(t){var e=$(t.currentTarget);if(this.handleItemEvents(e)){if(this.$touchScrollingSub&&this.$touchScrollingSub[0]==e.closest("ul")[0])return this.$touchScrollingSub=null,t.stopPropagation(),!1;if(this.$root.triggerHandler("click.smapi",e[0])===!1)return!1;var i=$(t.target).is(".sub-arrow"),s=e.dataSM("sub"),o=s?2==s.dataSM("level"):!1,a=this.isCollapsible(),n=/toggle$/.test(this.opts.collapsibleBehavior),r=/link$/.test(this.opts.collapsibleBehavior),h=/^accordion/.test(this.opts.collapsibleBehavior);if(s&&!s.is(":visible")){if((!r||!a||i)&&(this.opts.showOnClick&&o&&(this.clickActivated=!0),this.itemActivate(e,h),s.is(":visible")))return this.focusActivated=!0,!1}else if(a&&(n||i))return this.itemActivate(e,h),this.menuHide(s),n&&(this.focusActivated=!1),!1;return this.opts.showOnClick&&o||e.hasClass("disabled")||this.$root.triggerHandler("select.smapi",e[0])===!1?!1:void 0}},itemDown:function(t){var e=$(t.currentTarget);this.handleItemEvents(e)&&e.dataSM("mousedown",!0)},itemEnter:function(t){var e=$(t.currentTarget);if(this.handleItemEvents(e)){if(!this.isTouchMode()){this.showTimeout&&(clearTimeout(this.showTimeout),this.showTimeout=0);var i=this;this.showTimeout=setTimeout(function(){i.itemActivate(e)},this.opts.showOnClick&&1==e.closest("ul").dataSM("level")?1:this.opts.showTimeout)}this.$root.triggerHandler("mouseenter.smapi",e[0])}},itemFocus:function(t){var e=$(t.currentTarget);this.handleItemEvents(e)&&(!this.focusActivated||this.isTouchMode()&&e.dataSM("mousedown")||this.activatedItems.length&&this.activatedItems[this.activatedItems.length-1][0]==e[0]||this.itemActivate(e,!0),this.$root.triggerHandler("focus.smapi",e[0]))},itemLeave:function(t){var e=$(t.currentTarget);this.handleItemEvents(e)&&(this.isTouchMode()||(e[0].blur(),this.showTimeout&&(clearTimeout(this.showTimeout),this.showTimeout=0)),e.removeDataSM("mousedown"),this.$root.triggerHandler("mouseleave.smapi",e[0]))},menuHide:function(t){if(this.$root.triggerHandler("beforehide.smapi",t[0])!==!1&&(canAnimate&&t.stop(!0,!0),"none"!=t.css("display"))){var e=function(){t.css("z-index","")};this.isCollapsible()?canAnimate&&this.opts.collapsibleHideFunction?this.opts.collapsibleHideFunction.call(this,t,e):t.hide(this.opts.collapsibleHideDuration,e):canAnimate&&this.opts.hideFunction?this.opts.hideFunction.call(this,t,e):t.hide(this.opts.hideDuration,e),t.dataSM("scroll")&&(this.menuScrollStop(t),t.css({"touch-action":"","-ms-touch-action":"","-webkit-transform":"",transform:""}).off(".smartmenus_scroll").removeDataSM("scroll").dataSM("scroll-arrows").hide()),t.dataSM("parent-a").removeClass("highlighted").attr("aria-expanded","false"),t.attr({"aria-expanded":"false","aria-hidden":"true"});var i=t.dataSM("level");this.activatedItems.splice(i-1,1),this.visibleSubMenus.splice($.inArray(t,this.visibleSubMenus),1),this.$root.triggerHandler("hide.smapi",t[0])}},menuHideAll:function(){this.showTimeout&&(clearTimeout(this.showTimeout),this.showTimeout=0);for(var t=this.opts.isPopup?1:0,e=this.visibleSubMenus.length-1;e>=t;e--)this.menuHide(this.visibleSubMenus[e]);this.opts.isPopup&&(canAnimate&&this.$root.stop(!0,!0),this.$root.is(":visible")&&(canAnimate&&this.opts.hideFunction?this.opts.hideFunction.call(this,this.$root):this.$root.hide(this.opts.hideDuration))),this.activatedItems=[],this.visibleSubMenus=[],this.clickActivated=!1,this.focusActivated=!1,this.zIndexInc=0,this.$root.triggerHandler("hideAll.smapi")},menuHideSubMenus:function(t){for(var e=this.activatedItems.length-1;e>=t;e--){var i=this.activatedItems[e].dataSM("sub");i&&this.menuHide(i)}},menuInit:function(t){if(!t.dataSM("in-mega")){t.hasClass("mega-menu")&&t.find("ul").dataSM("in-mega",!0);for(var e=2,i=t[0];(i=i.parentNode.parentNode)!=this.$root[0];)e++;var s=t.prevAll("a").eq(-1);s.length||(s=t.prevAll().find("a").eq(-1)),s.addClass("has-submenu").dataSM("sub",t),t.dataSM("parent-a",s).dataSM("level",e).parent().dataSM("sub",t);var o=s.attr("id")||this.accessIdPrefix+ ++this.idInc,a=t.attr("id")||this.accessIdPrefix+ ++this.idInc;s.attr({id:o,"aria-haspopup":"true","aria-controls":a,"aria-expanded":"false"}),t.attr({id:a,role:"group","aria-hidden":"true","aria-labelledby":o,"aria-expanded":"false"}),this.opts.subIndicators&&s[this.opts.subIndicatorsPos](this.$subArrow.clone())}},menuPosition:function(t){var e,i,s=t.dataSM("parent-a"),o=s.closest("li"),a=o.parent(),n=t.dataSM("level"),r=this.getWidth(t),h=this.getHeight(t),u=s.offset(),l=u.left,c=u.top,d=this.getWidth(s),m=this.getHeight(s),p=$(window),f=p.scrollLeft(),v=p.scrollTop(),b=this.getViewportWidth(),S=this.getViewportHeight(),g=a.parent().is("[data-sm-horizontal-sub]")||2==n&&!a.hasClass("sm-vertical"),M=this.opts.rightToLeftSubMenus&&!o.is("[data-sm-reverse]")||!this.opts.rightToLeftSubMenus&&o.is("[data-sm-reverse]"),w=2==n?this.opts.mainMenuSubOffsetX:this.opts.subMenusSubOffsetX,T=2==n?this.opts.mainMenuSubOffsetY:this.opts.subMenusSubOffsetY;if(g?(e=M?d-r-w:w,i=this.opts.bottomToTopSubMenus?-h-T:m+T):(e=M?w-r:d-w,i=this.opts.bottomToTopSubMenus?m-T-h:T),this.opts.keepInViewport){var y=l+e,I=c+i;if(M&&f>y?e=g?f-y+e:d-w:!M&&y+r>f+b&&(e=g?f+b-r-y+e:w-r),g||(S>h&&I+h>v+S?i+=v+S-h-I:(h>=S||v>I)&&(i+=v-I)),g&&(I+h>v+S+.49||v>I)||!g&&h>S+.49){var x=this;t.dataSM("scroll-arrows")||t.dataSM("scroll-arrows",$([$('')[0],$('')[0]]).on({mouseenter:function(){t.dataSM("scroll").up=$(this).hasClass("scroll-up"),x.menuScroll(t)},mouseleave:function(e){x.menuScrollStop(t),x.menuScrollOut(t,e)},"mousewheel DOMMouseScroll":function(t){t.preventDefault()}}).insertAfter(t));var A=".smartmenus_scroll";if(t.dataSM("scroll",{y:this.cssTransforms3d?0:i-m,step:1,itemH:m,subH:h,arrowDownH:this.getHeight(t.dataSM("scroll-arrows").eq(1))}).on(getEventsNS({mouseover:function(e){x.menuScrollOver(t,e)},mouseout:function(e){x.menuScrollOut(t,e)},"mousewheel DOMMouseScroll":function(e){x.menuScrollMousewheel(t,e)}},A)).dataSM("scroll-arrows").css({top:"auto",left:"0",marginLeft:e+(parseInt(t.css("border-left-width"))||0),width:r-(parseInt(t.css("border-left-width"))||0)-(parseInt(t.css("border-right-width"))||0),zIndex:t.css("z-index")}).eq(g&&this.opts.bottomToTopSubMenus?0:1).show(),this.isFixed()){var C={};C[touchEvents?"touchstart touchmove touchend":"pointerdown pointermove pointerup MSPointerDown MSPointerMove MSPointerUp"]=function(e){x.menuScrollTouch(t,e)},t.css({"touch-action":"none","-ms-touch-action":"none"}).on(getEventsNS(C,A))}}}t.css({top:"auto",left:"0",marginLeft:e,marginTop:i-m})},menuScroll:function(t,e,i){var s,o=t.dataSM("scroll"),a=t.dataSM("scroll-arrows"),n=o.up?o.upEnd:o.downEnd;if(!e&&o.momentum){if(o.momentum*=.92,s=o.momentum,.5>s)return this.menuScrollStop(t),void 0}else s=i||(e||!this.opts.scrollAccelerate?this.opts.scrollStep:Math.floor(o.step));var r=t.dataSM("level");if(this.activatedItems[r-1]&&this.activatedItems[r-1].dataSM("sub")&&this.activatedItems[r-1].dataSM("sub").is(":visible")&&this.menuHideSubMenus(r-1),o.y=o.up&&o.y>=n||!o.up&&n>=o.y?o.y:Math.abs(n-o.y)>s?o.y+(o.up?s:-s):n,t.css(this.cssTransforms3d?{"-webkit-transform":"translate3d(0, "+o.y+"px, 0)",transform:"translate3d(0, "+o.y+"px, 0)"}:{marginTop:o.y}),mouse&&(o.up&&o.y>o.downEnd||!o.up&&o.y0;t.dataSM("scroll-arrows").eq(i?0:1).is(":visible")&&(t.dataSM("scroll").up=i,this.menuScroll(t,!0))}e.preventDefault()},menuScrollOut:function(t,e){mouse&&(/^scroll-(up|down)/.test((e.relatedTarget||"").className)||(t[0]==e.relatedTarget||$.contains(t[0],e.relatedTarget))&&this.getClosestMenu(e.relatedTarget)==t[0]||t.dataSM("scroll-arrows").css("visibility","hidden"))},menuScrollOver:function(t,e){if(mouse&&!/^scroll-(up|down)/.test(e.target.className)&&this.getClosestMenu(e.target)==t[0]){this.menuScrollRefreshData(t);var i=t.dataSM("scroll"),s=$(window).scrollTop()-t.dataSM("parent-a").offset().top-i.itemH;t.dataSM("scroll-arrows").eq(0).css("margin-top",s).end().eq(1).css("margin-top",s+this.getViewportHeight()-i.arrowDownH).end().css("visibility","visible")}},menuScrollRefreshData:function(t){var e=t.dataSM("scroll"),i=$(window).scrollTop()-t.dataSM("parent-a").offset().top-e.itemH;this.cssTransforms3d&&(i=-(parseFloat(t.css("margin-top"))-i)),$.extend(e,{upEnd:i,downEnd:i+this.getViewportHeight()-e.subH})},menuScrollStop:function(t){return this.scrollTimeout?(cancelAnimationFrame(this.scrollTimeout),this.scrollTimeout=0,t.dataSM("scroll").step=1,!0):void 0},menuScrollTouch:function(t,e){if(e=e.originalEvent,isTouchEvent(e)){var i=this.getTouchPoint(e);if(this.getClosestMenu(i.target)==t[0]){var s=t.dataSM("scroll");if(/(start|down)$/i.test(e.type))this.menuScrollStop(t)?(e.preventDefault(),this.$touchScrollingSub=t):this.$touchScrollingSub=null,this.menuScrollRefreshData(t),$.extend(s,{touchStartY:i.pageY,touchStartTime:e.timeStamp});else if(/move$/i.test(e.type)){var o=void 0!==s.touchY?s.touchY:s.touchStartY;if(void 0!==o&&o!=i.pageY){this.$touchScrollingSub=t;var a=i.pageY>o;void 0!==s.up&&s.up!=a&&$.extend(s,{touchStartY:i.pageY,touchStartTime:e.timeStamp}),$.extend(s,{up:a,touchY:i.pageY}),this.menuScroll(t,!0,Math.abs(i.pageY-o))}e.preventDefault()}else void 0!==s.touchY&&((s.momentum=15*Math.pow(Math.abs(i.pageY-s.touchStartY)/(e.timeStamp-s.touchStartTime),2))&&(this.menuScrollStop(t),this.menuScroll(t),e.preventDefault()),delete s.touchY)}}},menuShow:function(t){if((t.dataSM("beforefirstshowfired")||(t.dataSM("beforefirstshowfired",!0),this.$root.triggerHandler("beforefirstshow.smapi",t[0])!==!1))&&this.$root.triggerHandler("beforeshow.smapi",t[0])!==!1&&(t.dataSM("shown-before",!0),canAnimate&&t.stop(!0,!0),!t.is(":visible"))){var e=t.dataSM("parent-a"),i=this.isCollapsible();if((this.opts.keepHighlighted||i)&&e.addClass("highlighted"),i)t.removeClass("sm-nowrap").css({zIndex:"",width:"auto",minWidth:"",maxWidth:"",top:"",left:"",marginLeft:"",marginTop:""});else{if(t.css("z-index",this.zIndexInc=(this.zIndexInc||this.getStartZIndex())+1),(this.opts.subMenusMinWidth||this.opts.subMenusMaxWidth)&&(t.css({width:"auto",minWidth:"",maxWidth:""}).addClass("sm-nowrap"),this.opts.subMenusMinWidth&&t.css("min-width",this.opts.subMenusMinWidth),this.opts.subMenusMaxWidth)){var s=this.getWidth(t);t.css("max-width",this.opts.subMenusMaxWidth),s>this.getWidth(t)&&t.removeClass("sm-nowrap").css("width",this.opts.subMenusMaxWidth)}this.menuPosition(t)}var o=function(){t.css("overflow","")};i?canAnimate&&this.opts.collapsibleShowFunction?this.opts.collapsibleShowFunction.call(this,t,o):t.show(this.opts.collapsibleShowDuration,o):canAnimate&&this.opts.showFunction?this.opts.showFunction.call(this,t,o):t.show(this.opts.showDuration,o),e.attr("aria-expanded","true"),t.attr({"aria-expanded":"true","aria-hidden":"false"}),this.visibleSubMenus.push(t),this.$root.triggerHandler("show.smapi",t[0])}},popupHide:function(t){this.hideTimeout&&(clearTimeout(this.hideTimeout),this.hideTimeout=0);var e=this;this.hideTimeout=setTimeout(function(){e.menuHideAll()},t?1:this.opts.hideTimeout)},popupShow:function(t,e){if(!this.opts.isPopup)return alert('SmartMenus jQuery Error:\n\nIf you want to show this menu via the "popupShow" method, set the isPopup:true option.'),void 0;if(this.hideTimeout&&(clearTimeout(this.hideTimeout),this.hideTimeout=0),this.$root.dataSM("shown-before",!0),canAnimate&&this.$root.stop(!0,!0),!this.$root.is(":visible")){this.$root.css({left:t,top:e});var i=this,s=function(){i.$root.css("overflow","")};canAnimate&&this.opts.showFunction?this.opts.showFunction.call(this,this.$root,s):this.$root.show(this.opts.showDuration,s),this.visibleSubMenus[0]=this.$root}},refresh:function(){this.destroy(!0),this.init(!0)},rootKeyDown:function(t){if(this.handleEvents())switch(t.keyCode){case 27:var e=this.activatedItems[0];if(e){this.menuHideAll(),e[0].focus();var i=e.dataSM("sub");i&&this.menuHide(i)}break;case 32:var s=$(t.target);if(s.is("a")&&this.handleItemEvents(s)){var i=s.dataSM("sub");i&&!i.is(":visible")&&(this.itemClick({currentTarget:t.target}),t.preventDefault())}}},rootOut:function(t){if(this.handleEvents()&&!this.isTouchMode()&&t.target!=this.$root[0]&&(this.hideTimeout&&(clearTimeout(this.hideTimeout),this.hideTimeout=0),!this.opts.showOnClick||!this.opts.hideOnClick)){var e=this;this.hideTimeout=setTimeout(function(){e.menuHideAll()},this.opts.hideTimeout)}},rootOver:function(t){this.handleEvents()&&!this.isTouchMode()&&t.target!=this.$root[0]&&this.hideTimeout&&(clearTimeout(this.hideTimeout),this.hideTimeout=0)},winResize:function(t){if(this.handleEvents()){if(!("onorientationchange"in window)||"orientationchange"==t.type){var e=this.isCollapsible();this.wasCollapsible&&e||(this.activatedItems.length&&this.activatedItems[this.activatedItems.length-1][0].blur(),this.menuHideAll()),this.wasCollapsible=e}}else if(this.$disableOverlay){var i=this.$root.offset();this.$disableOverlay.css({top:i.top,left:i.left,width:this.$root.outerWidth(),height:this.$root.outerHeight()})}}}}),$.fn.dataSM=function(t,e){return e?this.data(t+"_smartmenus",e):this.data(t+"_smartmenus")},$.fn.removeDataSM=function(t){return this.removeData(t+"_smartmenus")},$.fn.smartmenus=function(options){if("string"==typeof options){var args=arguments,method=options;return Array.prototype.shift.call(args),this.each(function(){var t=$(this).data("smartmenus");t&&t[method]&&t[method].apply(t,args)})}return this.each(function(){var dataOpts=$(this).data("sm-options")||null;if(dataOpts)try{dataOpts=eval("("+dataOpts+")")}catch(e){dataOpts=null,alert('ERROR\n\nSmartMenus jQuery init:\nInvalid "data-sm-options" attribute value syntax.')}new $.SmartMenus(this,$.extend({},$.fn.smartmenus.defaults,options,dataOpts))})},$.fn.smartmenus.defaults={isPopup:!1,mainMenuSubOffsetX:0,mainMenuSubOffsetY:0,subMenusSubOffsetX:0,subMenusSubOffsetY:0,subMenusMinWidth:"10em",subMenusMaxWidth:"20em",subIndicators:!0,subIndicatorsPos:"append",subIndicatorsText:"",scrollStep:30,scrollAccelerate:!0,showTimeout:250,hideTimeout:500,showDuration:0,showFunction:null,hideDuration:0,hideFunction:function(t,e){t.fadeOut(200,e)},collapsibleShowDuration:0,collapsibleShowFunction:function(t,e){t.slideDown(200,e)},collapsibleHideDuration:0,collapsibleHideFunction:function(t,e){t.slideUp(200,e)},showOnClick:!1,hideOnClick:!0,noMouseOver:!1,keepInViewport:!0,keepHighlighted:!0,markCurrentItem:!1,markCurrentTree:!0,rightToLeftSubMenus:!1,bottomToTopSubMenus:!1,collapsibleBehavior:"default"},$}); \ No newline at end of file diff --git a/docs/menu.js b/docs/menu.js deleted file mode 100644 index 2fe2214..0000000 --- a/docs/menu.js +++ /dev/null @@ -1,51 +0,0 @@ -/* - @licstart The following is the entire license notice for the JavaScript code in this file. - - The MIT License (MIT) - - Copyright (C) 1997-2020 by Dimitri van Heesch - - 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. - - @licend The above is the entire license notice for the JavaScript code in this file - */ -function initMenu(relPath,searchEnabled,serverSide,searchPage,search) { - function makeTree(data,relPath) { - var result=''; - if ('children' in data) { - result+=''; - } - return result; - } - - $('#main-nav').append(makeTree(menudata,relPath)); - $('#main-nav').children(':first').addClass('sm sm-dox').attr('id','main-menu'); - if (searchEnabled) { - if (serverSide) { - $('#main-menu').append('
    • '); - } else { - $('#main-menu').append('
    • '); - } - } - $('#main-menu').smartmenus(); -} -/* @license-end */ diff --git a/docs/menudata.js b/docs/menudata.js deleted file mode 100644 index 6beb911..0000000 --- a/docs/menudata.js +++ /dev/null @@ -1,52 +0,0 @@ -/* - @licstart The following is the entire license notice for the JavaScript code in this file. - - The MIT License (MIT) - - Copyright (C) 1997-2020 by Dimitri van Heesch - - 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. - - @licend The above is the entire license notice for the JavaScript code in this file -*/ -var menudata={children:[ -{text:"Main Page",url:"index.html"}, -{text:"Classes",url:"annotated.html",children:[ -{text:"Class List",url:"annotated.html"}, -{text:"Class Index",url:"classes.html"}, -{text:"Class Members",url:"functions.html",children:[ -{text:"All",url:"functions.html",children:[ -{text:"b",url:"functions.html#index_b"}, -{text:"d",url:"functions.html#index_d"}, -{text:"e",url:"functions.html#index_e"}, -{text:"g",url:"functions.html#index_g"}, -{text:"i",url:"functions.html#index_i"}, -{text:"s",url:"functions.html#index_s"}, -{text:"v",url:"functions.html#index_v"}]}, -{text:"Functions",url:"functions_func.html",children:[ -{text:"b",url:"functions_func.html#index_b"}, -{text:"d",url:"functions_func.html#index_d"}, -{text:"e",url:"functions_func.html#index_e"}, -{text:"g",url:"functions_func.html#index_g"}, -{text:"i",url:"functions_func.html#index_i"}, -{text:"s",url:"functions_func.html#index_s"}, -{text:"v",url:"functions_func.html#index_v"}]}]}]}, -{text:"Files",url:"files.html",children:[ -{text:"File List",url:"files.html"}, -{text:"File Members",url:"globals.html",children:[ -{text:"All",url:"globals.html"}, -{text:"Enumerations",url:"globals_enum.html"}, -{text:"Macros",url:"globals_defs.html"}]}]}]} diff --git a/docs/nav_f.png b/docs/nav_f.png deleted file mode 100644 index 72a58a529ed3a9ed6aa0c51a79cf207e026deee2..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 153 zcmeAS@N?(olHy`uVBq!ia0vp^j6iI`!2~2XGqLUlQVE_ejv*C{Z|{2ZH7M}7UYxc) zn!W8uqtnIQ>_z8U diff --git a/docs/nav_g.png b/docs/nav_g.png deleted file mode 100644 index 2093a237a94f6c83e19ec6e5fd42f7ddabdafa81..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 95 zcmeAS@N?(olHy`uVBq!ia0vp^j6lrB!3HFm1ilyoDK$?Q$B+ufw|5PB85lU25BhtE tr?otc=hd~V+ws&_A@j8Fiv!KF$B+ufw|5=67#uj90@pIL wZ=Q8~_Ju`#59=RjDrmm`tMD@M=!-l18IR?&vFVdQ&MBb@0HFXL1|%O$WD@{VPM$7~Ar*{o?;hlAFyLXmaDC0y znK1_#cQqJWPES%4Uujug^TE?jMft$}Eq^WaR~)%f)vSNs&gek&x%A9X9sM - - - - - - - - - -
    -
    Loading...
    -
    - -
    Searching...
    -
    No Matches
    - -
    - - diff --git a/docs/search/all_0.js b/docs/search/all_0.js deleted file mode 100644 index bf3c0ac..0000000 --- a/docs/search/all_0.js +++ /dev/null @@ -1,4 +0,0 @@ -var searchData= -[ - ['begin_0',['begin',['../class_v_e_m_l7700.html#af40c061e72722295c3b31f27006055d7',1,'VEML7700']]] -]; diff --git a/docs/search/all_1.html b/docs/search/all_1.html deleted file mode 100644 index 9f80e90..0000000 --- a/docs/search/all_1.html +++ /dev/null @@ -1,37 +0,0 @@ - - - - - - - - - - -
    -
    Loading...
    -
    - -
    Searching...
    -
    No Matches
    - -
    - - diff --git a/docs/search/all_1.js b/docs/search/all_1.js deleted file mode 100644 index b223a64..0000000 --- a/docs/search/all_1.js +++ /dev/null @@ -1,4 +0,0 @@ -var searchData= -[ - ['disabledebugging_1',['disableDebugging',['../class_v_e_m_l7700.html#ad0925d35229ca65e98ad79a6c54c528f',1,'VEML7700']]] -]; diff --git a/docs/search/all_2.html b/docs/search/all_2.html deleted file mode 100644 index 02cfffc..0000000 --- a/docs/search/all_2.html +++ /dev/null @@ -1,37 +0,0 @@ - - - - - - - - - - -
    -
    Loading...
    -
    - -
    Searching...
    -
    No Matches
    - -
    - - diff --git a/docs/search/all_2.js b/docs/search/all_2.js deleted file mode 100644 index b856d72..0000000 --- a/docs/search/all_2.js +++ /dev/null @@ -1,4 +0,0 @@ -var searchData= -[ - ['enabledebugging_2',['enableDebugging',['../class_v_e_m_l7700.html#a257e7d2a70bb940ce89d5c41bbbeeed5',1,'VEML7700']]] -]; diff --git a/docs/search/all_3.html b/docs/search/all_3.html deleted file mode 100644 index 39767b8..0000000 --- a/docs/search/all_3.html +++ /dev/null @@ -1,37 +0,0 @@ - - - - - - - - - - -
    -
    Loading...
    -
    - -
    Searching...
    -
    No Matches
    - -
    - - diff --git a/docs/search/all_3.js b/docs/search/all_3.js deleted file mode 100644 index db7b097..0000000 --- a/docs/search/all_3.js +++ /dev/null @@ -1,17 +0,0 @@ -var searchData= -[ - ['getambientlight_3',['getAmbientLight',['../class_v_e_m_l7700.html#ae95aba5a71a08dff4f83aafb43a4515c',1,'VEML7700::getAmbientLight(uint16_t *ambient)'],['../class_v_e_m_l7700.html#a93257c7adaa80864434bc6d41ad5c2d9',1,'VEML7700::getAmbientLight()']]], - ['gethighthreshold_4',['getHighThreshold',['../class_v_e_m_l7700.html#a527b11af4d2816894e1db4ba710128b5',1,'VEML7700::getHighThreshold(uint16_t *threshold)'],['../class_v_e_m_l7700.html#ad7d4ee449edfe1b6ccbe5ae677e2284a',1,'VEML7700::getHighThreshold()']]], - ['getintegrationtime_5',['getIntegrationTime',['../class_v_e_m_l7700.html#abdfee8e09a34d9d7d965107147bf0ccc',1,'VEML7700::getIntegrationTime(VEML7700_integration_time_t *it)'],['../class_v_e_m_l7700.html#aa471e0f323c352295c653555de7c70b4',1,'VEML7700::getIntegrationTime()']]], - ['getintegrationtimestr_6',['getIntegrationTimeStr',['../class_v_e_m_l7700.html#aa83b00355c032ff3325c88187b74df40',1,'VEML7700']]], - ['getinterruptenable_7',['getInterruptEnable',['../class_v_e_m_l7700.html#a6c48807c2f8168b8399a51bcfc3a14d4',1,'VEML7700::getInterruptEnable(VEML7700_interrupt_enable_t *ie)'],['../class_v_e_m_l7700.html#a0e105e71ef9ee97f9ad88f44473dfd7d',1,'VEML7700::getInterruptEnable()']]], - ['getinterruptstatus_8',['getInterruptStatus',['../class_v_e_m_l7700.html#a6fe90efe56ba98524b24bf35949b0cfc',1,'VEML7700::getInterruptStatus(VEML7700_interrupt_status_t *status)'],['../class_v_e_m_l7700.html#a8249c59c8e66542ee002eaed2e29ed2e',1,'VEML7700::getInterruptStatus()']]], - ['getlowthreshold_9',['getLowThreshold',['../class_v_e_m_l7700.html#a2dd309f78a3dca06c355286ec2c9d691',1,'VEML7700::getLowThreshold(uint16_t *threshold)'],['../class_v_e_m_l7700.html#a3b2a4fae6441bd66bd282f17beaaadef',1,'VEML7700::getLowThreshold()']]], - ['getlux_10',['getLux',['../class_v_e_m_l7700.html#a1719f02916aa332b6f38e79f2d312405',1,'VEML7700::getLux(float *lux)'],['../class_v_e_m_l7700.html#ae0e25719d1dbd6165b39ab8693f963a1',1,'VEML7700::getLux()']]], - ['getpersistenceprotect_11',['getPersistenceProtect',['../class_v_e_m_l7700.html#afc21b11579aacde3eff53844b3f467b1',1,'VEML7700::getPersistenceProtect(VEML7700_persistence_protect_t *pp)'],['../class_v_e_m_l7700.html#ae771283dd0ae800bf7194269d54963ea',1,'VEML7700::getPersistenceProtect()']]], - ['getpersistenceprotectstr_12',['getPersistenceProtectStr',['../class_v_e_m_l7700.html#a056fc278531b54f0de0b5537c2e800ba',1,'VEML7700']]], - ['getsensitivitymode_13',['getSensitivityMode',['../class_v_e_m_l7700.html#a842bda613a4ec10da7e581e50c0b6563',1,'VEML7700::getSensitivityMode(VEML7700_sensitivity_mode_t *sm)'],['../class_v_e_m_l7700.html#aceb451c7600bf509bdd8b12381c4e35e',1,'VEML7700::getSensitivityMode()']]], - ['getsensitivitymodestr_14',['getSensitivityModeStr',['../class_v_e_m_l7700.html#abe744baacfb5483399820e479571aa9b',1,'VEML7700']]], - ['getshutdown_15',['getShutdown',['../class_v_e_m_l7700.html#aeb9f3b00c0ebd1297582f1e246007d94',1,'VEML7700']]], - ['getwhitelevel_16',['getWhiteLevel',['../class_v_e_m_l7700.html#a6a0894ae44f1c43828e8a7bdd36822b2',1,'VEML7700::getWhiteLevel(uint16_t *whiteLevel)'],['../class_v_e_m_l7700.html#ad172929df5518eec27201fce0b17a763',1,'VEML7700::getWhiteLevel()']]] -]; diff --git a/docs/search/all_4.html b/docs/search/all_4.html deleted file mode 100644 index fc40463..0000000 --- a/docs/search/all_4.html +++ /dev/null @@ -1,37 +0,0 @@ - - - - - - - - - - -
    -
    Loading...
    -
    - -
    Searching...
    -
    No Matches
    - -
    - - diff --git a/docs/search/all_4.js b/docs/search/all_4.js deleted file mode 100644 index 88875ba..0000000 --- a/docs/search/all_4.js +++ /dev/null @@ -1,4 +0,0 @@ -var searchData= -[ - ['isconnected_17',['isConnected',['../class_v_e_m_l7700.html#ac42b5cbc866aa31ba3e2ed1330c68559',1,'VEML7700']]] -]; diff --git a/docs/search/all_5.html b/docs/search/all_5.html deleted file mode 100644 index 9dd9344..0000000 --- a/docs/search/all_5.html +++ /dev/null @@ -1,37 +0,0 @@ - - - - - - - - - - -
    -
    Loading...
    -
    - -
    Searching...
    -
    No Matches
    - -
    - - diff --git a/docs/search/all_5.js b/docs/search/all_5.js deleted file mode 100644 index 6418bff..0000000 --- a/docs/search/all_5.js +++ /dev/null @@ -1,12 +0,0 @@ -var searchData= -[ - ['sethighthreshold_18',['setHighThreshold',['../class_v_e_m_l7700.html#a5a81f9bf4cf77922723819e406c7b107',1,'VEML7700']]], - ['setintegrationtime_19',['setIntegrationTime',['../class_v_e_m_l7700.html#a8b65876ae4dc75c61831ca4e40beec7e',1,'VEML7700']]], - ['setinterruptenable_20',['setInterruptEnable',['../class_v_e_m_l7700.html#a0aba999e5b3fd5b6e7658b2a27c06874',1,'VEML7700']]], - ['setlowthreshold_21',['setLowThreshold',['../class_v_e_m_l7700.html#a2dff042bdb48ee0524133a7f69e59613',1,'VEML7700']]], - ['setpersistenceprotect_22',['setPersistenceProtect',['../class_v_e_m_l7700.html#ae3b8c92425867e0dccc8c0393a3f7b95',1,'VEML7700']]], - ['setsensitivitymode_23',['setSensitivityMode',['../class_v_e_m_l7700.html#ae7146ad656795a542e5c489aef9a12f5',1,'VEML7700']]], - ['setshutdown_24',['setShutdown',['../class_v_e_m_l7700.html#a116075e77dfc702e40f282d8281f51e8',1,'VEML7700']]], - ['sparkfun_20veml7700_20ambient_20light_20sensor_20arduino_20library_25',['SparkFun VEML7700 Ambient Light Sensor Arduino Library',['../index.html',1,'']]], - ['sparkfun_5fveml7700_5farduino_5flibrary_2eh_26',['SparkFun_VEML7700_Arduino_Library.h',['../_spark_fun___v_e_m_l7700___arduino___library_8h.html',1,'']]] -]; diff --git a/docs/search/all_6.html b/docs/search/all_6.html deleted file mode 100644 index f1e516d..0000000 --- a/docs/search/all_6.html +++ /dev/null @@ -1,37 +0,0 @@ - - - - - - - - - - -
    -
    Loading...
    -
    - -
    Searching...
    -
    No Matches
    - -
    - - diff --git a/docs/search/all_6.js b/docs/search/all_6.js deleted file mode 100644 index dfce05c..0000000 --- a/docs/search/all_6.js +++ /dev/null @@ -1,12 +0,0 @@ -var searchData= -[ - ['veml7700_27',['VEML7700',['../class_v_e_m_l7700.html',1,'VEML7700'],['../class_v_e_m_l7700.html#a4f782190e7b6d4e8467f30c36dc27070',1,'VEML7700::VEML7700()']]], - ['veml7700_5ferror_5ft_28',['VEML7700_error_t',['../_spark_fun___v_e_m_l7700___arduino___library_8h.html#aa5bc51cc06d5a446ae172210fa340a87',1,'SparkFun_VEML7700_Arduino_Library.h']]], - ['veml7700_5fi2c_5faddress_29',['VEML7700_I2C_ADDRESS',['../_spark_fun___v_e_m_l7700___arduino___library_8h.html#a8f6fca44c3ac0e645fc6ab491b8919e9',1,'SparkFun_VEML7700_Arduino_Library.h']]], - ['veml7700_5fintegration_5ftime_5ft_30',['VEML7700_integration_time_t',['../_spark_fun___v_e_m_l7700___arduino___library_8h.html#a1bc94f9cd94b70f7c8b723fc33b393e7',1,'SparkFun_VEML7700_Arduino_Library.h']]], - ['veml7700_5finterrupt_5fenable_5ft_31',['VEML7700_interrupt_enable_t',['../_spark_fun___v_e_m_l7700___arduino___library_8h.html#a02770ddad75b2ab41c6a1fbeedd90ca9',1,'SparkFun_VEML7700_Arduino_Library.h']]], - ['veml7700_5finterrupt_5fstatus_5ft_32',['VEML7700_interrupt_status_t',['../_spark_fun___v_e_m_l7700___arduino___library_8h.html#aa9de4d5f69959ec6d10f697f48264458',1,'SparkFun_VEML7700_Arduino_Library.h']]], - ['veml7700_5fpersistence_5fprotect_5ft_33',['VEML7700_persistence_protect_t',['../_spark_fun___v_e_m_l7700___arduino___library_8h.html#af8b1b1186f6740af7c8e6a900e435c8a',1,'SparkFun_VEML7700_Arduino_Library.h']]], - ['veml7700_5fsensitivity_5fmode_5ft_34',['VEML7700_sensitivity_mode_t',['../_spark_fun___v_e_m_l7700___arduino___library_8h.html#af597f32e601f72da8594aef787f9196c',1,'SparkFun_VEML7700_Arduino_Library.h']]], - ['veml7700_5fshutdown_5ft_35',['VEML7700_shutdown_t',['../_spark_fun___v_e_m_l7700___arduino___library_8h.html#a48aaa806500374898400d6369a298560',1,'SparkFun_VEML7700_Arduino_Library.h']]] -]; diff --git a/docs/search/classes_0.html b/docs/search/classes_0.html deleted file mode 100644 index af8159e..0000000 --- a/docs/search/classes_0.html +++ /dev/null @@ -1,37 +0,0 @@ - - - - - - - - - - -
    -
    Loading...
    -
    - -
    Searching...
    -
    No Matches
    - -
    - - diff --git a/docs/search/classes_0.js b/docs/search/classes_0.js deleted file mode 100644 index 1fa65aa..0000000 --- a/docs/search/classes_0.js +++ /dev/null @@ -1,4 +0,0 @@ -var searchData= -[ - ['veml7700_36',['VEML7700',['../class_v_e_m_l7700.html',1,'']]] -]; diff --git a/docs/search/close.svg b/docs/search/close.svg deleted file mode 100644 index a933eea..0000000 --- a/docs/search/close.svg +++ /dev/null @@ -1,31 +0,0 @@ - - - - - - image/svg+xml - - - - - - - - diff --git a/docs/search/defines_0.html b/docs/search/defines_0.html deleted file mode 100644 index 15cc3de..0000000 --- a/docs/search/defines_0.html +++ /dev/null @@ -1,37 +0,0 @@ - - - - - - - - - - -
    -
    Loading...
    -
    - -
    Searching...
    -
    No Matches
    - -
    - - diff --git a/docs/search/defines_0.js b/docs/search/defines_0.js deleted file mode 100644 index af0c8aa..0000000 --- a/docs/search/defines_0.js +++ /dev/null @@ -1,4 +0,0 @@ -var searchData= -[ - ['veml7700_5fi2c_5faddress_71',['VEML7700_I2C_ADDRESS',['../_spark_fun___v_e_m_l7700___arduino___library_8h.html#a8f6fca44c3ac0e645fc6ab491b8919e9',1,'SparkFun_VEML7700_Arduino_Library.h']]] -]; diff --git a/docs/search/enums_0.html b/docs/search/enums_0.html deleted file mode 100644 index 141fff5..0000000 --- a/docs/search/enums_0.html +++ /dev/null @@ -1,37 +0,0 @@ - - - - - - - - - - -
    -
    Loading...
    -
    - -
    Searching...
    -
    No Matches
    - -
    - - diff --git a/docs/search/enums_0.js b/docs/search/enums_0.js deleted file mode 100644 index 784e038..0000000 --- a/docs/search/enums_0.js +++ /dev/null @@ -1,10 +0,0 @@ -var searchData= -[ - ['veml7700_5ferror_5ft_64',['VEML7700_error_t',['../_spark_fun___v_e_m_l7700___arduino___library_8h.html#aa5bc51cc06d5a446ae172210fa340a87',1,'SparkFun_VEML7700_Arduino_Library.h']]], - ['veml7700_5fintegration_5ftime_5ft_65',['VEML7700_integration_time_t',['../_spark_fun___v_e_m_l7700___arduino___library_8h.html#a1bc94f9cd94b70f7c8b723fc33b393e7',1,'SparkFun_VEML7700_Arduino_Library.h']]], - ['veml7700_5finterrupt_5fenable_5ft_66',['VEML7700_interrupt_enable_t',['../_spark_fun___v_e_m_l7700___arduino___library_8h.html#a02770ddad75b2ab41c6a1fbeedd90ca9',1,'SparkFun_VEML7700_Arduino_Library.h']]], - ['veml7700_5finterrupt_5fstatus_5ft_67',['VEML7700_interrupt_status_t',['../_spark_fun___v_e_m_l7700___arduino___library_8h.html#aa9de4d5f69959ec6d10f697f48264458',1,'SparkFun_VEML7700_Arduino_Library.h']]], - ['veml7700_5fpersistence_5fprotect_5ft_68',['VEML7700_persistence_protect_t',['../_spark_fun___v_e_m_l7700___arduino___library_8h.html#af8b1b1186f6740af7c8e6a900e435c8a',1,'SparkFun_VEML7700_Arduino_Library.h']]], - ['veml7700_5fsensitivity_5fmode_5ft_69',['VEML7700_sensitivity_mode_t',['../_spark_fun___v_e_m_l7700___arduino___library_8h.html#af597f32e601f72da8594aef787f9196c',1,'SparkFun_VEML7700_Arduino_Library.h']]], - ['veml7700_5fshutdown_5ft_70',['VEML7700_shutdown_t',['../_spark_fun___v_e_m_l7700___arduino___library_8h.html#a48aaa806500374898400d6369a298560',1,'SparkFun_VEML7700_Arduino_Library.h']]] -]; diff --git a/docs/search/files_0.html b/docs/search/files_0.html deleted file mode 100644 index 9498842..0000000 --- a/docs/search/files_0.html +++ /dev/null @@ -1,37 +0,0 @@ - - - - - - - - - - -
    -
    Loading...
    -
    - -
    Searching...
    -
    No Matches
    - -
    - - diff --git a/docs/search/files_0.js b/docs/search/files_0.js deleted file mode 100644 index 15c4928..0000000 --- a/docs/search/files_0.js +++ /dev/null @@ -1,4 +0,0 @@ -var searchData= -[ - ['sparkfun_5fveml7700_5farduino_5flibrary_2eh_37',['SparkFun_VEML7700_Arduino_Library.h',['../_spark_fun___v_e_m_l7700___arduino___library_8h.html',1,'']]] -]; diff --git a/docs/search/functions_0.html b/docs/search/functions_0.html deleted file mode 100644 index eb4c501..0000000 --- a/docs/search/functions_0.html +++ /dev/null @@ -1,37 +0,0 @@ - - - - - - - - - - -
    -
    Loading...
    -
    - -
    Searching...
    -
    No Matches
    - -
    - - diff --git a/docs/search/functions_0.js b/docs/search/functions_0.js deleted file mode 100644 index 4da0925..0000000 --- a/docs/search/functions_0.js +++ /dev/null @@ -1,4 +0,0 @@ -var searchData= -[ - ['begin_38',['begin',['../class_v_e_m_l7700.html#af40c061e72722295c3b31f27006055d7',1,'VEML7700']]] -]; diff --git a/docs/search/functions_1.html b/docs/search/functions_1.html deleted file mode 100644 index ef4088b..0000000 --- a/docs/search/functions_1.html +++ /dev/null @@ -1,37 +0,0 @@ - - - - - - - - - - -
    -
    Loading...
    -
    - -
    Searching...
    -
    No Matches
    - -
    - - diff --git a/docs/search/functions_1.js b/docs/search/functions_1.js deleted file mode 100644 index a012004..0000000 --- a/docs/search/functions_1.js +++ /dev/null @@ -1,4 +0,0 @@ -var searchData= -[ - ['disabledebugging_39',['disableDebugging',['../class_v_e_m_l7700.html#ad0925d35229ca65e98ad79a6c54c528f',1,'VEML7700']]] -]; diff --git a/docs/search/functions_2.html b/docs/search/functions_2.html deleted file mode 100644 index ca5aa10..0000000 --- a/docs/search/functions_2.html +++ /dev/null @@ -1,37 +0,0 @@ - - - - - - - - - - -
    -
    Loading...
    -
    - -
    Searching...
    -
    No Matches
    - -
    - - diff --git a/docs/search/functions_2.js b/docs/search/functions_2.js deleted file mode 100644 index b2196d2..0000000 --- a/docs/search/functions_2.js +++ /dev/null @@ -1,4 +0,0 @@ -var searchData= -[ - ['enabledebugging_40',['enableDebugging',['../class_v_e_m_l7700.html#a257e7d2a70bb940ce89d5c41bbbeeed5',1,'VEML7700']]] -]; diff --git a/docs/search/functions_3.html b/docs/search/functions_3.html deleted file mode 100644 index d79f55b..0000000 --- a/docs/search/functions_3.html +++ /dev/null @@ -1,37 +0,0 @@ - - - - - - - - - - -
    -
    Loading...
    -
    - -
    Searching...
    -
    No Matches
    - -
    - - diff --git a/docs/search/functions_3.js b/docs/search/functions_3.js deleted file mode 100644 index 5259793..0000000 --- a/docs/search/functions_3.js +++ /dev/null @@ -1,17 +0,0 @@ -var searchData= -[ - ['getambientlight_41',['getAmbientLight',['../class_v_e_m_l7700.html#ae95aba5a71a08dff4f83aafb43a4515c',1,'VEML7700::getAmbientLight(uint16_t *ambient)'],['../class_v_e_m_l7700.html#a93257c7adaa80864434bc6d41ad5c2d9',1,'VEML7700::getAmbientLight()']]], - ['gethighthreshold_42',['getHighThreshold',['../class_v_e_m_l7700.html#a527b11af4d2816894e1db4ba710128b5',1,'VEML7700::getHighThreshold(uint16_t *threshold)'],['../class_v_e_m_l7700.html#ad7d4ee449edfe1b6ccbe5ae677e2284a',1,'VEML7700::getHighThreshold()']]], - ['getintegrationtime_43',['getIntegrationTime',['../class_v_e_m_l7700.html#abdfee8e09a34d9d7d965107147bf0ccc',1,'VEML7700::getIntegrationTime(VEML7700_integration_time_t *it)'],['../class_v_e_m_l7700.html#aa471e0f323c352295c653555de7c70b4',1,'VEML7700::getIntegrationTime()']]], - ['getintegrationtimestr_44',['getIntegrationTimeStr',['../class_v_e_m_l7700.html#aa83b00355c032ff3325c88187b74df40',1,'VEML7700']]], - ['getinterruptenable_45',['getInterruptEnable',['../class_v_e_m_l7700.html#a6c48807c2f8168b8399a51bcfc3a14d4',1,'VEML7700::getInterruptEnable(VEML7700_interrupt_enable_t *ie)'],['../class_v_e_m_l7700.html#a0e105e71ef9ee97f9ad88f44473dfd7d',1,'VEML7700::getInterruptEnable()']]], - ['getinterruptstatus_46',['getInterruptStatus',['../class_v_e_m_l7700.html#a6fe90efe56ba98524b24bf35949b0cfc',1,'VEML7700::getInterruptStatus(VEML7700_interrupt_status_t *status)'],['../class_v_e_m_l7700.html#a8249c59c8e66542ee002eaed2e29ed2e',1,'VEML7700::getInterruptStatus()']]], - ['getlowthreshold_47',['getLowThreshold',['../class_v_e_m_l7700.html#a2dd309f78a3dca06c355286ec2c9d691',1,'VEML7700::getLowThreshold(uint16_t *threshold)'],['../class_v_e_m_l7700.html#a3b2a4fae6441bd66bd282f17beaaadef',1,'VEML7700::getLowThreshold()']]], - ['getlux_48',['getLux',['../class_v_e_m_l7700.html#a1719f02916aa332b6f38e79f2d312405',1,'VEML7700::getLux(float *lux)'],['../class_v_e_m_l7700.html#ae0e25719d1dbd6165b39ab8693f963a1',1,'VEML7700::getLux()']]], - ['getpersistenceprotect_49',['getPersistenceProtect',['../class_v_e_m_l7700.html#afc21b11579aacde3eff53844b3f467b1',1,'VEML7700::getPersistenceProtect(VEML7700_persistence_protect_t *pp)'],['../class_v_e_m_l7700.html#ae771283dd0ae800bf7194269d54963ea',1,'VEML7700::getPersistenceProtect()']]], - ['getpersistenceprotectstr_50',['getPersistenceProtectStr',['../class_v_e_m_l7700.html#a056fc278531b54f0de0b5537c2e800ba',1,'VEML7700']]], - ['getsensitivitymode_51',['getSensitivityMode',['../class_v_e_m_l7700.html#a842bda613a4ec10da7e581e50c0b6563',1,'VEML7700::getSensitivityMode(VEML7700_sensitivity_mode_t *sm)'],['../class_v_e_m_l7700.html#aceb451c7600bf509bdd8b12381c4e35e',1,'VEML7700::getSensitivityMode()']]], - ['getsensitivitymodestr_52',['getSensitivityModeStr',['../class_v_e_m_l7700.html#abe744baacfb5483399820e479571aa9b',1,'VEML7700']]], - ['getshutdown_53',['getShutdown',['../class_v_e_m_l7700.html#aeb9f3b00c0ebd1297582f1e246007d94',1,'VEML7700']]], - ['getwhitelevel_54',['getWhiteLevel',['../class_v_e_m_l7700.html#a6a0894ae44f1c43828e8a7bdd36822b2',1,'VEML7700::getWhiteLevel(uint16_t *whiteLevel)'],['../class_v_e_m_l7700.html#ad172929df5518eec27201fce0b17a763',1,'VEML7700::getWhiteLevel()']]] -]; diff --git a/docs/search/functions_4.html b/docs/search/functions_4.html deleted file mode 100644 index 1657cad..0000000 --- a/docs/search/functions_4.html +++ /dev/null @@ -1,37 +0,0 @@ - - - - - - - - - - -
    -
    Loading...
    -
    - -
    Searching...
    -
    No Matches
    - -
    - - diff --git a/docs/search/functions_4.js b/docs/search/functions_4.js deleted file mode 100644 index c5fd3b1..0000000 --- a/docs/search/functions_4.js +++ /dev/null @@ -1,4 +0,0 @@ -var searchData= -[ - ['isconnected_55',['isConnected',['../class_v_e_m_l7700.html#ac42b5cbc866aa31ba3e2ed1330c68559',1,'VEML7700']]] -]; diff --git a/docs/search/functions_5.html b/docs/search/functions_5.html deleted file mode 100644 index 9301d6b..0000000 --- a/docs/search/functions_5.html +++ /dev/null @@ -1,37 +0,0 @@ - - - - - - - - - - -
    -
    Loading...
    -
    - -
    Searching...
    -
    No Matches
    - -
    - - diff --git a/docs/search/functions_5.js b/docs/search/functions_5.js deleted file mode 100644 index c9e72fa..0000000 --- a/docs/search/functions_5.js +++ /dev/null @@ -1,10 +0,0 @@ -var searchData= -[ - ['sethighthreshold_56',['setHighThreshold',['../class_v_e_m_l7700.html#a5a81f9bf4cf77922723819e406c7b107',1,'VEML7700']]], - ['setintegrationtime_57',['setIntegrationTime',['../class_v_e_m_l7700.html#a8b65876ae4dc75c61831ca4e40beec7e',1,'VEML7700']]], - ['setinterruptenable_58',['setInterruptEnable',['../class_v_e_m_l7700.html#a0aba999e5b3fd5b6e7658b2a27c06874',1,'VEML7700']]], - ['setlowthreshold_59',['setLowThreshold',['../class_v_e_m_l7700.html#a2dff042bdb48ee0524133a7f69e59613',1,'VEML7700']]], - ['setpersistenceprotect_60',['setPersistenceProtect',['../class_v_e_m_l7700.html#ae3b8c92425867e0dccc8c0393a3f7b95',1,'VEML7700']]], - ['setsensitivitymode_61',['setSensitivityMode',['../class_v_e_m_l7700.html#ae7146ad656795a542e5c489aef9a12f5',1,'VEML7700']]], - ['setshutdown_62',['setShutdown',['../class_v_e_m_l7700.html#a116075e77dfc702e40f282d8281f51e8',1,'VEML7700']]] -]; diff --git a/docs/search/functions_6.html b/docs/search/functions_6.html deleted file mode 100644 index 9c4f5fc..0000000 --- a/docs/search/functions_6.html +++ /dev/null @@ -1,37 +0,0 @@ - - - - - - - - - - -
    -
    Loading...
    -
    - -
    Searching...
    -
    No Matches
    - -
    - - diff --git a/docs/search/functions_6.js b/docs/search/functions_6.js deleted file mode 100644 index b57a791..0000000 --- a/docs/search/functions_6.js +++ /dev/null @@ -1,4 +0,0 @@ -var searchData= -[ - ['veml7700_63',['VEML7700',['../class_v_e_m_l7700.html#a4f782190e7b6d4e8467f30c36dc27070',1,'VEML7700']]] -]; diff --git a/docs/search/mag_sel.svg b/docs/search/mag_sel.svg deleted file mode 100644 index 03626f6..0000000 --- a/docs/search/mag_sel.svg +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - - - image/svg+xml - - - - - - - - - - - diff --git a/docs/search/nomatches.html b/docs/search/nomatches.html deleted file mode 100644 index 2b9360b..0000000 --- a/docs/search/nomatches.html +++ /dev/null @@ -1,13 +0,0 @@ - - - - - - - - -
    -
    No Matches
    -
    - - diff --git a/docs/search/pages_0.html b/docs/search/pages_0.html deleted file mode 100644 index 8517b48..0000000 --- a/docs/search/pages_0.html +++ /dev/null @@ -1,37 +0,0 @@ - - - - - - - - - - -
    -
    Loading...
    -
    - -
    Searching...
    -
    No Matches
    - -
    - - diff --git a/docs/search/pages_0.js b/docs/search/pages_0.js deleted file mode 100644 index da23b30..0000000 --- a/docs/search/pages_0.js +++ /dev/null @@ -1,4 +0,0 @@ -var searchData= -[ - ['sparkfun_20veml7700_20ambient_20light_20sensor_20arduino_20library_72',['SparkFun VEML7700 Ambient Light Sensor Arduino Library',['../index.html',1,'']]] -]; diff --git a/docs/search/search.css b/docs/search/search.css deleted file mode 100644 index 9074198..0000000 --- a/docs/search/search.css +++ /dev/null @@ -1,257 +0,0 @@ -/*---------------- Search Box */ - -#MSearchBox { - white-space : nowrap; - background: white; - border-radius: 0.65em; - box-shadow: inset 0.5px 0.5px 3px 0px #555; - z-index: 102; -} - -#MSearchBox .left { - display: inline-block; - vertical-align: middle; - height: 1.4em; -} - -#MSearchSelect { - display: inline-block; - vertical-align: middle; - height: 1.4em; - padding: 0 0 0 0.3em; - margin: 0; -} - -#MSearchField { - display: inline-block; - vertical-align: middle; - width: 7.5em; - height: 1.1em; - margin: 0 0.15em; - padding: 0; - line-height: 1em; - border:none; - color: #909090; - outline: none; - font-family: Arial, Verdana, sans-serif; - -webkit-border-radius: 0px; - border-radius: 0px; - background: none; -} - - -#MSearchBox .right { - display: inline-block; - vertical-align: middle; - width: 1.4em; - height: 1.4em; -} - -#MSearchClose { - display: none; - font-size: inherit; - background : none; - border: none; - margin: 0; - padding: 0; - outline: none; - -} - -#MSearchCloseImg { - height: 1.4em; - padding: 0.3em; - margin: 0; -} - -.MSearchBoxActive #MSearchField { - color: #000000; -} - -#main-menu > li:last-child { - /* This
  • object is the parent of the search bar */ - display: flex; - justify-content: center; - align-items: center; - height: 36px; - margin-right: 1em; -} - -/*---------------- Search filter selection */ - -#MSearchSelectWindow { - display: none; - position: absolute; - left: 0; top: 0; - border: 1px solid #90A5CE; - background-color: #F9FAFC; - z-index: 10001; - padding-top: 4px; - padding-bottom: 4px; - -moz-border-radius: 4px; - -webkit-border-top-left-radius: 4px; - -webkit-border-top-right-radius: 4px; - -webkit-border-bottom-left-radius: 4px; - -webkit-border-bottom-right-radius: 4px; - -webkit-box-shadow: 5px 5px 5px rgba(0, 0, 0, 0.15); -} - -.SelectItem { - font: 8pt Arial, Verdana, sans-serif; - padding-left: 2px; - padding-right: 12px; - border: 0px; -} - -span.SelectionMark { - margin-right: 4px; - font-family: monospace; - outline-style: none; - text-decoration: none; -} - -a.SelectItem { - display: block; - outline-style: none; - color: #000000; - text-decoration: none; - padding-left: 6px; - padding-right: 12px; -} - -a.SelectItem:focus, -a.SelectItem:active { - color: #000000; - outline-style: none; - text-decoration: none; -} - -a.SelectItem:hover { - color: #FFFFFF; - background-color: #3D578C; - outline-style: none; - text-decoration: none; - cursor: pointer; - display: block; -} - -/*---------------- Search results window */ - -iframe#MSearchResults { - width: 60ex; - height: 15em; -} - -#MSearchResultsWindow { - display: none; - position: absolute; - left: 0; top: 0; - border: 1px solid #000; - background-color: #EEF1F7; - z-index:10000; -} - -/* ----------------------------------- */ - - -#SRIndex { - clear:both; - padding-bottom: 15px; -} - -.SREntry { - font-size: 10pt; - padding-left: 1ex; -} - -.SRPage .SREntry { - font-size: 8pt; - padding: 1px 5px; -} - -body.SRPage { - margin: 5px 2px; -} - -.SRChildren { - padding-left: 3ex; padding-bottom: .5em -} - -.SRPage .SRChildren { - display: none; -} - -.SRSymbol { - font-weight: bold; - color: #425E97; - font-family: Arial, Verdana, sans-serif; - text-decoration: none; - outline: none; -} - -a.SRScope { - display: block; - color: #425E97; - font-family: Arial, Verdana, sans-serif; - text-decoration: none; - outline: none; -} - -a.SRSymbol:focus, a.SRSymbol:active, -a.SRScope:focus, a.SRScope:active { - text-decoration: underline; -} - -span.SRScope { - padding-left: 4px; - font-family: Arial, Verdana, sans-serif; -} - -.SRPage .SRStatus { - padding: 2px 5px; - font-size: 8pt; - font-style: italic; - font-family: Arial, Verdana, sans-serif; -} - -.SRResult { - display: none; -} - -div.searchresults { - margin-left: 10px; - margin-right: 10px; -} - -/*---------------- External search page results */ - -.searchresult { - background-color: #F0F3F8; -} - -.pages b { - color: white; - padding: 5px 5px 3px 5px; - background-image: url("../tab_a.png"); - background-repeat: repeat-x; - text-shadow: 0 1px 1px #000000; -} - -.pages { - line-height: 17px; - margin-left: 4px; - text-decoration: none; -} - -.hl { - font-weight: bold; -} - -#searchresults { - margin-bottom: 20px; -} - -.searchpages { - margin-top: 10px; -} - diff --git a/docs/search/search.js b/docs/search/search.js deleted file mode 100644 index fb226f7..0000000 --- a/docs/search/search.js +++ /dev/null @@ -1,816 +0,0 @@ -/* - @licstart The following is the entire license notice for the JavaScript code in this file. - - The MIT License (MIT) - - Copyright (C) 1997-2020 by Dimitri van Heesch - - 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. - - @licend The above is the entire license notice for the JavaScript code in this file - */ -function convertToId(search) -{ - var result = ''; - for (i=0;i do a search - { - this.Search(); - } - } - - this.OnSearchSelectKey = function(evt) - { - var e = (evt) ? evt : window.event; // for IE - if (e.keyCode==40 && this.searchIndex0) // Up - { - this.searchIndex--; - this.OnSelectItem(this.searchIndex); - } - else if (e.keyCode==13 || e.keyCode==27) - { - this.OnSelectItem(this.searchIndex); - this.CloseSelectionWindow(); - this.DOMSearchField().focus(); - } - return false; - } - - // --------- Actions - - // Closes the results window. - this.CloseResultsWindow = function() - { - this.DOMPopupSearchResultsWindow().style.display = 'none'; - this.DOMSearchClose().style.display = 'none'; - this.Activate(false); - } - - this.CloseSelectionWindow = function() - { - this.DOMSearchSelectWindow().style.display = 'none'; - } - - // Performs a search. - this.Search = function() - { - this.keyTimeout = 0; - - // strip leading whitespace - var searchValue = this.DOMSearchField().value.replace(/^ +/, ""); - - var code = searchValue.toLowerCase().charCodeAt(0); - var idxChar = searchValue.substr(0, 1).toLowerCase(); - if ( 0xD800 <= code && code <= 0xDBFF && searchValue > 1) // surrogate pair - { - idxChar = searchValue.substr(0, 2); - } - - var resultsPage; - var resultsPageWithSearch; - var hasResultsPage; - - var idx = indexSectionsWithContent[this.searchIndex].indexOf(idxChar); - if (idx!=-1) - { - var hexCode=idx.toString(16); - resultsPage = this.resultsPath + '/' + indexSectionNames[this.searchIndex] + '_' + hexCode + this.extension; - resultsPageWithSearch = resultsPage+'?'+escape(searchValue); - hasResultsPage = true; - } - else // nothing available for this search term - { - resultsPage = this.resultsPath + '/nomatches' + this.extension; - resultsPageWithSearch = resultsPage; - hasResultsPage = false; - } - - window.frames.MSearchResults.location = resultsPageWithSearch; - var domPopupSearchResultsWindow = this.DOMPopupSearchResultsWindow(); - - if (domPopupSearchResultsWindow.style.display!='block') - { - var domSearchBox = this.DOMSearchBox(); - this.DOMSearchClose().style.display = 'inline-block'; - if (this.insideFrame) - { - var domPopupSearchResults = this.DOMPopupSearchResults(); - domPopupSearchResultsWindow.style.position = 'relative'; - domPopupSearchResultsWindow.style.display = 'block'; - var width = document.body.clientWidth - 8; // the -8 is for IE :-( - domPopupSearchResultsWindow.style.width = width + 'px'; - domPopupSearchResults.style.width = width + 'px'; - } - else - { - var domPopupSearchResults = this.DOMPopupSearchResults(); - var left = getXPos(domSearchBox) + 150; // domSearchBox.offsetWidth; - var top = getYPos(domSearchBox) + 20; // domSearchBox.offsetHeight + 1; - domPopupSearchResultsWindow.style.display = 'block'; - left -= domPopupSearchResults.offsetWidth; - domPopupSearchResultsWindow.style.top = top + 'px'; - domPopupSearchResultsWindow.style.left = left + 'px'; - } - } - - this.lastSearchValue = searchValue; - this.lastResultsPage = resultsPage; - } - - // -------- Activation Functions - - // Activates or deactivates the search panel, resetting things to - // their default values if necessary. - this.Activate = function(isActive) - { - if (isActive || // open it - this.DOMPopupSearchResultsWindow().style.display == 'block' - ) - { - this.DOMSearchBox().className = 'MSearchBoxActive'; - - var searchField = this.DOMSearchField(); - - if (searchField.value == this.searchLabel) // clear "Search" term upon entry - { - searchField.value = ''; - this.searchActive = true; - } - } - else if (!isActive) // directly remove the panel - { - this.DOMSearchBox().className = 'MSearchBoxInactive'; - this.DOMSearchField().value = this.searchLabel; - this.searchActive = false; - this.lastSearchValue = '' - this.lastResultsPage = ''; - } - } -} - -// ----------------------------------------------------------------------- - -// The class that handles everything on the search results page. -function SearchResults(name) -{ - // The number of matches from the last run of . - this.lastMatchCount = 0; - this.lastKey = 0; - this.repeatOn = false; - - // Toggles the visibility of the passed element ID. - this.FindChildElement = function(id) - { - var parentElement = document.getElementById(id); - var element = parentElement.firstChild; - - while (element && element!=parentElement) - { - if (element.nodeName.toLowerCase() == 'div' && element.className == 'SRChildren') - { - return element; - } - - if (element.nodeName.toLowerCase() == 'div' && element.hasChildNodes()) - { - element = element.firstChild; - } - else if (element.nextSibling) - { - element = element.nextSibling; - } - else - { - do - { - element = element.parentNode; - } - while (element && element!=parentElement && !element.nextSibling); - - if (element && element!=parentElement) - { - element = element.nextSibling; - } - } - } - } - - this.Toggle = function(id) - { - var element = this.FindChildElement(id); - if (element) - { - if (element.style.display == 'block') - { - element.style.display = 'none'; - } - else - { - element.style.display = 'block'; - } - } - } - - // Searches for the passed string. If there is no parameter, - // it takes it from the URL query. - // - // Always returns true, since other documents may try to call it - // and that may or may not be possible. - this.Search = function(search) - { - if (!search) // get search word from URL - { - search = window.location.search; - search = search.substring(1); // Remove the leading '?' - search = unescape(search); - } - - search = search.replace(/^ +/, ""); // strip leading spaces - search = search.replace(/ +$/, ""); // strip trailing spaces - search = search.toLowerCase(); - search = convertToId(search); - - var resultRows = document.getElementsByTagName("div"); - var matches = 0; - - var i = 0; - while (i < resultRows.length) - { - var row = resultRows.item(i); - if (row.className == "SRResult") - { - var rowMatchName = row.id.toLowerCase(); - rowMatchName = rowMatchName.replace(/^sr\d*_/, ''); // strip 'sr123_' - - if (search.length<=rowMatchName.length && - rowMatchName.substr(0, search.length)==search) - { - row.style.display = 'block'; - matches++; - } - else - { - row.style.display = 'none'; - } - } - i++; - } - document.getElementById("Searching").style.display='none'; - if (matches == 0) // no results - { - document.getElementById("NoMatches").style.display='block'; - } - else // at least one result - { - document.getElementById("NoMatches").style.display='none'; - } - this.lastMatchCount = matches; - return true; - } - - // return the first item with index index or higher that is visible - this.NavNext = function(index) - { - var focusItem; - while (1) - { - var focusName = 'Item'+index; - focusItem = document.getElementById(focusName); - if (focusItem && focusItem.parentNode.parentNode.style.display=='block') - { - break; - } - else if (!focusItem) // last element - { - break; - } - focusItem=null; - index++; - } - return focusItem; - } - - this.NavPrev = function(index) - { - var focusItem; - while (1) - { - var focusName = 'Item'+index; - focusItem = document.getElementById(focusName); - if (focusItem && focusItem.parentNode.parentNode.style.display=='block') - { - break; - } - else if (!focusItem) // last element - { - break; - } - focusItem=null; - index--; - } - return focusItem; - } - - this.ProcessKeys = function(e) - { - if (e.type == "keydown") - { - this.repeatOn = false; - this.lastKey = e.keyCode; - } - else if (e.type == "keypress") - { - if (!this.repeatOn) - { - if (this.lastKey) this.repeatOn = true; - return false; // ignore first keypress after keydown - } - } - else if (e.type == "keyup") - { - this.lastKey = 0; - this.repeatOn = false; - } - return this.lastKey!=0; - } - - this.Nav = function(evt,itemIndex) - { - var e = (evt) ? evt : window.event; // for IE - if (e.keyCode==13) return true; - if (!this.ProcessKeys(e)) return false; - - if (this.lastKey==38) // Up - { - var newIndex = itemIndex-1; - var focusItem = this.NavPrev(newIndex); - if (focusItem) - { - var child = this.FindChildElement(focusItem.parentNode.parentNode.id); - if (child && child.style.display == 'block') // children visible - { - var n=0; - var tmpElem; - while (1) // search for last child - { - tmpElem = document.getElementById('Item'+newIndex+'_c'+n); - if (tmpElem) - { - focusItem = tmpElem; - } - else // found it! - { - break; - } - n++; - } - } - } - if (focusItem) - { - focusItem.focus(); - } - else // return focus to search field - { - parent.document.getElementById("MSearchField").focus(); - } - } - else if (this.lastKey==40) // Down - { - var newIndex = itemIndex+1; - var focusItem; - var item = document.getElementById('Item'+itemIndex); - var elem = this.FindChildElement(item.parentNode.parentNode.id); - if (elem && elem.style.display == 'block') // children visible - { - focusItem = document.getElementById('Item'+itemIndex+'_c0'); - } - if (!focusItem) focusItem = this.NavNext(newIndex); - if (focusItem) focusItem.focus(); - } - else if (this.lastKey==39) // Right - { - var item = document.getElementById('Item'+itemIndex); - var elem = this.FindChildElement(item.parentNode.parentNode.id); - if (elem) elem.style.display = 'block'; - } - else if (this.lastKey==37) // Left - { - var item = document.getElementById('Item'+itemIndex); - var elem = this.FindChildElement(item.parentNode.parentNode.id); - if (elem) elem.style.display = 'none'; - } - else if (this.lastKey==27) // Escape - { - parent.searchBox.CloseResultsWindow(); - parent.document.getElementById("MSearchField").focus(); - } - else if (this.lastKey==13) // Enter - { - return true; - } - return false; - } - - this.NavChild = function(evt,itemIndex,childIndex) - { - var e = (evt) ? evt : window.event; // for IE - if (e.keyCode==13) return true; - if (!this.ProcessKeys(e)) return false; - - if (this.lastKey==38) // Up - { - if (childIndex>0) - { - var newIndex = childIndex-1; - document.getElementById('Item'+itemIndex+'_c'+newIndex).focus(); - } - else // already at first child, jump to parent - { - document.getElementById('Item'+itemIndex).focus(); - } - } - else if (this.lastKey==40) // Down - { - var newIndex = childIndex+1; - var elem = document.getElementById('Item'+itemIndex+'_c'+newIndex); - if (!elem) // last child, jump to parent next parent - { - elem = this.NavNext(itemIndex+1); - } - if (elem) - { - elem.focus(); - } - } - else if (this.lastKey==27) // Escape - { - parent.searchBox.CloseResultsWindow(); - parent.document.getElementById("MSearchField").focus(); - } - else if (this.lastKey==13) // Enter - { - return true; - } - return false; - } -} - -function setKeyActions(elem,action) -{ - elem.setAttribute('onkeydown',action); - elem.setAttribute('onkeypress',action); - elem.setAttribute('onkeyup',action); -} - -function setClassAttr(elem,attr) -{ - elem.setAttribute('class',attr); - elem.setAttribute('className',attr); -} - -function createResults() -{ - var results = document.getElementById("SRResults"); - for (var e=0; e(R!W8j_r#qQ#gnr4kAxdU#F0+OBry$Z+ z_0PMi;P|#{d%mw(dnw=jM%@$onTJa%@6Nm3`;2S#nwtVFJI#`U@2Q@@JCCctagvF- z8H=anvo~dTmJ2YA%wA6IHRv%{vxvUm|R)kgZeo zmX%Zb;mpflGZdXCTAgit`||AFzkI#z&(3d4(htA?U2FOL4WF6wY&TB#n3n*I4+hl| z*NBpo#FA92vEu822WQ%mvv4FO#qs` BFGc_W diff --git a/docs/search/search_r.png b/docs/search/search_r.png deleted file mode 100644 index 1af5d21ee13e070d7600f1c4657fde843b953a69..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 553 zcmeAS@N?(olHy`uVBq!ia0vp^LO?9c!2%@BXHTsJQY`6?zK#qG8~eHcB(ehe3dtTp zz6=bxGZ+|(`xqD=STHa&U1eaXVrO7DwS|Gf*oA>XrmV$GYcEhOQT(QLuS{~ooZ2P@v=Xc@RKW@Irliv8_;wroU0*)0O?temdsA~70jrdux+`@W7 z-N(<(C)L?hOO?KV{>8(jC{hpKsws)#Fh zvsO>IB+gb@b+rGWaO&!a9Z{!U+fV*s7TS>fdt&j$L%^U@Epd$~Nl7e8wMs5Z1yT$~ z28I^8hDN#u<{^fLRz?<9hUVG^237_Jy7tbuQ8eV{r(~v8;?@w8^gA7>fx*+&&t;uc GLK6VEQpiUD diff --git a/docs/search/searchdata.js b/docs/search/searchdata.js deleted file mode 100644 index d558729..0000000 --- a/docs/search/searchdata.js +++ /dev/null @@ -1,33 +0,0 @@ -var indexSectionsWithContent = -{ - 0: "bdegisv", - 1: "v", - 2: "s", - 3: "bdegisv", - 4: "v", - 5: "v", - 6: "s" -}; - -var indexSectionNames = -{ - 0: "all", - 1: "classes", - 2: "files", - 3: "functions", - 4: "enums", - 5: "defines", - 6: "pages" -}; - -var indexSectionLabels = -{ - 0: "All", - 1: "Classes", - 2: "Files", - 3: "Functions", - 4: "Enumerations", - 5: "Macros", - 6: "Pages" -}; - diff --git a/docs/splitbar.png b/docs/splitbar.png deleted file mode 100644 index fe895f2c58179b471a22d8320b39a4bd7312ec8e..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 314 zcmeAS@N?(olHy`uVBq!ia0vp^Yzz!63>-{AmhX=Jf(#6djGiuzAr*{o?=JLmPLyc> z_*`QK&+BH@jWrYJ7>r6%keRM@)Qyv8R=enp0jiI>aWlGyB58O zFVR20d+y`K7vDw(hJF3;>dD*3-?v=<8M)@x|EEGLnJsniYK!2U1 Y!`|5biEc?d1`HDhPgg&ebxsLQ02F6;9RL6T diff --git a/docs/sync_off.png b/docs/sync_off.png deleted file mode 100644 index 3b443fc62892114406e3d399421b2a881b897acc..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 853 zcmV-b1FHOqP)oT|#XixUYy%lpuf3i8{fX!o zUyDD0jOrAiT^tq>fLSOOABs-#u{dV^F$b{L9&!2=9&RmV;;8s^x&UqB$PCj4FdKbh zoB1WTskPUPu05XzFbA}=KZ-GP1fPpAfSs>6AHb12UlR%-i&uOlTpFNS7{jm@mkU1V zh`nrXr~+^lsV-s1dkZOaI|kYyVj3WBpPCY{n~yd%u%e+d=f%`N0FItMPtdgBb@py; zq@v6NVArhyTC7)ULw-Jy8y42S1~4n(3LkrW8mW(F-4oXUP3E`e#g**YyqI7h-J2zK zK{m9##m4ri!7N>CqQqCcnI3hqo1I;Yh&QLNY4T`*ptiQGozK>FF$!$+84Z`xwmeMh zJ0WT+OH$WYFALEaGj2_l+#DC3t7_S`vHpSivNeFbP6+r50cO8iu)`7i%Z4BTPh@_m3Tk!nAm^)5Bqnr%Ov|Baunj#&RPtRuK& z4RGz|D5HNrW83-#ydk}tVKJrNmyYt-sTxLGlJY5nc&Re zU4SgHNPx8~Yxwr$bsju?4q&%T1874xxzq+_%?h8_ofw~(bld=o3iC)LUNR*BY%c0y zWd_jX{Y8`l%z+ol1$@Qa?Cy!(0CVIEeYpKZ`(9{z>3$CIe;pJDQk$m3p}$>xBm4lb zKo{4S)`wdU9Ba9jJbVJ0C=SOefZe%d$8=2r={nu<_^a3~>c#t_U6dye5)JrR(_a^E f@}b6j1K9lwFJq@>o)+Ry00000NkvXXu0mjfWa5j* diff --git a/docs/sync_on.png b/docs/sync_on.png deleted file mode 100644 index e08320fb64e6fa33b573005ed6d8fe294e19db76..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 845 zcmV-T1G4;yP)Y;xxyHF2B5Wzm| zOOGupOTn@c(JmBOl)e;XMNnZuiTJP>rM8<|Q`7I_))aP?*T)ow&n59{}X4$3Goat zgjs?*aasfbrokzG5cT4K=uG`E14xZl@z)F={P0Y^?$4t z>v!teRnNZym<6h{7sLyF1V0HsfEl+l6TrZpsfr1}luH~F7L}ktXu|*uVX^RG$L0`K zWs3j|0tIvVe(N%_?2{(iCPFGf#B6Hjy6o&}D$A%W%jfO8_W%ZO#-mh}EM$LMn7joJ z05dHr!5Y92g+31l<%i1(=L1a1pXX+OYnalY>31V4K}BjyRe3)9n#;-cCVRD_IG1fT zOKGeNY8q;TL@K{dj@D^scf&VCs*-Jb>8b>|`b*osv52-!A?BpbYtTQBns5EAU**$m zSnVSm(teh>tQi*S*A>#ySc=n;`BHz`DuG4&g4Kf8lLhca+zvZ7t7RflD6-i-mcK=M z!=^P$*u2)bkY5asG4gsss!Hn%u~>}kIW`vMs%lJLH+u*9<4PaV_c6U`KqWXQH%+Nu zTv41O(^ZVi@qhjQdG!fbZw&y+2o!iYymO^?ud3{P*HdoX83YV*Uu_HB=?U&W9%AU# z80}k1SS-CXTU7dcQlsm<^oYLxVSseqY6NO}dc`Nj?8vrhNuCdm@^{a3AQ_>6myOj+ z`1RsLUXF|dm|3k7s2jD(B{rzE>WI2scH8i1;=O5Cc9xB3^aJk%fQjqsu+kH#0=_5a z0nCE8@dbQa-|YIuUVvG0L_IwHMEhOj$Mj4Uq05 X8=0q~qBNan00000NkvXXu0mjfptF>5 diff --git a/docs/tab_a.png b/docs/tab_a.png deleted file mode 100644 index 3b725c41c5a527a3a3e40097077d0e206a681247..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 142 zcmeAS@N?(olHy`uVBq!ia0vp^j6kfy!2~3aiye;!QlXwMjv*C{Z|8b*H5dputLHD# z=<0|*y7z(Vor?d;H&?EG&cXR}?!j-Lm&u1OOI7AIF5&c)RFE;&p0MYK>*Kl@eiymD r@|NpwKX@^z+;{u_Z~trSBfrMKa%3`zocFjEXaR$#tDnm{r-UW|TZ1%4 diff --git a/docs/tab_b.png b/docs/tab_b.png deleted file mode 100644 index e2b4a8638cb3496a016eaed9e16ffc12846dea18..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 169 zcmeAS@N?(olHy`uVBq!ia0vp^j6kfy!2~3aiye;!QU#tajv*C{Z}0l@H7kg?K0Lnr z!j&C6_(~HV9oQ0Pa6x{-v0AGV_E?vLn=ZI-;YrdjIl`U`uzuDWSP?o#Dmo{%SgM#oan kX~E1%D-|#H#QbHoIja2U-MgvsK&LQxy85}Sb4q9e0Efg%P5=M^ diff --git a/docs/tabs.css b/docs/tabs.css deleted file mode 100644 index 85a0cd5..0000000 --- a/docs/tabs.css +++ /dev/null @@ -1 +0,0 @@ -.sm{position:relative;z-index:9999}.sm,.sm ul,.sm li{display:block;list-style:none;margin:0;padding:0;line-height:normal;direction:ltr;text-align:left;-webkit-tap-highlight-color:rgba(0,0,0,0)}.sm-rtl,.sm-rtl ul,.sm-rtl li{direction:rtl;text-align:right}.sm>li>h1,.sm>li>h2,.sm>li>h3,.sm>li>h4,.sm>li>h5,.sm>li>h6{margin:0;padding:0}.sm ul{display:none}.sm li,.sm a{position:relative}.sm a{display:block}.sm a.disabled{cursor:not-allowed}.sm:after{content:"\00a0";display:block;height:0;font:0/0 serif;clear:both;visibility:hidden;overflow:hidden}.sm,.sm *,.sm *:before,.sm *:after{-moz-box-sizing:border-box;-webkit-box-sizing:border-box;box-sizing:border-box}.sm-dox{background-image:url("tab_b.png")}.sm-dox a,.sm-dox a:focus,.sm-dox a:hover,.sm-dox a:active{padding:0 12px;padding-right:43px;font-family:"Lucida Grande","Geneva","Helvetica",Arial,sans-serif;font-size:13px;font-weight:bold;line-height:36px;text-decoration:none;text-shadow:0 1px 1px rgba(255,255,255,0.9);color:#283a5d;outline:0}.sm-dox a:hover{background-image:url("tab_a.png");background-repeat:repeat-x;color:white;text-shadow:0 1px 1px black}.sm-dox a.current{color:#d23600}.sm-dox a.disabled{color:#bbb}.sm-dox a span.sub-arrow{position:absolute;top:50%;margin-top:-14px;left:auto;right:3px;width:28px;height:28px;overflow:hidden;font:bold 12px/28px monospace!important;text-align:center;text-shadow:none;background:rgba(255,255,255,0.5);-moz-border-radius:5px;-webkit-border-radius:5px;border-radius:5px}.sm-dox a.highlighted span.sub-arrow:before{display:block;content:'-'}.sm-dox>li:first-child>a,.sm-dox>li:first-child>:not(ul) a{-moz-border-radius:5px 5px 0 0;-webkit-border-radius:5px;border-radius:5px 5px 0 0}.sm-dox>li:last-child>a,.sm-dox>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul{-moz-border-radius:0 0 5px 5px;-webkit-border-radius:0;border-radius:0 0 5px 5px}.sm-dox>li:last-child>a.highlighted,.sm-dox>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a.highlighted{-moz-border-radius:0;-webkit-border-radius:0;border-radius:0}.sm-dox ul{background:rgba(162,162,162,0.1)}.sm-dox ul a,.sm-dox ul a:focus,.sm-dox ul a:hover,.sm-dox ul a:active{font-size:12px;border-left:8px solid transparent;line-height:36px;text-shadow:none;background-color:white;background-image:none}.sm-dox ul a:hover{background-image:url("tab_a.png");background-repeat:repeat-x;color:white;text-shadow:0 1px 1px black}.sm-dox ul ul a,.sm-dox ul ul a:hover,.sm-dox ul ul a:focus,.sm-dox ul ul a:active{border-left:16px solid transparent}.sm-dox ul ul ul a,.sm-dox ul ul ul a:hover,.sm-dox ul ul ul a:focus,.sm-dox ul ul ul a:active{border-left:24px solid transparent}.sm-dox ul ul ul ul a,.sm-dox ul ul ul ul a:hover,.sm-dox ul ul ul ul a:focus,.sm-dox ul ul ul ul a:active{border-left:32px solid transparent}.sm-dox ul ul ul ul ul a,.sm-dox ul ul ul ul ul a:hover,.sm-dox ul ul ul ul ul a:focus,.sm-dox ul ul ul ul ul a:active{border-left:40px solid transparent}@media(min-width:768px){.sm-dox ul{position:absolute;width:12em}.sm-dox li{float:left}.sm-dox.sm-rtl li{float:right}.sm-dox ul li,.sm-dox.sm-rtl ul li,.sm-dox.sm-vertical li{float:none}.sm-dox a{white-space:nowrap}.sm-dox ul a,.sm-dox.sm-vertical a{white-space:normal}.sm-dox .sm-nowrap>li>a,.sm-dox .sm-nowrap>li>:not(ul) a{white-space:nowrap}.sm-dox{padding:0 10px;background-image:url("tab_b.png");line-height:36px}.sm-dox a span.sub-arrow{top:50%;margin-top:-2px;right:12px;width:0;height:0;border-width:4px;border-style:solid dashed dashed dashed;border-color:#283a5d transparent transparent transparent;background:transparent;-moz-border-radius:0;-webkit-border-radius:0;border-radius:0}.sm-dox a,.sm-dox a:focus,.sm-dox a:active,.sm-dox a:hover,.sm-dox a.highlighted{padding:0 12px;background-image:url("tab_s.png");background-repeat:no-repeat;background-position:right;-moz-border-radius:0!important;-webkit-border-radius:0;border-radius:0!important}.sm-dox a:hover{background-image:url("tab_a.png");background-repeat:repeat-x;color:white;text-shadow:0 1px 1px black}.sm-dox a:hover span.sub-arrow{border-color:white transparent transparent transparent}.sm-dox a.has-submenu{padding-right:24px}.sm-dox li{border-top:0}.sm-dox>li>ul:before,.sm-dox>li>ul:after{content:'';position:absolute;top:-18px;left:30px;width:0;height:0;overflow:hidden;border-width:9px;border-style:dashed dashed solid dashed;border-color:transparent transparent #bbb transparent}.sm-dox>li>ul:after{top:-16px;left:31px;border-width:8px;border-color:transparent transparent #fff transparent}.sm-dox ul{border:1px solid #bbb;padding:5px 0;background:#fff;-moz-border-radius:5px!important;-webkit-border-radius:5px;border-radius:5px!important;-moz-box-shadow:0 5px 9px rgba(0,0,0,0.2);-webkit-box-shadow:0 5px 9px rgba(0,0,0,0.2);box-shadow:0 5px 9px rgba(0,0,0,0.2)}.sm-dox ul a span.sub-arrow{right:8px;top:50%;margin-top:-5px;border-width:5px;border-color:transparent transparent transparent #555;border-style:dashed dashed dashed solid}.sm-dox ul a,.sm-dox ul a:hover,.sm-dox ul a:focus,.sm-dox ul a:active,.sm-dox ul a.highlighted{color:#555;background-image:none;border:0!important;color:#555;background-image:none}.sm-dox ul a:hover{background-image:url("tab_a.png");background-repeat:repeat-x;color:white;text-shadow:0 1px 1px black}.sm-dox ul a:hover span.sub-arrow{border-color:transparent transparent transparent white}.sm-dox span.scroll-up,.sm-dox span.scroll-down{position:absolute;display:none;visibility:hidden;overflow:hidden;background:#fff;height:36px}.sm-dox span.scroll-up:hover,.sm-dox span.scroll-down:hover{background:#eee}.sm-dox span.scroll-up:hover span.scroll-up-arrow,.sm-dox span.scroll-up:hover span.scroll-down-arrow{border-color:transparent transparent #d23600 transparent}.sm-dox span.scroll-down:hover span.scroll-down-arrow{border-color:#d23600 transparent transparent transparent}.sm-dox span.scroll-up-arrow,.sm-dox span.scroll-down-arrow{position:absolute;top:0;left:50%;margin-left:-6px;width:0;height:0;overflow:hidden;border-width:6px;border-style:dashed dashed solid dashed;border-color:transparent transparent #555 transparent}.sm-dox span.scroll-down-arrow{top:8px;border-style:solid dashed dashed dashed;border-color:#555 transparent transparent transparent}.sm-dox.sm-rtl a.has-submenu{padding-right:12px;padding-left:24px}.sm-dox.sm-rtl a span.sub-arrow{right:auto;left:12px}.sm-dox.sm-rtl.sm-vertical a.has-submenu{padding:10px 20px}.sm-dox.sm-rtl.sm-vertical a span.sub-arrow{right:auto;left:8px;border-style:dashed solid dashed dashed;border-color:transparent #555 transparent transparent}.sm-dox.sm-rtl>li>ul:before{left:auto;right:30px}.sm-dox.sm-rtl>li>ul:after{left:auto;right:31px}.sm-dox.sm-rtl ul a.has-submenu{padding:10px 20px!important}.sm-dox.sm-rtl ul a span.sub-arrow{right:auto;left:8px;border-style:dashed solid dashed dashed;border-color:transparent #555 transparent transparent}.sm-dox.sm-vertical{padding:10px 0;-moz-border-radius:5px;-webkit-border-radius:5px;border-radius:5px}.sm-dox.sm-vertical a{padding:10px 20px}.sm-dox.sm-vertical a:hover,.sm-dox.sm-vertical a:focus,.sm-dox.sm-vertical a:active,.sm-dox.sm-vertical a.highlighted{background:#fff}.sm-dox.sm-vertical a.disabled{background-image:url("tab_b.png")}.sm-dox.sm-vertical a span.sub-arrow{right:8px;top:50%;margin-top:-5px;border-width:5px;border-style:dashed dashed dashed solid;border-color:transparent transparent transparent #555}.sm-dox.sm-vertical>li>ul:before,.sm-dox.sm-vertical>li>ul:after{display:none}.sm-dox.sm-vertical ul a{padding:10px 20px}.sm-dox.sm-vertical ul a:hover,.sm-dox.sm-vertical ul a:focus,.sm-dox.sm-vertical ul a:active,.sm-dox.sm-vertical ul a.highlighted{background:#eee}.sm-dox.sm-vertical ul a.disabled{background:#fff}} \ No newline at end of file From b27afc404db760ca68c5d0229f8abd0e8025fcca Mon Sep 17 00:00:00 2001 From: Kirk Benell Date: Sat, 12 Jul 2025 13:09:32 -0600 Subject: [PATCH 11/25] put in place the current doxygen setup for sparkfun repos --- .gitmodules | 3 + docs/doxygen/doxygen-awesome-css | 1 + docs/doxygen/doxygen-config | 2818 +++++++++++++++++++++++ docs/doxygen/doxygen-custom/custom.css | 21 + docs/doxygen/doxygen-custom/header.html | 126 + docs/images/sfe_flame.png | Bin 0 -> 3832 bytes 6 files changed, 2969 insertions(+) create mode 100644 .gitmodules create mode 160000 docs/doxygen/doxygen-awesome-css create mode 100644 docs/doxygen/doxygen-config create mode 100644 docs/doxygen/doxygen-custom/custom.css create mode 100644 docs/doxygen/doxygen-custom/header.html create mode 100644 docs/images/sfe_flame.png diff --git a/.gitmodules b/.gitmodules new file mode 100644 index 0000000..a8d0052 --- /dev/null +++ b/.gitmodules @@ -0,0 +1,3 @@ +[submodule "docs/doxygen/doxygen-awesome-css"] + path = docs/doxygen/doxygen-awesome-css + url = https://github.com/jothepro/doxygen-awesome-css.git diff --git a/docs/doxygen/doxygen-awesome-css b/docs/doxygen/doxygen-awesome-css new file mode 160000 index 0000000..568f56c --- /dev/null +++ b/docs/doxygen/doxygen-awesome-css @@ -0,0 +1 @@ +Subproject commit 568f56cde6ac78b6dfcc14acd380b2e745c301ea diff --git a/docs/doxygen/doxygen-config b/docs/doxygen/doxygen-config new file mode 100644 index 0000000..15d3764 --- /dev/null +++ b/docs/doxygen/doxygen-config @@ -0,0 +1,2818 @@ +# Doxyfile 1.10.0 + +# This file describes the settings to be used by the documentation system +# doxygen (www.doxygen.org) for a project. +# +# All text after a double hash (##) is considered a comment and is placed in +# front of the TAG it is preceding. +# +# All text after a single hash (#) is considered a comment and will be ignored. +# The format is: +# TAG = value [value, ...] +# For lists, items can also be appended using: +# TAG += value [value, ...] +# Values that contain spaces should be placed between quotes (\" \"). +# +# Note: +# +# Use doxygen to compare the used configuration file with the template +# configuration file: +# doxygen -x [configFile] +# Use doxygen to compare the used configuration file with the template +# configuration file without replacing the environment variables or CMake type +# replacement variables: +# doxygen -x_noenv [configFile] + +#--------------------------------------------------------------------------- +# Project related configuration options +#--------------------------------------------------------------------------- + +# This tag specifies the encoding used for all characters in the configuration +# file that follow. The default is UTF-8 which is also the encoding used for all +# text before the first occurrence of this tag. Doxygen uses libiconv (or the +# iconv built into libc) for the transcoding. See +# https://www.gnu.org/software/libiconv/ for the list of possible encodings. +# The default value is: UTF-8. + +DOXYFILE_ENCODING = UTF-8 + +# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by +# double-quotes, unless you are using Doxywizard) that should identify the +# project for which the documentation is generated. This name is used in the +# title of most generated pages and in a few other places. +# The default value is: My Project. + +PROJECT_NAME = "SparkFun Ambient Light Sensor - VEML7700" + +# The PROJECT_NUMBER tag can be used to enter a project or revision number. This +# could be handy for archiving the generated documentation or if some version +# control system is used. + +# PROJECT_NUMBER = + +# Using the PROJECT_BRIEF tag one can provide an optional one line description +# for a project that appears at the top of each page and should give viewer a +# quick idea about the purpose of the project. Keep the description short. + +PROJECT_BRIEF = "Library for the SparkFun Ambient Light Sensor - VEML7700" + +# With the PROJECT_LOGO tag one can specify a logo or an icon that is included +# in the documentation. The maximum height of the logo should not exceed 55 +# pixels and the maximum width should not exceed 200 pixels. Doxygen will copy +# the logo to the output directory. + +PROJECT_LOGO = ./docs/images/sfe_flame.png + +# With the PROJECT_ICON tag one can specify an icon that is included in the tabs +# when the HTML document is shown. Doxygen will copy the logo to the output +# directory. + +PROJECT_ICON = + +# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path +# into which the generated documentation will be written. If a relative path is +# entered, it will be relative to the location where doxygen was started. If +# left blank the current directory will be used. + +OUTPUT_DIRECTORY = ./docs + +# If the CREATE_SUBDIRS tag is set to YES then doxygen will create up to 4096 +# sub-directories (in 2 levels) under the output directory of each output format +# and will distribute the generated files over these directories. Enabling this +# option can be useful when feeding doxygen a huge amount of source files, where +# putting all generated files in the same directory would otherwise causes +# performance problems for the file system. Adapt CREATE_SUBDIRS_LEVEL to +# control the number of sub-directories. +# The default value is: NO. + +CREATE_SUBDIRS = NO + +# Controls the number of sub-directories that will be created when +# CREATE_SUBDIRS tag is set to YES. Level 0 represents 16 directories, and every +# level increment doubles the number of directories, resulting in 4096 +# directories at level 8 which is the default and also the maximum value. The +# sub-directories are organized in 2 levels, the first level always has a fixed +# number of 16 directories. +# Minimum value: 0, maximum value: 8, default value: 8. +# This tag requires that the tag CREATE_SUBDIRS is set to YES. + +CREATE_SUBDIRS_LEVEL = 8 + +# If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII +# characters to appear in the names of generated files. If set to NO, non-ASCII +# characters will be escaped, for example _xE3_x81_x84 will be used for Unicode +# U+3044. +# The default value is: NO. + +ALLOW_UNICODE_NAMES = NO + +# The OUTPUT_LANGUAGE tag is used to specify the language in which all +# documentation generated by doxygen is written. Doxygen will use this +# information to generate all constant output in the proper language. +# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Bulgarian, +# Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish, Dutch, English +# (United States), Esperanto, Farsi (Persian), Finnish, French, German, Greek, +# Hindi, Hungarian, Indonesian, Italian, Japanese, Japanese-en (Japanese with +# English messages), Korean, Korean-en (Korean with English messages), Latvian, +# Lithuanian, Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, +# Romanian, Russian, Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, +# Swedish, Turkish, Ukrainian and Vietnamese. +# The default value is: English. + +OUTPUT_LANGUAGE = English + +# If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member +# descriptions after the members that are listed in the file and class +# documentation (similar to Javadoc). Set to NO to disable this. +# The default value is: YES. + +BRIEF_MEMBER_DESC = YES + +# If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief +# description of a member or function before the detailed description +# +# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the +# brief descriptions will be completely suppressed. +# The default value is: YES. + +REPEAT_BRIEF = YES + +# This tag implements a quasi-intelligent brief description abbreviator that is +# used to form the text in various listings. Each string in this list, if found +# as the leading text of the brief description, will be stripped from the text +# and the result, after processing the whole list, is used as the annotated +# text. Otherwise, the brief description is used as-is. If left blank, the +# following values are used ($name is automatically replaced with the name of +# the entity):The $name class, The $name widget, The $name file, is, provides, +# specifies, contains, represents, a, an and the. + +ABBREVIATE_BRIEF = "The $name class" \ + "The $name widget" \ + "The $name file" \ + is \ + provides \ + specifies \ + contains \ + represents \ + a \ + an \ + the + +# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then +# doxygen will generate a detailed section even if there is only a brief +# description. +# The default value is: NO. + +ALWAYS_DETAILED_SEC = YES + +# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all +# inherited members of a class in the documentation of that class as if those +# members were ordinary class members. Constructors, destructors and assignment +# operators of the base classes will not be shown. +# The default value is: NO. + +INLINE_INHERITED_MEMB = YES + +# If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path +# before files name in the file list and in the header files. If set to NO the +# shortest path that makes the file name unique will be used +# The default value is: YES. + +FULL_PATH_NAMES = YES + +# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path. +# Stripping is only done if one of the specified strings matches the left-hand +# part of the path. The tag can be used to show relative paths in the file list. +# If left blank the directory from which doxygen is run is used as the path to +# strip. +# +# Note that you can specify absolute paths here, but also relative paths, which +# will be relative from the directory where doxygen is started. +# This tag requires that the tag FULL_PATH_NAMES is set to YES. + +STRIP_FROM_PATH = + +# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the +# path mentioned in the documentation of a class, which tells the reader which +# header file to include in order to use a class. If left blank only the name of +# the header file containing the class definition is used. Otherwise one should +# specify the list of include paths that are normally passed to the compiler +# using the -I flag. + +STRIP_FROM_INC_PATH = + +# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but +# less readable) file names. This can be useful is your file systems doesn't +# support long names like on DOS, Mac, or CD-ROM. +# The default value is: NO. + +SHORT_NAMES = NO + +# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the +# first line (until the first dot) of a Javadoc-style comment as the brief +# description. If set to NO, the Javadoc-style will behave just like regular Qt- +# style comments (thus requiring an explicit @brief command for a brief +# description.) +# The default value is: NO. + +JAVADOC_AUTOBRIEF = NO + +# If the JAVADOC_BANNER tag is set to YES then doxygen will interpret a line +# such as +# /*************** +# as being the beginning of a Javadoc-style comment "banner". If set to NO, the +# Javadoc-style will behave just like regular comments and it will not be +# interpreted by doxygen. +# The default value is: NO. + +JAVADOC_BANNER = NO + +# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first +# line (until the first dot) of a Qt-style comment as the brief description. If +# set to NO, the Qt-style will behave just like regular Qt-style comments (thus +# requiring an explicit \brief command for a brief description.) +# The default value is: NO. + +QT_AUTOBRIEF = NO + +# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a +# multi-line C++ special comment block (i.e. a block of //! or /// comments) as +# a brief description. This used to be the default behavior. The new default is +# to treat a multi-line C++ comment block as a detailed description. Set this +# tag to YES if you prefer the old behavior instead. +# +# Note that setting this tag to YES also means that rational rose comments are +# not recognized any more. +# The default value is: NO. + +MULTILINE_CPP_IS_BRIEF = NO + +# By default Python docstrings are displayed as preformatted text and doxygen's +# special commands cannot be used. By setting PYTHON_DOCSTRING to NO the +# doxygen's special commands can be used and the contents of the docstring +# documentation blocks is shown as doxygen documentation. +# The default value is: YES. + +PYTHON_DOCSTRING = YES + +# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the +# documentation from any documented member that it re-implements. +# The default value is: YES. + +INHERIT_DOCS = YES + +# If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new +# page for each member. If set to NO, the documentation of a member will be part +# of the file/class/namespace that contains it. +# The default value is: NO. + +SEPARATE_MEMBER_PAGES = NO + +# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen +# uses this value to replace tabs by spaces in code fragments. +# Minimum value: 1, maximum value: 16, default value: 4. + +TAB_SIZE = 4 + +# This tag can be used to specify a number of aliases that act as commands in +# the documentation. An alias has the form: +# name=value +# For example adding +# "sideeffect=@par Side Effects:^^" +# will allow you to put the command \sideeffect (or @sideeffect) in the +# documentation, which will result in a user-defined paragraph with heading +# "Side Effects:". Note that you cannot put \n's in the value part of an alias +# to insert newlines (in the resulting output). You can put ^^ in the value part +# of an alias to insert a newline as if a physical newline was in the original +# file. When you need a literal { or } or , in the value part of an alias you +# have to escape them by means of a backslash (\), this can lead to conflicts +# with the commands \{ and \} for these it is advised to use the version @{ and +# @} or use a double escape (\\{ and \\}) + +ALIASES = + +# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources +# only. Doxygen will then generate output that is more tailored for C. For +# instance, some of the names that are used will be different. The list of all +# members will be omitted, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_FOR_C = NO + +# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or +# Python sources only. Doxygen will then generate output that is more tailored +# for that language. For instance, namespaces will be presented as packages, +# qualified scopes will look different, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_JAVA = NO + +# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran +# sources. Doxygen will then generate output that is tailored for Fortran. +# The default value is: NO. + +OPTIMIZE_FOR_FORTRAN = NO + +# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL +# sources. Doxygen will then generate output that is tailored for VHDL. +# The default value is: NO. + +OPTIMIZE_OUTPUT_VHDL = NO + +# Set the OPTIMIZE_OUTPUT_SLICE tag to YES if your project consists of Slice +# sources only. Doxygen will then generate output that is more tailored for that +# language. For instance, namespaces will be presented as modules, types will be +# separated into more groups, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_SLICE = NO + +# Doxygen selects the parser to use depending on the extension of the files it +# parses. With this tag you can assign which parser to use for a given +# extension. Doxygen has a built-in mapping, but you can override or extend it +# using this tag. The format is ext=language, where ext is a file extension, and +# language is one of the parsers supported by doxygen: IDL, Java, JavaScript, +# Csharp (C#), C, C++, Lex, D, PHP, md (Markdown), Objective-C, Python, Slice, +# VHDL, Fortran (fixed format Fortran: FortranFixed, free formatted Fortran: +# FortranFree, unknown formatted Fortran: Fortran. In the later case the parser +# tries to guess whether the code is fixed or free formatted code, this is the +# default for Fortran type files). For instance to make doxygen treat .inc files +# as Fortran files (default is PHP), and .f files as C (default is Fortran), +# use: inc=Fortran f=C. +# +# Note: For files without extension you can use no_extension as a placeholder. +# +# Note that for custom extensions you also need to set FILE_PATTERNS otherwise +# the files are not read by doxygen. When specifying no_extension you should add +# * to the FILE_PATTERNS. +# +# Note see also the list of default file extension mappings. + +EXTENSION_MAPPING = + +# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments +# according to the Markdown format, which allows for more readable +# documentation. See https://daringfireball.net/projects/markdown/ for details. +# The output of markdown processing is further processed by doxygen, so you can +# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in +# case of backward compatibilities issues. +# The default value is: YES. + +MARKDOWN_SUPPORT = YES + +# When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up +# to that level are automatically included in the table of contents, even if +# they do not have an id attribute. +# Note: This feature currently applies only to Markdown headings. +# Minimum value: 0, maximum value: 99, default value: 5. +# This tag requires that the tag MARKDOWN_SUPPORT is set to YES. + +TOC_INCLUDE_HEADINGS = 5 + +# The MARKDOWN_ID_STYLE tag can be used to specify the algorithm used to +# generate identifiers for the Markdown headings. Note: Every identifier is +# unique. +# Possible values are: DOXYGEN use a fixed 'autotoc_md' string followed by a +# sequence number starting at 0 and GITHUB use the lower case version of title +# with any whitespace replaced by '-' and punctuation characters removed. +# The default value is: DOXYGEN. +# This tag requires that the tag MARKDOWN_SUPPORT is set to YES. + +MARKDOWN_ID_STYLE = DOXYGEN + +# When enabled doxygen tries to link words that correspond to documented +# classes, or namespaces to their corresponding documentation. Such a link can +# be prevented in individual cases by putting a % sign in front of the word or +# globally by setting AUTOLINK_SUPPORT to NO. +# The default value is: YES. + +AUTOLINK_SUPPORT = YES + +# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want +# to include (a tag file for) the STL sources as input, then you should set this +# tag to YES in order to let doxygen match functions declarations and +# definitions whose arguments contain STL classes (e.g. func(std::string); +# versus func(std::string) {}). This also make the inheritance and collaboration +# diagrams that involve STL classes more complete and accurate. +# The default value is: NO. + +BUILTIN_STL_SUPPORT = YES + +# If you use Microsoft's C++/CLI language, you should set this option to YES to +# enable parsing support. +# The default value is: NO. + +CPP_CLI_SUPPORT = NO + +# Set the SIP_SUPPORT tag to YES if your project consists of sip (see: +# https://www.riverbankcomputing.com/software/sip/intro) sources only. Doxygen +# will parse them like normal C++ but will assume all classes use public instead +# of private inheritance when no explicit protection keyword is present. +# The default value is: NO. + +SIP_SUPPORT = NO + +# For Microsoft's IDL there are propget and propput attributes to indicate +# getter and setter methods for a property. Setting this option to YES will make +# doxygen to replace the get and set methods by a property in the documentation. +# This will only work if the methods are indeed getting or setting a simple +# type. If this is not the case, or you want to show the methods anyway, you +# should set this option to NO. +# The default value is: YES. + +IDL_PROPERTY_SUPPORT = YES + +# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC +# tag is set to YES then doxygen will reuse the documentation of the first +# member in the group (if any) for the other members of the group. By default +# all members of a group must be documented explicitly. +# The default value is: NO. + +DISTRIBUTE_GROUP_DOC = NO + +# If one adds a struct or class to a group and this option is enabled, then also +# any nested class or struct is added to the same group. By default this option +# is disabled and one has to add nested compounds explicitly via \ingroup. +# The default value is: NO. + +GROUP_NESTED_COMPOUNDS = NO + +# Set the SUBGROUPING tag to YES to allow class member groups of the same type +# (for instance a group of public functions) to be put as a subgroup of that +# type (e.g. under the Public Functions section). Set it to NO to prevent +# subgrouping. Alternatively, this can be done per class using the +# \nosubgrouping command. +# The default value is: YES. + +SUBGROUPING = YES + +# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions +# are shown inside the group in which they are included (e.g. using \ingroup) +# instead of on a separate page (for HTML and Man pages) or section (for LaTeX +# and RTF). +# +# Note that this feature does not work in combination with +# SEPARATE_MEMBER_PAGES. +# The default value is: NO. + +INLINE_GROUPED_CLASSES = NO + +# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions +# with only public data fields or simple typedef fields will be shown inline in +# the documentation of the scope in which they are defined (i.e. file, +# namespace, or group documentation), provided this scope is documented. If set +# to NO, structs, classes, and unions are shown on a separate page (for HTML and +# Man pages) or section (for LaTeX and RTF). +# The default value is: NO. + +INLINE_SIMPLE_STRUCTS = NO + +# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or +# enum is documented as struct, union, or enum with the name of the typedef. So +# typedef struct TypeS {} TypeT, will appear in the documentation as a struct +# with name TypeT. When disabled the typedef will appear as a member of a file, +# namespace, or class. And the struct will be named TypeS. This can typically be +# useful for C code in case the coding convention dictates that all compound +# types are typedef'ed and only the typedef is referenced, never the tag name. +# The default value is: NO. + +TYPEDEF_HIDES_STRUCT = NO + +# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This +# cache is used to resolve symbols given their name and scope. Since this can be +# an expensive process and often the same symbol appears multiple times in the +# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small +# doxygen will become slower. If the cache is too large, memory is wasted. The +# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range +# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536 +# symbols. At the end of a run doxygen will report the cache usage and suggest +# the optimal cache size from a speed point of view. +# Minimum value: 0, maximum value: 9, default value: 0. + +LOOKUP_CACHE_SIZE = 0 + +# The NUM_PROC_THREADS specifies the number of threads doxygen is allowed to use +# during processing. When set to 0 doxygen will based this on the number of +# cores available in the system. You can set it explicitly to a value larger +# than 0 to get more control over the balance between CPU load and processing +# speed. At this moment only the input processing can be done using multiple +# threads. Since this is still an experimental feature the default is set to 1, +# which effectively disables parallel processing. Please report any issues you +# encounter. Generating dot graphs in parallel is controlled by the +# DOT_NUM_THREADS setting. +# Minimum value: 0, maximum value: 32, default value: 1. + +NUM_PROC_THREADS = 1 + +# If the TIMESTAMP tag is set different from NO then each generated page will +# contain the date or date and time when the page was generated. Setting this to +# NO can help when comparing the output of multiple runs. +# Possible values are: YES, NO, DATETIME and DATE. +# The default value is: NO. + +TIMESTAMP = NO + +#--------------------------------------------------------------------------- +# Build related configuration options +#--------------------------------------------------------------------------- + +# If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in +# documentation are documented, even if no documentation was available. Private +# class members and static file members will be hidden unless the +# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. +# Note: This will also disable the warnings about undocumented members that are +# normally produced when WARNINGS is set to YES. +# The default value is: NO. + +EXTRACT_ALL = YES + +# If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will +# be included in the documentation. +# The default value is: NO. + +EXTRACT_PRIVATE = NO + +# If the EXTRACT_PRIV_VIRTUAL tag is set to YES, documented private virtual +# methods of a class will be included in the documentation. +# The default value is: NO. + +EXTRACT_PRIV_VIRTUAL = NO + +# If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal +# scope will be included in the documentation. +# The default value is: NO. + +EXTRACT_PACKAGE = NO + +# If the EXTRACT_STATIC tag is set to YES, all static members of a file will be +# included in the documentation. +# The default value is: NO. + +EXTRACT_STATIC = NO + +# If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined +# locally in source files will be included in the documentation. If set to NO, +# only classes defined in header files are included. Does not have any effect +# for Java sources. +# The default value is: YES. + +EXTRACT_LOCAL_CLASSES = YES + +# This flag is only useful for Objective-C code. If set to YES, local methods, +# which are defined in the implementation section but not in the interface are +# included in the documentation. If set to NO, only methods in the interface are +# included. +# The default value is: NO. + +EXTRACT_LOCAL_METHODS = NO + +# If this flag is set to YES, the members of anonymous namespaces will be +# extracted and appear in the documentation as a namespace called +# 'anonymous_namespace{file}', where file will be replaced with the base name of +# the file that contains the anonymous namespace. By default anonymous namespace +# are hidden. +# The default value is: NO. + +EXTRACT_ANON_NSPACES = NO + +# If this flag is set to YES, the name of an unnamed parameter in a declaration +# will be determined by the corresponding definition. By default unnamed +# parameters remain unnamed in the output. +# The default value is: YES. + +RESOLVE_UNNAMED_PARAMS = YES + +# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all +# undocumented members inside documented classes or files. If set to NO these +# members will be included in the various overviews, but no documentation +# section is generated. This option has no effect if EXTRACT_ALL is enabled. +# The default value is: NO. + +HIDE_UNDOC_MEMBERS = NO + +# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all +# undocumented classes that are normally visible in the class hierarchy. If set +# to NO, these classes will be included in the various overviews. This option +# will also hide undocumented C++ concepts if enabled. This option has no effect +# if EXTRACT_ALL is enabled. +# The default value is: NO. + +HIDE_UNDOC_CLASSES = NO + +# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend +# declarations. If set to NO, these declarations will be included in the +# documentation. +# The default value is: NO. + +HIDE_FRIEND_COMPOUNDS = NO + +# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any +# documentation blocks found inside the body of a function. If set to NO, these +# blocks will be appended to the function's detailed documentation block. +# The default value is: NO. + +HIDE_IN_BODY_DOCS = NO + +# The INTERNAL_DOCS tag determines if documentation that is typed after a +# \internal command is included. If the tag is set to NO then the documentation +# will be excluded. Set it to YES to include the internal documentation. +# The default value is: NO. + +INTERNAL_DOCS = NO + +# With the correct setting of option CASE_SENSE_NAMES doxygen will better be +# able to match the capabilities of the underlying filesystem. In case the +# filesystem is case sensitive (i.e. it supports files in the same directory +# whose names only differ in casing), the option must be set to YES to properly +# deal with such files in case they appear in the input. For filesystems that +# are not case sensitive the option should be set to NO to properly deal with +# output files written for symbols that only differ in casing, such as for two +# classes, one named CLASS and the other named Class, and to also support +# references to files without having to specify the exact matching casing. On +# Windows (including Cygwin) and MacOS, users should typically set this option +# to NO, whereas on Linux or other Unix flavors it should typically be set to +# YES. +# Possible values are: SYSTEM, NO and YES. +# The default value is: SYSTEM. + +CASE_SENSE_NAMES = NO + +# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with +# their full class and namespace scopes in the documentation. If set to YES, the +# scope will be hidden. +# The default value is: NO. + +HIDE_SCOPE_NAMES = NO + +# If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will +# append additional text to a page's title, such as Class Reference. If set to +# YES the compound reference will be hidden. +# The default value is: NO. + +HIDE_COMPOUND_REFERENCE = NO + +# If the SHOW_HEADERFILE tag is set to YES then the documentation for a class +# will show which file needs to be included to use the class. +# The default value is: YES. + +SHOW_HEADERFILE = YES + +# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of +# the files that are included by a file in the documentation of that file. +# The default value is: YES. + +SHOW_INCLUDE_FILES = YES + +# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each +# grouped member an include statement to the documentation, telling the reader +# which file to include in order to use the member. +# The default value is: NO. + +SHOW_GROUPED_MEMB_INC = NO + +# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include +# files with double quotes in the documentation rather than with sharp brackets. +# The default value is: NO. + +FORCE_LOCAL_INCLUDES = NO + +# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the +# documentation for inline members. +# The default value is: YES. + +INLINE_INFO = YES + +# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the +# (detailed) documentation of file and class members alphabetically by member +# name. If set to NO, the members will appear in declaration order. +# The default value is: YES. + +SORT_MEMBER_DOCS = YES + +# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief +# descriptions of file, namespace and class members alphabetically by member +# name. If set to NO, the members will appear in declaration order. Note that +# this will also influence the order of the classes in the class list. +# The default value is: NO. + +SORT_BRIEF_DOCS = NO + +# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the +# (brief and detailed) documentation of class members so that constructors and +# destructors are listed first. If set to NO the constructors will appear in the +# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS. +# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief +# member documentation. +# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting +# detailed member documentation. +# The default value is: NO. + +SORT_MEMBERS_CTORS_1ST = NO + +# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy +# of group names into alphabetical order. If set to NO the group names will +# appear in their defined order. +# The default value is: NO. + +SORT_GROUP_NAMES = NO + +# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by +# fully-qualified names, including namespaces. If set to NO, the class list will +# be sorted only by class name, not including the namespace part. +# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. +# Note: This option applies only to the class list, not to the alphabetical +# list. +# The default value is: NO. + +SORT_BY_SCOPE_NAME = NO + +# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper +# type resolution of all parameters of a function it will reject a match between +# the prototype and the implementation of a member function even if there is +# only one candidate or it is obvious which candidate to choose by doing a +# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still +# accept a match between prototype and implementation in such cases. +# The default value is: NO. + +STRICT_PROTO_MATCHING = NO + +# The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo +# list. This list is created by putting \todo commands in the documentation. +# The default value is: YES. + +GENERATE_TODOLIST = YES + +# The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test +# list. This list is created by putting \test commands in the documentation. +# The default value is: YES. + +GENERATE_TESTLIST = YES + +# The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug +# list. This list is created by putting \bug commands in the documentation. +# The default value is: YES. + +GENERATE_BUGLIST = YES + +# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO) +# the deprecated list. This list is created by putting \deprecated commands in +# the documentation. +# The default value is: YES. + +GENERATE_DEPRECATEDLIST = YES + +# The ENABLED_SECTIONS tag can be used to enable conditional documentation +# sections, marked by \if ... \endif and \cond +# ... \endcond blocks. + +ENABLED_SECTIONS = + +# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the +# initial value of a variable or macro / define can have for it to appear in the +# documentation. If the initializer consists of more lines than specified here +# it will be hidden. Use a value of 0 to hide initializers completely. The +# appearance of the value of individual variables and macros / defines can be +# controlled using \showinitializer or \hideinitializer command in the +# documentation regardless of this setting. +# Minimum value: 0, maximum value: 10000, default value: 30. + +MAX_INITIALIZER_LINES = 30 + +# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at +# the bottom of the documentation of classes and structs. If set to YES, the +# list will mention the files that were used to generate the documentation. +# The default value is: YES. + +SHOW_USED_FILES = YES + +# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This +# will remove the Files entry from the Quick Index and from the Folder Tree View +# (if specified). +# The default value is: YES. + +SHOW_FILES = YES + +# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces +# page. This will remove the Namespaces entry from the Quick Index and from the +# Folder Tree View (if specified). +# The default value is: YES. + +SHOW_NAMESPACES = NO + +# The FILE_VERSION_FILTER tag can be used to specify a program or script that +# doxygen should invoke to get the current version for each file (typically from +# the version control system). Doxygen will invoke the program by executing (via +# popen()) the command command input-file, where command is the value of the +# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided +# by doxygen. Whatever the program writes to standard output is used as the file +# version. For an example see the documentation. + +FILE_VERSION_FILTER = + +# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed +# by doxygen. The layout file controls the global structure of the generated +# output files in an output format independent way. To create the layout file +# that represents doxygen's defaults, run doxygen with the -l option. You can +# optionally specify a file name after the option, if omitted DoxygenLayout.xml +# will be used as the name of the layout file. See also section "Changing the +# layout of pages" for information. +# +# Note that if you run doxygen from a directory containing a file called +# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE +# tag is left empty. + +LAYOUT_FILE = + +# The CITE_BIB_FILES tag can be used to specify one or more bib files containing +# the reference definitions. This must be a list of .bib files. The .bib +# extension is automatically appended if omitted. This requires the bibtex tool +# to be installed. See also https://en.wikipedia.org/wiki/BibTeX for more info. +# For LaTeX the style of the bibliography can be controlled using +# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the +# search path. See also \cite for info how to create references. + +CITE_BIB_FILES = + +#--------------------------------------------------------------------------- +# Configuration options related to warning and progress messages +#--------------------------------------------------------------------------- + +# The QUIET tag can be used to turn on/off the messages that are generated to +# standard output by doxygen. If QUIET is set to YES this implies that the +# messages are off. +# The default value is: NO. + +QUIET = NO + +# The WARNINGS tag can be used to turn on/off the warning messages that are +# generated to standard error (stderr) by doxygen. If WARNINGS is set to YES +# this implies that the warnings are on. +# +# Tip: Turn warnings on while writing the documentation. +# The default value is: YES. + +WARNINGS = YES + +# If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate +# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag +# will automatically be disabled. +# The default value is: YES. + +WARN_IF_UNDOCUMENTED = YES + +# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for +# potential errors in the documentation, such as documenting some parameters in +# a documented function twice, or documenting parameters that don't exist or +# using markup commands wrongly. +# The default value is: YES. + +WARN_IF_DOC_ERROR = YES + +# If WARN_IF_INCOMPLETE_DOC is set to YES, doxygen will warn about incomplete +# function parameter documentation. If set to NO, doxygen will accept that some +# parameters have no documentation without warning. +# The default value is: YES. + +WARN_IF_INCOMPLETE_DOC = YES + +# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that +# are documented, but have no documentation for their parameters or return +# value. If set to NO, doxygen will only warn about wrong parameter +# documentation, but not about the absence of documentation. If EXTRACT_ALL is +# set to YES then this flag will automatically be disabled. See also +# WARN_IF_INCOMPLETE_DOC +# The default value is: NO. + +WARN_NO_PARAMDOC = NO + +# If WARN_IF_UNDOC_ENUM_VAL option is set to YES, doxygen will warn about +# undocumented enumeration values. If set to NO, doxygen will accept +# undocumented enumeration values. If EXTRACT_ALL is set to YES then this flag +# will automatically be disabled. +# The default value is: NO. + +WARN_IF_UNDOC_ENUM_VAL = NO + +# If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when +# a warning is encountered. If the WARN_AS_ERROR tag is set to FAIL_ON_WARNINGS +# then doxygen will continue running as if WARN_AS_ERROR tag is set to NO, but +# at the end of the doxygen process doxygen will return with a non-zero status. +# If the WARN_AS_ERROR tag is set to FAIL_ON_WARNINGS_PRINT then doxygen behaves +# like FAIL_ON_WARNINGS but in case no WARN_LOGFILE is defined doxygen will not +# write the warning messages in between other messages but write them at the end +# of a run, in case a WARN_LOGFILE is defined the warning messages will be +# besides being in the defined file also be shown at the end of a run, unless +# the WARN_LOGFILE is defined as - i.e. standard output (stdout) in that case +# the behavior will remain as with the setting FAIL_ON_WARNINGS. +# Possible values are: NO, YES, FAIL_ON_WARNINGS and FAIL_ON_WARNINGS_PRINT. +# The default value is: NO. + +WARN_AS_ERROR = NO + +# The WARN_FORMAT tag determines the format of the warning messages that doxygen +# can produce. The string should contain the $file, $line, and $text tags, which +# will be replaced by the file and line number from which the warning originated +# and the warning text. Optionally the format may contain $version, which will +# be replaced by the version of the file (if it could be obtained via +# FILE_VERSION_FILTER) +# See also: WARN_LINE_FORMAT +# The default value is: $file:$line: $text. + +WARN_FORMAT = "$file:$line: $text" + +# In the $text part of the WARN_FORMAT command it is possible that a reference +# to a more specific place is given. To make it easier to jump to this place +# (outside of doxygen) the user can define a custom "cut" / "paste" string. +# Example: +# WARN_LINE_FORMAT = "'vi $file +$line'" +# See also: WARN_FORMAT +# The default value is: at line $line of file $file. + +WARN_LINE_FORMAT = "at line $line of file $file" + +# The WARN_LOGFILE tag can be used to specify a file to which warning and error +# messages should be written. If left blank the output is written to standard +# error (stderr). In case the file specified cannot be opened for writing the +# warning and error messages are written to standard error. When as file - is +# specified the warning and error messages are written to standard output +# (stdout). + +WARN_LOGFILE = + +#--------------------------------------------------------------------------- +# Configuration options related to the input files +#--------------------------------------------------------------------------- + +# The INPUT tag is used to specify the files and/or directories that contain +# documented source files. You may enter file names like myfile.cpp or +# directories like /usr/src/myproject. Separate the files or directories with +# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING +# Note: If this tag is empty the current directory is searched. + +INPUT = src \ + README.md \ + docs + +# This tag can be used to specify the character encoding of the source files +# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses +# libiconv (or the iconv built into libc) for the transcoding. See the libiconv +# documentation (see: +# https://www.gnu.org/software/libiconv/) for the list of possible encodings. +# See also: INPUT_FILE_ENCODING +# The default value is: UTF-8. + +INPUT_ENCODING = UTF-8 + +# This tag can be used to specify the character encoding of the source files +# that doxygen parses The INPUT_FILE_ENCODING tag can be used to specify +# character encoding on a per file pattern basis. Doxygen will compare the file +# name with each pattern and apply the encoding instead of the default +# INPUT_ENCODING) if there is a match. The character encodings are a list of the +# form: pattern=encoding (like *.php=ISO-8859-1). See cfg_input_encoding +# "INPUT_ENCODING" for further information on supported encodings. + +INPUT_FILE_ENCODING = + +# If the value of the INPUT tag contains directories, you can use the +# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and +# *.h) to filter out the source-files in the directories. +# +# Note that for custom extensions or not directly supported extensions you also +# need to set EXTENSION_MAPPING for the extension otherwise the files are not +# read by doxygen. +# +# Note the list of default checked file patterns might differ from the list of +# default file extension mappings. +# +# If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cxxm, +# *.cpp, *.cppm, *.ccm, *.c++, *.c++m, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, +# *.idl, *.ddl, *.odl, *.h, *.hh, *.hxx, *.hpp, *.h++, *.ixx, *.l, *.cs, *.d, +# *.php, *.php4, *.php5, *.phtml, *.inc, *.m, *.markdown, *.md, *.mm, *.dox (to +# be provided as doxygen C comment), *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, +# *.f18, *.f, *.for, *.vhd, *.vhdl, *.ucf, *.qsf and *.ice. + +FILE_PATTERNS = *.c \ + *.cc \ + *.cxx \ + *.cpp \ + *.c++ \ + *.h \ + *.hpp \ + *.markdown \ + *.md \ + *.dox + +# The RECURSIVE tag can be used to specify whether or not subdirectories should +# be searched for input files as well. +# The default value is: NO. + +RECURSIVE = YES + +# The EXCLUDE tag can be used to specify files and/or directories that should be +# excluded from the INPUT source files. This way you can easily exclude a +# subdirectory from a directory tree whose root is specified with the INPUT tag. +# +# Note that relative paths are relative to the directory from which doxygen is +# run. + +EXCLUDE = docs/doxygen \ + docs/html + +# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or +# directories that are symbolic links (a Unix file system feature) are excluded +# from the input. +# The default value is: NO. + +EXCLUDE_SYMLINKS = NO + +# If the value of the INPUT tag contains directories, you can use the +# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude +# certain files from those directories. +# +# Note that the wildcards are matched against the file with absolute path, so to +# exclude all test directories for example use the pattern */test/* + +EXCLUDE_PATTERNS = + +# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names +# (namespaces, classes, functions, etc.) that should be excluded from the +# output. The symbol name can be a fully qualified name, a word, or if the +# wildcard * is used, a substring. Examples: ANamespace, AClass, +# ANamespace::AClass, ANamespace::*Test + +EXCLUDE_SYMBOLS = + +# The EXAMPLE_PATH tag can be used to specify one or more files or directories +# that contain example code fragments that are included (see the \include +# command). + +EXAMPLE_PATH = + +# If the value of the EXAMPLE_PATH tag contains directories, you can use the +# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and +# *.h) to filter out the source-files in the directories. If left blank all +# files are included. + +EXAMPLE_PATTERNS = * + +# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be +# searched for input files to be used with the \include or \dontinclude commands +# irrespective of the value of the RECURSIVE tag. +# The default value is: NO. + +EXAMPLE_RECURSIVE = NO + +# The IMAGE_PATH tag can be used to specify one or more files or directories +# that contain images that are to be included in the documentation (see the +# \image command). + +IMAGE_PATH = docs/images + +# The INPUT_FILTER tag can be used to specify a program that doxygen should +# invoke to filter for each input file. Doxygen will invoke the filter program +# by executing (via popen()) the command: +# +# +# +# where is the value of the INPUT_FILTER tag, and is the +# name of an input file. Doxygen will then use the output that the filter +# program writes to standard output. If FILTER_PATTERNS is specified, this tag +# will be ignored. +# +# Note that the filter must not add or remove lines; it is applied before the +# code is scanned, but not when the output code is generated. If lines are added +# or removed, the anchors will not be placed correctly. +# +# Note that doxygen will use the data processed and written to standard output +# for further processing, therefore nothing else, like debug statements or used +# commands (so in case of a Windows batch file always use @echo OFF), should be +# written to standard output. +# +# Note that for custom extensions or not directly supported extensions you also +# need to set EXTENSION_MAPPING for the extension otherwise the files are not +# properly processed by doxygen. + +INPUT_FILTER = + +# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern +# basis. Doxygen will compare the file name with each pattern and apply the +# filter if there is a match. The filters are a list of the form: pattern=filter +# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how +# filters are used. If the FILTER_PATTERNS tag is empty or if none of the +# patterns match the file name, INPUT_FILTER is applied. +# +# Note that for custom extensions or not directly supported extensions you also +# need to set EXTENSION_MAPPING for the extension otherwise the files are not +# properly processed by doxygen. + +FILTER_PATTERNS = + +# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using +# INPUT_FILTER) will also be used to filter the input files that are used for +# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES). +# The default value is: NO. + +FILTER_SOURCE_FILES = NO + +# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file +# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and +# it is also possible to disable source filtering for a specific pattern using +# *.ext= (so without naming a filter). +# This tag requires that the tag FILTER_SOURCE_FILES is set to YES. + +FILTER_SOURCE_PATTERNS = + +# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that +# is part of the input, its contents will be placed on the main page +# (index.html). This can be useful if you have a project on for instance GitHub +# and want to reuse the introduction page also for the doxygen output. + +USE_MDFILE_AS_MAINPAGE = README.md + +# The Fortran standard specifies that for fixed formatted Fortran code all +# characters from position 72 are to be considered as comment. A common +# extension is to allow longer lines before the automatic comment starts. The +# setting FORTRAN_COMMENT_AFTER will also make it possible that longer lines can +# be processed before the automatic comment starts. +# Minimum value: 7, maximum value: 10000, default value: 72. + +FORTRAN_COMMENT_AFTER = 72 + +#--------------------------------------------------------------------------- +# Configuration options related to source browsing +#--------------------------------------------------------------------------- + +# If the SOURCE_BROWSER tag is set to YES then a list of source files will be +# generated. Documented entities will be cross-referenced with these sources. +# +# Note: To get rid of all source code in the generated output, make sure that +# also VERBATIM_HEADERS is set to NO. +# The default value is: NO. + +SOURCE_BROWSER = NO + +# Setting the INLINE_SOURCES tag to YES will include the body of functions, +# multi-line macros, enums or list initialized variables directly into the +# documentation. +# The default value is: NO. + +INLINE_SOURCES = NO + +# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any +# special comment blocks from generated source code fragments. Normal C, C++ and +# Fortran comments will always remain visible. +# The default value is: YES. + +STRIP_CODE_COMMENTS = YES + +# If the REFERENCED_BY_RELATION tag is set to YES then for each documented +# entity all documented functions referencing it will be listed. +# The default value is: NO. + +REFERENCED_BY_RELATION = NO + +# If the REFERENCES_RELATION tag is set to YES then for each documented function +# all documented entities called/used by that function will be listed. +# The default value is: NO. + +REFERENCES_RELATION = NO + +# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set +# to YES then the hyperlinks from functions in REFERENCES_RELATION and +# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will +# link to the documentation. +# The default value is: YES. + +REFERENCES_LINK_SOURCE = YES + +# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the +# source code will show a tooltip with additional information such as prototype, +# brief description and links to the definition and documentation. Since this +# will make the HTML file larger and loading of large files a bit slower, you +# can opt to disable this feature. +# The default value is: YES. +# This tag requires that the tag SOURCE_BROWSER is set to YES. + +SOURCE_TOOLTIPS = YES + +# If the USE_HTAGS tag is set to YES then the references to source code will +# point to the HTML generated by the htags(1) tool instead of doxygen built-in +# source browser. The htags tool is part of GNU's global source tagging system +# (see https://www.gnu.org/software/global/global.html). You will need version +# 4.8.6 or higher. +# +# To use it do the following: +# - Install the latest version of global +# - Enable SOURCE_BROWSER and USE_HTAGS in the configuration file +# - Make sure the INPUT points to the root of the source tree +# - Run doxygen as normal +# +# Doxygen will invoke htags (and that will in turn invoke gtags), so these +# tools must be available from the command line (i.e. in the search path). +# +# The result: instead of the source browser generated by doxygen, the links to +# source code will now point to the output of htags. +# The default value is: NO. +# This tag requires that the tag SOURCE_BROWSER is set to YES. + +USE_HTAGS = NO + +# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a +# verbatim copy of the header file for each class for which an include is +# specified. Set to NO to disable this. +# See also: Section \class. +# The default value is: YES. + +VERBATIM_HEADERS = YES + +#--------------------------------------------------------------------------- +# Configuration options related to the alphabetical class index +#--------------------------------------------------------------------------- + +# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all +# compounds will be generated. Enable this if the project contains a lot of +# classes, structs, unions or interfaces. +# The default value is: YES. + +ALPHABETICAL_INDEX = YES + +# The IGNORE_PREFIX tag can be used to specify a prefix (or a list of prefixes) +# that should be ignored while generating the index headers. The IGNORE_PREFIX +# tag works for classes, function and member names. The entity will be placed in +# the alphabetical list under the first letter of the entity name that remains +# after removing the prefix. +# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. + +IGNORE_PREFIX = + +#--------------------------------------------------------------------------- +# Configuration options related to the HTML output +#--------------------------------------------------------------------------- + +# If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output +# The default value is: YES. + +GENERATE_HTML = YES + +# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a +# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of +# it. +# The default directory is: html. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_OUTPUT = html + +# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each +# generated HTML page (for example: .htm, .php, .asp). +# The default value is: .html. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FILE_EXTENSION = .html + +# The HTML_HEADER tag can be used to specify a user-defined HTML header file for +# each generated HTML page. If the tag is left blank doxygen will generate a +# standard header. +# +# To get valid HTML the header file that includes any scripts and style sheets +# that doxygen needs, which is dependent on the configuration options used (e.g. +# the setting GENERATE_TREEVIEW). It is highly recommended to start with a +# default header using +# doxygen -w html new_header.html new_footer.html new_stylesheet.css +# YourConfigFile +# and then modify the file new_header.html. See also section "Doxygen usage" +# for information on how to generate the default header that doxygen normally +# uses. +# Note: The header is subject to change so you typically have to regenerate the +# default header when upgrading to a newer version of doxygen. For a description +# of the possible markers and block names see the documentation. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_HEADER = ./docs/doxygen/doxygen-custom/header.html + +# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each +# generated HTML page. If the tag is left blank doxygen will generate a standard +# footer. See HTML_HEADER for more information on how to generate a default +# footer and what special commands can be used inside the footer. See also +# section "Doxygen usage" for information on how to generate the default footer +# that doxygen normally uses. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FOOTER = + +# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style +# sheet that is used by each HTML page. It can be used to fine-tune the look of +# the HTML output. If left blank doxygen will generate a default style sheet. +# See also section "Doxygen usage" for information on how to generate the style +# sheet that doxygen normally uses. +# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as +# it is more robust and this tag (HTML_STYLESHEET) will in the future become +# obsolete. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_STYLESHEET = + +# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined +# cascading style sheets that are included after the standard style sheets +# created by doxygen. Using this option one can overrule certain style aspects. +# This is preferred over using HTML_STYLESHEET since it does not replace the +# standard style sheet and is therefore more robust against future updates. +# Doxygen will copy the style sheet files to the output directory. +# Note: The order of the extra style sheet files is of importance (e.g. the last +# style sheet in the list overrules the setting of the previous ones in the +# list). +# Note: Since the styling of scrollbars can currently not be overruled in +# Webkit/Chromium, the styling will be left out of the default doxygen.css if +# one or more extra stylesheets have been specified. So if scrollbar +# customization is desired it has to be added explicitly. For an example see the +# documentation. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_EXTRA_STYLESHEET = docs/doxygen/doxygen-awesome-css/doxygen-awesome.css \ + docs/doxygen/doxygen-awesome-css/doxygen-awesome-sidebar-only.css \ + docs/doxygen/doxygen-custom/custom.css + +# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or +# other source files which should be copied to the HTML output directory. Note +# that these files will be copied to the base HTML output directory. Use the +# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these +# files. In the HTML_STYLESHEET file, use the file name only. Also note that the +# files will be copied as-is; there are no commands or markers available. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_EXTRA_FILES = + +# The HTML_COLORSTYLE tag can be used to specify if the generated HTML output +# should be rendered with a dark or light theme. +# Possible values are: LIGHT always generate light mode output, DARK always +# generate dark mode output, AUTO_LIGHT automatically set the mode according to +# the user preference, use light mode if no preference is set (the default), +# AUTO_DARK automatically set the mode according to the user preference, use +# dark mode if no preference is set and TOGGLE allow to user to switch between +# light and dark mode via a button. +# The default value is: AUTO_LIGHT. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE = AUTO_LIGHT + +# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen +# will adjust the colors in the style sheet and background images according to +# this color. Hue is specified as an angle on a color-wheel, see +# https://en.wikipedia.org/wiki/Hue for more information. For instance the value +# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 +# purple, and 360 is red again. +# Minimum value: 0, maximum value: 359, default value: 220. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_HUE = 209 + +# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors +# in the HTML output. For a value of 0 the output will use gray-scales only. A +# value of 255 will produce the most vivid colors. +# Minimum value: 0, maximum value: 255, default value: 100. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_SAT = 255 + +# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the +# luminance component of the colors in the HTML output. Values below 100 +# gradually make the output lighter, whereas values above 100 make the output +# darker. The value divided by 100 is the actual gamma applied, so 80 represents +# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not +# change the gamma. +# Minimum value: 40, maximum value: 240, default value: 80. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_GAMMA = 113 + +# If the HTML_DYNAMIC_MENUS tag is set to YES then the generated HTML +# documentation will contain a main index with vertical navigation menus that +# are dynamically created via JavaScript. If disabled, the navigation index will +# consists of multiple levels of tabs that are statically embedded in every HTML +# page. Disable this option to support browsers that do not have JavaScript, +# like the Qt help browser. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_DYNAMIC_MENUS = YES + +# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML +# documentation will contain sections that can be hidden and shown after the +# page has loaded. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_DYNAMIC_SECTIONS = NO + +# If the HTML_CODE_FOLDING tag is set to YES then classes and functions can be +# dynamically folded and expanded in the generated HTML source code. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_CODE_FOLDING = YES + +# If the HTML_COPY_CLIPBOARD tag is set to YES then doxygen will show an icon in +# the top right corner of code and text fragments that allows the user to copy +# its content to the clipboard. Note this only works if supported by the browser +# and the web page is served via a secure context (see: +# https://www.w3.org/TR/secure-contexts/), i.e. using the https: or file: +# protocol. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COPY_CLIPBOARD = YES + +# Doxygen stores a couple of settings persistently in the browser (via e.g. +# cookies). By default these settings apply to all HTML pages generated by +# doxygen across all projects. The HTML_PROJECT_COOKIE tag can be used to store +# the settings under a project specific key, such that the user preferences will +# be stored separately. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_PROJECT_COOKIE = + +# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries +# shown in the various tree structured indices initially; the user can expand +# and collapse entries dynamically later on. Doxygen will expand the tree to +# such a level that at most the specified number of entries are visible (unless +# a fully collapsed tree already exceeds this amount). So setting the number of +# entries 1 will produce a full collapsed tree by default. 0 is a special value +# representing an infinite number of entries and will result in a full expanded +# tree by default. +# Minimum value: 0, maximum value: 9999, default value: 100. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_INDEX_NUM_ENTRIES = 12 + +# If the GENERATE_DOCSET tag is set to YES, additional index files will be +# generated that can be used as input for Apple's Xcode 3 integrated development +# environment (see: +# https://developer.apple.com/xcode/), introduced with OSX 10.5 (Leopard). To +# create a documentation set, doxygen will generate a Makefile in the HTML +# output directory. Running make will produce the docset in that directory and +# running make install will install the docset in +# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at +# startup. See https://developer.apple.com/library/archive/featuredarticles/Doxy +# genXcode/_index.html for more information. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_DOCSET = NO + +# This tag determines the name of the docset feed. A documentation feed provides +# an umbrella under which multiple documentation sets from a single provider +# (such as a company or product suite) can be grouped. +# The default value is: Doxygen generated docs. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_FEEDNAME = "Doxygen generated docs" + +# This tag determines the URL of the docset feed. A documentation feed provides +# an umbrella under which multiple documentation sets from a single provider +# (such as a company or product suite) can be grouped. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_FEEDURL = + +# This tag specifies a string that should uniquely identify the documentation +# set bundle. This should be a reverse domain-name style string, e.g. +# com.mycompany.MyDocSet. Doxygen will append .docset to the name. +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_BUNDLE_ID = org.doxygen.Project + +# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify +# the documentation publisher. This should be a reverse domain-name style +# string, e.g. com.mycompany.MyDocSet.documentation. +# The default value is: org.doxygen.Publisher. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_PUBLISHER_ID = org.doxygen.Publisher + +# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. +# The default value is: Publisher. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_PUBLISHER_NAME = Publisher + +# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three +# additional HTML index files: index.hhp, index.hhc, and index.hhk. The +# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop +# on Windows. In the beginning of 2021 Microsoft took the original page, with +# a.o. the download links, offline the HTML help workshop was already many years +# in maintenance mode). You can download the HTML help workshop from the web +# archives at Installation executable (see: +# http://web.archive.org/web/20160201063255/http://download.microsoft.com/downlo +# ad/0/A/9/0A939EF6-E31C-430F-A3DF-DFAE7960D564/htmlhelp.exe). +# +# The HTML Help Workshop contains a compiler that can convert all HTML output +# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML +# files are now used as the Windows 98 help format, and will replace the old +# Windows help format (.hlp) on all Windows platforms in the future. Compressed +# HTML files also contain an index, a table of contents, and you can search for +# words in the documentation. The HTML workshop also contains a viewer for +# compressed HTML files. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_HTMLHELP = NO + +# The CHM_FILE tag can be used to specify the file name of the resulting .chm +# file. You can add a path in front of the file if the result should not be +# written to the html output directory. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +CHM_FILE = + +# The HHC_LOCATION tag can be used to specify the location (absolute path +# including file name) of the HTML help compiler (hhc.exe). If non-empty, +# doxygen will try to run the HTML help compiler on the generated index.hhp. +# The file has to be specified with full path. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +HHC_LOCATION = + +# The GENERATE_CHI flag controls if a separate .chi index file is generated +# (YES) or that it should be included in the main .chm file (NO). +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +GENERATE_CHI = NO + +# The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc) +# and project file content. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +CHM_INDEX_ENCODING = + +# The BINARY_TOC flag controls whether a binary table of contents is generated +# (YES) or a normal table of contents (NO) in the .chm file. Furthermore it +# enables the Previous and Next buttons. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +BINARY_TOC = NO + +# The TOC_EXPAND flag can be set to YES to add extra items for group members to +# the table of contents of the HTML help documentation and to the tree view. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +TOC_EXPAND = NO + +# The SITEMAP_URL tag is used to specify the full URL of the place where the +# generated documentation will be placed on the server by the user during the +# deployment of the documentation. The generated sitemap is called sitemap.xml +# and placed on the directory specified by HTML_OUTPUT. In case no SITEMAP_URL +# is specified no sitemap is generated. For information about the sitemap +# protocol see https://www.sitemaps.org +# This tag requires that the tag GENERATE_HTML is set to YES. + +SITEMAP_URL = + +# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and +# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that +# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help +# (.qch) of the generated HTML documentation. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_QHP = NO + +# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify +# the file name of the resulting .qch file. The path specified is relative to +# the HTML output folder. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QCH_FILE = + +# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help +# Project output. For more information please see Qt Help Project / Namespace +# (see: +# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#namespace). +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_NAMESPACE = org.doxygen.Project + +# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt +# Help Project output. For more information please see Qt Help Project / Virtual +# Folders (see: +# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#virtual-folders). +# The default value is: doc. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_VIRTUAL_FOLDER = doc + +# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom +# filter to add. For more information please see Qt Help Project / Custom +# Filters (see: +# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-filters). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_CUST_FILTER_NAME = + +# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the +# custom filter to add. For more information please see Qt Help Project / Custom +# Filters (see: +# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-filters). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_CUST_FILTER_ATTRS = + +# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this +# project's filter section matches. Qt Help Project / Filter Attributes (see: +# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#filter-attributes). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_SECT_FILTER_ATTRS = + +# The QHG_LOCATION tag can be used to specify the location (absolute path +# including file name) of Qt's qhelpgenerator. If non-empty doxygen will try to +# run qhelpgenerator on the generated .qhp file. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHG_LOCATION = + +# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be +# generated, together with the HTML files, they form an Eclipse help plugin. To +# install this plugin and make it available under the help contents menu in +# Eclipse, the contents of the directory containing the HTML and XML files needs +# to be copied into the plugins directory of eclipse. The name of the directory +# within the plugins directory should be the same as the ECLIPSE_DOC_ID value. +# After copying Eclipse needs to be restarted before the help appears. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_ECLIPSEHELP = NO + +# A unique identifier for the Eclipse help plugin. When installing the plugin +# the directory name containing the HTML and XML files should also have this +# name. Each documentation set should have its own identifier. +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES. + +ECLIPSE_DOC_ID = org.doxygen.Project + +# If you want full control over the layout of the generated HTML pages it might +# be necessary to disable the index and replace it with your own. The +# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top +# of each HTML page. A value of NO enables the index and the value YES disables +# it. Since the tabs in the index contain the same information as the navigation +# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +DISABLE_INDEX = NO + +# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index +# structure should be generated to display hierarchical information. If the tag +# value is set to YES, a side panel will be generated containing a tree-like +# index structure (just like the one that is generated for HTML Help). For this +# to work a browser that supports JavaScript, DHTML, CSS and frames is required +# (i.e. any modern browser). Windows users are probably better off using the +# HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can +# further fine tune the look of the index (see "Fine-tuning the output"). As an +# example, the default style sheet generated by doxygen has an example that +# shows how to put an image at the root of the tree instead of the PROJECT_NAME. +# Since the tree basically has the same information as the tab index, you could +# consider setting DISABLE_INDEX to YES when enabling this option. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_TREEVIEW = YES + +# When both GENERATE_TREEVIEW and DISABLE_INDEX are set to YES, then the +# FULL_SIDEBAR option determines if the side bar is limited to only the treeview +# area (value NO) or if it should extend to the full height of the window (value +# YES). Setting this to YES gives a layout similar to +# https://docs.readthedocs.io with more room for contents, but less room for the +# project logo, title, and description. If either GENERATE_TREEVIEW or +# DISABLE_INDEX is set to NO, this option has no effect. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +FULL_SIDEBAR = NO + +# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that +# doxygen will group on one line in the generated HTML documentation. +# +# Note that a value of 0 will completely suppress the enum values from appearing +# in the overview section. +# Minimum value: 0, maximum value: 20, default value: 4. +# This tag requires that the tag GENERATE_HTML is set to YES. + +ENUM_VALUES_PER_LINE = 4 + +# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used +# to set the initial width (in pixels) of the frame in which the tree is shown. +# Minimum value: 0, maximum value: 1500, default value: 250. +# This tag requires that the tag GENERATE_HTML is set to YES. + +TREEVIEW_WIDTH = 350 + +# If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to +# external symbols imported via tag files in a separate window. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +EXT_LINKS_IN_WINDOW = NO + +# If the OBFUSCATE_EMAILS tag is set to YES, doxygen will obfuscate email +# addresses. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +OBFUSCATE_EMAILS = YES + +# If the HTML_FORMULA_FORMAT option is set to svg, doxygen will use the pdf2svg +# tool (see https://github.com/dawbarton/pdf2svg) or inkscape (see +# https://inkscape.org) to generate formulas as SVG images instead of PNGs for +# the HTML output. These images will generally look nicer at scaled resolutions. +# Possible values are: png (the default) and svg (looks nicer but requires the +# pdf2svg or inkscape tool). +# The default value is: png. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FORMULA_FORMAT = png + +# Use this tag to change the font size of LaTeX formulas included as images in +# the HTML documentation. When you change the font size after a successful +# doxygen run you need to manually remove any form_*.png images from the HTML +# output directory to force them to be regenerated. +# Minimum value: 8, maximum value: 50, default value: 10. +# This tag requires that the tag GENERATE_HTML is set to YES. + +FORMULA_FONTSIZE = 10 + +# The FORMULA_MACROFILE can contain LaTeX \newcommand and \renewcommand commands +# to create new LaTeX commands to be used in formulas as building blocks. See +# the section "Including formulas" for details. + +FORMULA_MACROFILE = + +# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see +# https://www.mathjax.org) which uses client side JavaScript for the rendering +# instead of using pre-rendered bitmaps. Use this if you do not have LaTeX +# installed or if you want to formulas look prettier in the HTML output. When +# enabled you may also need to install MathJax separately and configure the path +# to it using the MATHJAX_RELPATH option. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +USE_MATHJAX = NO + +# With MATHJAX_VERSION it is possible to specify the MathJax version to be used. +# Note that the different versions of MathJax have different requirements with +# regards to the different settings, so it is possible that also other MathJax +# settings have to be changed when switching between the different MathJax +# versions. +# Possible values are: MathJax_2 and MathJax_3. +# The default value is: MathJax_2. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_VERSION = MathJax_2 + +# When MathJax is enabled you can set the default output format to be used for +# the MathJax output. For more details about the output format see MathJax +# version 2 (see: +# http://docs.mathjax.org/en/v2.7-latest/output.html) and MathJax version 3 +# (see: +# http://docs.mathjax.org/en/latest/web/components/output.html). +# Possible values are: HTML-CSS (which is slower, but has the best +# compatibility. This is the name for Mathjax version 2, for MathJax version 3 +# this will be translated into chtml), NativeMML (i.e. MathML. Only supported +# for NathJax 2. For MathJax version 3 chtml will be used instead.), chtml (This +# is the name for Mathjax version 3, for MathJax version 2 this will be +# translated into HTML-CSS) and SVG. +# The default value is: HTML-CSS. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_FORMAT = HTML-CSS + +# When MathJax is enabled you need to specify the location relative to the HTML +# output directory using the MATHJAX_RELPATH option. The destination directory +# should contain the MathJax.js script. For instance, if the mathjax directory +# is located at the same level as the HTML output directory, then +# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax +# Content Delivery Network so you can quickly see the result without installing +# MathJax. However, it is strongly recommended to install a local copy of +# MathJax from https://www.mathjax.org before deployment. The default value is: +# - in case of MathJax version 2: https://cdn.jsdelivr.net/npm/mathjax@2 +# - in case of MathJax version 3: https://cdn.jsdelivr.net/npm/mathjax@3 +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_RELPATH = https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.2/ + +# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax +# extension names that should be enabled during MathJax rendering. For example +# for MathJax version 2 (see +# https://docs.mathjax.org/en/v2.7-latest/tex.html#tex-and-latex-extensions): +# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols +# For example for MathJax version 3 (see +# http://docs.mathjax.org/en/latest/input/tex/extensions/index.html): +# MATHJAX_EXTENSIONS = ams +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_EXTENSIONS = + +# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces +# of code that will be used on startup of the MathJax code. See the MathJax site +# (see: +# http://docs.mathjax.org/en/v2.7-latest/output.html) for more details. For an +# example see the documentation. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_CODEFILE = + +# When the SEARCHENGINE tag is enabled doxygen will generate a search box for +# the HTML output. The underlying search engine uses javascript and DHTML and +# should work on any modern browser. Note that when using HTML help +# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) +# there is already a search function so this one should typically be disabled. +# For large projects the javascript based search engine can be slow, then +# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to +# search using the keyboard; to jump to the search box use + S +# (what the is depends on the OS and browser, but it is typically +# , /