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 }}
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/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/README.md b/README.md
index 4d4493b..e18a61c 100644
--- a/README.md
+++ b/README.md
@@ -1,38 +1,55 @@
-SparkFun VEML7700 Arduino Library
-==============================
+
-[](https://www.sparkfun.com/products/18981)
+# SparkFun Ambient Light Sensor - VEML7700 Arduino Library
-[*SparkX Ambient Light Sensor - VEML7700 (Qwiic) (SPX-18981)*](https://www.sparkfun.com/products/18981)
+SparkFun Ambient Light Sensor - VEML7700 - AS7343 (QWIIC)
-The Vishay Semiconductors VEML7700 is a high accuracy ambient light sensor with 16-bit resolution in a miniature transparent package. It includes a high sensitive photo diode, a low noise amplifier, a 16-bit A/D converter and supports the I2C bus communication interface.
-
-This library handles the initialization and configuration of the sensor, and monitoring of the ambient light level.
+
+
+
+
+
+
-## Repository Contents
-* **/examples** - Example sketches for the library (.ino). Run these from the Arduino IDE.
-* **/src** - Source files for the library (.cpp, .h).
-* **keywords.txt** - Keywords from this library that will be highlighted in the Arduino IDE.
-* **library.properties** - General library properties for the Arduino package manager.
-* **LICENSE.md** - Contains the license information.
+This library provides full access to the functions of the VEML7700 Ambient Light Sensor through an I2C connection using the SparkFun Qwiic connectors and cables.
+
+### Supported Products
+This library is intended for use with the following SparkFun Product - available at [www.sparkfun.com](https://www.sparkfun.com).
+
+| Product | Description|
+|--|--|
+|[SparkFun Ambient Light Sensor - VEML7700 (Qwiic)](https://www.sparkfun.com/sparkfun-ambient-light-sensor-veml7700-qwiic.html) | The SparkFun Qwiic VEML7700 Ambient Light Sensor provides accurate, 16-bit ambient light readings from 0 to 167,000 lux via the I2C interface. This miniature sensor (6.8mm x 3.0mm x 2.5mm) features a high-sensitivity photodiode, a low-noise amplifier, and a 16-bit analog-to-digital (A/D) converter. Its unshifted 7-bit I2C address is 0x10.|
## Documentation
-- **/docs** - HTML documentation generated with [Doxygen](https://www.doxygen.nl/index.html). Open [**GitHub Pages**](https://sparkfun.github.io/SparkFun_VEML7700_Arduino_Library/) to view the documentation.
-- **[Installing an Arduino Library Guide](https://learn.sparkfun.com/tutorials/installing-an-arduino-library)** - Basic information on how to install an Arduino library.
+|Reference | Description |
+|---|---|
+|[Library Documentation](https://docs.sparkfun.com/SparkFun_VEML7700_Arduino_Library/)| The full documentation and API for this Arduino library|
+|[SparkFun Ambient Light Sensor - VEML7700 (Qwiic)](https://github.com/sparkfun/SparkFun_Ambient_Light_Sensor-VEML7700)| Hardware GitHub Repository|
+|[Hook Up Guide - SparkFun Ambient Light Sensor - VEML7700 (Qwiic)](https://docs.sparkfun.com/SparkFun_Ambient_Light_Sensor-VEML7700/introduction/) | Hardware Overview and Quick Start for the Ambient Light Sensor - VEML7700|
+|[SparkFun Ambient Light Sensor - VEML7700 (Qwiic)](https://github.com/sparkfun/SparkFun_VEML7700_Arduino_Library)| Arduino Library - GitHub Repository|
+|[VEML7700 Datasheet](https://cdn.sparkfun.com/assets/a/2/b/a/4/VEML7700_Datasheet.pdf) | Datasheet for the VEML7700 IC|
+|[Installing an Arduino Library Guide](https://learn.sparkfun.com/tutorials/installing-an-arduino-library)| Basic information on how to install an Arduino library|
-## Products That Use This Library
+## Examples
-* [SPX-18976](https://www.sparkfun.com/products/18976) - smôl Environmental Peripheral Board
-* [SPX-18981](https://www.sparkfun.com/products/18981) - Ambient Light Sensor - VEML7700 (Qwiic)
+The following examples are provided with the library
+
+| Example | Description |
+|---|---|
+|[Read LUX Value](examples/Example1_getLux/Example1_getLux.ino)| Take basic readings from the sensor - read the currently detect LUX value.|
+|[Change Settings](examples/Example2_changeSettings/Example2_changeSettings.ino)| Change the operational settings of the sensor|
+|[Threshold Settings](examples/Example3_threshold/Example3_threshold.ino)| Set threshold values and check for threshold triggered interrupts.|
+|[Power Settomgs](examples/Example4_shutDown/Example4_shutDown.ino)| Shows how to shutdown and power up the sensor.|
+|[Production Test](examples/Example5_ProductionTest/Example5_ProductionTest.ino)| Test used during board production |
-## License Information
-This product is _**open source**_!
-Please use, reuse, and modify these files as you see fit. Please maintain attribution to SparkFun Electronics and release anything derivative under the same license.
-Distributed as-is; no warranty is given.
+## License Information
+
+This product is ***open source***!
+
+This product is licensed using the [MIT Open Source License](https://opensource.org/license/mit).
-- Your friends at SparkFun.
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
-
-
-
-
-
-
-
-
-
-
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
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
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...
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...
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...
-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.
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
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
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
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
-
-
-Generated by 1.9.1
-
-
-
diff --git a/docs/doc.png b/docs/doc.png
deleted file mode 100644
index 17edabf..0000000
Binary files a/docs/doc.png and /dev/null differ
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/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/Doxyfile b/docs/doxygen/doxygen-config
similarity index 80%
rename from Doxyfile
rename to docs/doxygen/doxygen-config
index 681f4b0..15d3764 100644
--- a/Doxyfile
+++ b/docs/doxygen/doxygen-config
@@ -1,4 +1,4 @@
-# Doxyfile 1.9.1
+# Doxyfile 1.10.0
# This file describes the settings to be used by the documentation system
# doxygen (www.doxygen.org) for a project.
@@ -12,6 +12,16 @@
# 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
@@ -32,44 +42,62 @@ DOXYFILE_ENCODING = UTF-8
# title of most generated pages and in a few other places.
# The default value is: My Project.
-PROJECT_NAME = SparkFun_VEML7700_Arduino_Library
+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 =
+# 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 =
+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 =
+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 =
+OUTPUT_DIRECTORY = ./docs
-# If the CREATE_SUBDIRS tag is set to YES then doxygen will create 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
+# 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.
+# 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
@@ -81,26 +109,18 @@ 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, Catalan, Chinese,
-# Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States),
-# Esperanto, Farsi (Persian), Finnish, French, German, Greek, 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.
+# 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
-# The OUTPUT_TEXT_DIRECTION tag is used to specify the direction in which all
-# documentation generated by doxygen is written. Doxygen will use this
-# information to generate all generated output in the proper direction.
-# Possible values are: None, LTR, RTL and Context.
-# The default value is: None.
-
-OUTPUT_TEXT_DIRECTION = None
-
# 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.
@@ -143,7 +163,7 @@ ABBREVIATE_BRIEF = "The $name class" \
# description.
# The default value is: NO.
-ALWAYS_DETAILED_SEC = 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
@@ -151,7 +171,7 @@ ALWAYS_DETAILED_SEC = NO
# operators of the base classes will not be shown.
# The default value is: NO.
-INLINE_INHERITED_MEMB = 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
@@ -258,16 +278,16 @@ TAB_SIZE = 4
# the documentation. An alias has the form:
# name=value
# For example adding
-# "sideeffect=@par Side Effects:\n"
+# "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:". You can 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 \\})
+# "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 =
@@ -312,8 +332,8 @@ OPTIMIZE_OUTPUT_SLICE = NO
# 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++, D, PHP, md (Markdown), Objective-C, Python, Slice, VHDL,
-# Fortran (fixed format Fortran: FortranFixed, free formatted Fortran:
+# 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
@@ -349,6 +369,17 @@ MARKDOWN_SUPPORT = 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
@@ -365,7 +396,7 @@ AUTOLINK_SUPPORT = YES
# diagrams that involve STL classes more complete and accurate.
# The default value is: NO.
-BUILTIN_STL_SUPPORT = NO
+BUILTIN_STL_SUPPORT = YES
# If you use Microsoft's C++/CLI language, you should set this option to YES to
# enable parsing support.
@@ -460,19 +491,27 @@ TYPEDEF_HIDES_STRUCT = NO
LOOKUP_CACHE_SIZE = 0
-# The NUM_PROC_THREADS specifies the number threads doxygen is allowed to use
+# 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 efficively disables parallel processing. Please report any issues you
+# 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
#---------------------------------------------------------------------------
@@ -485,7 +524,7 @@ NUM_PROC_THREADS = 1
# normally produced when WARNINGS is set to YES.
# The default value is: NO.
-EXTRACT_ALL = 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.
@@ -554,7 +593,8 @@ 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
-# has no effect if EXTRACT_ALL is enabled.
+# 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
@@ -585,14 +625,15 @@ INTERNAL_DOCS = NO
# 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 be set to NO to properly deal with
+# 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.
-# The default value is: system dependent.
+# Possible values are: SYSTEM, NO and YES.
+# The default value is: SYSTEM.
CASE_SENSE_NAMES = NO
@@ -608,7 +649,13 @@ HIDE_SCOPE_NAMES = NO
# YES the compound reference will be hidden.
# The default value is: NO.
-HIDE_COMPOUND_REFERENCE= 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.
@@ -712,7 +759,7 @@ GENERATE_BUGLIST = YES
# the documentation.
# The default value is: YES.
-GENERATE_DEPRECATEDLIST= YES
+GENERATE_DEPRECATEDLIST = YES
# The ENABLED_SECTIONS tag can be used to enable conditional documentation
# sections, marked by \if ... \endif and \cond
@@ -750,7 +797,7 @@ SHOW_FILES = YES
# Folder Tree View (if specified).
# The default value is: YES.
-SHOW_NAMESPACES = 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
@@ -767,7 +814,8 @@ FILE_VERSION_FILTER =
# 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.
+# 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
@@ -813,27 +861,50 @@ WARNINGS = 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 not documenting some parameters
-# in a documented function, or documenting parameters that don't exist or using
-# markup commands wrongly.
+# 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 or incomplete
-# parameter documentation, but not about the absence of documentation. If
-# EXTRACT_ALL is set to YES then this flag will automatically be disabled.
+# 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.
-# Possible values are: NO, YES and FAIL_ON_WARNINGS.
+# 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
@@ -844,13 +915,27 @@ WARN_AS_ERROR = NO
# 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).
+# 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 =
@@ -864,17 +949,30 @@ WARN_LOGFILE =
# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
# Note: If this tag is empty the current directory is searched.
-INPUT = src
+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.
@@ -886,64 +984,29 @@ INPUT_ENCODING = UTF-8
# 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, *.cpp,
-# *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h,
-# *.hh, *.hxx, *.hpp, *.h++, *.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.
+# 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++ \
- *.java \
- *.ii \
- *.ixx \
- *.ipp \
- *.i++ \
- *.inl \
- *.idl \
- *.ddl \
- *.odl \
*.h \
- *.hh \
- *.hxx \
*.hpp \
- *.h++ \
- *.cs \
- *.d \
- *.php \
- *.php4 \
- *.php5 \
- *.phtml \
- *.inc \
- *.m \
*.markdown \
*.md \
- *.mm \
- *.dox \
- *.py \
- *.pyw \
- *.f90 \
- *.f95 \
- *.f03 \
- *.f08 \
- *.f18 \
- *.f \
- *.for \
- *.vhd \
- *.vhdl \
- *.ucf \
- *.qsf \
- *.ice
+ *.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 = 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
@@ -952,7 +1015,8 @@ RECURSIVE = NO
# Note that relative paths are relative to the directory from which doxygen is
# run.
-EXCLUDE =
+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
@@ -974,10 +1038,7 @@ EXCLUDE_PATTERNS =
# (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,
-# AClass::ANamespace, ANamespace::*Test
-#
-# Note that the wildcards are matched against the file with absolute path, so to
-# exclude all test directories use the pattern */test/*
+# ANamespace::AClass, ANamespace::*Test
EXCLUDE_SYMBOLS =
@@ -1005,7 +1066,7 @@ EXAMPLE_RECURSIVE = NO
# that contain images that are to be included in the documentation (see the
# \image command).
-IMAGE_PATH =
+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
@@ -1022,6 +1083,11 @@ IMAGE_PATH =
# 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.
@@ -1061,7 +1127,16 @@ FILTER_SOURCE_PATTERNS =
# (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 =
+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
@@ -1077,7 +1152,8 @@ USE_MDFILE_AS_MAINPAGE =
SOURCE_BROWSER = NO
# Setting the INLINE_SOURCES tag to YES will include the body of functions,
-# classes and enums directly into the documentation.
+# multi-line macros, enums or list initialized variables directly into the
+# documentation.
# The default value is: NO.
INLINE_SOURCES = NO
@@ -1149,44 +1225,6 @@ USE_HTAGS = NO
VERBATIM_HEADERS = YES
-# If the CLANG_ASSISTED_PARSING tag is set to YES then doxygen will use the
-# clang parser (see:
-# http://clang.llvm.org/) for more accurate parsing at the cost of reduced
-# performance. This can be particularly helpful with template rich C++ code for
-# which doxygen's built-in parser lacks the necessary type information.
-# Note: The availability of this option depends on whether or not doxygen was
-# generated with the -Duse_libclang=ON option for CMake.
-# The default value is: NO.
-
-CLANG_ASSISTED_PARSING = NO
-
-# If clang assisted parsing is enabled and the CLANG_ADD_INC_PATHS tag is set to
-# YES then doxygen will add the directory of each input to the include path.
-# The default value is: YES.
-
-CLANG_ADD_INC_PATHS = YES
-
-# If clang assisted parsing is enabled you can provide the compiler with command
-# line options that you would normally use when invoking the compiler. Note that
-# the include paths will already be set by doxygen for the files and directories
-# specified with INPUT and INCLUDE_PATH.
-# This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES.
-
-CLANG_OPTIONS =
-
-# If clang assisted parsing is enabled you can provide the clang parser with the
-# path to the directory containing a file called compile_commands.json. This
-# file is the compilation database (see:
-# http://clang.llvm.org/docs/HowToSetupToolingForLLVM.html) containing the
-# options used when the source files were built. This is equivalent to
-# specifying the -p option to a clang tool, such as clang-check. These options
-# will then be passed to the parser. Any options specified with CLANG_OPTIONS
-# will be added as well.
-# Note: The availability of this option depends on whether or not doxygen was
-# generated with the -Duse_libclang=ON option for CMake.
-
-CLANG_DATABASE_PATH =
-
#---------------------------------------------------------------------------
# Configuration options related to the alphabetical class index
#---------------------------------------------------------------------------
@@ -1198,10 +1236,11 @@ CLANG_DATABASE_PATH =
ALPHABETICAL_INDEX = YES
-# In case all classes in a project start with a common prefix, all classes will
-# be put under the same header in the alphabetical index. 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 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 =
@@ -1248,7 +1287,7 @@ HTML_FILE_EXTENSION = .html
# of the possible markers and block names see the documentation.
# This tag requires that the tag GENERATE_HTML is set to YES.
-HTML_HEADER =
+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
@@ -1280,10 +1319,17 @@ HTML_STYLESHEET =
# 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). For an example see the documentation.
+# 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 =
+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
@@ -1295,24 +1341,37 @@ HTML_EXTRA_STYLESHEET =
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 colorwheel, see
+# 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 = 220
+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 grayscales only. A
+# 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 = 100
+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
@@ -1323,16 +1382,7 @@ HTML_COLORSTYLE_SAT = 100
# Minimum value: 40, maximum value: 240, default value: 80.
# This tag requires that the tag GENERATE_HTML is set to YES.
-HTML_COLORSTYLE_GAMMA = 80
-
-# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
-# page will contain the date and time when the page was generated. Setting this
-# to YES can help to show when doxygen was last run and thus if the
-# documentation is up to date.
-# The default value is: NO.
-# This tag requires that the tag GENERATE_HTML is set to YES.
-
-HTML_TIMESTAMP = NO
+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
@@ -1353,6 +1403,33 @@ HTML_DYNAMIC_MENUS = 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
@@ -1364,7 +1441,7 @@ HTML_DYNAMIC_SECTIONS = NO
# 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 = 100
+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
@@ -1389,6 +1466,13 @@ GENERATE_DOCSET = NO
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.
@@ -1414,8 +1498,12 @@ 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
-# (see:
-# https://www.microsoft.com/en-us/download/details.aspx?id=21138) on Windows.
+# 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
@@ -1472,6 +1560,16 @@ BINARY_TOC = NO
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
@@ -1574,15 +1672,27 @@ DISABLE_INDEX = NO
# 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. 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.
+# 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.
-GENERATE_TREEVIEW = NO
+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.
@@ -1599,7 +1709,7 @@ ENUM_VALUES_PER_LINE = 4
# Minimum value: 0, maximum value: 1500, default value: 250.
# This tag requires that the tag GENERATE_HTML is set to YES.
-TREEVIEW_WIDTH = 250
+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.
@@ -1608,6 +1718,13 @@ TREEVIEW_WIDTH = 250
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
@@ -1628,17 +1745,6 @@ HTML_FORMULA_FORMAT = png
FORMULA_FONTSIZE = 10
-# Use the FORMULA_TRANSPARENT tag to determine whether or not the images
-# generated for formulas are transparent PNGs. Transparent PNGs are not
-# supported properly for IE 6.0, but are supported on all modern browsers.
-#
-# Note that when changing this option you need to delete any form_*.png files in
-# the HTML output directory before the changes have effect.
-# The default value is: YES.
-# This tag requires that the tag GENERATE_HTML is set to YES.
-
-FORMULA_TRANSPARENT = YES
-
# 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.
@@ -1656,11 +1762,29 @@ FORMULA_MACROFILE =
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. See the MathJax site (see:
-# http://docs.mathjax.org/en/v2.7-latest/output.html) for more details.
+# 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), NativeMML (i.e. MathML) and SVG.
+# 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.
@@ -1673,15 +1797,21 @@ MATHJAX_FORMAT = HTML-CSS
# 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: https://cdn.jsdelivr.net/npm/mathjax@2.
+# 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://cdn.jsdelivr.net/npm/mathjax@2
+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 =
@@ -1810,7 +1940,7 @@ LATEX_OUTPUT = latex
# the output language.
# This tag requires that the tag GENERATE_LATEX is set to YES.
-LATEX_CMD_NAME =
+LATEX_CMD_NAME = latex
# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate
# index for LaTeX.
@@ -1861,29 +1991,31 @@ PAPER_TYPE = a4
EXTRA_PACKAGES =
-# The LATEX_HEADER tag can be used to specify a personal LaTeX header for the
-# generated LaTeX document. The header should contain everything until the first
-# chapter. If it is left blank doxygen will generate a standard header. See
-# section "Doxygen usage" for information on how to let doxygen write the
-# default header to a separate file.
+# The LATEX_HEADER tag can be used to specify a user-defined LaTeX header for
+# the generated LaTeX document. The header should contain everything until the
+# first chapter. If it is left blank doxygen will generate a standard header. It
+# is highly recommended to start with a default header using
+# doxygen -w latex new_header.tex new_footer.tex new_stylesheet.sty
+# and then modify the file new_header.tex. See also section "Doxygen usage" for
+# information on how to generate the default header that doxygen normally uses.
#
-# Note: Only use a user-defined header if you know what you are doing! The
-# following commands have a special meaning inside the header: $title,
-# $datetime, $date, $doxygenversion, $projectname, $projectnumber,
-# $projectbrief, $projectlogo. Doxygen will replace $title with the empty
-# string, for the replacement values of the other commands the user is referred
-# to HTML_HEADER.
+# Note: Only use a user-defined header if you know what you are doing!
+# Note: The header is subject to change so you typically have to regenerate the
+# default header when upgrading to a newer version of doxygen. The following
+# commands have a special meaning inside the header (and footer): For a
+# description of the possible markers and block names see the documentation.
# This tag requires that the tag GENERATE_LATEX is set to YES.
LATEX_HEADER =
-# The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for the
-# generated LaTeX document. The footer should contain everything after the last
-# chapter. If it is left blank doxygen will generate a standard footer. See
+# The LATEX_FOOTER tag can be used to specify a user-defined LaTeX footer for
+# the generated LaTeX document. The footer should contain everything after the
+# last chapter. If it is left blank doxygen will generate a standard footer. See
# LATEX_HEADER for more information on how to generate a default footer and what
-# special commands can be used inside the footer.
-#
-# Note: Only use a user-defined footer if you know what you are doing!
+# 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. Note: Only use a user-defined footer if you know what you are
+# doing!
# This tag requires that the tag GENERATE_LATEX is set to YES.
LATEX_FOOTER =
@@ -1926,10 +2058,16 @@ PDF_HYPERLINKS = YES
USE_PDFLATEX = YES
-# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode
-# command to the generated LaTeX files. This will instruct LaTeX to keep running
-# if errors occur, instead of asking the user for help. This option is also used
-# when generating formulas in HTML.
+# The LATEX_BATCHMODE tag signals the behavior of LaTeX in case of an error.
+# Possible values are: NO same as ERROR_STOP, YES same as BATCH, BATCH In batch
+# mode nothing is printed on the terminal, errors are scrolled as if is
+# hit at every error; missing files that TeX tries to input or request from
+# keyboard input (\read on a not open input stream) cause the job to abort,
+# NON_STOP In nonstop mode the diagnostic message will appear on the terminal,
+# but there is no possibility of user interaction just like in batch mode,
+# SCROLL In scroll mode, TeX will stop only for missing files to input or if
+# keyboard input is necessary and ERROR_STOP In errorstop mode, TeX will stop at
+# each error, asking for user intervention.
# The default value is: NO.
# This tag requires that the tag GENERATE_LATEX is set to YES.
@@ -1942,16 +2080,6 @@ LATEX_BATCHMODE = NO
LATEX_HIDE_INDICES = NO
-# If the LATEX_SOURCE_CODE tag is set to YES then doxygen will include source
-# code with syntax highlighting in the LaTeX output.
-#
-# Note that which sources are shown also depends on other settings such as
-# SOURCE_BROWSER.
-# The default value is: NO.
-# This tag requires that the tag GENERATE_LATEX is set to YES.
-
-LATEX_SOURCE_CODE = NO
-
# The LATEX_BIB_STYLE tag can be used to specify the style to use for the
# bibliography, e.g. plainnat, or ieeetr. See
# https://en.wikipedia.org/wiki/BibTeX and \cite for more info.
@@ -1960,14 +2088,6 @@ LATEX_SOURCE_CODE = NO
LATEX_BIB_STYLE = plain
-# If the LATEX_TIMESTAMP tag is set to YES then the footer of each generated
-# page will contain the date and time when the page was generated. Setting this
-# to NO can help when comparing the output of multiple runs.
-# The default value is: NO.
-# This tag requires that the tag GENERATE_LATEX is set to YES.
-
-LATEX_TIMESTAMP = NO
-
# The LATEX_EMOJI_DIRECTORY tag is used to specify the (relative or absolute)
# path from which the emoji images will be read. If a relative path is entered,
# it will be relative to the LATEX_OUTPUT directory. If left blank the
@@ -2032,16 +2152,6 @@ RTF_STYLESHEET_FILE =
RTF_EXTENSIONS_FILE =
-# If the RTF_SOURCE_CODE tag is set to YES then doxygen will include source code
-# with syntax highlighting in the RTF output.
-#
-# Note that which sources are shown also depends on other settings such as
-# SOURCE_BROWSER.
-# The default value is: NO.
-# This tag requires that the tag GENERATE_RTF is set to YES.
-
-RTF_SOURCE_CODE = NO
-
#---------------------------------------------------------------------------
# Configuration options related to the man page output
#---------------------------------------------------------------------------
@@ -2138,21 +2248,12 @@ GENERATE_DOCBOOK = NO
DOCBOOK_OUTPUT = docbook
-# If the DOCBOOK_PROGRAMLISTING tag is set to YES, doxygen will include the
-# program listings (including syntax highlighting and cross-referencing
-# information) to the DOCBOOK output. Note that enabling this will significantly
-# increase the size of the DOCBOOK output.
-# The default value is: NO.
-# This tag requires that the tag GENERATE_DOCBOOK is set to YES.
-
-DOCBOOK_PROGRAMLISTING = NO
-
#---------------------------------------------------------------------------
# Configuration options for the AutoGen Definitions output
#---------------------------------------------------------------------------
# If the GENERATE_AUTOGEN_DEF tag is set to YES, doxygen will generate an
-# AutoGen Definitions (see http://autogen.sourceforge.net/) file that captures
+# AutoGen Definitions (see https://autogen.sourceforge.net/) file that captures
# the structure of the code including all documentation. Note that this feature
# is still experimental and incomplete at the moment.
# The default value is: NO.
@@ -2163,6 +2264,28 @@ GENERATE_AUTOGEN_DEF = NO
# Configuration options related to Sqlite3 output
#---------------------------------------------------------------------------
+# If the GENERATE_SQLITE3 tag is set to YES doxygen will generate a Sqlite3
+# database with symbols found by doxygen stored in tables.
+# The default value is: NO.
+
+GENERATE_SQLITE3 = NO
+
+# The SQLITE3_OUTPUT tag is used to specify where the Sqlite3 database 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: sqlite3.
+# This tag requires that the tag GENERATE_SQLITE3 is set to YES.
+
+SQLITE3_OUTPUT = sqlite3
+
+# The SQLITE3_RECREATE_DB tag is set to YES, the existing doxygen_sqlite3.db
+# database file will be recreated with each doxygen run. If set to NO, doxygen
+# will warn if a database file is already found and not modify it.
+# The default value is: YES.
+# This tag requires that the tag GENERATE_SQLITE3 is set to YES.
+
+SQLITE3_RECREATE_DB = YES
+
#---------------------------------------------------------------------------
# Configuration options related to the Perl module output
#---------------------------------------------------------------------------
@@ -2237,7 +2360,8 @@ SEARCH_INCLUDES = YES
# The INCLUDE_PATH tag can be used to specify one or more directories that
# contain include files that are not input files but should be processed by the
-# preprocessor.
+# preprocessor. Note that the INCLUDE_PATH is not recursive, so the setting of
+# RECURSIVE has no effect here.
# This tag requires that the tag SEARCH_INCLUDES is set to YES.
INCLUDE_PATH =
@@ -2304,15 +2428,15 @@ TAGFILES =
GENERATE_TAGFILE =
-# If the ALLEXTERNALS tag is set to YES, all external class will be listed in
-# the class index. If set to NO, only the inherited external classes will be
-# listed.
+# If the ALLEXTERNALS tag is set to YES, all external classes and namespaces
+# will be listed in the class and namespace index. If set to NO, only the
+# inherited external classes will be listed.
# The default value is: NO.
ALLEXTERNALS = NO
# If the EXTERNAL_GROUPS tag is set to YES, all external groups will be listed
-# in the modules index. If set to NO, only the current project's groups will be
+# in the topic index. If set to NO, only the current project's groups will be
# listed.
# The default value is: YES.
@@ -2326,25 +2450,9 @@ EXTERNAL_GROUPS = YES
EXTERNAL_PAGES = YES
#---------------------------------------------------------------------------
-# Configuration options related to the dot tool
+# Configuration options related to diagram generator tools
#---------------------------------------------------------------------------
-# If the CLASS_DIAGRAMS tag is set to YES, doxygen will generate a class diagram
-# (in HTML and LaTeX) for classes with base or super classes. Setting the tag to
-# NO turns the diagrams off. Note that this option also works with HAVE_DOT
-# disabled, but it is recommended to install and use dot, since it yields more
-# powerful graphs.
-# The default value is: YES.
-
-CLASS_DIAGRAMS = YES
-
-# You can include diagrams made with dia in doxygen documentation. Doxygen will
-# then run dia to produce the diagram and insert it in the documentation. The
-# DIA_PATH tag allows you to specify the directory where the dia binary resides.
-# If left empty dia is assumed to be found in the default search path.
-
-DIA_PATH =
-
# If set to YES the inheritance and collaboration graphs will hide inheritance
# and usage relations if the target is undocumented or is not a class.
# The default value is: YES.
@@ -2353,12 +2461,12 @@ HIDE_UNDOC_RELATIONS = YES
# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
# available from the path. This tool is part of Graphviz (see:
-# http://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent
+# https://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent
# Bell Labs. The other options in this section have no effect if this option is
# set to NO
# The default value is: NO.
-HAVE_DOT = NO
+HAVE_DOT = YES
# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed
# to run in parallel. When set to 0 doxygen will base this on the number of
@@ -2370,49 +2478,77 @@ HAVE_DOT = NO
DOT_NUM_THREADS = 0
-# When you want a differently looking font in the dot files that doxygen
-# generates you can specify the font name using DOT_FONTNAME. You need to make
-# sure dot is able to find the font, which can be done by putting it in a
-# standard location or by setting the DOTFONTPATH environment variable or by
-# setting DOT_FONTPATH to the directory containing the font.
-# The default value is: Helvetica.
+# DOT_COMMON_ATTR is common attributes for nodes, edges and labels of
+# subgraphs. When you want a differently looking font in the dot files that
+# doxygen generates you can specify fontname, fontcolor and fontsize attributes.
+# For details please see Node,
+# Edge and Graph Attributes specification You need to make sure dot is able
+# to find the font, which can be done by putting it in a standard location or by
+# setting the DOTFONTPATH environment variable or by setting DOT_FONTPATH to the
+# directory containing the font. Default graphviz fontsize is 14.
+# The default value is: fontname=Helvetica,fontsize=10.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+DOT_COMMON_ATTR = "fontname=Helvetica,fontsize=10"
+
+# DOT_EDGE_ATTR is concatenated with DOT_COMMON_ATTR. For elegant style you can
+# add 'arrowhead=open, arrowtail=open, arrowsize=0.5'. Complete documentation about
+# arrows shapes.
+# The default value is: labelfontname=Helvetica,labelfontsize=10.
# This tag requires that the tag HAVE_DOT is set to YES.
-DOT_FONTNAME = Helvetica
+DOT_EDGE_ATTR = "labelfontname=Helvetica,labelfontsize=10"
-# The DOT_FONTSIZE tag can be used to set the size (in points) of the font of
-# dot graphs.
-# Minimum value: 4, maximum value: 24, default value: 10.
+# DOT_NODE_ATTR is concatenated with DOT_COMMON_ATTR. For view without boxes
+# around nodes set 'shape=plain' or 'shape=plaintext' Shapes specification
+# The default value is: shape=box,height=0.2,width=0.4.
# This tag requires that the tag HAVE_DOT is set to YES.
-DOT_FONTSIZE = 10
+DOT_NODE_ATTR = "shape=box,height=0.2,width=0.4"
-# By default doxygen will tell dot to use the default font as specified with
-# DOT_FONTNAME. If you specify a different font using DOT_FONTNAME you can set
-# the path where dot can find it using this tag.
+# You can set the path where dot can find font specified with fontname in
+# DOT_COMMON_ATTR and others dot attributes.
# This tag requires that the tag HAVE_DOT is set to YES.
DOT_FONTPATH =
-# If the CLASS_GRAPH tag is set to YES then doxygen will generate a graph for
-# each documented class showing the direct and indirect inheritance relations.
-# Setting this tag to YES will force the CLASS_DIAGRAMS tag to NO.
+# If the CLASS_GRAPH tag is set to YES or GRAPH or BUILTIN then doxygen will
+# generate a graph for each documented class showing the direct and indirect
+# inheritance relations. In case the CLASS_GRAPH tag is set to YES or GRAPH and
+# HAVE_DOT is enabled as well, then dot will be used to draw the graph. In case
+# the CLASS_GRAPH tag is set to YES and HAVE_DOT is disabled or if the
+# CLASS_GRAPH tag is set to BUILTIN, then the built-in generator will be used.
+# If the CLASS_GRAPH tag is set to TEXT the direct and indirect inheritance
+# relations will be shown as texts / links. Explicit enabling an inheritance
+# graph or choosing a different representation for an inheritance graph of a
+# specific class, can be accomplished by means of the command \inheritancegraph.
+# Disabling an inheritance graph can be accomplished by means of the command
+# \hideinheritancegraph.
+# Possible values are: NO, YES, TEXT, GRAPH and BUILTIN.
# The default value is: YES.
-# This tag requires that the tag HAVE_DOT is set to YES.
CLASS_GRAPH = YES
# If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a
# graph for each documented class showing the direct and indirect implementation
# dependencies (inheritance, containment, and class references variables) of the
-# class with other documented classes.
+# class with other documented classes. Explicit enabling a collaboration graph,
+# when COLLABORATION_GRAPH is set to NO, can be accomplished by means of the
+# command \collaborationgraph. Disabling a collaboration graph can be
+# accomplished by means of the command \hidecollaborationgraph.
# The default value is: YES.
# This tag requires that the tag HAVE_DOT is set to YES.
-COLLABORATION_GRAPH = YES
+COLLABORATION_GRAPH = NO
# If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for
-# groups, showing the direct groups dependencies.
+# groups, showing the direct groups dependencies. Explicit enabling a group
+# dependency graph, when GROUP_GRAPHS is set to NO, can be accomplished by means
+# of the command \groupgraph. Disabling a directory graph can be accomplished by
+# means of the command \hidegroupgraph. See also the chapter Grouping in the
+# manual.
# The default value is: YES.
# This tag requires that the tag HAVE_DOT is set to YES.
@@ -2424,7 +2560,7 @@ GROUP_GRAPHS = YES
# The default value is: NO.
# This tag requires that the tag HAVE_DOT is set to YES.
-UML_LOOK = NO
+UML_LOOK = YES
# If the UML_LOOK tag is enabled, the fields and methods are shown inside the
# class node. If there are many fields or methods and many nodes the graph may
@@ -2454,8 +2590,8 @@ DOT_UML_DETAILS = NO
# The DOT_WRAP_THRESHOLD tag can be used to set the maximum number of characters
# to display on a single line. If the actual line length exceeds this threshold
-# significantly it will wrapped across multiple lines. Some heuristics are apply
-# to avoid ugly line breaks.
+# significantly it will be wrapped across multiple lines. Some heuristics are
+# applied to avoid ugly line breaks.
# Minimum value: 0, maximum value: 1000, default value: 17.
# This tag requires that the tag HAVE_DOT is set to YES.
@@ -2472,7 +2608,9 @@ TEMPLATE_RELATIONS = NO
# If the INCLUDE_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are set to
# YES then doxygen will generate a graph for each documented file showing the
# direct and indirect include dependencies of the file with other documented
-# files.
+# files. Explicit enabling an include graph, when INCLUDE_GRAPH is is set to NO,
+# can be accomplished by means of the command \includegraph. Disabling an
+# include graph can be accomplished by means of the command \hideincludegraph.
# The default value is: YES.
# This tag requires that the tag HAVE_DOT is set to YES.
@@ -2481,7 +2619,10 @@ INCLUDE_GRAPH = YES
# If the INCLUDED_BY_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are
# set to YES then doxygen will generate a graph for each documented file showing
# the direct and indirect include dependencies of the file with other documented
-# files.
+# files. Explicit enabling an included by graph, when INCLUDED_BY_GRAPH is set
+# to NO, can be accomplished by means of the command \includedbygraph. Disabling
+# an included by graph can be accomplished by means of the command
+# \hideincludedbygraph.
# The default value is: YES.
# This tag requires that the tag HAVE_DOT is set to YES.
@@ -2521,16 +2662,26 @@ GRAPHICAL_HIERARCHY = YES
# If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the
# dependencies a directory has on other directories in a graphical way. The
# dependency relations are determined by the #include relations between the
-# files in the directories.
+# files in the directories. Explicit enabling a directory graph, when
+# DIRECTORY_GRAPH is set to NO, can be accomplished by means of the command
+# \directorygraph. Disabling a directory graph can be accomplished by means of
+# the command \hidedirectorygraph.
# The default value is: YES.
# This tag requires that the tag HAVE_DOT is set to YES.
DIRECTORY_GRAPH = YES
+# The DIR_GRAPH_MAX_DEPTH tag can be used to limit the maximum number of levels
+# of child directories generated in directory dependency graphs by dot.
+# Minimum value: 1, maximum value: 25, default value: 1.
+# This tag requires that the tag DIRECTORY_GRAPH is set to YES.
+
+DIR_GRAPH_MAX_DEPTH = 1
+
# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
# generated by dot. For an explanation of the image formats see the section
# output formats in the documentation of the dot tool (Graphviz (see:
-# http://www.graphviz.org/)).
+# https://www.graphviz.org/)).
# Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order
# to make the SVG files visible in IE 9+ (other browsers do not have this
# requirement).
@@ -2540,7 +2691,7 @@ DIRECTORY_GRAPH = YES
# The default value is: png.
# This tag requires that the tag HAVE_DOT is set to YES.
-DOT_IMAGE_FORMAT = png
+DOT_IMAGE_FORMAT = svg
# If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
# enable generation of interactive SVG images that allow zooming and panning.
@@ -2567,11 +2718,12 @@ DOT_PATH =
DOTFILE_DIRS =
-# The MSCFILE_DIRS tag can be used to specify one or more directories that
-# contain msc files that are included in the documentation (see the \mscfile
-# command).
+# You can include diagrams made with dia in doxygen documentation. Doxygen will
+# then run dia to produce the diagram and insert it in the documentation. The
+# DIA_PATH tag allows you to specify the directory where the dia binary resides.
+# If left empty dia is assumed to be found in the default search path.
-MSCFILE_DIRS =
+DIA_PATH =
# The DIAFILE_DIRS tag can be used to specify one or more directories that
# contain dia files that are included in the documentation (see the \diafile
@@ -2580,10 +2732,10 @@ MSCFILE_DIRS =
DIAFILE_DIRS =
# When using plantuml, the PLANTUML_JAR_PATH tag should be used to specify the
-# path where java can find the plantuml.jar file. If left blank, it is assumed
-# PlantUML is not used or called during a preprocessing step. Doxygen will
-# generate a warning when it encounters a \startuml command in this case and
-# will not generate output for the diagram.
+# path where java can find the plantuml.jar file or to the filename of jar file
+# to be used. If left blank, it is assumed PlantUML is not used or called during
+# a preprocessing step. Doxygen will generate a warning when it encounters a
+# \startuml command in this case and will not generate output for the diagram.
PLANTUML_JAR_PATH =
@@ -2621,18 +2773,6 @@ DOT_GRAPH_MAX_NODES = 50
MAX_DOT_GRAPH_DEPTH = 0
-# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
-# background. This is disabled by default, because dot on Windows does not seem
-# to support this out of the box.
-#
-# Warning: Depending on the platform used, enabling this option may lead to
-# badly anti-aliased labels on the edges of a graph (i.e. they become hard to
-# read).
-# The default value is: NO.
-# This tag requires that the tag HAVE_DOT is set to YES.
-
-DOT_TRANSPARENT = NO
-
# Set the DOT_MULTI_TARGETS tag to YES to allow dot to generate multiple output
# files in one run (i.e. multiple -o and -T options on the command line). This
# makes dot run faster, but since only newer versions of dot (>1.8.10) support
@@ -2645,6 +2785,8 @@ DOT_MULTI_TARGETS = NO
# If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page
# explaining the meaning of the various boxes and arrows in the dot generated
# graphs.
+# Note: This tag requires that UML_LOOK isn't set, i.e. the doxygen internal
+# graphical representation for inheritance and collaboration diagrams is used.
# The default value is: YES.
# This tag requires that the tag HAVE_DOT is set to YES.
@@ -2653,8 +2795,24 @@ GENERATE_LEGEND = YES
# If the DOT_CLEANUP tag is set to YES, doxygen will remove the intermediate
# files that are used to generate the various graphs.
#
-# Note: This setting is not only used for dot files but also for msc and
-# plantuml temporary files.
+# Note: This setting is not only used for dot files but also for msc temporary
+# files.
# The default value is: YES.
DOT_CLEANUP = YES
+
+# You can define message sequence charts within doxygen comments using the \msc
+# command. If the MSCGEN_TOOL tag is left empty (the default), then doxygen will
+# use a built-in version of mscgen tool to produce the charts. Alternatively,
+# the MSCGEN_TOOL tag can also specify the name an external tool. For instance,
+# specifying prog as the value, doxygen will call the tool as prog -T
+# -o . The external tool should support
+# output file formats "png", "eps", "svg", and "ismap".
+
+MSCGEN_TOOL =
+
+# The MSCFILE_DIRS tag can be used to specify one or more directories that
+# contain msc files that are included in the documentation (see the \mscfile
+# command).
+
+MSCFILE_DIRS =
diff --git a/docs/doxygen/doxygen-custom/custom.css b/docs/doxygen/doxygen-custom/custom.css
new file mode 100644
index 0000000..3ca06b8
--- /dev/null
+++ b/docs/doxygen/doxygen-custom/custom.css
@@ -0,0 +1,21 @@
+:root {
+ --side-nav-fixed-width: 300px;
+}
+
+.github-corner svg {
+ fill: var(--primary-light-color);
+ color: var(--page-background-color);
+ width: 72px;
+ height: 72px;
+}
+
+#projectnumber {
+ margin-right: 22px;
+}
+
+@media screen and (max-width: 767px) {
+ .github-corner svg {
+ width: 55px;
+ height: 55px;
+ }
+}
\ No newline at end of file
diff --git a/docs/doxygen/doxygen-custom/header.html b/docs/doxygen/doxygen-custom/header.html
new file mode 100644
index 0000000..8263189
--- /dev/null
+++ b/docs/doxygen/doxygen-custom/header.html
@@ -0,0 +1,126 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ $projectname: $title
+
+ $title
+
+
+
+
+ $treeview
+ $search
+ $mathjax
+
+ $extrastylesheet
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
$projectname
+ $projectnumber
+
+
+
$projectbrief
+
+
+
+
+
+
$projectbrief
+
+
+
+
+
+
$searchbox
+
+
+
+
+
+
+
+
\ No newline at end of file
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:
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
"),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+='
');
- }
- }
- $('#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 72a58a5..0000000
Binary files a/docs/nav_f.png and /dev/null differ
diff --git a/docs/nav_g.png b/docs/nav_g.png
deleted file mode 100644
index 2093a23..0000000
Binary files a/docs/nav_g.png and /dev/null differ
diff --git a/docs/nav_h.png b/docs/nav_h.png
deleted file mode 100644
index 33389b1..0000000
Binary files a/docs/nav_h.png and /dev/null differ
diff --git a/docs/open.png b/docs/open.png
deleted file mode 100644
index 30f75c7..0000000
Binary files a/docs/open.png and /dev/null differ
diff --git a/docs/search/all_0.html b/docs/search/all_0.html
deleted file mode 100644
index 1ec5b2d..0000000
--- a/docs/search/all_0.html
+++ /dev/null
@@ -1,37 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
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; eli>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
diff --git a/examples/Example1_getLux/Example1_getLux.ino b/examples/Example1_getLux/Example1_getLux.ino
index 4c05d1a..c969dce 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.getLux(), 4); // Read the lux from the sensor and print it
+ delay(250);
}
diff --git a/examples/Example2_changeSettings/Example2_changeSettings.ino b/examples/Example2_changeSettings/Example2_changeSettings.ino
index ea05291..9fcfcb2 100644
--- a/examples/Example2_changeSettings/Example2_changeSettings.ino
+++ b/examples/Example2_changeSettings/Example2_changeSettings.ino
@@ -5,88 +5,88 @@
* Paul Clark
* SparkFun Electronics
* November 4th 2021
- *
+ *
* This example demonstrates how to change the VEML7700's sensitivity (gain) and integration time settings.
- *
+ *
* 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)
+ ;
+ }
- //The default integration time is 100ms.
- //Possible values are:
- //VEML7700_INTEGRATION_25ms
- //VEML7700_INTEGRATION_50ms
- //VEML7700_INTEGRATION_100ms
- //VEML7700_INTEGRATION_200ms
- //VEML7700_INTEGRATION_400ms
- //VEML7700_INTEGRATION_800ms
- //Let's change the integration time to 50ms:
- mySensor.setIntegrationTime(VEML7700_INTEGRATION_50ms);
+ // The default integration time is 100ms.
+ // Possible values are:
+ // VEML7700_INTEGRATION_25ms
+ // VEML7700_INTEGRATION_50ms
+ // VEML7700_INTEGRATION_100ms
+ // VEML7700_INTEGRATION_200ms
+ // VEML7700_INTEGRATION_400ms
+ // VEML7700_INTEGRATION_800ms
+ // Let's change the integration time to 50ms:
+ mySensor.setIntegrationTime(VEML7700_INTEGRATION_50ms);
- //Confirm the integration time was set correctly
- Serial.print(F("The sensor integration time is: "));
- Serial.println(mySensor.getIntegrationTimeStr());
+ // Confirm the integration time was set correctly
+ Serial.print(F("The sensor integration time is: "));
+ Serial.println(mySensor.integrationTimeString());
- //The default gain (sensitivity mode) is x1
- //Possible values are:
- //VEML7700_SENSITIVITY_x1
- //VEML7700_SENSITIVITY_x2
- //VEML7700_SENSITIVITY_x1_8
- //VEML7700_SENSITIVITY_x1_4
- //Let's change the sensitivity to x2:
- mySensor.setSensitivityMode(VEML7700_SENSITIVITY_x2);
+ // The default gain (sensitivity mode) is x1
+ // Possible values are:
+ // VEML7700_SENSITIVITY_x1
+ // VEML7700_SENSITIVITY_x2
+ // VEML7700_SENSITIVITY_x1_8
+ // VEML7700_SENSITIVITY_x1_4
+ // Let's change the sensitivity to x2:
+ mySensor.setSensitivityMode(VEML7700_SENSITIVITY_x2);
- //Confirm that the sensitivity mode was set correctly
- Serial.print(F("The sensor gain (sensitivity mode) is: "));
- Serial.println(mySensor.getSensitivityModeStr());
+ // Confirm that the sensitivity mode was set correctly
+ Serial.print(F("The sensor gain (sensitivity mode) is: "));
+ Serial.println(mySensor.sensitivityModeString());
- //We can also change the persistence ptotect number. Default is 1.
- //Possible values are:
- //VEML7700_PERSISTENCE_1
- //VEML7700_PERSISTENCE_2
- //VEML7700_PERSISTENCE_4
- //VEML7700_PERSISTENCE_8
- //Let's change the persistence protect to 4:
- mySensor.setPersistenceProtect(VEML7700_PERSISTENCE_4);
+ // We can also change the persistence ptotect number. Default is 1.
+ // Possible values are:
+ // VEML7700_PERSISTENCE_1
+ // VEML7700_PERSISTENCE_2
+ // VEML7700_PERSISTENCE_4
+ // VEML7700_PERSISTENCE_8
+ // Let's change the persistence protect to 4:
+ mySensor.setPersistenceProtect(VEML7700_PERSISTENCE_4);
- //Confirm that the persistence protect was set correctly
- Serial.print(F("The sensor persistence protect setting is: "));
- Serial.println(mySensor.getPersistenceProtectStr());
+ // Confirm that the persistence protect was set correctly
+ Serial.print(F("The sensor persistence protect setting is: "));
+ Serial.println(mySensor.persistenceProtectString());
- Serial.println(F("Lux:\tAmbient:\tWhite Level:"));
+ Serial.println(F("Lux:\tAmbient:\tWhite Level:"));
}
void loop()
{
- Serial.print(mySensor.getLux(), 4); // Read the lux from the sensor and print it
- Serial.print("\t");
- Serial.print(mySensor.getAmbientLight()); // Read the ambient light level
- Serial.print("\t");
- Serial.println(mySensor.getWhiteLevel()); // Read the white channel level
- delay(250);
+ Serial.print(mySensor.getLux(), 4); // Read the lux from the sensor and print it
+ Serial.print("\t");
+ Serial.print(mySensor.getAmbientLight()); // Read the ambient light level
+ Serial.print("\t");
+ Serial.println(mySensor.getWhiteLevel()); // Read the white channel level
+ delay(250);
}
diff --git a/examples/Example3_threshold/Example3_threshold.ino b/examples/Example3_threshold/Example3_threshold.ino
index 2d348f7..1faf977 100644
--- a/examples/Example3_threshold/Example3_threshold.ino
+++ b/examples/Example3_threshold/Example3_threshold.ino
@@ -5,95 +5,94 @@
* Paul Clark
* SparkFun Electronics
* November 4th 2021
- *
+ *
* This example demonstrates how to change the VEML7700's threshold settings.
- *
+ *
* 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"));
-
- Wire.begin();
-
- //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)
- ;
- }
-
- //Let's change the high threshold to 30000 counts:
- mySensor.setHighThreshold(30000);
-
- //Confirm the high threshold was set correctly
- Serial.print(F("The high threshold is: "));
- Serial.println(mySensor.getHighThreshold());
-
- //Let's change the low threshold to 1000 counts:
- mySensor.setLowThreshold(1000);
-
- //Confirm the low threshold was set correctly
- Serial.print(F("The low threshold is: "));
- Serial.println(mySensor.getLowThreshold());
-
- //Enable the high and low threshold interrupts
- mySensor.setInterruptEnable(VEML7700_INT_ENABLE);
-
- //Check that the interrupts are enabled
- Serial.print(F("Interrupts are "));
- VEML7700_interrupt_enable_t ie;
- mySensor.getInterruptEnable(&ie);
- if ((ie == VEML7700_INT_DISABLE) || ( ie == VEML7700_INT_INVALID))
- Serial.print(F("not "));
- Serial.println(F("enabled"));
+ Serial.begin(115200);
+ Serial.println(F("SparkFun VEML7700 Example"));
+
+ Wire.begin();
+
+ // 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)
+ ;
+ }
+
+ // Let's change the high threshold to 30000 counts:
+ mySensor.setHighThreshold(30000);
+
+ // Confirm the high threshold was set correctly
+ Serial.print(F("The high threshold is: "));
+ Serial.println(mySensor.highThreshold());
+
+ // Let's change the low threshold to 1000 counts:
+ mySensor.setLowThreshold(1000);
+
+ // Confirm the low threshold was set correctly
+ Serial.print(F("The low threshold is: "));
+ Serial.println(mySensor.lowThreshold());
+
+ // Enable the high and low threshold interrupts
+ mySensor.enableInterrupt(true);
+
+ // Check that the interrupts are enabled
+ Serial.print(F("Interrupts are "));
+
+ if (mySensor.isInterruptEnabled() == false)
+ Serial.print(F("not "));
+ Serial.println(F("enabled"));
}
void loop()
{
- Serial.print(F("Ambient: "));
- Serial.print(mySensor.getAmbientLight()); // Read the ambient light level from the sensor and print it
-
- // Note: reading the interrupt status register clears the interrupts, so we need to check both
- // the high and low interrupt flags in a single read
-
- VEML7700_interrupt_status_t intStatus = mySensor.getInterruptStatus(); // Check the interrupt status
-
- // Possible values for intStatus are:
- // VEML7700_INT_STATUS_NONE
- // VEML7700_INT_STATUS_HIGH
- // VEML7700_INT_STATUS_LOW
- // VEML7700_INT_STATUS_BOTH
- // VEML7700_INT_STATUS_INVALID
-
- if (intStatus == VEML7700_INT_STATUS_INVALID)
- {
- Serial.print(F("\tInterrupt Status Read Error!"));
- }
- else
- {
- if (intStatus & VEML7700_INT_STATUS_HIGH) // Use a logical AND to check if the high flag is set
- Serial.print(F("\tHigh Threshold Exceeded"));
-
- if (intStatus & VEML7700_INT_STATUS_LOW) // Use a logical AND to check if the low flag is set
- Serial.print(F("\tLow Threshold Exceeded"));
- }
-
- Serial.println();
-
- delay(250);
+ Serial.print(F("Ambient: "));
+ Serial.print(mySensor.getAmbientLight()); // Read the ambient light level from the sensor and print it
+
+ // Note: reading the interrupt status register clears the interrupts, so we need to check both
+ // the high and low interrupt flags in a single read
+
+ VEML7700_interrupt_status_t intStatus = mySensor.interruptStatus(); // Check the interrupt status
+
+ // Possible values for intStatus are:
+ // VEML7700_INT_STATUS_NONE
+ // VEML7700_INT_STATUS_HIGH
+ // VEML7700_INT_STATUS_LOW
+ // VEML7700_INT_STATUS_BOTH
+ // VEML7700_INT_STATUS_INVALID
+
+ if (intStatus == VEML7700_INT_STATUS_INVALID)
+ {
+ Serial.print(F("\tInterrupt Status Read Error!"));
+ }
+ else
+ {
+ if (intStatus & VEML7700_INT_STATUS_HIGH) // Use a logical AND to check if the high flag is set
+ Serial.print(F("\tHigh Threshold Exceeded"));
+
+ if (intStatus & VEML7700_INT_STATUS_LOW) // Use a logical AND to check if the low flag is set
+ Serial.print(F("\tLow Threshold Exceeded"));
+ }
+
+ Serial.println();
+
+ delay(250);
}
diff --git a/examples/Example4_shutDown/Example4_shutDown.ino b/examples/Example4_shutDown/Example4_shutDown.ino
index 95bf923..3adae65 100644
--- a/examples/Example4_shutDown/Example4_shutDown.ino
+++ b/examples/Example4_shutDown/Example4_shutDown.ino
@@ -5,73 +5,66 @@
* Paul Clark
* SparkFun Electronics
* November 4th 2021
- *
+ *
* This example demonstrates how to shut down the VEML7700.
- *
+ *
* 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
unsigned long lastMillis = 0; // Keep track of time
-VEML7700_shutdown_t shutdownState = VEML7700_POWER_ON; // Toggle between VEML7700_POWER_ON and VEML7700_SHUT_DOWN
+// start with a power on state
+bool shutdownState = false;
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)
+ ;
+ }
- lastMillis = millis(); // Keep track of time
+ lastMillis = millis(); // Keep track of time
}
void loop()
{
- if (shutdownState == VEML7700_POWER_ON) // Are we "On"? (Comment this line if you are interested in how it effects the sleep current)
- {
- Serial.print(F("Lux: "));
- Serial.println(mySensor.getLux(), 4); // Read the lux from the sensor and print it
- }
-
- //Check if it is time to change the power state
- if (millis() > (lastMillis + 5000)) // Change state every 5 seconds
- {
- lastMillis = millis(); // Keep track of time
-
- if (shutdownState == VEML7700_POWER_ON) // Are we "On"?
+ // Are we "On"? (Comment this line if you are interested in how it effects the sleep current)
+ if (shutdownState == false)
{
- shutdownState = VEML7700_SHUT_DOWN; // Put sensor to sleep
- mySensor.setShutdown(shutdownState);
-
- //mySensor.shutDown(); // This would do the same thing
+ Serial.print(F("Lux: "));
+ Serial.println(mySensor.getLux(), 4); // Read the lux from the sensor and print it
}
- else
+
+ // Check if it is time to change the power state
+ if (millis() > (lastMillis + 5000)) // Change state every 5 seconds
{
- shutdownState = VEML7700_POWER_ON; // Power sensor on
- mySensor.setShutdown(shutdownState);
-
- //mySensor.powerOn(); // This would do the same thing
+ lastMillis = millis(); // Keep track of time
+
+ shutdownState = !shutdownState; // Toggle the shutdown state
+ mySensor.setShutdown(shutdownState); // Set the shutdown state
+
+ Serial.print("Power - ");
+ Serial.println(shutdownState ? "Off" : "On");
}
- }
- delay(125);
+ delay(125);
}
diff --git a/examples/Example5_ProductionTest/Example5_ProductionTest.ino b/examples/Example5_ProductionTest/Example5_ProductionTest.ino
new file mode 100644
index 0000000..e521fe0
--- /dev/null
+++ b/examples/Example5_ProductionTest/Example5_ProductionTest.ino
@@ -0,0 +1,75 @@
+/*!
+ * @file Example6_ProductionTest.ino
+ *
+ * This example was written by:
+ * Paul Clark
+ * SparkFun Electronics
+ * December 7th 2021
+ *
+ * This is the code we use to test the SPX-18981 Ambient Light Sensor.
+ * LED_BUILTIN will light up if the VEML7700 is detected correctly and the lux is within bounds.
+ *
+ * Want to support open source hardware? Buy a board from SparkFun!
+ * SparkX Ambient Light Sensor - VEML7700 (SPX-18981): https://www.sparkfun.com/products/18981
+ *
+ * Please see LICENSE.md for the license information
+ *
+ */
+
+#include // Click here to get the library: http://librarymanager/All#SparkFun_VEML7700
+
+SparkFunVEML7700 mySensor; // Create a VEML7700 object
+
+void setup()
+{
+ Serial.begin(115200);
+ Serial.println(F("VEML7700 Production Test"));
+
+ pinMode(LED_BUILTIN, OUTPUT);
+ digitalWrite(LED_BUILTIN, LOW);
+}
+
+void loop()
+{
+ delay(250); // Try every 0.25 seconds
+
+ Wire.begin();
+
+ Wire.beginTransmission(0x10); // Detect VEML7700 on address 0x10
+ if (Wire.endTransmission() != 0)
+ {
+ digitalWrite(LED_BUILTIN, LOW);
+ Wire.end();
+ Serial.println(F("Error: nothing detected on address 0x10"));
+ return;
+ }
+
+ // Initialize sensor
+ if (mySensor.begin() == false)
+ {
+ digitalWrite(LED_BUILTIN, LOW);
+ Wire.end();
+ Serial.println(F("Error: .begin failed"));
+ return;
+ }
+
+ delay(250); // Default integration time is 100ms
+
+ // Now we read the lux from the sensor
+ float lux = mySensor.getLux(); // Read the lux
+
+ // Check the lux is within bounds
+ if ((lux < 20.0) || (lux > 100000.0))
+ {
+ digitalWrite(LED_BUILTIN, LOW);
+ Wire.end();
+ Serial.print(F("Error: invalid lux reading: "));
+ Serial.println(lux, 4);
+ return;
+ }
+
+ // All good!
+ Serial.println(F("Test passed!"));
+ digitalWrite(LED_BUILTIN, HIGH);
+ Wire.end();
+}
diff --git a/examples/Example5_alternatePorts/Example5_alternatePorts.ino b/examples/Example5_alternatePorts/Example5_alternatePorts.ino
deleted file mode 100644
index b7a3462..0000000
--- a/examples/Example5_alternatePorts/Example5_alternatePorts.ino
+++ /dev/null
@@ -1,50 +0,0 @@
-/*!
- * @file Example5_alternatePorts.ino
- *
- * This example was written by:
- * Paul Clark
- * SparkFun Electronics
- * November 4th 2021
- *
- * This example demonstrates how to use alternate Wire and Serial ports when communicating with the VEML7700.
- *
- * 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
-
-#define myWire Wire // Change this to (e.g.) Wire1 if required
-#define mySerial Serial // Change this to (e.g.) Serial1 if required
-
-void setup()
-{
- mySerial.begin(115200);
- mySerial.println(F("SparkFun VEML7700 Example"));
-
- myWire.begin();
-
- //mySensor.enableDebugging(mySerial); // Uncomment this line to enable helpful debug messages on mySerial
-
- // Begin the VEML7700 using the myWire I2C port
- // .begin will return true on success, or false on failure to communicate
- if (mySensor.begin(myWire) == false)
- {
- mySerial.println("Unable to communicate with the VEML7700. Please check the wiring. Freezing...");
- while (1)
- ;
- }
-
- mySerial.println(F("Lux:"));
-}
-
-void loop()
-{
- mySerial.println(mySensor.getLux(), 4); // Read the lux from the sensor and print it
- delay(250);
-}
diff --git a/examples/Example6_ProductionTest/Example6_ProductionTest.ino b/examples/Example6_ProductionTest/Example6_ProductionTest.ino
deleted file mode 100644
index d6ac3ca..0000000
--- a/examples/Example6_ProductionTest/Example6_ProductionTest.ino
+++ /dev/null
@@ -1,75 +0,0 @@
-/*!
- * @file Example6_ProductionTest.ino
- *
- * This example was written by:
- * Paul Clark
- * SparkFun Electronics
- * December 7th 2021
- *
- * This is the code we use to test the SPX-18981 Ambient Light Sensor.
- * LED_BUILTIN will light up if the VEML7700 is detected correctly and the lux is within bounds.
- *
- * Want to support open source hardware? Buy a board from SparkFun!
- * SparkX Ambient Light Sensor - VEML7700 (SPX-18981): https://www.sparkfun.com/products/18981
- *
- * 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
-
-void setup()
-{
- Serial.begin(115200);
- Serial.println(F("VEML7700 Production Test"));
-
- pinMode(LED_BUILTIN, OUTPUT);
- digitalWrite(LED_BUILTIN, LOW);
-}
-
-void loop()
-{
- delay(250); // Try every 0.25 seconds
-
- Wire.begin();
-
- Wire.beginTransmission(0x10); // Detect VEML7700 on address 0x10
- if (Wire.endTransmission() != 0)
- {
- digitalWrite(LED_BUILTIN, LOW);
- Wire.end();
- Serial.println(F("Error: nothing detected on address 0x10"));
- return;
- }
-
- //Initialize sensor
- if (mySensor.begin() == false)
- {
- digitalWrite(LED_BUILTIN, LOW);
- Wire.end();
- Serial.println(F("Error: .begin failed"));
- return;
- }
-
- delay(250); // Default integration time is 100ms
-
- // Now we read the lux from the sensor
- float lux = mySensor.getLux(); // Read the lux
-
- // Check the lux is within bounds
- if ((lux < 20.0) || (lux > 100000.0))
- {
- digitalWrite(LED_BUILTIN, LOW);
- Wire.end();
- Serial.print(F("Error: invalid lux reading: "));
- Serial.println(lux, 4);
- return;
- }
-
- // All good!
- Serial.println(F("Test passed!"));
- digitalWrite(LED_BUILTIN, HIGH);
- Wire.end();
-}
diff --git a/keywords.txt b/keywords.txt
index 9d6fecf..372a319 100644
--- a/keywords.txt
+++ b/keywords.txt
@@ -29,36 +29,34 @@ setShutdown KEYWORD2
powerOn KEYWORD2
shutdown KEYWORD2
getShutdown KEYWORD2
-setInterruptEnable KEYWORD2
-getInterruptEnable KEYWORD2
+enableInterrupt KEYWORD2
+isInterruptEnabled KEYWORD2
setPersistenceProtect KEYWORD2
getPersistenceProtect KEYWORD2
-getPersistenceProtectStr KEYWORD2
+persistenceProtect KEYWORD2
+persistenceProtectString KEYWORD2
setIntegrationTime KEYWORD2
getIntegrationTime KEYWORD2
-getIntegrationTimeStr KEYWORD2
+integrationTime KEYWORD2
+integrationTimeString KEYWORD2
setSensitivityMode KEYWORD2
getSensitivityMode KEYWORD2
-getSensitivityModeStr KEYWORD2
+sensitivityMode KEYWORD2
+sensitivityModeString KEYWORD2
setHighThreshold KEYWORD2
-getHighThreshold KEYWORD2
+highThreshold KEYWORD2
setLowThreshold KEYWORD2
-getLowThreshold KEYWORD2
+lowThreshold KEYWORD2
getAmbientLight KEYWORD2
getWhiteLevel KEYWORD2
getLux KEYWORD2
-getInterruptStatus KEYWORD2
+interruptStatus KEYWORD2
#######################################
# Constants (LITERAL1)
#######################################
-VEML7700_ERROR_READ LITERAL1
-VEML7700_ERROR_WRITE LITERAL1
-VEML7700_ERROR_INVALID_ADDRESS LITERAL1
-VEML7700_ERROR_UNDEFINED LITERAL1
-VEML7700_ERROR_SUCCESS LITERAL1
-VEML7700_SUCCESS LITERAL1
+
VEML7700_SENSITIVITY_x1 LITERAL1
VEML7700_SENSITIVITY_x2 LITERAL1
VEML7700_SENSITIVITY_x1_8 LITERAL1
@@ -79,9 +77,6 @@ VEML7700_PERSISTENCE_INVALID LITERAL1
VEML7700_INT_DISABLE LITERAL1
VEML7700_INT_ENABLE LITERAL1
VEML7700_INT_INVALID LITERAL1
-VEML7700_POWER_ON LITERAL1
-VEML7700_SHUT_DOWN LITERAL1
-VEML7700_SHUTDOWN_INVALID LITERAL1
VEML7700_INT_STATUS_NONE LITERAL1
VEML7700_INT_STATUS_HIGH LITERAL1
VEML7700_INT_STATUS_LOW LITERAL1
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/SparkFun_VEML7700_Arduino_Library.cpp
deleted file mode 100644
index 2138b3b..0000000
--- a/src/SparkFun_VEML7700_Arduino_Library.cpp
+++ /dev/null
@@ -1,967 +0,0 @@
-/*!
- * @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
- *
- */
-
-#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
-
-/** 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
-};
-
-/** 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"
-};
-
-/** 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 persistence protect settings as text (string) */
-const char *VEML7700_PERSISTENCE_PROTECT_SETTINGS[VEML7700_NUM_PERSISTENCE_PROTECT + 1] =
-{
- "1", "2", "4", "8", "INVALID"
-};
-
-VEML7700::VEML7700()
-{
- _i2cPort = NULL;
- _debugPort = NULL;
- _deviceAddress = VEML7700_I2C_ADDRESS;
- _debugEnabled = false;
-}
-
-/**************************************************************************/
-/*!
- @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)
-{
- VEML7700_error_t err;
-
- _i2cPort = &wirePort;
-
- /** 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. */
-
- _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;
-}
-
-/**************************************************************************/
-/*!
- @brief Check that the VEML7700 is awake and communicating.
- @return True if communication with the VEML7700 was successful, otherwise false.
-*/
-/**************************************************************************/
-boolean VEML7700::isConnected()
-{
- 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;
-}
-
-/**************************************************************************/
-/*!
- @brief Set the VEML7700's shut down setting (ALS_SD)
- @param sd
- 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)
-{
- VEML7700_error_t err;
-
- err = readI2CRegister((VEML7700_t *)&_configurationRegister, VEML7700_CONFIGURATION_REGISTER);
- if (err != VEML7700_ERROR_SUCCESS)
- {
- return err;
- }
-
- _configurationRegister.CONFIG_REG_SD = (VEML7700_t)sd;
-
- return writeI2CRegister(_configurationRegister.all, VEML7700_CONFIGURATION_REGISTER);
-}
-
-/**************************************************************************/
-/*!
- @brief Get the VEML7700's shut down setting (ALS_SD)
- @return VEML7700_POWER_ON or VEML7700_SHUT_DOWN if successful, VEML7700_SHUTDOWN_INVALID otherwise
-*/
-/**************************************************************************/
-VEML7700_shutdown_t VEML7700::getShutdown()
-{
- VEML7700_error_t err;
-
- err = readI2CRegister((VEML7700_t *)&_configurationRegister, VEML7700_CONFIGURATION_REGISTER);
- if (err != VEML7700_ERROR_SUCCESS)
- {
- return VEML7700_SHUTDOWN_INVALID;
- }
-
- return ((VEML7700_shutdown_t)_configurationRegister.CONFIG_REG_SD);
-}
-
-/**************************************************************************/
-/*!
- @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
-*/
-/**************************************************************************/
-VEML7700_error_t VEML7700::setInterruptEnable(VEML7700_interrupt_enable_t ie)
-{
- VEML7700_error_t err;
-
- err = readI2CRegister((VEML7700_t *)&_configurationRegister, VEML7700_CONFIGURATION_REGISTER);
- if (err != VEML7700_ERROR_SUCCESS)
- {
- return err;
- }
-
- _configurationRegister.CONFIG_REG_INT_EN = (VEML7700_t)ie;
-
- return writeI2CRegister(_configurationRegister.all, VEML7700_CONFIGURATION_REGISTER);
-}
-
-/**************************************************************************/
-/*!
- @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
-*/
-/**************************************************************************/
-VEML7700_error_t VEML7700::getInterruptEnable(VEML7700_interrupt_enable_t *ie)
-{
- 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;
-
- err = readI2CRegister((VEML7700_t *)&_configurationRegister, VEML7700_CONFIGURATION_REGISTER);
- if (err != VEML7700_ERROR_SUCCESS)
- {
- return VEML7700_INT_INVALID;
- }
-
- return ((VEML7700_interrupt_enable_t)_configurationRegister.CONFIG_REG_INT_EN);
-}
-
-/**************************************************************************/
-/*!
- @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
-*/
-/**************************************************************************/
-VEML7700_error_t VEML7700::setPersistenceProtect(VEML7700_persistence_protect_t pp)
-{
- VEML7700_error_t err;
-
- err = readI2CRegister((VEML7700_t *)&_configurationRegister, VEML7700_CONFIGURATION_REGISTER);
- if (err != VEML7700_ERROR_SUCCESS)
- {
- return err;
- }
-
- _configurationRegister.CONFIG_REG_PERS = (VEML7700_t)pp;
-
- return writeI2CRegister(_configurationRegister.all, VEML7700_CONFIGURATION_REGISTER);
-}
-
-/**************************************************************************/
-/*!
- @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_error_t VEML7700::getPersistenceProtect(VEML7700_persistence_protect_t *pp)
-{
- 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);
-}
-
-/**************************************************************************/
-/*!
- @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;
- }
-
- return ((VEML7700_persistence_protect_t)_configurationRegister.CONFIG_REG_PERS);
-}
-
-/**************************************************************************/
-/*!
- @brief Get the VEML7700's persistence protect number setting (ALS_PERS) as printable text
-*/
-/**************************************************************************/
-const char * VEML7700::getPersistenceProtectStr()
-{
- VEML7700_persistence_protect_t pp;
-
- getPersistenceProtect(&pp);
-
- return (VEML7700_PERSISTENCE_PROTECT_SETTINGS[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
-*/
-/**************************************************************************/
-VEML7700_error_t VEML7700::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;
- }
-
- _configurationRegister.CONFIG_REG_IT = (VEML7700_t)integrationTimeConfig(it);
-
- return writeI2CRegister(_configurationRegister.all, VEML7700_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);
-}
-
-/**************************************************************************/
-/*!
- @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 VEML7700::getIntegrationTime()
-{
- VEML7700_error_t err;
-
- err = readI2CRegister((VEML7700_t *)&_configurationRegister, VEML7700_CONFIGURATION_REGISTER);
- if (err != VEML7700_ERROR_SUCCESS)
- {
- return VEML7700_INTEGRATION_INVALID;
- }
-
- return ((VEML7700_integration_time_t)integrationTimeFromConfig((VEML7700_config_integration_time_t)_configurationRegister.CONFIG_REG_IT));
-}
-
-/**************************************************************************/
-/*!
- @brief Get the VEML7700's integration time setting (ALS_IT) as printable text
-*/
-/**************************************************************************/
-const char * VEML7700::getIntegrationTimeStr()
-{
- VEML7700_integration_time_t it;
-
- getIntegrationTime(&it);
-
- return (VEML7700_INTEGRATION_TIMES[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
-*/
-/**************************************************************************/
-VEML7700_error_t VEML7700::setSensitivityMode(VEML7700_sensitivity_mode_t sm)
-{
- VEML7700_error_t err;
-
- err = readI2CRegister((VEML7700_t *)&_configurationRegister, VEML7700_CONFIGURATION_REGISTER);
- if (err != VEML7700_ERROR_SUCCESS)
- {
- return err;
- }
-
- _configurationRegister.CONFIG_REG_SM = (VEML7700_t)sm;
-
- 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);
-}
-
-/**************************************************************************/
-/*!
- @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 VEML7700::getSensitivityMode()
-{
- VEML7700_error_t err;
-
- err = readI2CRegister((VEML7700_t *)&_configurationRegister, VEML7700_CONFIGURATION_REGISTER);
- if (err != VEML7700_ERROR_SUCCESS)
- {
- return VEML7700_SENSITIVITY_INVALID;
- }
-
- return ((VEML7700_sensitivity_mode_t)_configurationRegister.CONFIG_REG_SM);
-}
-
-/**************************************************************************/
-/*!
- @brief Get the VEML7700's sensitivity mode selection (ALS_SM) as printable text
-*/
-/**************************************************************************/
-const char * VEML7700::getSensitivityModeStr()
-{
- VEML7700_sensitivity_mode_t sm;
-
- getSensitivityMode(&sm);
-
- return (VEML7700_GAIN_SETTINGS[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
-*/
-/**************************************************************************/
-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)
-{
- return (readI2CRegister((VEML7700_t *)threshold, VEML7700_HIGH_THRESHOLD));
-}
-
-/**************************************************************************/
-/*!
- @brief Get the VEML7700's ALS high threshold window setting (ALS_WH)
- @return The threshold setting
-*/
-/**************************************************************************/
-uint16_t VEML7700::getHighThreshold()
-{
- uint16_t threshold;
- getHighThreshold(&threshold);
- return (threshold);
-}
-
-/**************************************************************************/
-/*!
- @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
-*/
-/**************************************************************************/
-VEML7700_error_t VEML7700::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));
-}
-
-/**************************************************************************/
-/*!
- @brief Get the VEML7700's ALS low threshold window setting (ALS_WL)
- @return The threshold setting
-*/
-/**************************************************************************/
-uint16_t VEML7700::getLowThreshold()
-{
- 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));
-}
-
-/**************************************************************************/
-/*!
- @brief Get the VEML7700's ambient light sensor data (ALS)
- @return The ambient light reading
-*/
-/**************************************************************************/
-uint16_t VEML7700::getAmbientLight()
-{
- 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));
-}
-
-/**************************************************************************/
-/*!
- @brief Get the VEML7700's white level data (WHITE)
- @return The white level reading
-*/
-/**************************************************************************/
-uint16_t VEML7700::getWhiteLevel()
-{
- uint16_t whiteLevel;
- getWhiteLevel(&whiteLevel);
- return (whiteLevel);
-}
-
-/**************************************************************************/
-/*!
- @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
-*/
-/**************************************************************************/
-VEML7700_error_t VEML7700::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. */
-
- 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]);
- }
-
- /** Now we can extract the correct resolution from the look up table. */
- float resolution = VEML7700_LUX_RESOLUTION[sm][it];
-
- if (_debugEnabled)
- {
- _debugPort->print(F("VEML7700::getLux: resolution: "));
- _debugPort->println(resolution, 4);
- }
-
- /** Now we read the ambient level and multiply it by the resolution */
- uint16_t ambient;
-
- err = getAmbientLight(&ambient);
-
- if (err != VEML7700_ERROR_SUCCESS)
- return (err);
-
- if (_debugEnabled)
- {
- _debugPort->print(F("VEML7700::getLux: ambient: "));
- _debugPort->println(ambient);
- }
-
- *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);
-}
-
-/**************************************************************************/
-/*!
- @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_error_t VEML7700::getInterruptStatus(VEML7700_interrupt_status_t *status)
-{
- VEML7700_error_t err;
- VEML7700_INTERRUPT_STATUS_REGISTER_t isr;
-
- err = readI2CRegister((VEML7700_t *)&isr, VEML7700_INTERRUPT_STATUS);
-
- if (err == VEML7700_ERROR_SUCCESS)
- {
- *status = (VEML7700_interrupt_status_t)isr.INT_STATUS_REG_INT_FLAGS;
- }
- else
- {
- *status = VEML7700_INT_STATUS_INVALID;
- }
-
- return (err);
-}
-
-/**************************************************************************/
-/*!
- @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()
-{
- VEML7700_error_t err;
- VEML7700_INTERRUPT_STATUS_REGISTER_t isr;
-
- err = readI2CRegister((VEML7700_t *)&isr, VEML7700_INTERRUPT_STATUS);
-
- if (err != VEML7700_ERROR_SUCCESS)
- return (VEML7700_INT_STATUS_INVALID);
-
- return ((VEML7700_interrupt_status_t)isr.INT_STATUS_REG_INT_FLAGS);
-}
-
-VEML7700_error_t VEML7700::readI2CBuffer(uint8_t *dest, VEML7700_registers_t startRegister, uint16_t len)
-{
- _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)
- {
- _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;
- case VEML7700_CONFIG_INTEGRATION_50ms:
- return (VEML7700_INTEGRATION_50ms);
- break;
- case VEML7700_CONFIG_INTEGRATION_100ms:
- return (VEML7700_INTEGRATION_100ms);
- break;
- case VEML7700_CONFIG_INTEGRATION_200ms:
- return (VEML7700_INTEGRATION_200ms);
- break;
- case VEML7700_CONFIG_INTEGRATION_400ms:
- return (VEML7700_INTEGRATION_400ms);
- break;
- case VEML7700_CONFIG_INTEGRATION_800ms:
- return (VEML7700_INTEGRATION_800ms);
- break;
- default:
- break;
- }
- return (VEML7700_INTEGRATION_INVALID);
-}
diff --git a/src/SparkFun_VEML7700_Arduino_Library.h b/src/SparkFun_VEML7700_Arduino_Library.h
index 4362c3e..bfe25dd 100644
--- a/src/SparkFun_VEML7700_Arduino_Library.h
+++ b/src/SparkFun_VEML7700_Arduino_Library.h
@@ -1,252 +1,76 @@
-/*!
+/******************************************************************************
* @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__
+#pragma once
-#include
-#include
+// helps to keep the Toolkit header before the tk calls
+// clang-format off
+#include
+#include "sfTk/sfDevVEML7700.h"
+// clang-format on
-typedef uint16_t VEML7700_t;
-
-/** VEML7700 I2C address */
-#define VEML7700_I2C_ADDRESS 0x10
-
-/** VEML7700 error code returns */
-typedef enum
+// For backwards compatibility - with the SparkX (v1.0.0) library, remap error codes
+// to the toolkit error codes
+typedef enum : sfTkError_t
{
- VEML7700_ERROR_READ = -4,
- VEML7700_ERROR_WRITE = -3,
- VEML7700_ERROR_INVALID_ADDRESS = -2,
- VEML7700_ERROR_UNDEFINED = -1,
- VEML7700_ERROR_SUCCESS = 1
+ VEML7700_ERROR_READ = ksfTkErrFail,
+ VEML7700_ERROR_WRITE = ksfTkErrFail,
+ VEML7700_ERROR_INVALID_ADDRESS = ksfTkErrInvalidParam,
+ VEML7700_ERROR_UNDEFINED = ksfTkErrInvalidParam,
+ VEML7700_ERROR_SUCCESS = ksfTkErrOk
} 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
+/**
+ * @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 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();
-
- bool isConnected();
-
- /** 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
+ 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;
+ // Setup Arduino I2C bus
+ _theI2CBus.init(wirePort, address);
+ _theI2CBus.setStop(false); // Do not send a stop condition after each read/write
- /** 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;
+ // Begin the sensor
+ sfTkError_t rc = sfDevVEML7700::begin(&_theI2CBus);
- /** 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;
-
- TwoWire *_i2cPort;
- Stream *_debugPort;
- uint8_t _deviceAddress;
- bool _debugEnabled;
-
- 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
+// for backwards compatibility
+class VEML7700 : public SparkFunVEML7700
+{
+};
\ No newline at end of file
diff --git a/src/sfTk/sfDevVEML7700.cpp b/src/sfTk/sfDevVEML7700.cpp
new file mode 100644
index 0000000..c2171a7
--- /dev/null
+++ b/src/sfTk/sfDevVEML7700.cpp
@@ -0,0 +1,598 @@
+/*!
+ * @file sfDevVEML7700.cpp
+ *
+ * @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!
+ *
+ * @section author Author
+ *
+ * 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
+
+ *
+ */
+
+#include "sfDevVEML7700.h"
+#include "Arduino.h"
+
+/**
+ * @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
+ {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
+};
+
+/**
+ * @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"};
+
+/**
+ * @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"};
+
+/**
+ * @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 - reads the configuration register
+sfTkError_t sfDevVEML7700::updateConfiguration(sfDevVEML7700Config_t &config)
+{
+ if (_theBus == nullptr)
+ return ksfTkErrBusNotInit; // Not initialized
+
+ 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;
+
+ // Set bus pointer
+ _theBus = theBus;
+
+ /** 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;
+
+ return theBus->writeRegister(VEML7700_CONFIGURATION_REGISTER, configurationRegister.all);
+}
+
+//--------------------------------------------------------------------------------------------------
+// Check if the VEML7700 is connected by reading the configuration register.
+//
+bool sfDevVEML7700::isConnected(void)
+{
+ sfDevVEML7700Config_t config;
+ return updateConfiguration(config) == ksfTkErrOk;
+}
+
+//--------------------------------------------------------------------------------------------------
+// Set the VEML7700's shut down setting. This will power down the device if shutdown is true
+//
+sfTkError_t sfDevVEML7700::setShutdown(bool shutdown)
+{
+
+ sfDevVEML7700Config_t config;
+ sfTkError_t rc = updateConfiguration(config);
+
+ 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);
+}
+
+//--------------------------------------------------------------------------------------------------
+// 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;
+ sfTkError_t rc = updateConfiguration(config);
+
+ if (rc != ksfTkErrOk)
+ return true; // Error reading the configuration register
+
+ return (((VEML7700_shutdown_t)config.CONFIG_REG_SD) == VEML7700_SHUT_DOWN);
+}
+
+//--------------------------------------------------------------------------------------------------
+// Set the VEML7700's interrupt enable setting.
+//
+sfTkError_t sfDevVEML7700::enableInterrupt(bool bEnable)
+{
+
+ sfDevVEML7700Config_t config;
+ sfTkError_t rc = updateConfiguration(config);
+
+ 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);
+}
+//--------------------------------------------------------------------------------------------------
+// Get the interrupt enable setting.
+//
+
+bool sfDevVEML7700::isInterruptEnabled(void)
+{
+
+ sfDevVEML7700Config_t config;
+ sfTkError_t rc = updateConfiguration(config);
+
+ if (rc != ksfTkErrOk)
+ return false; // Error reading the configuration register
+
+ return config.CONFIG_REG_INT_EN == VEML7700_INT_ENABLE;
+}
+
+//--------------------------------------------------------------------------------------------------
+// Set the VEML7700's Persistence Protect Number setting
+//
+
+sfTkError_t sfDevVEML7700::setPersistenceProtect(VEML7700_persistence_protect_t pp)
+{
+ if (pp >= VEML7700_PERSISTENCE_INVALID)
+ return ksfTkErrInvalidParam;
+
+ sfDevVEML7700Config_t config;
+ sfTkError_t rc = updateConfiguration(config);
+
+ 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);
+}
+//--------------------------------------------------------------------------------------------------
+// Get the VEML7700's Persistence Protect Number setting
+// Method provides an error code as well as the value of the persistence protect number
+//
+
+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)
+ pp = (VEML7700_persistence_protect_t)config.CONFIG_REG_PERS;
+
+ return rc;
+}
+
+//--------------------------------------------------------------------------------------------------
+// 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();
+
+ if (pp < VEML7700_PERSISTENCE_1 || pp >= VEML7700_PERSISTENCE_INVALID)
+ return "INVALID"; // Invalid persistence protect setting
+
+ return kVEML7700PersistenceProtectStrings[pp];
+}
+
+//--------------------------------------------------------------------------------------------------
+// Set the VEML7700's integration time setting
+//
+sfTkError_t sfDevVEML7700::setIntegrationTime(VEML7700_integration_time_t it)
+{
+
+ if (it >= VEML7700_INTEGRATION_INVALID)
+ return ksfTkErrInvalidParam; // Invalid integration time setting
+
+ sfDevVEML7700Config_t config;
+ sfTkError_t rc = updateConfiguration(config);
+
+ 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);
+}
+
+//--------------------------------------------------------------------------------------------------
+// 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)
+ it = integrationTimeFromConfig((VEML7700_config_integration_time_t)config.CONFIG_REG_IT);
+
+ return rc;
+}
+
+//--------------------------------------------------------------------------------------------------
+// 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();
+
+ if (it < VEML7700_INTEGRATION_25ms || it >= VEML7700_INTEGRATION_INVALID)
+ return "INVALID"; // Invalid integration time setting
+
+ return kVEML7799IntegrationTimesString[it];
+}
+
+//--------------------------------------------------------------------------------------------------
+// Set the VEML7700's sensitivity mode setting (ALS_SM)
+//
+sfTkError_t sfDevVEML7700::setSensitivityMode(VEML7700_sensitivity_mode_t sm)
+{
+ if (sm >= VEML7700_SENSITIVITY_INVALID)
+ return ksfTkErrInvalidParam;
+
+ sfDevVEML7700Config_t config;
+ sfTkError_t rc = updateConfiguration(config);
+
+ 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);
+}
+
+//--------------------------------------------------------------------------------------------------
+// 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)
+ sm = (VEML7700_sensitivity_mode_t)config.CONFIG_REG_SM;
+
+ return rc;
+}
+
+//--------------------------------------------------------------------------------------------------
+// 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();
+
+ if (sm < VEML7700_SENSITIVITY_x1 || sm >= VEML7700_SENSITIVITY_INVALID)
+ return "INVALID"; // Invalid sensitivity mode setting
+
+ return kVEML7700GainSettingsString[sm];
+}
+
+//--------------------------------------------------------------------------------------------------
+// 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);
+}
+
+//--------------------------------------------------------------------------------------------------
+// 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 = getHighThreshold(threshold);
+
+ return rc == ksfTkErrOk ? threshold : kVEML7700ValueError; // Return 0xFFFF on error
+}
+
+//---------------------------------------------------------------------------------------------------
+// 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);
+}
+
+//---------------------------------------------------------------------------------------------------
+// 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 = getLowThreshold(threshold);
+
+ return rc == ksfTkErrOk ? threshold : kVEML7700ValueError; // Return 0xFFFF on error
+}
+
+//----------------------------------------------------------------------------------------------------
+// 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 = getAmbientLight(ambient);
+
+ return rc == ksfTkErrOk ? ambient : kVEML7700ValueError;
+}
+
+//----------------------------------------------------------------------------------------------------
+// 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 = getWhiteLevel(whiteLevel);
+
+ return rc == ksfTkErrOk ? whiteLevel : kVEML7700ValueError;
+}
+
+//----------------------------------------------------------------------------------------------------
+// Calculate the lux from the ambient light sensor data (ALS)
+// This method also returns an error code
+//
+sfTkError_t sfDevVEML7700::getLux(float &lux)
+
+{
+ lux = 0.0f; // Default to 0.0f
+
+ // 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.
+
+ sfTkError_t rc;
+
+ VEML7700_sensitivity_mode_t senseMode;
+ rc = getSensitivityMode(senseMode);
+
+ if (rc != ksfTkErrOk)
+ return rc;
+
+ VEML7700_integration_time_t intTime;
+ rc = getIntegrationTime(intTime);
+
+ if (rc != ksfTkErrOk)
+ return rc;
+
+ // 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
+ lux = ambient * VEML7700_LUX_RESOLUTION[senseMode][intTime];
+
+ return ksfTkErrOk; // Return success
+}
+
+//----------------------------------------------------------------------------------------------------
+// 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);
+
+ 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 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,
+ VEML7700_CONFIG_INTEGRATION_400ms, VEML7700_CONFIG_INTEGRATION_800ms};
+
+ 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)
+{
+ switch (it)
+ {
+ case VEML7700_CONFIG_INTEGRATION_25ms:
+ return (VEML7700_INTEGRATION_25ms);
+ break;
+ case VEML7700_CONFIG_INTEGRATION_50ms:
+ return (VEML7700_INTEGRATION_50ms);
+ break;
+ case VEML7700_CONFIG_INTEGRATION_100ms:
+ return (VEML7700_INTEGRATION_100ms);
+ break;
+ case VEML7700_CONFIG_INTEGRATION_200ms:
+ return (VEML7700_INTEGRATION_200ms);
+ break;
+ case VEML7700_CONFIG_INTEGRATION_400ms:
+ return (VEML7700_INTEGRATION_400ms);
+ break;
+ case VEML7700_CONFIG_INTEGRATION_800ms:
+ return (VEML7700_INTEGRATION_800ms);
+ break;
+ default:
+ break;
+ }
+ return (VEML7700_INTEGRATION_INVALID);
+}
diff --git a/src/sfTk/sfDevVEML7700.h b/src/sfTk/sfDevVEML7700.h
new file mode 100644
index 0000000..29623c8
--- /dev/null
+++ b/src/sfTk/sfDevVEML7700.h
@@ -0,0 +1,639 @@
+/*!
+ * @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 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
+{
+ 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
+ * @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:
+ sfDevVEML7700() : _theBus{nullptr}
+ {
+ }
+
+ /**
+ * @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 isInterruptEnabled(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 Get the Persistence Protect object - this is for backward compatibility.
+ *
+ * @deprecated since version 2.0.0, use persistenceProtect() instead.
+ * @return VEML7700_persistence_protect_t
+ */
+ const char *getPersistenceProtectStr(void)
+ {
+ return persistenceProtectString();
+ }
+
+ /**
+ * @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 Get the Integration Time object - this is for backward compatibility.
+ *
+ * @deprecated since version 2.0.0, use integrationTime() instead.
+ * @return VEML7700_integration_time_t
+ */
+
+ VEML7700_integration_time_t getIntegrationTime(void)
+ {
+ return integrationTime();
+ }
+ /**
+ * @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 Get the Integration Time string - this is for backward compatibility.
+ *
+ * @deprecated since version 2.0.0, use integrationTimeString() instead.
+ * @return const char* A string representing the integration time setting.
+ */
+ const char *getIntegrationTimeStr(void)
+ {
+ return integrationTimeString();
+ }
+
+ /**
+ * @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 Get the Sensitivity Mode object - this is for backward compatibility.
+ *
+ * @deprecated since version 2.0.0, use sensitivityMode() instead.
+ * @return VEML7700_sensitivity_mode_t
+ */
+ VEML7700_sensitivity_mode_t getSensitivityMode(void)
+ {
+ return sensitivityMode();
+ }
+
+ /**
+ * @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 Get the Sensitivity Mode string - this is for backward compatibility.
+ *
+ * @deprecated since version 2.0.0, use sensitivityModeString() instead.
+ * @return const char* A string representing the sensitivity mode setting.
+ */
+ const char *getSensitivityModeStr(void)
+ {
+ return sensitivityModeString();
+ }
+
+ /**
+ * @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 Get the High Threshold object - this is for backward compatibility.
+ *
+ * @deprecated since version 2.0.0, use highThreshold() instead.
+ * @return uint16_t The current high threshold value (16-bit unsigned integer): 0x0000 to 0xFFFF
+ */
+ uint16_t getHighThreshold(void)
+ {
+ return highThreshold();
+ }
+
+ /**
+ * @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);
+
+ /**
+ * @brief Get the Low Threshold object - this is for backward compatibility.
+ *
+ * @deprecated since version 2.0.0, use lowThreshold() instead.
+ * @return uint16_t The current low threshold value (16-bit unsigned integer): 0x0000 to 0xFFFF
+ */
+ uint16_t getLowThreshold(void)
+ {
+ return lowThreshold();
+ } // Get the Low Threshold object - this is for backward compatibility
+
+ /** Read the sensor data */
+
+ /**
+ * @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);
+
+ /**
+ * @brief Gets the interrupt status of the VEML7700 sensor.
+ *
+ * @deprecated since version 2.0.0, use interruptStatus() instead.
+ * @return VEML7700_interrupt_status_t The current interrupt status of the sensor.
+ */
+ VEML7700_interrupt_status_t getInterruptStatus(void)
+ {
+ return interruptStatus();
+ } // Get the Interrupt Status object - this is for backward compatibility
+
+ 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 - note types are uint8_t to match the I2C register size
+
+ static constexpr uint8_t VEML7700_CONFIGURATION_REGISTER = 0;
+ static constexpr uint8_t VEML7700_HIGH_THRESHOLD = 1;
+ static constexpr uint8_t VEML7700_LOW_THRESHOLD = 2;
+ static constexpr uint8_t VEML7700_ALS_OUTPUT = 4;
+ static constexpr uint8_t VEML7700_WHITE_OUTPUT = 5;
+ static constexpr uint8_t VEML7700_INTERRUPT_STATUS = 6;
+
+ // 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;
+
+ /**
+ * @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);
+
+ /**
+ * @breif Convert the (sequential) integration time into the corresponding (non-sequential) configuration value
+ *
+ */
+ VEML7700_config_integration_time_t integrationTimeConfig(VEML7700_integration_time_t it);
+
+ /**
+ * @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;
+};
