From 629e905914bbcfcff1d7ecebe6c4b33616f1bfef Mon Sep 17 00:00:00 2001 From: spatialfree Date: Sat, 27 Jan 2024 22:05:00 -0500 Subject: [PATCH] BIG COMMIT --- .gitignore | 2 + .vscode/arduino.json | 7 + .vscode/c_cpp_properties.json | 584 ++++ README.md | 8 +- _wifi_config.h | 4 + braille_xr.ino | 207 ++ debug.cfg | 15 + debug_custom.json | 19 + .../examples/AsyncUDPClient/.skip.esp32h2 | 0 .../AsyncUDPClient/AsyncUDPClient.ino | 51 + .../AsyncUDPMulticastServer/.skip.esp32h2 | 0 .../AsyncUDPMulticastServer.ino | 52 + .../examples/AsyncUDPServer/.skip.esp32h2 | 0 .../AsyncUDPServer/AsyncUDPServer.ino | 50 + libs/AsyncUDP/keywords.txt | 33 + libs/AsyncUDP/library.properties | 9 + libs/AsyncUDP/src/AsyncUDP.cpp | 879 ++++++ libs/AsyncUDP/src/AsyncUDP.h | 159 ++ libs/ESP32Servo/AddDoxygenToGHPages.sh | 32 + libs/ESP32Servo/README.md | 90 + libs/ESP32Servo/doxy.doxyfile | 2428 +++++++++++++++++ libs/ESP32Servo/examples/Knob/Knob.ino | 85 + .../Multiple-Servo-Example-Arduino.ino | 162 ++ .../examples/PWMExample/PWMExample.ino | 36 + libs/ESP32Servo/examples/Sweep/Sweep.ino | 82 + .../examples/ToneExample/ToneExample.ino | 25 + .../analogWriteExample/analogWriteExample.ino | 87 + libs/ESP32Servo/keywords.txt | 26 + libs/ESP32Servo/library.properties | 11 + libs/ESP32Servo/src/ESP32PWM.cpp | 324 +++ libs/ESP32Servo/src/ESP32PWM.h | 133 + libs/ESP32Servo/src/ESP32Servo.cpp | 257 ++ libs/ESP32Servo/src/ESP32Servo.h | 169 ++ .../examples/FTM/FTM_Initiator/.skip.esp32h2 | 0 .../FTM/FTM_Initiator/FTM_Initiator.ino | 91 + .../WiFi/examples/FTM/FTM_Initiator/README.md | 110 + .../examples/FTM/FTM_Responder/.skip.esp32h2 | 0 .../FTM/FTM_Responder/FTM_Responder.ino | 23 + .../WiFi/examples/FTM/FTM_Responder/README.md | 94 + .../examples/SimpleWiFiServer/.skip.esp32h2 | 0 .../SimpleWiFiServer/SimpleWiFiServer.ino | 114 + libs/WiFi/examples/WPS/.skip.esp32h2 | 0 libs/WiFi/examples/WPS/README.md | 104 + libs/WiFi/examples/WPS/WPS.ino | 116 + .../examples/WiFiAccessPoint/.skip.esp32h2 | 0 .../WiFiAccessPoint/WiFiAccessPoint.ino | 99 + .../WiFiBlueToothSwitch/.skip.esp32h2 | 0 .../WiFiBlueToothSwitch/.skip.esp32s2 | 0 .../WiFiBlueToothSwitch.ino | 129 + libs/WiFi/examples/WiFiClient/.skip.esp32h2 | 0 libs/WiFi/examples/WiFiClient/README.md | 165 ++ libs/WiFi/examples/WiFiClient/WiFiClient.ino | 108 + .../examples/WiFiClientBasic/.skip.esp32h2 | 0 .../WiFiClientBasic/WiFiClientBasic.ino | 87 + .../examples/WiFiClientConnect/.skip.esp32h2 | 0 .../WiFi/examples/WiFiClientConnect/README.md | 75 + .../WiFiClientConnect/WiFiClientConnect.ino | 100 + .../WiFiClientEnterprise/.skip.esp32h2 | 0 .../examples/WiFiClientEnterprise/README.md | 43 + .../WiFiClientEnterprise.ino | 85 + .../examples/WiFiClientEvents/.skip.esp32h2 | 0 .../WiFiClientEvents/WiFiClientEvents.ino | 176 ++ .../examples/WiFiClientStaticIP/.skip.esp32h2 | 0 .../WiFiClientStaticIP/WiFiClientStaticIP.ino | 92 + libs/WiFi/examples/WiFiIPv6/.skip.esp32h2 | 0 libs/WiFi/examples/WiFiIPv6/WiFiIPv6.ino | 119 + libs/WiFi/examples/WiFiMulti/.skip.esp32h2 | 0 libs/WiFi/examples/WiFiMulti/WiFiMulti.ino | 35 + .../examples/WiFiMultiAdvanced/.skip.esp32h2 | 0 .../WiFiMultiAdvanced/WiFiMultiAdvanced.ino | 64 + libs/WiFi/examples/WiFiScan/.skip.esp32h2 | 0 libs/WiFi/examples/WiFiScan/README.md | 65 + libs/WiFi/examples/WiFiScan/WiFiScan.ino | 86 + .../WiFi/examples/WiFiScanAsync/.skip.esp32h2 | 1 + libs/WiFi/examples/WiFiScanAsync/README.md | 75 + .../examples/WiFiScanAsync/WiFiScanAsync.ino | 102 + .../WiFiScanDualAntenna/.skip.esp32h2 | 0 .../examples/WiFiScanDualAntenna/README.md | 70 + .../WiFiScanDualAntenna.ino | 79 + .../examples/WiFiSmartConfig/.skip.esp32h2 | 0 .../WiFiSmartConfig/WiFiSmartConfig.ino | 36 + .../examples/WiFiTelnetToSerial/.skip.esp32h2 | 0 .../WiFiTelnetToSerial/WiFiTelnetToSerial.ino | 129 + .../WiFi/examples/WiFiUDPClient/.skip.esp32h2 | 0 .../examples/WiFiUDPClient/WiFiUDPClient.ino | 76 + .../WiFi/examples/WiFiUDPClient/udp_server.py | 30 + .../WiFi/examples/WiFiUDPClient/udp_server.rb | 16 + libs/WiFi/keywords.txt | 68 + libs/WiFi/library.properties | 9 + libs/WiFi/src/WiFi.cpp | 101 + libs/WiFi/src/WiFi.h | 74 + libs/WiFi/src/WiFiAP.cpp | 445 +++ libs/WiFi/src/WiFiAP.h | 74 + libs/WiFi/src/WiFiClient.cpp | 663 +++++ libs/WiFi/src/WiFiClient.h | 112 + libs/WiFi/src/WiFiGeneric.cpp | 1723 ++++++++++++ libs/WiFi/src/WiFiGeneric.h | 245 ++ libs/WiFi/src/WiFiMulti.cpp | 305 +++ libs/WiFi/src/WiFiMulti.h | 79 + libs/WiFi/src/WiFiSTA.cpp | 943 +++++++ libs/WiFi/src/WiFiSTA.h | 132 + libs/WiFi/src/WiFiScan.cpp | 290 ++ libs/WiFi/src/WiFiScan.h | 66 + libs/WiFi/src/WiFiServer.cpp | 143 + libs/WiFi/src/WiFiServer.h | 62 + libs/WiFi/src/WiFiType.h | 54 + libs/WiFi/src/WiFiUdp.cpp | 390 +++ libs/WiFi/src/WiFiUdp.h | 77 + 108 files changed, 14873 insertions(+), 2 deletions(-) create mode 100644 .vscode/arduino.json create mode 100644 .vscode/c_cpp_properties.json create mode 100644 _wifi_config.h create mode 100644 braille_xr.ino create mode 100644 debug.cfg create mode 100644 debug_custom.json create mode 100644 libs/AsyncUDP/examples/AsyncUDPClient/.skip.esp32h2 create mode 100644 libs/AsyncUDP/examples/AsyncUDPClient/AsyncUDPClient.ino create mode 100644 libs/AsyncUDP/examples/AsyncUDPMulticastServer/.skip.esp32h2 create mode 100644 libs/AsyncUDP/examples/AsyncUDPMulticastServer/AsyncUDPMulticastServer.ino create mode 100644 libs/AsyncUDP/examples/AsyncUDPServer/.skip.esp32h2 create mode 100644 libs/AsyncUDP/examples/AsyncUDPServer/AsyncUDPServer.ino create mode 100644 libs/AsyncUDP/keywords.txt create mode 100644 libs/AsyncUDP/library.properties create mode 100644 libs/AsyncUDP/src/AsyncUDP.cpp create mode 100644 libs/AsyncUDP/src/AsyncUDP.h create mode 100644 libs/ESP32Servo/AddDoxygenToGHPages.sh create mode 100644 libs/ESP32Servo/README.md create mode 100644 libs/ESP32Servo/doxy.doxyfile create mode 100644 libs/ESP32Servo/examples/Knob/Knob.ino create mode 100644 libs/ESP32Servo/examples/Multiple-Servo-Example-Arduino/Multiple-Servo-Example-Arduino.ino create mode 100644 libs/ESP32Servo/examples/PWMExample/PWMExample.ino create mode 100644 libs/ESP32Servo/examples/Sweep/Sweep.ino create mode 100644 libs/ESP32Servo/examples/ToneExample/ToneExample.ino create mode 100644 libs/ESP32Servo/examples/analogWriteExample/analogWriteExample.ino create mode 100644 libs/ESP32Servo/keywords.txt create mode 100644 libs/ESP32Servo/library.properties create mode 100644 libs/ESP32Servo/src/ESP32PWM.cpp create mode 100644 libs/ESP32Servo/src/ESP32PWM.h create mode 100644 libs/ESP32Servo/src/ESP32Servo.cpp create mode 100644 libs/ESP32Servo/src/ESP32Servo.h create mode 100644 libs/WiFi/examples/FTM/FTM_Initiator/.skip.esp32h2 create mode 100644 libs/WiFi/examples/FTM/FTM_Initiator/FTM_Initiator.ino create mode 100644 libs/WiFi/examples/FTM/FTM_Initiator/README.md create mode 100644 libs/WiFi/examples/FTM/FTM_Responder/.skip.esp32h2 create mode 100644 libs/WiFi/examples/FTM/FTM_Responder/FTM_Responder.ino create mode 100644 libs/WiFi/examples/FTM/FTM_Responder/README.md create mode 100644 libs/WiFi/examples/SimpleWiFiServer/.skip.esp32h2 create mode 100644 libs/WiFi/examples/SimpleWiFiServer/SimpleWiFiServer.ino create mode 100644 libs/WiFi/examples/WPS/.skip.esp32h2 create mode 100644 libs/WiFi/examples/WPS/README.md create mode 100644 libs/WiFi/examples/WPS/WPS.ino create mode 100644 libs/WiFi/examples/WiFiAccessPoint/.skip.esp32h2 create mode 100644 libs/WiFi/examples/WiFiAccessPoint/WiFiAccessPoint.ino create mode 100644 libs/WiFi/examples/WiFiBlueToothSwitch/.skip.esp32h2 create mode 100644 libs/WiFi/examples/WiFiBlueToothSwitch/.skip.esp32s2 create mode 100644 libs/WiFi/examples/WiFiBlueToothSwitch/WiFiBlueToothSwitch.ino create mode 100644 libs/WiFi/examples/WiFiClient/.skip.esp32h2 create mode 100644 libs/WiFi/examples/WiFiClient/README.md create mode 100644 libs/WiFi/examples/WiFiClient/WiFiClient.ino create mode 100644 libs/WiFi/examples/WiFiClientBasic/.skip.esp32h2 create mode 100644 libs/WiFi/examples/WiFiClientBasic/WiFiClientBasic.ino create mode 100644 libs/WiFi/examples/WiFiClientConnect/.skip.esp32h2 create mode 100644 libs/WiFi/examples/WiFiClientConnect/README.md create mode 100644 libs/WiFi/examples/WiFiClientConnect/WiFiClientConnect.ino create mode 100644 libs/WiFi/examples/WiFiClientEnterprise/.skip.esp32h2 create mode 100644 libs/WiFi/examples/WiFiClientEnterprise/README.md create mode 100644 libs/WiFi/examples/WiFiClientEnterprise/WiFiClientEnterprise.ino create mode 100644 libs/WiFi/examples/WiFiClientEvents/.skip.esp32h2 create mode 100644 libs/WiFi/examples/WiFiClientEvents/WiFiClientEvents.ino create mode 100644 libs/WiFi/examples/WiFiClientStaticIP/.skip.esp32h2 create mode 100644 libs/WiFi/examples/WiFiClientStaticIP/WiFiClientStaticIP.ino create mode 100644 libs/WiFi/examples/WiFiIPv6/.skip.esp32h2 create mode 100644 libs/WiFi/examples/WiFiIPv6/WiFiIPv6.ino create mode 100644 libs/WiFi/examples/WiFiMulti/.skip.esp32h2 create mode 100644 libs/WiFi/examples/WiFiMulti/WiFiMulti.ino create mode 100644 libs/WiFi/examples/WiFiMultiAdvanced/.skip.esp32h2 create mode 100644 libs/WiFi/examples/WiFiMultiAdvanced/WiFiMultiAdvanced.ino create mode 100644 libs/WiFi/examples/WiFiScan/.skip.esp32h2 create mode 100644 libs/WiFi/examples/WiFiScan/README.md create mode 100644 libs/WiFi/examples/WiFiScan/WiFiScan.ino create mode 100644 libs/WiFi/examples/WiFiScanAsync/.skip.esp32h2 create mode 100644 libs/WiFi/examples/WiFiScanAsync/README.md create mode 100644 libs/WiFi/examples/WiFiScanAsync/WiFiScanAsync.ino create mode 100644 libs/WiFi/examples/WiFiScanDualAntenna/.skip.esp32h2 create mode 100644 libs/WiFi/examples/WiFiScanDualAntenna/README.md create mode 100644 libs/WiFi/examples/WiFiScanDualAntenna/WiFiScanDualAntenna.ino create mode 100644 libs/WiFi/examples/WiFiSmartConfig/.skip.esp32h2 create mode 100644 libs/WiFi/examples/WiFiSmartConfig/WiFiSmartConfig.ino create mode 100644 libs/WiFi/examples/WiFiTelnetToSerial/.skip.esp32h2 create mode 100644 libs/WiFi/examples/WiFiTelnetToSerial/WiFiTelnetToSerial.ino create mode 100644 libs/WiFi/examples/WiFiUDPClient/.skip.esp32h2 create mode 100644 libs/WiFi/examples/WiFiUDPClient/WiFiUDPClient.ino create mode 100644 libs/WiFi/examples/WiFiUDPClient/udp_server.py create mode 100644 libs/WiFi/examples/WiFiUDPClient/udp_server.rb create mode 100644 libs/WiFi/keywords.txt create mode 100644 libs/WiFi/library.properties create mode 100644 libs/WiFi/src/WiFi.cpp create mode 100644 libs/WiFi/src/WiFi.h create mode 100644 libs/WiFi/src/WiFiAP.cpp create mode 100644 libs/WiFi/src/WiFiAP.h create mode 100644 libs/WiFi/src/WiFiClient.cpp create mode 100644 libs/WiFi/src/WiFiClient.h create mode 100644 libs/WiFi/src/WiFiGeneric.cpp create mode 100644 libs/WiFi/src/WiFiGeneric.h create mode 100644 libs/WiFi/src/WiFiMulti.cpp create mode 100644 libs/WiFi/src/WiFiMulti.h create mode 100644 libs/WiFi/src/WiFiSTA.cpp create mode 100644 libs/WiFi/src/WiFiSTA.h create mode 100644 libs/WiFi/src/WiFiScan.cpp create mode 100644 libs/WiFi/src/WiFiScan.h create mode 100644 libs/WiFi/src/WiFiServer.cpp create mode 100644 libs/WiFi/src/WiFiServer.h create mode 100644 libs/WiFi/src/WiFiType.h create mode 100644 libs/WiFi/src/WiFiUdp.cpp create mode 100644 libs/WiFi/src/WiFiUdp.h diff --git a/.gitignore b/.gitignore index 8e69dd4..e451505 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,5 @@ +wifi_config.h + #### UNITY /[Ll]ibrary/ diff --git a/.vscode/arduino.json b/.vscode/arduino.json new file mode 100644 index 0000000..69d075c --- /dev/null +++ b/.vscode/arduino.json @@ -0,0 +1,7 @@ +{ + "configuration": "JTAGAdapter=bridge,PSRAM=disabled,PartitionScheme=default,CPUFreq=240,FlashMode=qio,FlashFreq=80,FlashSize=4M,UploadSpeed=921600,LoopCore=1,EventsCore=1,DebugLevel=none,EraseFlash=none", + "board": "esp32:esp32:esp32", + "port": "/dev/ttyUSB0", + "programmer": "esptool", + "sketch": "braille_xr.ino" +} \ No newline at end of file diff --git a/.vscode/c_cpp_properties.json b/.vscode/c_cpp_properties.json new file mode 100644 index 0000000..f3816be --- /dev/null +++ b/.vscode/c_cpp_properties.json @@ -0,0 +1,584 @@ +{ + "version": 4, + "configurations": [ + { + "name": "Arduino", + "compilerPath": "/home/spatialfree/.arduino15/packages/esp32/tools/xtensa-esp32-elf-gcc/esp-2021r2-patch5-8.4.0/bin/xtensa-esp32-elf-g++", + "compilerArgs": [ + "-mlongcalls", + "-Wno-frame-address", + "-ffunction-sections", + "-fdata-sections", + "-Wno-error=unused-function", + "-Wno-error=unused-variable", + "-Wno-error=deprecated-declarations", + "-Wno-unused-parameter", + "-Wno-sign-compare", + "-freorder-blocks", + "-Wwrite-strings", + "-fstack-protector", + "-fstrict-volatile-bitfields", + "-Wno-error=unused-but-set-variable", + "-fno-jump-tables", + "-fno-tree-switch-conversion", + "-std=gnu++11", + "-fexceptions", + "-fno-rtti" + ], + "intelliSenseMode": "gcc-x64", + "includePath": [ + "/home/spatialfree/.arduino15/packages/esp32/hardware/esp32/2.0.11/tools/sdk/esp32/include/newlib/platform_include", + "/home/spatialfree/.arduino15/packages/esp32/hardware/esp32/2.0.11/tools/sdk/esp32/include/freertos/include", + "/home/spatialfree/.arduino15/packages/esp32/hardware/esp32/2.0.11/tools/sdk/esp32/include/freertos/include/esp_additions/freertos", + "/home/spatialfree/.arduino15/packages/esp32/hardware/esp32/2.0.11/tools/sdk/esp32/include/freertos/port/xtensa/include", + "/home/spatialfree/.arduino15/packages/esp32/hardware/esp32/2.0.11/tools/sdk/esp32/include/freertos/include/esp_additions", + "/home/spatialfree/.arduino15/packages/esp32/hardware/esp32/2.0.11/tools/sdk/esp32/include/esp_hw_support/include", + "/home/spatialfree/.arduino15/packages/esp32/hardware/esp32/2.0.11/tools/sdk/esp32/include/esp_hw_support/include/soc", + "/home/spatialfree/.arduino15/packages/esp32/hardware/esp32/2.0.11/tools/sdk/esp32/include/esp_hw_support/include/soc/esp32", + "/home/spatialfree/.arduino15/packages/esp32/hardware/esp32/2.0.11/tools/sdk/esp32/include/esp_hw_support/port/esp32", + "/home/spatialfree/.arduino15/packages/esp32/hardware/esp32/2.0.11/tools/sdk/esp32/include/esp_hw_support/port/esp32/private_include", + "/home/spatialfree/.arduino15/packages/esp32/hardware/esp32/2.0.11/tools/sdk/esp32/include/heap/include", + "/home/spatialfree/.arduino15/packages/esp32/hardware/esp32/2.0.11/tools/sdk/esp32/include/log/include", + "/home/spatialfree/.arduino15/packages/esp32/hardware/esp32/2.0.11/tools/sdk/esp32/include/lwip/include/apps", + "/home/spatialfree/.arduino15/packages/esp32/hardware/esp32/2.0.11/tools/sdk/esp32/include/lwip/include/apps/sntp", + "/home/spatialfree/.arduino15/packages/esp32/hardware/esp32/2.0.11/tools/sdk/esp32/include/lwip/lwip/src/include", + "/home/spatialfree/.arduino15/packages/esp32/hardware/esp32/2.0.11/tools/sdk/esp32/include/lwip/port/esp32/include", + "/home/spatialfree/.arduino15/packages/esp32/hardware/esp32/2.0.11/tools/sdk/esp32/include/lwip/port/esp32/include/arch", + "/home/spatialfree/.arduino15/packages/esp32/hardware/esp32/2.0.11/tools/sdk/esp32/include/soc/include", + "/home/spatialfree/.arduino15/packages/esp32/hardware/esp32/2.0.11/tools/sdk/esp32/include/soc/esp32", + "/home/spatialfree/.arduino15/packages/esp32/hardware/esp32/2.0.11/tools/sdk/esp32/include/soc/esp32/include", + "/home/spatialfree/.arduino15/packages/esp32/hardware/esp32/2.0.11/tools/sdk/esp32/include/hal/esp32/include", + "/home/spatialfree/.arduino15/packages/esp32/hardware/esp32/2.0.11/tools/sdk/esp32/include/hal/include", + "/home/spatialfree/.arduino15/packages/esp32/hardware/esp32/2.0.11/tools/sdk/esp32/include/hal/platform_port/include", + "/home/spatialfree/.arduino15/packages/esp32/hardware/esp32/2.0.11/tools/sdk/esp32/include/esp_rom/include", + "/home/spatialfree/.arduino15/packages/esp32/hardware/esp32/2.0.11/tools/sdk/esp32/include/esp_rom/include/esp32", + "/home/spatialfree/.arduino15/packages/esp32/hardware/esp32/2.0.11/tools/sdk/esp32/include/esp_rom/esp32", + "/home/spatialfree/.arduino15/packages/esp32/hardware/esp32/2.0.11/tools/sdk/esp32/include/esp_common/include", + "/home/spatialfree/.arduino15/packages/esp32/hardware/esp32/2.0.11/tools/sdk/esp32/include/esp_system/include", + "/home/spatialfree/.arduino15/packages/esp32/hardware/esp32/2.0.11/tools/sdk/esp32/include/esp_system/port/soc", + "/home/spatialfree/.arduino15/packages/esp32/hardware/esp32/2.0.11/tools/sdk/esp32/include/esp_system/port/public_compat", + "/home/spatialfree/.arduino15/packages/esp32/hardware/esp32/2.0.11/tools/sdk/esp32/include/esp32/include", + "/home/spatialfree/.arduino15/packages/esp32/hardware/esp32/2.0.11/tools/sdk/esp32/include/xtensa/include", + "/home/spatialfree/.arduino15/packages/esp32/hardware/esp32/2.0.11/tools/sdk/esp32/include/xtensa/esp32/include", + "/home/spatialfree/.arduino15/packages/esp32/hardware/esp32/2.0.11/tools/sdk/esp32/include/driver/include", + "/home/spatialfree/.arduino15/packages/esp32/hardware/esp32/2.0.11/tools/sdk/esp32/include/driver/esp32/include", + "/home/spatialfree/.arduino15/packages/esp32/hardware/esp32/2.0.11/tools/sdk/esp32/include/esp_pm/include", + "/home/spatialfree/.arduino15/packages/esp32/hardware/esp32/2.0.11/tools/sdk/esp32/include/esp_ringbuf/include", + "/home/spatialfree/.arduino15/packages/esp32/hardware/esp32/2.0.11/tools/sdk/esp32/include/efuse/include", + "/home/spatialfree/.arduino15/packages/esp32/hardware/esp32/2.0.11/tools/sdk/esp32/include/efuse/esp32/include", + "/home/spatialfree/.arduino15/packages/esp32/hardware/esp32/2.0.11/tools/sdk/esp32/include/vfs/include", + "/home/spatialfree/.arduino15/packages/esp32/hardware/esp32/2.0.11/tools/sdk/esp32/include/esp_wifi/include", + "/home/spatialfree/.arduino15/packages/esp32/hardware/esp32/2.0.11/tools/sdk/esp32/include/esp_event/include", + "/home/spatialfree/.arduino15/packages/esp32/hardware/esp32/2.0.11/tools/sdk/esp32/include/esp_netif/include", + "/home/spatialfree/.arduino15/packages/esp32/hardware/esp32/2.0.11/tools/sdk/esp32/include/esp_eth/include", + "/home/spatialfree/.arduino15/packages/esp32/hardware/esp32/2.0.11/tools/sdk/esp32/include/tcpip_adapter/include", + "/home/spatialfree/.arduino15/packages/esp32/hardware/esp32/2.0.11/tools/sdk/esp32/include/esp_phy/include", + "/home/spatialfree/.arduino15/packages/esp32/hardware/esp32/2.0.11/tools/sdk/esp32/include/esp_phy/esp32/include", + "/home/spatialfree/.arduino15/packages/esp32/hardware/esp32/2.0.11/tools/sdk/esp32/include/esp_ipc/include", + "/home/spatialfree/.arduino15/packages/esp32/hardware/esp32/2.0.11/tools/sdk/esp32/include/app_trace/include", + "/home/spatialfree/.arduino15/packages/esp32/hardware/esp32/2.0.11/tools/sdk/esp32/include/esp_timer/include", + "/home/spatialfree/.arduino15/packages/esp32/hardware/esp32/2.0.11/tools/sdk/esp32/include/mbedtls/port/include", + "/home/spatialfree/.arduino15/packages/esp32/hardware/esp32/2.0.11/tools/sdk/esp32/include/mbedtls/mbedtls/include", + "/home/spatialfree/.arduino15/packages/esp32/hardware/esp32/2.0.11/tools/sdk/esp32/include/mbedtls/esp_crt_bundle/include", + "/home/spatialfree/.arduino15/packages/esp32/hardware/esp32/2.0.11/tools/sdk/esp32/include/app_update/include", + "/home/spatialfree/.arduino15/packages/esp32/hardware/esp32/2.0.11/tools/sdk/esp32/include/spi_flash/include", + "/home/spatialfree/.arduino15/packages/esp32/hardware/esp32/2.0.11/tools/sdk/esp32/include/bootloader_support/include", + "/home/spatialfree/.arduino15/packages/esp32/hardware/esp32/2.0.11/tools/sdk/esp32/include/nvs_flash/include", + "/home/spatialfree/.arduino15/packages/esp32/hardware/esp32/2.0.11/tools/sdk/esp32/include/pthread/include", + "/home/spatialfree/.arduino15/packages/esp32/hardware/esp32/2.0.11/tools/sdk/esp32/include/esp_gdbstub/include", + "/home/spatialfree/.arduino15/packages/esp32/hardware/esp32/2.0.11/tools/sdk/esp32/include/esp_gdbstub/xtensa", + "/home/spatialfree/.arduino15/packages/esp32/hardware/esp32/2.0.11/tools/sdk/esp32/include/esp_gdbstub/esp32", + "/home/spatialfree/.arduino15/packages/esp32/hardware/esp32/2.0.11/tools/sdk/esp32/include/espcoredump/include", + "/home/spatialfree/.arduino15/packages/esp32/hardware/esp32/2.0.11/tools/sdk/esp32/include/espcoredump/include/port/xtensa", + "/home/spatialfree/.arduino15/packages/esp32/hardware/esp32/2.0.11/tools/sdk/esp32/include/wpa_supplicant/include", + "/home/spatialfree/.arduino15/packages/esp32/hardware/esp32/2.0.11/tools/sdk/esp32/include/wpa_supplicant/port/include", + "/home/spatialfree/.arduino15/packages/esp32/hardware/esp32/2.0.11/tools/sdk/esp32/include/wpa_supplicant/esp_supplicant/include", + "/home/spatialfree/.arduino15/packages/esp32/hardware/esp32/2.0.11/tools/sdk/esp32/include/ieee802154/include", + "/home/spatialfree/.arduino15/packages/esp32/hardware/esp32/2.0.11/tools/sdk/esp32/include/console", + "/home/spatialfree/.arduino15/packages/esp32/hardware/esp32/2.0.11/tools/sdk/esp32/include/asio/asio/asio/include", + "/home/spatialfree/.arduino15/packages/esp32/hardware/esp32/2.0.11/tools/sdk/esp32/include/asio/port/include", + "/home/spatialfree/.arduino15/packages/esp32/hardware/esp32/2.0.11/tools/sdk/esp32/include/bt/common/osi/include", + "/home/spatialfree/.arduino15/packages/esp32/hardware/esp32/2.0.11/tools/sdk/esp32/include/bt/include/esp32/include", + "/home/spatialfree/.arduino15/packages/esp32/hardware/esp32/2.0.11/tools/sdk/esp32/include/bt/common/api/include/api", + "/home/spatialfree/.arduino15/packages/esp32/hardware/esp32/2.0.11/tools/sdk/esp32/include/bt/common/btc/profile/esp/blufi/include", + "/home/spatialfree/.arduino15/packages/esp32/hardware/esp32/2.0.11/tools/sdk/esp32/include/bt/common/btc/profile/esp/include", + "/home/spatialfree/.arduino15/packages/esp32/hardware/esp32/2.0.11/tools/sdk/esp32/include/bt/host/bluedroid/api/include/api", + "/home/spatialfree/.arduino15/packages/esp32/hardware/esp32/2.0.11/tools/sdk/esp32/include/bt/esp_ble_mesh/mesh_common/include", + "/home/spatialfree/.arduino15/packages/esp32/hardware/esp32/2.0.11/tools/sdk/esp32/include/bt/esp_ble_mesh/mesh_common/tinycrypt/include", + "/home/spatialfree/.arduino15/packages/esp32/hardware/esp32/2.0.11/tools/sdk/esp32/include/bt/esp_ble_mesh/mesh_core", + "/home/spatialfree/.arduino15/packages/esp32/hardware/esp32/2.0.11/tools/sdk/esp32/include/bt/esp_ble_mesh/mesh_core/include", + "/home/spatialfree/.arduino15/packages/esp32/hardware/esp32/2.0.11/tools/sdk/esp32/include/bt/esp_ble_mesh/mesh_core/storage", + "/home/spatialfree/.arduino15/packages/esp32/hardware/esp32/2.0.11/tools/sdk/esp32/include/bt/esp_ble_mesh/btc/include", + "/home/spatialfree/.arduino15/packages/esp32/hardware/esp32/2.0.11/tools/sdk/esp32/include/bt/esp_ble_mesh/mesh_models/common/include", + "/home/spatialfree/.arduino15/packages/esp32/hardware/esp32/2.0.11/tools/sdk/esp32/include/bt/esp_ble_mesh/mesh_models/client/include", + "/home/spatialfree/.arduino15/packages/esp32/hardware/esp32/2.0.11/tools/sdk/esp32/include/bt/esp_ble_mesh/mesh_models/server/include", + "/home/spatialfree/.arduino15/packages/esp32/hardware/esp32/2.0.11/tools/sdk/esp32/include/bt/esp_ble_mesh/api/core/include", + "/home/spatialfree/.arduino15/packages/esp32/hardware/esp32/2.0.11/tools/sdk/esp32/include/bt/esp_ble_mesh/api/models/include", + "/home/spatialfree/.arduino15/packages/esp32/hardware/esp32/2.0.11/tools/sdk/esp32/include/bt/esp_ble_mesh/api", + "/home/spatialfree/.arduino15/packages/esp32/hardware/esp32/2.0.11/tools/sdk/esp32/include/cbor/port/include", + "/home/spatialfree/.arduino15/packages/esp32/hardware/esp32/2.0.11/tools/sdk/esp32/include/unity/include", + "/home/spatialfree/.arduino15/packages/esp32/hardware/esp32/2.0.11/tools/sdk/esp32/include/unity/unity/src", + "/home/spatialfree/.arduino15/packages/esp32/hardware/esp32/2.0.11/tools/sdk/esp32/include/cmock/CMock/src", + "/home/spatialfree/.arduino15/packages/esp32/hardware/esp32/2.0.11/tools/sdk/esp32/include/coap/port/include", + "/home/spatialfree/.arduino15/packages/esp32/hardware/esp32/2.0.11/tools/sdk/esp32/include/coap/libcoap/include", + "/home/spatialfree/.arduino15/packages/esp32/hardware/esp32/2.0.11/tools/sdk/esp32/include/nghttp/port/include", + "/home/spatialfree/.arduino15/packages/esp32/hardware/esp32/2.0.11/tools/sdk/esp32/include/nghttp/nghttp2/lib/includes", + "/home/spatialfree/.arduino15/packages/esp32/hardware/esp32/2.0.11/tools/sdk/esp32/include/esp-tls", + "/home/spatialfree/.arduino15/packages/esp32/hardware/esp32/2.0.11/tools/sdk/esp32/include/esp-tls/esp-tls-crypto", + "/home/spatialfree/.arduino15/packages/esp32/hardware/esp32/2.0.11/tools/sdk/esp32/include/esp_adc_cal/include", + "/home/spatialfree/.arduino15/packages/esp32/hardware/esp32/2.0.11/tools/sdk/esp32/include/esp_hid/include", + "/home/spatialfree/.arduino15/packages/esp32/hardware/esp32/2.0.11/tools/sdk/esp32/include/tcp_transport/include", + "/home/spatialfree/.arduino15/packages/esp32/hardware/esp32/2.0.11/tools/sdk/esp32/include/esp_http_client/include", + "/home/spatialfree/.arduino15/packages/esp32/hardware/esp32/2.0.11/tools/sdk/esp32/include/esp_http_server/include", + "/home/spatialfree/.arduino15/packages/esp32/hardware/esp32/2.0.11/tools/sdk/esp32/include/esp_https_ota/include", + "/home/spatialfree/.arduino15/packages/esp32/hardware/esp32/2.0.11/tools/sdk/esp32/include/esp_https_server/include", + "/home/spatialfree/.arduino15/packages/esp32/hardware/esp32/2.0.11/tools/sdk/esp32/include/esp_lcd/include", + "/home/spatialfree/.arduino15/packages/esp32/hardware/esp32/2.0.11/tools/sdk/esp32/include/esp_lcd/interface", + "/home/spatialfree/.arduino15/packages/esp32/hardware/esp32/2.0.11/tools/sdk/esp32/include/protobuf-c/protobuf-c", + "/home/spatialfree/.arduino15/packages/esp32/hardware/esp32/2.0.11/tools/sdk/esp32/include/protocomm/include/common", + "/home/spatialfree/.arduino15/packages/esp32/hardware/esp32/2.0.11/tools/sdk/esp32/include/protocomm/include/security", + "/home/spatialfree/.arduino15/packages/esp32/hardware/esp32/2.0.11/tools/sdk/esp32/include/protocomm/include/transports", + "/home/spatialfree/.arduino15/packages/esp32/hardware/esp32/2.0.11/tools/sdk/esp32/include/mdns/include", + "/home/spatialfree/.arduino15/packages/esp32/hardware/esp32/2.0.11/tools/sdk/esp32/include/esp_local_ctrl/include", + "/home/spatialfree/.arduino15/packages/esp32/hardware/esp32/2.0.11/tools/sdk/esp32/include/sdmmc/include", + "/home/spatialfree/.arduino15/packages/esp32/hardware/esp32/2.0.11/tools/sdk/esp32/include/esp_serial_slave_link/include", + "/home/spatialfree/.arduino15/packages/esp32/hardware/esp32/2.0.11/tools/sdk/esp32/include/esp_websocket_client/include", + "/home/spatialfree/.arduino15/packages/esp32/hardware/esp32/2.0.11/tools/sdk/esp32/include/expat/expat/expat/lib", + "/home/spatialfree/.arduino15/packages/esp32/hardware/esp32/2.0.11/tools/sdk/esp32/include/expat/port/include", + "/home/spatialfree/.arduino15/packages/esp32/hardware/esp32/2.0.11/tools/sdk/esp32/include/wear_levelling/include", + "/home/spatialfree/.arduino15/packages/esp32/hardware/esp32/2.0.11/tools/sdk/esp32/include/fatfs/diskio", + "/home/spatialfree/.arduino15/packages/esp32/hardware/esp32/2.0.11/tools/sdk/esp32/include/fatfs/vfs", + "/home/spatialfree/.arduino15/packages/esp32/hardware/esp32/2.0.11/tools/sdk/esp32/include/fatfs/src", + "/home/spatialfree/.arduino15/packages/esp32/hardware/esp32/2.0.11/tools/sdk/esp32/include/freemodbus/freemodbus/common/include", + "/home/spatialfree/.arduino15/packages/esp32/hardware/esp32/2.0.11/tools/sdk/esp32/include/idf_test/include", + "/home/spatialfree/.arduino15/packages/esp32/hardware/esp32/2.0.11/tools/sdk/esp32/include/idf_test/include/esp32", + "/home/spatialfree/.arduino15/packages/esp32/hardware/esp32/2.0.11/tools/sdk/esp32/include/jsmn/include", + "/home/spatialfree/.arduino15/packages/esp32/hardware/esp32/2.0.11/tools/sdk/esp32/include/json/cJSON", + "/home/spatialfree/.arduino15/packages/esp32/hardware/esp32/2.0.11/tools/sdk/esp32/include/libsodium/libsodium/src/libsodium/include", + "/home/spatialfree/.arduino15/packages/esp32/hardware/esp32/2.0.11/tools/sdk/esp32/include/libsodium/port_include", + "/home/spatialfree/.arduino15/packages/esp32/hardware/esp32/2.0.11/tools/sdk/esp32/include/mqtt/esp-mqtt/include", + "/home/spatialfree/.arduino15/packages/esp32/hardware/esp32/2.0.11/tools/sdk/esp32/include/openssl/include", + "/home/spatialfree/.arduino15/packages/esp32/hardware/esp32/2.0.11/tools/sdk/esp32/include/perfmon/include", + "/home/spatialfree/.arduino15/packages/esp32/hardware/esp32/2.0.11/tools/sdk/esp32/include/spiffs/include", + "/home/spatialfree/.arduino15/packages/esp32/hardware/esp32/2.0.11/tools/sdk/esp32/include/ulp/include", + "/home/spatialfree/.arduino15/packages/esp32/hardware/esp32/2.0.11/tools/sdk/esp32/include/wifi_provisioning/include", + "/home/spatialfree/.arduino15/packages/esp32/hardware/esp32/2.0.11/tools/sdk/esp32/include/rmaker_common/include", + "/home/spatialfree/.arduino15/packages/esp32/hardware/esp32/2.0.11/tools/sdk/esp32/include/esp_diagnostics/include", + "/home/spatialfree/.arduino15/packages/esp32/hardware/esp32/2.0.11/tools/sdk/esp32/include/rtc_store/include", + "/home/spatialfree/.arduino15/packages/esp32/hardware/esp32/2.0.11/tools/sdk/esp32/include/esp_insights/include", + "/home/spatialfree/.arduino15/packages/esp32/hardware/esp32/2.0.11/tools/sdk/esp32/include/json_parser/upstream/include", + "/home/spatialfree/.arduino15/packages/esp32/hardware/esp32/2.0.11/tools/sdk/esp32/include/json_parser/upstream", + "/home/spatialfree/.arduino15/packages/esp32/hardware/esp32/2.0.11/tools/sdk/esp32/include/json_generator/upstream", + "/home/spatialfree/.arduino15/packages/esp32/hardware/esp32/2.0.11/tools/sdk/esp32/include/esp_schedule/include", + "/home/spatialfree/.arduino15/packages/esp32/hardware/esp32/2.0.11/tools/sdk/esp32/include/espressif__esp_secure_cert_mgr/include", + "/home/spatialfree/.arduino15/packages/esp32/hardware/esp32/2.0.11/tools/sdk/esp32/include/esp_rainmaker/include", + "/home/spatialfree/.arduino15/packages/esp32/hardware/esp32/2.0.11/tools/sdk/esp32/include/gpio_button/button/include", + "/home/spatialfree/.arduino15/packages/esp32/hardware/esp32/2.0.11/tools/sdk/esp32/include/qrcode/include", + "/home/spatialfree/.arduino15/packages/esp32/hardware/esp32/2.0.11/tools/sdk/esp32/include/ws2812_led", + "/home/spatialfree/.arduino15/packages/esp32/hardware/esp32/2.0.11/tools/sdk/esp32/include/esp_littlefs/include", + "/home/spatialfree/.arduino15/packages/esp32/hardware/esp32/2.0.11/tools/sdk/esp32/include/esp-dl/include", + "/home/spatialfree/.arduino15/packages/esp32/hardware/esp32/2.0.11/tools/sdk/esp32/include/esp-dl/include/tool", + "/home/spatialfree/.arduino15/packages/esp32/hardware/esp32/2.0.11/tools/sdk/esp32/include/esp-dl/include/typedef", + "/home/spatialfree/.arduino15/packages/esp32/hardware/esp32/2.0.11/tools/sdk/esp32/include/esp-dl/include/image", + "/home/spatialfree/.arduino15/packages/esp32/hardware/esp32/2.0.11/tools/sdk/esp32/include/esp-dl/include/math", + "/home/spatialfree/.arduino15/packages/esp32/hardware/esp32/2.0.11/tools/sdk/esp32/include/esp-dl/include/nn", + "/home/spatialfree/.arduino15/packages/esp32/hardware/esp32/2.0.11/tools/sdk/esp32/include/esp-dl/include/layer", + "/home/spatialfree/.arduino15/packages/esp32/hardware/esp32/2.0.11/tools/sdk/esp32/include/esp-dl/include/detect", + "/home/spatialfree/.arduino15/packages/esp32/hardware/esp32/2.0.11/tools/sdk/esp32/include/esp-dl/include/model_zoo", + "/home/spatialfree/.arduino15/packages/esp32/hardware/esp32/2.0.11/tools/sdk/esp32/include/esp32-camera/driver/include", + "/home/spatialfree/.arduino15/packages/esp32/hardware/esp32/2.0.11/tools/sdk/esp32/include/esp32-camera/conversions/include", + "/home/spatialfree/.arduino15/packages/esp32/hardware/esp32/2.0.11/tools/sdk/esp32/include/espressif__esp-dsp/modules/dotprod/include", + "/home/spatialfree/.arduino15/packages/esp32/hardware/esp32/2.0.11/tools/sdk/esp32/include/espressif__esp-dsp/modules/support/include", + "/home/spatialfree/.arduino15/packages/esp32/hardware/esp32/2.0.11/tools/sdk/esp32/include/espressif__esp-dsp/modules/support/mem/include", + "/home/spatialfree/.arduino15/packages/esp32/hardware/esp32/2.0.11/tools/sdk/esp32/include/espressif__esp-dsp/modules/windows/include", + "/home/spatialfree/.arduino15/packages/esp32/hardware/esp32/2.0.11/tools/sdk/esp32/include/espressif__esp-dsp/modules/windows/hann/include", + "/home/spatialfree/.arduino15/packages/esp32/hardware/esp32/2.0.11/tools/sdk/esp32/include/espressif__esp-dsp/modules/windows/blackman/include", + "/home/spatialfree/.arduino15/packages/esp32/hardware/esp32/2.0.11/tools/sdk/esp32/include/espressif__esp-dsp/modules/windows/blackman_harris/include", + "/home/spatialfree/.arduino15/packages/esp32/hardware/esp32/2.0.11/tools/sdk/esp32/include/espressif__esp-dsp/modules/windows/blackman_nuttall/include", + "/home/spatialfree/.arduino15/packages/esp32/hardware/esp32/2.0.11/tools/sdk/esp32/include/espressif__esp-dsp/modules/windows/nuttall/include", + "/home/spatialfree/.arduino15/packages/esp32/hardware/esp32/2.0.11/tools/sdk/esp32/include/espressif__esp-dsp/modules/windows/flat_top/include", + "/home/spatialfree/.arduino15/packages/esp32/hardware/esp32/2.0.11/tools/sdk/esp32/include/espressif__esp-dsp/modules/iir/include", + "/home/spatialfree/.arduino15/packages/esp32/hardware/esp32/2.0.11/tools/sdk/esp32/include/espressif__esp-dsp/modules/fir/include", + "/home/spatialfree/.arduino15/packages/esp32/hardware/esp32/2.0.11/tools/sdk/esp32/include/espressif__esp-dsp/modules/math/include", + "/home/spatialfree/.arduino15/packages/esp32/hardware/esp32/2.0.11/tools/sdk/esp32/include/espressif__esp-dsp/modules/math/add/include", + "/home/spatialfree/.arduino15/packages/esp32/hardware/esp32/2.0.11/tools/sdk/esp32/include/espressif__esp-dsp/modules/math/sub/include", + "/home/spatialfree/.arduino15/packages/esp32/hardware/esp32/2.0.11/tools/sdk/esp32/include/espressif__esp-dsp/modules/math/mul/include", + "/home/spatialfree/.arduino15/packages/esp32/hardware/esp32/2.0.11/tools/sdk/esp32/include/espressif__esp-dsp/modules/math/addc/include", + "/home/spatialfree/.arduino15/packages/esp32/hardware/esp32/2.0.11/tools/sdk/esp32/include/espressif__esp-dsp/modules/math/mulc/include", + "/home/spatialfree/.arduino15/packages/esp32/hardware/esp32/2.0.11/tools/sdk/esp32/include/espressif__esp-dsp/modules/math/sqrt/include", + "/home/spatialfree/.arduino15/packages/esp32/hardware/esp32/2.0.11/tools/sdk/esp32/include/espressif__esp-dsp/modules/matrix/include", + "/home/spatialfree/.arduino15/packages/esp32/hardware/esp32/2.0.11/tools/sdk/esp32/include/espressif__esp-dsp/modules/fft/include", + "/home/spatialfree/.arduino15/packages/esp32/hardware/esp32/2.0.11/tools/sdk/esp32/include/espressif__esp-dsp/modules/dct/include", + "/home/spatialfree/.arduino15/packages/esp32/hardware/esp32/2.0.11/tools/sdk/esp32/include/espressif__esp-dsp/modules/conv/include", + "/home/spatialfree/.arduino15/packages/esp32/hardware/esp32/2.0.11/tools/sdk/esp32/include/espressif__esp-dsp/modules/common/include", + "/home/spatialfree/.arduino15/packages/esp32/hardware/esp32/2.0.11/tools/sdk/esp32/include/espressif__esp-dsp/modules/kalman/ekf/include", + "/home/spatialfree/.arduino15/packages/esp32/hardware/esp32/2.0.11/tools/sdk/esp32/include/espressif__esp-dsp/modules/kalman/ekf_imu13states/include", + "/home/spatialfree/.arduino15/packages/esp32/hardware/esp32/2.0.11/tools/sdk/esp32/include/fb_gfx/include", + "/home/spatialfree/.arduino15/packages/esp32/hardware/esp32/2.0.11/tools/sdk/esp32/qio_qspi/include", + "/home/spatialfree/.arduino15/packages/esp32/hardware/esp32/2.0.11/cores/esp32", + "/home/spatialfree/.arduino15/packages/esp32/hardware/esp32/2.0.11/variants/esp32", + "/home/spatialfree/.arduino15/packages/esp32/hardware/esp32/2.0.11/libraries/WiFi/src", + "/home/spatialfree/.arduino15/packages/esp32/hardware/esp32/2.0.11/libraries/AsyncUDP/src", + "/home/spatialfree/Arduino/libraries/ESP32Servo/src", + "/home/spatialfree/.arduino15/packages/esp32/tools/xtensa-esp32-elf-gcc/esp-2021r2-patch5-8.4.0/xtensa-esp32-elf/include/c++/8.4.0", + "/home/spatialfree/.arduino15/packages/esp32/tools/xtensa-esp32-elf-gcc/esp-2021r2-patch5-8.4.0/xtensa-esp32-elf/include/c++/8.4.0/xtensa-esp32-elf", + "/home/spatialfree/.arduino15/packages/esp32/tools/xtensa-esp32-elf-gcc/esp-2021r2-patch5-8.4.0/xtensa-esp32-elf/include/c++/8.4.0/backward", + "/home/spatialfree/.arduino15/packages/esp32/tools/xtensa-esp32-elf-gcc/esp-2021r2-patch5-8.4.0/lib/gcc/xtensa-esp32-elf/8.4.0/include", + "/home/spatialfree/.arduino15/packages/esp32/tools/xtensa-esp32-elf-gcc/esp-2021r2-patch5-8.4.0/lib/gcc/xtensa-esp32-elf/8.4.0/include-fixed", + "/home/spatialfree/.arduino15/packages/esp32/tools/xtensa-esp32-elf-gcc/esp-2021r2-patch5-8.4.0/xtensa-esp32-elf/sys-include", + "/home/spatialfree/.arduino15/packages/esp32/tools/xtensa-esp32-elf-gcc/esp-2021r2-patch5-8.4.0/xtensa-esp32-elf/include" + ], + "forcedInclude": [ + "/home/spatialfree/.arduino15/packages/esp32/hardware/esp32/2.0.11/cores/esp32/Arduino.h" + ], + "cStandard": "c11", + "cppStandard": "c++11", + "defines": [ + "HAVE_CONFIG_H", + "MBEDTLS_CONFIG_FILE=\"mbedtls/esp_config.h\"", + "UNITY_INCLUDE_CONFIG_H", + "WITH_POSIX", + "_GNU_SOURCE", + "IDF_VER=\"v4.4.5\"", + "ESP_PLATFORM", + "_POSIX_READER_WRITER_LOCKS", + "F_CPU=240000000L", + "ARDUINO=10607", + "ARDUINO_ESP32_DEV", + "ARDUINO_ARCH_ESP32", + "ARDUINO_BOARD=\"ESP32_DEV\"", + "ARDUINO_VARIANT=\"esp32\"", + "ARDUINO_PARTITION_default", + "ESP32", + "CORE_DEBUG_LEVEL=0", + "ARDUINO_RUNNING_CORE=1", + "ARDUINO_EVENT_RUNNING_CORE=1", + "ARDUINO_USB_CDC_ON_BOOT=0", + "__DBL_MIN_EXP__=(-1021)", + "__FLT32X_MAX_EXP__=1024", + "__cpp_attributes=200809", + "__UINT_LEAST16_MAX__=0xffff", + "__ATOMIC_ACQUIRE=2", + "__FLT_MIN__=1.1754943508222875e-38F", + "__GCC_IEC_559_COMPLEX=0", + "__cpp_aggregate_nsdmi=201304", + "__UINT_LEAST8_TYPE__=unsigned char", + "__INTMAX_C(c)=c ## LL", + "__CHAR_BIT__=8", + "__UINT8_MAX__=0xff", + "__WINT_MAX__=0xffffffffU", + "__FLT32_MIN_EXP__=(-125)", + "__cpp_static_assert=200410", + "__ORDER_LITTLE_ENDIAN__=1234", + "__SIZE_MAX__=0xffffffffU", + "__WCHAR_MAX__=0xffff", + "__GCC_HAVE_SYNC_COMPARE_AND_SWAP_1=1", + "__GCC_HAVE_SYNC_COMPARE_AND_SWAP_2=1", + "__GCC_HAVE_SYNC_COMPARE_AND_SWAP_4=1", + "__DBL_DENORM_MIN__=double(4.9406564584124654e-324L)", + "__GCC_ATOMIC_CHAR_LOCK_FREE=2", + "__GCC_IEC_559=0", + "__FLT32X_DECIMAL_DIG__=17", + "__FLT_EVAL_METHOD__=0", + "__cpp_binary_literals=201304", + "__FLT64_DECIMAL_DIG__=17", + "__GCC_ATOMIC_CHAR32_T_LOCK_FREE=2", + "__cpp_variadic_templates=200704", + "__UINT_FAST64_MAX__=0xffffffffffffffffULL", + "__SIG_ATOMIC_TYPE__=int", + "__DBL_MIN_10_EXP__=(-307)", + "__FINITE_MATH_ONLY__=0", + "__cpp_variable_templates=201304", + "__GNUC_PATCHLEVEL__=0", + "__FLT32_HAS_DENORM__=1", + "__UINT_FAST8_MAX__=0xffffffffU", + "__has_include(STR)=__has_include__(STR)", + "__DEC64_MAX_EXP__=385", + "__INT8_C(c)=c", + "__INT_LEAST8_WIDTH__=8", + "__UINT_LEAST64_MAX__=0xffffffffffffffffULL", + "__SHRT_MAX__=0x7fff", + "__LDBL_MAX__=1.7976931348623157e+308L", + "__UINT_LEAST8_MAX__=0xff", + "__GCC_ATOMIC_BOOL_LOCK_FREE=2", + "__UINTMAX_TYPE__=long long unsigned int", + "__DEC32_EPSILON__=1E-6DF", + "__FLT_EVAL_METHOD_TS_18661_3__=0", + "__CHAR_UNSIGNED__=1", + "__UINT32_MAX__=0xffffffffU", + "__GXX_EXPERIMENTAL_CXX0X__=1", + "__LDBL_MAX_EXP__=1024", + "__WINT_MIN__=0U", + "__INT_LEAST16_WIDTH__=16", + "__SCHAR_MAX__=0x7f", + "__WCHAR_MIN__=0", + "__INT64_C(c)=c ## LL", + "__DBL_DIG__=15", + "__GCC_ATOMIC_POINTER_LOCK_FREE=2", + "__SIZEOF_INT__=4", + "__SIZEOF_POINTER__=4", + "__GCC_ATOMIC_CHAR16_T_LOCK_FREE=2", + "__USER_LABEL_PREFIX__", + "__STDC_HOSTED__=1", + "__LDBL_HAS_INFINITY__=1", + "__XTENSA_EL__=1", + "__FLT32_DIG__=6", + "__FLT_EPSILON__=1.1920928955078125e-7F", + "__GXX_WEAK__=1", + "__SHRT_WIDTH__=16", + "__LDBL_MIN__=2.2250738585072014e-308L", + "__DEC32_MAX__=9.999999E96DF", + "__cpp_threadsafe_static_init=200806", + "__FLT32X_HAS_INFINITY__=1", + "__INT32_MAX__=0x7fffffff", + "__INT_WIDTH__=32", + "__SIZEOF_LONG__=4", + "__UINT16_C(c)=c", + "__PTRDIFF_WIDTH__=32", + "__DECIMAL_DIG__=17", + "__FLT64_EPSILON__=2.2204460492503131e-16F64", + "__INTMAX_WIDTH__=64", + "__FLT64_MIN_EXP__=(-1021)", + "__has_include_next(STR)=__has_include_next__(STR)", + "__LDBL_HAS_QUIET_NAN__=1", + "__FLT64_MANT_DIG__=53", + "__GNUC__=8", + "__GXX_RTTI=1", + "__cpp_delegating_constructors=200604", + "__FLT_HAS_DENORM__=1", + "__SIZEOF_LONG_DOUBLE__=8", + "__BIGGEST_ALIGNMENT__=16", + "__STDC_UTF_16__=1", + "__FLT64_MAX_10_EXP__=308", + "__FLT32_HAS_INFINITY__=1", + "__DBL_MAX__=double(1.7976931348623157e+308L)", + "__cpp_raw_strings=200710", + "__INT_FAST32_MAX__=0x7fffffff", + "__DBL_HAS_INFINITY__=1", + "__DEC32_MIN_EXP__=(-94)", + "__INTPTR_WIDTH__=32", + "__FLT32X_HAS_DENORM__=1", + "__INT_FAST16_TYPE__=int", + "__LDBL_HAS_DENORM__=1", + "__cplusplus=201402L", + "__cpp_ref_qualifiers=200710", + "__DEC128_MAX__=9.999999999999999999999999999999999E6144DL", + "__INT_LEAST32_MAX__=0x7fffffff", + "__DEC32_MIN__=1E-95DF", + "__DEPRECATED=1", + "__cpp_rvalue_references=200610", + "__DBL_MAX_EXP__=1024", + "__WCHAR_WIDTH__=16", + "__FLT32_MAX__=3.4028234663852886e+38F32", + "__DEC128_EPSILON__=1E-33DL", + "__PTRDIFF_MAX__=0x7fffffff", + "__FLT32_HAS_QUIET_NAN__=1", + "__GNUG__=8", + "__LONG_LONG_MAX__=0x7fffffffffffffffLL", + "__SIZEOF_SIZE_T__=4", + "__cpp_rvalue_reference=200610", + "__cpp_nsdmi=200809", + "__SIZEOF_WINT_T__=4", + "__LONG_LONG_WIDTH__=64", + "__cpp_initializer_lists=200806", + "__FLT32_MAX_EXP__=128", + "__cpp_hex_float=201603", + "__GXX_ABI_VERSION=1013", + "__FLT_MIN_EXP__=(-125)", + "__cpp_lambdas=200907", + "__INT_FAST64_TYPE__=long long int", + "__FP_FAST_FMAF=1", + "__FLT64_DENORM_MIN__=4.9406564584124654e-324F64", + "__DBL_MIN__=double(2.2250738585072014e-308L)", + "__FLT32X_EPSILON__=2.2204460492503131e-16F32x", + "__FLT64_MIN_10_EXP__=(-307)", + "__DEC128_MIN__=1E-6143DL", + "__REGISTER_PREFIX__", + "__UINT16_MAX__=0xffff", + "__DBL_HAS_DENORM__=1", + "__FLT32_MIN__=1.1754943508222875e-38F32", + "__UINT8_TYPE__=unsigned char", + "__NO_INLINE__=1", + "__FLT_MANT_DIG__=24", + "__LDBL_DECIMAL_DIG__=17", + "__VERSION__=\"8.4.0\"", + "__UINT64_C(c)=c ## ULL", + "__cpp_unicode_characters=200704", + "__cpp_decltype_auto=201304", + "__GCC_ATOMIC_INT_LOCK_FREE=2", + "__FLT32_MANT_DIG__=24", + "__FLOAT_WORD_ORDER__=__ORDER_LITTLE_ENDIAN__", + "__SCHAR_WIDTH__=8", + "__INT32_C(c)=c", + "__DEC64_EPSILON__=1E-15DD", + "__ORDER_PDP_ENDIAN__=3412", + "__DEC128_MIN_EXP__=(-6142)", + "__FLT32_MAX_10_EXP__=38", + "__INT_FAST32_TYPE__=int", + "__UINT_LEAST16_TYPE__=short unsigned int", + "__INT16_MAX__=0x7fff", + "__cpp_rtti=199711", + "__SIZE_TYPE__=unsigned int", + "__UINT64_MAX__=0xffffffffffffffffULL", + "__INT8_TYPE__=signed char", + "__cpp_digit_separators=201309", + "__ELF__=1", + "__xtensa__=1", + "__FLT_RADIX__=2", + "__INT_LEAST16_TYPE__=short int", + "__LDBL_EPSILON__=2.2204460492503131e-16L", + "__UINTMAX_C(c)=c ## ULL", + "__SIG_ATOMIC_MAX__=0x7fffffff", + "__GCC_ATOMIC_WCHAR_T_LOCK_FREE=2", + "__SIZEOF_PTRDIFF_T__=4", + "__FLT32X_MANT_DIG__=53", + "__FLT32X_MIN_EXP__=(-1021)", + "__DEC32_SUBNORMAL_MIN__=0.000001E-95DF", + "__INT_FAST16_MAX__=0x7fffffff", + "__FLT64_DIG__=15", + "__UINT_FAST32_MAX__=0xffffffffU", + "__UINT_LEAST64_TYPE__=long long unsigned int", + "__FLT_HAS_QUIET_NAN__=1", + "__FLT_MAX_10_EXP__=38", + "__LONG_MAX__=0x7fffffffL", + "__DEC128_SUBNORMAL_MIN__=0.000000000000000000000000000000001E-6143DL", + "__FLT_HAS_INFINITY__=1", + "__cpp_unicode_literals=200710", + "__UINT_FAST16_TYPE__=unsigned int", + "__DEC64_MAX__=9.999999999999999E384DD", + "__INT_FAST32_WIDTH__=32", + "__CHAR16_TYPE__=short unsigned int", + "__PRAGMA_REDEFINE_EXTNAME=1", + "__SIZE_WIDTH__=32", + "__INT_LEAST16_MAX__=0x7fff", + "__DEC64_MANT_DIG__=16", + "__INT64_MAX__=0x7fffffffffffffffLL", + "__UINT_LEAST32_MAX__=0xffffffffU", + "__FLT32_DENORM_MIN__=1.4012984643248171e-45F32", + "__GCC_ATOMIC_LONG_LOCK_FREE=2", + "__SIG_ATOMIC_WIDTH__=32", + "__INT_LEAST64_TYPE__=long long int", + "__INT16_TYPE__=short int", + "__INT_LEAST8_TYPE__=signed char", + "__DEC32_MAX_EXP__=97", + "__INT_FAST8_MAX__=0x7fffffff", + "__INTPTR_MAX__=0x7fffffff", + "__cpp_sized_deallocation=201309", + "__cpp_range_based_for=200907", + "__FLT64_HAS_QUIET_NAN__=1", + "__FLT32_MIN_10_EXP__=(-37)", + "__EXCEPTIONS=1", + "__LDBL_MANT_DIG__=53", + "__DBL_HAS_QUIET_NAN__=1", + "__FLT64_HAS_INFINITY__=1", + "__SIG_ATOMIC_MIN__=(-__SIG_ATOMIC_MAX__ - 1)", + "__cpp_return_type_deduction=201304", + "__INTPTR_TYPE__=int", + "__UINT16_TYPE__=short unsigned int", + "__WCHAR_TYPE__=short unsigned int", + "__SIZEOF_FLOAT__=4", + "__UINTPTR_MAX__=0xffffffffU", + "__INT_FAST64_WIDTH__=64", + "__DEC64_MIN_EXP__=(-382)", + "__cpp_decltype=200707", + "__FLT32_DECIMAL_DIG__=9", + "__INT_FAST64_MAX__=0x7fffffffffffffffLL", + "__GCC_ATOMIC_TEST_AND_SET_TRUEVAL=1", + "__FLT_DIG__=6", + "__UINT_FAST64_TYPE__=long long unsigned int", + "__INT_MAX__=0x7fffffff", + "__INT64_TYPE__=long long int", + "__FLT_MAX_EXP__=128", + "__DBL_MANT_DIG__=53", + "__cpp_inheriting_constructors=201511", + "__INT_LEAST64_MAX__=0x7fffffffffffffffLL", + "__FP_FAST_FMAF32=1", + "__DEC64_MIN__=1E-383DD", + "__WINT_TYPE__=unsigned int", + "__UINT_LEAST32_TYPE__=unsigned int", + "__SIZEOF_SHORT__=2", + "__LDBL_MIN_EXP__=(-1021)", + "__FLT64_MAX__=1.7976931348623157e+308F64", + "__WINT_WIDTH__=32", + "__INT_LEAST8_MAX__=0x7f", + "__FLT32X_MAX_10_EXP__=308", + "__WCHAR_UNSIGNED__=1", + "__LDBL_MAX_10_EXP__=308", + "__ATOMIC_RELAXED=0", + "__DBL_EPSILON__=double(2.2204460492503131e-16L)", + "__XTENSA_WINDOWED_ABI__=1", + "__UINT8_C(c)=c", + "__FLT64_MAX_EXP__=1024", + "__INT_LEAST32_TYPE__=int", + "__SIZEOF_WCHAR_T__=2", + "__INT_FAST8_TYPE__=int", + "__GNUC_STDC_INLINE__=1", + "__FLT64_HAS_DENORM__=1", + "__FLT32_EPSILON__=1.1920928955078125e-7F32", + "__DBL_DECIMAL_DIG__=17", + "__STDC_UTF_32__=1", + "__INT_FAST8_WIDTH__=32", + "__DEC_EVAL_METHOD__=2", + "__FLT32X_MAX__=1.7976931348623157e+308F32x", + "__XTENSA__=1", + "__ORDER_BIG_ENDIAN__=4321", + "__cpp_runtime_arrays=198712", + "__UINT64_TYPE__=long long unsigned int", + "__UINT32_C(c)=c ## U", + "__INTMAX_MAX__=0x7fffffffffffffffLL", + "__cpp_alias_templates=200704", + "__BYTE_ORDER__=__ORDER_LITTLE_ENDIAN__", + "__FLT_DENORM_MIN__=1.4012984643248171e-45F", + "__INT8_MAX__=0x7f", + "__LONG_WIDTH__=32", + "__UINT_FAST32_TYPE__=unsigned int", + "__CHAR32_TYPE__=unsigned int", + "__FLT_MAX__=3.4028234663852886e+38F", + "__cpp_constexpr=201304", + "__INT32_TYPE__=int", + "__SIZEOF_DOUBLE__=8", + "__cpp_exceptions=199711", + "__FLT_MIN_10_EXP__=(-37)", + "__FLT64_MIN__=2.2250738585072014e-308F64", + "__INT_LEAST32_WIDTH__=32", + "__INTMAX_TYPE__=long long int", + "__DEC128_MAX_EXP__=6145", + "__FLT32X_HAS_QUIET_NAN__=1", + "__ATOMIC_CONSUME=1", + "__GNUC_MINOR__=4", + "__INT_FAST16_WIDTH__=32", + "__UINTMAX_MAX__=0xffffffffffffffffULL", + "__DEC32_MANT_DIG__=7", + "__FLT32X_DENORM_MIN__=4.9406564584124654e-324F32x", + "__DBL_MAX_10_EXP__=308", + "__LDBL_DENORM_MIN__=4.9406564584124654e-324L", + "__INT16_C(c)=c", + "__cpp_generic_lambdas=201304", + "__STDC__=1", + "__FLT32X_DIG__=15", + "__PTRDIFF_TYPE__=int", + "__ATOMIC_SEQ_CST=5", + "__UINT32_TYPE__=unsigned int", + "__FLT32X_MIN_10_EXP__=(-307)", + "__UINTPTR_TYPE__=unsigned int", + "__DEC64_SUBNORMAL_MIN__=0.000000000000001E-383DD", + "__DEC128_MANT_DIG__=34", + "__LDBL_MIN_10_EXP__=(-307)", + "__SIZEOF_LONG_LONG__=8", + "__cpp_user_defined_literals=200809", + "__GCC_ATOMIC_LLONG_LOCK_FREE=1", + "__FLT32X_MIN__=2.2250738585072014e-308F32x", + "__LDBL_DIG__=15", + "__FLT_DECIMAL_DIG__=9", + "__UINT_FAST16_MAX__=0xffffffffU", + "__GCC_ATOMIC_SHORT_LOCK_FREE=2", + "__INT_LEAST64_WIDTH__=64", + "__UINT_FAST8_TYPE__=unsigned int", + "__cpp_init_captures=201304", + "__ATOMIC_ACQ_REL=4", + "__ATOMIC_RELEASE=3", + "USBCON" + ] + } + ] +} \ No newline at end of file diff --git a/README.md b/README.md index 88e179b..63b1bd5 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,11 @@ refreshable braille display for rendering and input ## Setup -Tell everyone what your project needs in order to run. This might involve many components or software. Maybe some cool libraries? +!!! edit _wifi_config.h to setup your wifi credentials first +```shell +# + on linux make sure you can r/w +sudo chmod 666 /dev/ttyUSB0 +``` ### Hardware Required @@ -19,7 +23,7 @@ Tell everyone what your project needs in order to run. This might involve many c ## Run ```shell -run() +# ... ``` ## Shout-Outs diff --git a/_wifi_config.h b/_wifi_config.h new file mode 100644 index 0000000..e1504d7 --- /dev/null +++ b/_wifi_config.h @@ -0,0 +1,4 @@ +// PLEASE RENAME THIS FILE TO wifi_config.h +// once you've filled in your wifi credentials +const char* ssid = "your_ssid"; +const char* pass = "your_password"; \ No newline at end of file diff --git a/braille_xr.ino b/braille_xr.ino new file mode 100644 index 0000000..d9e1ddd --- /dev/null +++ b/braille_xr.ino @@ -0,0 +1,207 @@ +#include "WiFi.h" +#include "AsyncUDP.h" +#include "wifi_config.h" +AsyncUDP udp; + +int bindex = 0; + +#include +struct ServoPin { + Servo servo; + int pin; +}; +// Recommended PWM GPIO pins on the ESP32 include 2,4,12-19,21-23,25-27,32-33 +ServoPin servos[6] = { + {Servo(), 4 }, {Servo(), 16}, + {Servo(), 17}, {Servo(), 5 }, + {Servo(), 18}, {Servo(), 19} +}; + +// braille alphabet +// example: +// *1 = 180 degrees +// a (0 index) +// 10 +// 00 +// 00 +// braille alphabet array +struct BrailleChar { + int servoStates[6]; +}; +BrailleChar brailleAlphabet[26] = { + {{1, 0, + 0, 0, + 0, 0 + }}, // a + {{1, 0, + 1, 0, + 0, 0 + }}, // b + {{1, 1, + 0, 0, + 0, 0 + }}, // c + {{1, 1, + 0, 1, + 0, 0 + }}, // d + {{1, 0, + 0, 1, + 0, 0 + }}, // e + {{1, 1, + 1, 0, + 0, 0 + }}, // f + {{1, 1, + 1, 1, + 0, 0 + }}, // g + {{1, 0, + 1, 1, + 0, 0 + }}, // h + {{0, 1, + 1, 0, + 0, 0 + }}, // i + {{0, 1, + 1, 1, + 0, 0 + }}, // j + {{1, 0, + 0, 0, + 1, 0 + }}, // k + {{1, 0, + 1, 0, + 1, 0 + }}, // l + {{1, 1, + 0, 0, + 1, 0 + }}, // m + {{1, 1, + 0, 1, + 1, 0 + }}, // n + {{1, 0, + 0, 1, + 1, 0 + }}, // o + {{1, 1, + 1, 0, + 1, 0 + }}, // p + {{1, 1, + 1, 1, + 1, 0 + }}, // q + {{1, 0, + 1, 1, + 1, 0 + }}, // r + {{0, 1, + 1, 0, + 1, 0 + }}, // s + {{0, 1, + 1, 1, + 1, 0 + }}, // t + {{1, 0, + 0, 0, + 1, 1 + }}, // u + {{1, 0, + 1, 0, + 1, 1 + }}, // v + {{0, 1, + 1, 1, + 0, 1 + }}, // w + {{1, 1, + 0, 0, + 1, 1 + }}, // x + {{1, 1, + 0, 1, + 1, 1 + }}, // y + {{1, 0, + 0, 1, + 1, 1 + }} // z +}; + +void setup() +{ + Serial.begin(115200); + + WiFi.disconnect(true); + WiFi.mode(WIFI_STA); + WiFi.begin(ssid, pass); + while (WiFi.status() != WL_CONNECTED) { + delay(500); + Serial.print("."); + // and print status + Serial.println(WiFi.status()); + } + if (udp.listen(1234)) { + Serial.print("UDP Listening on IP: "); + Serial.println(WiFi.localIP()); + udp.onPacket([](AsyncUDPPacket packet) { + Serial.print(", Length: "); + Serial.print(packet.length()); //dlzka packetu + Serial.print(", Data: "); + // Serial.write(packet.data(), packet.length()); + // that is printing a character instead of a number + // so do this instead + // Serial.print(packet.data()[0]); + // and set the bindex to that value + bindex = packet.data()[0]; + Serial.print(bindex); + Serial.println(); + uint32_t receivedData; + memcpy(&receivedData, packet.data(), sizeof(receivedData)); + packet.printf("Got %u bytes of data", packet.length()); + }); + } + + // Allow allocation of all timers + ESP32PWM::allocateTimer(0); + ESP32PWM::allocateTimer(1); + ESP32PWM::allocateTimer(2); + ESP32PWM::allocateTimer(3); + // myservo.setPeriodHertz(50); // standard 50 hz servo + // myservo.attach(servoPin, 1000, 2000); // attaches the servo on pin x to the servo object + // using default min/max of 1000us and 2000us + // different servos may require different min/max settings + // for an accurate 0 to 180 sweep + for (int i = 0; i < 6; i++) { + servos[i].servo.setPeriodHertz(50); + servos[i].servo.attach(servos[i].pin, 1000, 2000); + } +} + +void loop() +{ + // delay(1000); + // udp.broadcast("Anyone here?"); + + // for (pos = 0; pos <= 180; pos += 1) { // goes from 0 degrees to 180 degrees + // // in steps of 1 degree + // myservo.write(pos); // tell servo to go to position in variable 'pos' + // delay(15); // waits 15ms for the servo to reach the position + // } + // for (pos = 180; pos >= 0; pos -= 1) { // goes from 180 degrees to 0 degrees + // myservo.write(pos); // tell servo to go to position in variable 'pos' + // delay(15); // waits 15ms for the servo to reach the position + // } + + // myservo.write(bindex); + for (int i = 0; i < 6; i++) { + servos[i].servo.write(bindex); + } +} \ No newline at end of file diff --git a/debug.cfg b/debug.cfg new file mode 100644 index 0000000..17146e5 --- /dev/null +++ b/debug.cfg @@ -0,0 +1,15 @@ +# SPDX-License-Identifier: GPL-2.0-or-later +# +# Example OpenOCD configuration file for ESP32 connected via ESP USB Bridge board +# +# For example, OpenOCD can be started for ESP32 debugging on +# +# openocd -f board/esp32-bridge.cfg +# + +# Source the JTAG interface configuration file +source [find interface/esp_usb_bridge.cfg] +# ESP32 chip id defined in the idf esp_chip_model_t +espusbjtag chip_id 1 +# Source the ESP32 configuration file +source [find target/esp32.cfg] diff --git a/debug_custom.json b/debug_custom.json new file mode 100644 index 0000000..4dbe431 --- /dev/null +++ b/debug_custom.json @@ -0,0 +1,19 @@ +{ + "name":"Arduino on ESP32", + "toolchainPrefix":"xtensa-esp32-elf", + "svdFile":"debug.svd", + "request":"attach", + "postAttachCommands":[ + "set remote hardware-watchpoint-limit 2", + "monitor reset halt", + "monitor gdb_sync", + "thb setup", + "c" + ], + "overrideRestartCommands":[ + "monitor reset halt", + "monitor gdb_sync", + "thb setup", + "c" + ] +} \ No newline at end of file diff --git a/libs/AsyncUDP/examples/AsyncUDPClient/.skip.esp32h2 b/libs/AsyncUDP/examples/AsyncUDPClient/.skip.esp32h2 new file mode 100644 index 0000000..e69de29 diff --git a/libs/AsyncUDP/examples/AsyncUDPClient/AsyncUDPClient.ino b/libs/AsyncUDP/examples/AsyncUDPClient/AsyncUDPClient.ino new file mode 100644 index 0000000..3348f8a --- /dev/null +++ b/libs/AsyncUDP/examples/AsyncUDPClient/AsyncUDPClient.ino @@ -0,0 +1,51 @@ +#include "WiFi.h" +#include "AsyncUDP.h" + +const char * ssid = "***********"; +const char * password = "***********"; + +AsyncUDP udp; + +void setup() +{ + Serial.begin(115200); + WiFi.mode(WIFI_STA); + WiFi.begin(ssid, password); + if (WiFi.waitForConnectResult() != WL_CONNECTED) { + Serial.println("WiFi Failed"); + while(1) { + delay(1000); + } + } + if(udp.connect(IPAddress(192,168,1,100), 1234)) { + Serial.println("UDP connected"); + udp.onPacket([](AsyncUDPPacket packet) { + Serial.print("UDP Packet Type: "); + Serial.print(packet.isBroadcast()?"Broadcast":packet.isMulticast()?"Multicast":"Unicast"); + Serial.print(", From: "); + Serial.print(packet.remoteIP()); + Serial.print(":"); + Serial.print(packet.remotePort()); + Serial.print(", To: "); + Serial.print(packet.localIP()); + Serial.print(":"); + Serial.print(packet.localPort()); + Serial.print(", Length: "); + Serial.print(packet.length()); + Serial.print(", Data: "); + Serial.write(packet.data(), packet.length()); + Serial.println(); + //reply to the client + packet.printf("Got %u bytes of data", packet.length()); + }); + //Send unicast + udp.print("Hello Server!"); + } +} + +void loop() +{ + delay(1000); + //Send broadcast on port 1234 + udp.broadcastTo("Anyone here?", 1234); +} diff --git a/libs/AsyncUDP/examples/AsyncUDPMulticastServer/.skip.esp32h2 b/libs/AsyncUDP/examples/AsyncUDPMulticastServer/.skip.esp32h2 new file mode 100644 index 0000000..e69de29 diff --git a/libs/AsyncUDP/examples/AsyncUDPMulticastServer/AsyncUDPMulticastServer.ino b/libs/AsyncUDP/examples/AsyncUDPMulticastServer/AsyncUDPMulticastServer.ino new file mode 100644 index 0000000..2bbbac5 --- /dev/null +++ b/libs/AsyncUDP/examples/AsyncUDPMulticastServer/AsyncUDPMulticastServer.ino @@ -0,0 +1,52 @@ +#include "WiFi.h" +#include "AsyncUDP.h" + +const char * ssid = "***********"; +const char * password = "***********"; + +AsyncUDP udp; + +void setup() +{ + Serial.begin(115200); + WiFi.mode(WIFI_STA); + WiFi.begin(ssid, password); + if (WiFi.waitForConnectResult() != WL_CONNECTED) { + Serial.println("WiFi Failed"); + while(1) { + delay(1000); + } + } + if(udp.listenMulticast(IPAddress(239,1,2,3), 1234)) { + Serial.print("UDP Listening on IP: "); + Serial.println(WiFi.localIP()); + udp.onPacket([](AsyncUDPPacket packet) { + Serial.print("UDP Packet Type: "); + Serial.print(packet.isBroadcast()?"Broadcast":packet.isMulticast()?"Multicast":"Unicast"); + Serial.print(", From: "); + Serial.print(packet.remoteIP()); + Serial.print(":"); + Serial.print(packet.remotePort()); + Serial.print(", To: "); + Serial.print(packet.localIP()); + Serial.print(":"); + Serial.print(packet.localPort()); + Serial.print(", Length: "); + Serial.print(packet.length()); + Serial.print(", Data: "); + Serial.write(packet.data(), packet.length()); + Serial.println(); + //reply to the client + packet.printf("Got %u bytes of data", packet.length()); + }); + //Send multicast + udp.print("Hello!"); + } +} + +void loop() +{ + delay(1000); + //Send multicast + udp.print("Anyone here?"); +} diff --git a/libs/AsyncUDP/examples/AsyncUDPServer/.skip.esp32h2 b/libs/AsyncUDP/examples/AsyncUDPServer/.skip.esp32h2 new file mode 100644 index 0000000..e69de29 diff --git a/libs/AsyncUDP/examples/AsyncUDPServer/AsyncUDPServer.ino b/libs/AsyncUDP/examples/AsyncUDPServer/AsyncUDPServer.ino new file mode 100644 index 0000000..1f8529b --- /dev/null +++ b/libs/AsyncUDP/examples/AsyncUDPServer/AsyncUDPServer.ino @@ -0,0 +1,50 @@ +#include "WiFi.h" +#include "AsyncUDP.h" + +const char * ssid = "***********"; +const char * password = "***********"; + +AsyncUDP udp; + +void setup() +{ + Serial.begin(115200); + WiFi.mode(WIFI_STA); + WiFi.begin(ssid, password); + if (WiFi.waitForConnectResult() != WL_CONNECTED) { + Serial.println("WiFi Failed"); + while(1) { + delay(1000); + } + } + if(udp.listen(1234)) { + Serial.print("UDP Listening on IP: "); + Serial.println(WiFi.localIP()); + udp.onPacket([](AsyncUDPPacket packet) { + Serial.print("UDP Packet Type: "); + Serial.print(packet.isBroadcast()?"Broadcast":packet.isMulticast()?"Multicast":"Unicast"); + Serial.print(", From: "); + Serial.print(packet.remoteIP()); + Serial.print(":"); + Serial.print(packet.remotePort()); + Serial.print(", To: "); + Serial.print(packet.localIP()); + Serial.print(":"); + Serial.print(packet.localPort()); + Serial.print(", Length: "); + Serial.print(packet.length()); + Serial.print(", Data: "); + Serial.write(packet.data(), packet.length()); + Serial.println(); + //reply to the client + packet.printf("Got %u bytes of data", packet.length()); + }); + } +} + +void loop() +{ + delay(1000); + //Send broadcast + udp.broadcast("Anyone here?"); +} diff --git a/libs/AsyncUDP/keywords.txt b/libs/AsyncUDP/keywords.txt new file mode 100644 index 0000000..67c0b97 --- /dev/null +++ b/libs/AsyncUDP/keywords.txt @@ -0,0 +1,33 @@ +####################################### +# Syntax Coloring Map For Ultrasound +####################################### + +####################################### +# Datatypes (KEYWORD1) +####################################### + +AsyncUDP KEYWORD1 +AsyncUDPPacket KEYWORD1 + +####################################### +# Methods and Functions (KEYWORD2) +####################################### + +connect KEYWORD2 +connected KEYWORD2 +listen KEYWORD2 +listenMulticast KEYWORD2 +close KEYWORD2 +write KEYWORD2 +broadcast KEYWORD2 +onPacket KEYWORD2 +data KEYWORD2 +length KEYWORD2 +localIP KEYWORD2 +localPort KEYWORD2 +remoteIP KEYWORD2 +remotePort KEYWORD2 + +####################################### +# Constants (LITERAL1) +####################################### diff --git a/libs/AsyncUDP/library.properties b/libs/AsyncUDP/library.properties new file mode 100644 index 0000000..f606bb8 --- /dev/null +++ b/libs/AsyncUDP/library.properties @@ -0,0 +1,9 @@ +name=ESP32 Async UDP +version=2.0.0 +author=Me-No-Dev +maintainer=Me-No-Dev +sentence=Async UDP Library for ESP32 +paragraph=Async UDP Library for ESP32 +category=Other +url=https://github.com/me-no-dev/ESPAsyncUDP +architectures=* diff --git a/libs/AsyncUDP/src/AsyncUDP.cpp b/libs/AsyncUDP/src/AsyncUDP.cpp new file mode 100644 index 0000000..1c650f1 --- /dev/null +++ b/libs/AsyncUDP/src/AsyncUDP.cpp @@ -0,0 +1,879 @@ +#include "Arduino.h" +#include "AsyncUDP.h" + +extern "C" { +#include "lwip/opt.h" +#include "lwip/inet.h" +#include "lwip/udp.h" +#include "lwip/igmp.h" +#include "lwip/ip_addr.h" +#include "lwip/mld6.h" +#include "lwip/prot/ethernet.h" +#include +#include +} + +#include "lwip/priv/tcpip_priv.h" + +static const char * netif_ifkeys[TCPIP_ADAPTER_IF_MAX] = { + "WIFI_STA_DEF", "WIFI_AP_DEF", "ETH_DEF", "PPP_DEF" +}; + +static esp_err_t tcpip_adapter_get_netif(tcpip_adapter_if_t tcpip_if, void ** netif){ + *netif = NULL; + if(tcpip_if < TCPIP_ADAPTER_IF_MAX){ + esp_netif_t *esp_netif = esp_netif_get_handle_from_ifkey(netif_ifkeys[tcpip_if]); + if(esp_netif == NULL){ + return ESP_FAIL; + } + int netif_index = esp_netif_get_netif_impl_index(esp_netif); + if(netif_index < 0){ + return ESP_FAIL; + } + *netif = (void*)netif_get_by_index(netif_index); + } else { + *netif = netif_default; + } + return (*netif != NULL)?ESP_OK:ESP_FAIL; +} + +typedef struct { + struct tcpip_api_call_data call; + udp_pcb * pcb; + const ip_addr_t *addr; + uint16_t port; + struct pbuf *pb; + struct netif *netif; + err_t err; +} udp_api_call_t; + +static err_t _udp_connect_api(struct tcpip_api_call_data *api_call_msg){ + udp_api_call_t * msg = (udp_api_call_t *)api_call_msg; + msg->err = udp_connect(msg->pcb, msg->addr, msg->port); + return msg->err; +} + +static err_t _udp_connect(struct udp_pcb *pcb, const ip_addr_t *addr, u16_t port){ + udp_api_call_t msg; + msg.pcb = pcb; + msg.addr = addr; + msg.port = port; + tcpip_api_call(_udp_connect_api, (struct tcpip_api_call_data*)&msg); + return msg.err; +} + +static err_t _udp_disconnect_api(struct tcpip_api_call_data *api_call_msg){ + udp_api_call_t * msg = (udp_api_call_t *)api_call_msg; + msg->err = 0; + udp_disconnect(msg->pcb); + return msg->err; +} + +static void _udp_disconnect(struct udp_pcb *pcb){ + udp_api_call_t msg; + msg.pcb = pcb; + tcpip_api_call(_udp_disconnect_api, (struct tcpip_api_call_data*)&msg); +} + +static err_t _udp_remove_api(struct tcpip_api_call_data *api_call_msg){ + udp_api_call_t * msg = (udp_api_call_t *)api_call_msg; + msg->err = 0; + udp_remove(msg->pcb); + return msg->err; +} + +static void _udp_remove(struct udp_pcb *pcb){ + udp_api_call_t msg; + msg.pcb = pcb; + tcpip_api_call(_udp_remove_api, (struct tcpip_api_call_data*)&msg); +} + +static err_t _udp_bind_api(struct tcpip_api_call_data *api_call_msg){ + udp_api_call_t * msg = (udp_api_call_t *)api_call_msg; + msg->err = udp_bind(msg->pcb, msg->addr, msg->port); + return msg->err; +} + +static err_t _udp_bind(struct udp_pcb *pcb, const ip_addr_t *addr, u16_t port){ + udp_api_call_t msg; + msg.pcb = pcb; + msg.addr = addr; + msg.port = port; + tcpip_api_call(_udp_bind_api, (struct tcpip_api_call_data*)&msg); + return msg.err; +} + +static err_t _udp_sendto_api(struct tcpip_api_call_data *api_call_msg){ + udp_api_call_t * msg = (udp_api_call_t *)api_call_msg; + msg->err = udp_sendto(msg->pcb, msg->pb, msg->addr, msg->port); + return msg->err; +} + +static err_t _udp_sendto(struct udp_pcb *pcb, struct pbuf *pb, const ip_addr_t *addr, u16_t port){ + udp_api_call_t msg; + msg.pcb = pcb; + msg.addr = addr; + msg.port = port; + msg.pb = pb; + tcpip_api_call(_udp_sendto_api, (struct tcpip_api_call_data*)&msg); + return msg.err; +} + +static err_t _udp_sendto_if_api(struct tcpip_api_call_data *api_call_msg){ + udp_api_call_t * msg = (udp_api_call_t *)api_call_msg; + msg->err = udp_sendto_if(msg->pcb, msg->pb, msg->addr, msg->port, msg->netif); + return msg->err; +} + +static err_t _udp_sendto_if(struct udp_pcb *pcb, struct pbuf *pb, const ip_addr_t *addr, u16_t port, struct netif *netif){ + udp_api_call_t msg; + msg.pcb = pcb; + msg.addr = addr; + msg.port = port; + msg.pb = pb; + msg.netif = netif; + tcpip_api_call(_udp_sendto_if_api, (struct tcpip_api_call_data*)&msg); + return msg.err; +} + +typedef struct { + void *arg; + udp_pcb *pcb; + pbuf *pb; + const ip_addr_t *addr; + uint16_t port; + struct netif * netif; +} lwip_event_packet_t; + +static QueueHandle_t _udp_queue; +static volatile TaskHandle_t _udp_task_handle = NULL; + +static void _udp_task(void *pvParameters){ + lwip_event_packet_t * e = NULL; + for (;;) { + if(xQueueReceive(_udp_queue, &e, portMAX_DELAY) == pdTRUE){ + if(!e->pb){ + free((void*)(e)); + continue; + } + AsyncUDP::_s_recv(e->arg, e->pcb, e->pb, e->addr, e->port, e->netif); + free((void*)(e)); + } + } + _udp_task_handle = NULL; + vTaskDelete(NULL); +} + +static bool _udp_task_start(){ + if(!_udp_queue){ + _udp_queue = xQueueCreate(32, sizeof(lwip_event_packet_t *)); + if(!_udp_queue){ + return false; + } + } + if(!_udp_task_handle){ + xTaskCreateUniversal(_udp_task, "async_udp", 4096, NULL, CONFIG_ARDUINO_UDP_TASK_PRIORITY, (TaskHandle_t*)&_udp_task_handle, CONFIG_ARDUINO_UDP_RUNNING_CORE); + if(!_udp_task_handle){ + return false; + } + } + return true; +} + +static bool _udp_task_post(void *arg, udp_pcb *pcb, pbuf *pb, const ip_addr_t *addr, uint16_t port, struct netif *netif) +{ + if(!_udp_task_handle || !_udp_queue){ + return false; + } + lwip_event_packet_t * e = (lwip_event_packet_t *)malloc(sizeof(lwip_event_packet_t)); + if(!e){ + return false; + } + e->arg = arg; + e->pcb = pcb; + e->pb = pb; + e->addr = addr; + e->port = port; + e->netif = netif; + if (xQueueSend(_udp_queue, &e, portMAX_DELAY) != pdPASS) { + free((void*)(e)); + return false; + } + return true; +} + +static void _udp_recv(void *arg, udp_pcb *pcb, pbuf *pb, const ip_addr_t *addr, uint16_t port) +{ + while(pb != NULL) { + pbuf * this_pb = pb; + pb = pb->next; + this_pb->next = NULL; + if(!_udp_task_post(arg, pcb, this_pb, addr, port, ip_current_input_netif())){ + pbuf_free(this_pb); + } + } +} +/* +static bool _udp_task_stop(){ + if(!_udp_task_post(NULL, NULL, NULL, NULL, 0, NULL)){ + return false; + } + while(_udp_task_handle){ + vTaskDelay(10); + } + + lwip_event_packet_t * e; + while (xQueueReceive(_udp_queue, &e, 0) == pdTRUE) { + if(e->pb){ + pbuf_free(e->pb); + } + free((void*)(e)); + } + vQueueDelete(_udp_queue); + _udp_queue = NULL; +} +*/ + + + +#define UDP_MUTEX_LOCK() //xSemaphoreTake(_lock, portMAX_DELAY) +#define UDP_MUTEX_UNLOCK() //xSemaphoreGive(_lock) + + +AsyncUDPMessage::AsyncUDPMessage(size_t size) +{ + _index = 0; + if(size > CONFIG_TCP_MSS) { + size = CONFIG_TCP_MSS; + } + _size = size; + _buffer = (uint8_t *)malloc(size); +} + +AsyncUDPMessage::~AsyncUDPMessage() +{ + if(_buffer) { + free(_buffer); + } +} + +size_t AsyncUDPMessage::write(const uint8_t *data, size_t len) +{ + if(_buffer == NULL) { + return 0; + } + size_t s = space(); + if(len > s) { + len = s; + } + memcpy(_buffer + _index, data, len); + _index += len; + return len; +} + +size_t AsyncUDPMessage::write(uint8_t data) +{ + return write(&data, 1); +} + +size_t AsyncUDPMessage::space() +{ + if(_buffer == NULL) { + return 0; + } + return _size - _index; +} + +uint8_t * AsyncUDPMessage::data() +{ + return _buffer; +} + +size_t AsyncUDPMessage::length() +{ + return _index; +} + +void AsyncUDPMessage::flush() +{ + _index = 0; +} + +AsyncUDPPacket::AsyncUDPPacket(AsyncUDPPacket &packet){ + _udp = packet._udp; + _pb = packet._pb; + _if = packet._if; + _data = packet._data; + _len = packet._len; + _index = 0; + + memcpy(&_remoteIp, &packet._remoteIp, sizeof(ip_addr_t)); + memcpy(&_localIp, &packet._localIp, sizeof(ip_addr_t)); + _localPort = packet._localPort; + _remotePort = packet._remotePort; + memcpy(_remoteMac, packet._remoteMac, 6); + + pbuf_ref(_pb); +} + +AsyncUDPPacket::AsyncUDPPacket(AsyncUDP *udp, pbuf *pb, const ip_addr_t *raddr, uint16_t rport, struct netif * ntif) +{ + _udp = udp; + _pb = pb; + _if = TCPIP_ADAPTER_IF_MAX; + _data = (uint8_t*)(pb->payload); + _len = pb->len; + _index = 0; + + pbuf_ref(_pb); + + //memcpy(&_remoteIp, raddr, sizeof(ip_addr_t)); + _remoteIp.type = raddr->type; + _localIp.type = _remoteIp.type; + + eth_hdr* eth = NULL; + udp_hdr* udphdr = (udp_hdr *)(_data - UDP_HLEN); + _localPort = ntohs(udphdr->dest); + _remotePort = ntohs(udphdr->src); + + if (_remoteIp.type == IPADDR_TYPE_V4) { + eth = (eth_hdr *)(_data - UDP_HLEN - IP_HLEN - SIZEOF_ETH_HDR); + struct ip_hdr * iphdr = (struct ip_hdr *)(_data - UDP_HLEN - IP_HLEN); + _localIp.u_addr.ip4.addr = iphdr->dest.addr; + _remoteIp.u_addr.ip4.addr = iphdr->src.addr; + } else { + eth = (eth_hdr *)(_data - UDP_HLEN - IP6_HLEN - SIZEOF_ETH_HDR); + struct ip6_hdr * ip6hdr = (struct ip6_hdr *)(_data - UDP_HLEN - IP6_HLEN); + memcpy(&_localIp.u_addr.ip6.addr, (uint8_t *)ip6hdr->dest.addr, 16); + memcpy(&_remoteIp.u_addr.ip6.addr, (uint8_t *)ip6hdr->src.addr, 16); + } + memcpy(_remoteMac, eth->src.addr, 6); + + struct netif * netif = NULL; + void * nif = NULL; + int i; + for (i=0; i a){ + len = a; + } + for(i=0;iwriteTo(data, len, &_remoteIp, _remotePort, _if); +} + +size_t AsyncUDPPacket::write(uint8_t data) +{ + return write(&data, 1); +} + +size_t AsyncUDPPacket::send(AsyncUDPMessage &message) +{ + return write(message.data(), message.length()); +} + +bool AsyncUDP::_init(){ + if(_pcb){ + return true; + } + _pcb = udp_new(); + if(!_pcb){ + return false; + } + //_lock = xSemaphoreCreateMutex(); + udp_recv(_pcb, &_udp_recv, (void *) this); + return true; +} + +AsyncUDP::AsyncUDP() +{ + _pcb = NULL; + _connected = false; + _lastErr = ERR_OK; + _handler = NULL; +} + +AsyncUDP::~AsyncUDP() +{ + close(); + UDP_MUTEX_LOCK(); + udp_recv(_pcb, NULL, NULL); + _udp_remove(_pcb); + _pcb = NULL; + UDP_MUTEX_UNLOCK(); + //vSemaphoreDelete(_lock); +} + +void AsyncUDP::close() +{ + UDP_MUTEX_LOCK(); + if(_pcb != NULL) { + if(_connected) { + _udp_disconnect(_pcb); + } + _connected = false; + //todo: unjoin multicast group + } + UDP_MUTEX_UNLOCK(); +} + +bool AsyncUDP::connect(const ip_addr_t *addr, uint16_t port) +{ + if(!_udp_task_start()){ + log_e("failed to start task"); + return false; + } + if(!_init()) { + return false; + } + close(); + UDP_MUTEX_LOCK(); + _lastErr = _udp_connect(_pcb, addr, port); + if(_lastErr != ERR_OK) { + UDP_MUTEX_UNLOCK(); + return false; + } + _connected = true; + UDP_MUTEX_UNLOCK(); + return true; +} + +bool AsyncUDP::listen(const ip_addr_t *addr, uint16_t port) +{ + if(!_udp_task_start()){ + log_e("failed to start task"); + return false; + } + if(!_init()) { + return false; + } + close(); + if(addr){ + IP_SET_TYPE_VAL(_pcb->local_ip, addr->type); + IP_SET_TYPE_VAL(_pcb->remote_ip, addr->type); + } + UDP_MUTEX_LOCK(); + if(_udp_bind(_pcb, addr, port) != ERR_OK) { + UDP_MUTEX_UNLOCK(); + return false; + } + _connected = true; + UDP_MUTEX_UNLOCK(); + return true; +} + +static esp_err_t joinMulticastGroup(const ip_addr_t *addr, bool join, tcpip_adapter_if_t tcpip_if=TCPIP_ADAPTER_IF_MAX) +{ + struct netif * netif = NULL; + if(tcpip_if < TCPIP_ADAPTER_IF_MAX){ + void * nif = NULL; + esp_err_t err = tcpip_adapter_get_netif(tcpip_if, &nif); + if (err) { + return ESP_ERR_INVALID_ARG; + } + netif = (struct netif *)nif; + + if (addr->type == IPADDR_TYPE_V4) { + if(join){ + if (igmp_joingroup_netif(netif, (const ip4_addr *)&(addr->u_addr.ip4))) { + return ESP_ERR_INVALID_STATE; + } + } else { + if (igmp_leavegroup_netif(netif, (const ip4_addr *)&(addr->u_addr.ip4))) { + return ESP_ERR_INVALID_STATE; + } + } + } else { + if(join){ + if (mld6_joingroup_netif(netif, &(addr->u_addr.ip6))) { + return ESP_ERR_INVALID_STATE; + } + } else { + if (mld6_leavegroup_netif(netif, &(addr->u_addr.ip6))) { + return ESP_ERR_INVALID_STATE; + } + } + } + } else { + if (addr->type == IPADDR_TYPE_V4) { + if(join){ + if (igmp_joingroup((const ip4_addr *)IP4_ADDR_ANY, (const ip4_addr *)&(addr->u_addr.ip4))) { + return ESP_ERR_INVALID_STATE; + } + } else { + if (igmp_leavegroup((const ip4_addr *)IP4_ADDR_ANY, (const ip4_addr *)&(addr->u_addr.ip4))) { + return ESP_ERR_INVALID_STATE; + } + } + } else { + if(join){ + if (mld6_joingroup((const ip6_addr *)IP6_ADDR_ANY, &(addr->u_addr.ip6))) { + return ESP_ERR_INVALID_STATE; + } + } else { + if (mld6_leavegroup((const ip6_addr *)IP6_ADDR_ANY, &(addr->u_addr.ip6))) { + return ESP_ERR_INVALID_STATE; + } + } + } + } + return ESP_OK; +} + +bool AsyncUDP::listenMulticast(const ip_addr_t *addr, uint16_t port, uint8_t ttl, tcpip_adapter_if_t tcpip_if) +{ + if(!ip_addr_ismulticast(addr)) { + return false; + } + + if (joinMulticastGroup(addr, true, tcpip_if)!= ERR_OK) { + return false; + } + + if(!listen(NULL, port)) { + return false; + } + + UDP_MUTEX_LOCK(); + _pcb->mcast_ttl = ttl; + _pcb->remote_port = port; + ip_addr_copy(_pcb->remote_ip, *addr); + //ip_addr_copy(_pcb->remote_ip, ip_addr_any_type); + UDP_MUTEX_UNLOCK(); + + return true; +} + +size_t AsyncUDP::writeTo(const uint8_t * data, size_t len, const ip_addr_t * addr, uint16_t port, tcpip_adapter_if_t tcpip_if) +{ + if(!_pcb) { + UDP_MUTEX_LOCK(); + _pcb = udp_new(); + UDP_MUTEX_UNLOCK(); + if(_pcb == NULL) { + return 0; + } + } + if(len > CONFIG_TCP_MSS) { + len = CONFIG_TCP_MSS; + } + _lastErr = ERR_OK; + pbuf* pbt = pbuf_alloc(PBUF_TRANSPORT, len, PBUF_RAM); + if(pbt != NULL) { + uint8_t* dst = reinterpret_cast(pbt->payload); + memcpy(dst, data, len); + UDP_MUTEX_LOCK(); + if(tcpip_if < TCPIP_ADAPTER_IF_MAX){ + void * nif = NULL; + tcpip_adapter_get_netif((tcpip_adapter_if_t)tcpip_if, &nif); + if(!nif){ + _lastErr = _udp_sendto(_pcb, pbt, addr, port); + } else { + _lastErr = _udp_sendto_if(_pcb, pbt, addr, port, (struct netif *)nif); + } + } else { + _lastErr = _udp_sendto(_pcb, pbt, addr, port); + } + UDP_MUTEX_UNLOCK(); + pbuf_free(pbt); + if(_lastErr < ERR_OK) { + return 0; + } + return len; + } + return 0; +} + +void AsyncUDP::_recv(udp_pcb *upcb, pbuf *pb, const ip_addr_t *addr, uint16_t port, struct netif * netif) +{ + while(pb != NULL) { + pbuf * this_pb = pb; + pb = pb->next; + this_pb->next = NULL; + if(_handler) { + AsyncUDPPacket packet(this, this_pb, addr, port, netif); + _handler(packet); + } + pbuf_free(this_pb); + } +} + +void AsyncUDP::_s_recv(void *arg, udp_pcb *upcb, pbuf *p, const ip_addr_t *addr, uint16_t port, struct netif * netif) +{ + reinterpret_cast(arg)->_recv(upcb, p, addr, port, netif); +} + +bool AsyncUDP::listen(uint16_t port) +{ + return listen(IP_ANY_TYPE, port); +} + +bool AsyncUDP::listen(const IPAddress addr, uint16_t port) +{ + ip_addr_t laddr; + addr.to_ip_addr_t(&laddr); + return listen(&laddr, port); +} + +bool AsyncUDP::listenMulticast(const IPAddress addr, uint16_t port, uint8_t ttl, tcpip_adapter_if_t tcpip_if) +{ + ip_addr_t laddr; + addr.to_ip_addr_t(&laddr); + return listenMulticast(&laddr, port, ttl, tcpip_if); +} + +bool AsyncUDP::connect(const IPAddress addr, uint16_t port) +{ + ip_addr_t daddr; + addr.to_ip_addr_t(&daddr); + return connect(&daddr, port); +} + +size_t AsyncUDP::writeTo(const uint8_t *data, size_t len, const IPAddress addr, uint16_t port, tcpip_adapter_if_t tcpip_if) +{ + ip_addr_t daddr; + addr.to_ip_addr_t(&daddr); + return writeTo(data, len, &daddr, port, tcpip_if); +} + +IPAddress AsyncUDP::listenIP() +{ + if(!_pcb || _pcb->remote_ip.type != IPADDR_TYPE_V4){ + return IPAddress(); + } + return IPAddress(_pcb->remote_ip.u_addr.ip4.addr); +} + +IPAddress AsyncUDP::listenIPv6() +{ + if(!_pcb || _pcb->remote_ip.type != IPADDR_TYPE_V6){ + return IPAddress(IPv6); + } + return IPAddress(IPv6, (const uint8_t *)_pcb->remote_ip.u_addr.ip6.addr, _pcb->remote_ip.u_addr.ip6.zone); +} + +size_t AsyncUDP::write(const uint8_t *data, size_t len) +{ + return writeTo(data, len, &(_pcb->remote_ip), _pcb->remote_port); +} + +size_t AsyncUDP::write(uint8_t data) +{ + return write(&data, 1); +} + +size_t AsyncUDP::broadcastTo(uint8_t *data, size_t len, uint16_t port, tcpip_adapter_if_t tcpip_if) +{ + return writeTo(data, len, IP_ADDR_BROADCAST, port, tcpip_if); +} + +size_t AsyncUDP::broadcastTo(const char * data, uint16_t port, tcpip_adapter_if_t tcpip_if) +{ + return broadcastTo((uint8_t *)data, strlen(data), port, tcpip_if); +} + +size_t AsyncUDP::broadcast(uint8_t *data, size_t len) +{ + if(_pcb->local_port != 0) { + return broadcastTo(data, len, _pcb->local_port); + } + return 0; +} + +size_t AsyncUDP::broadcast(const char * data) +{ + return broadcast((uint8_t *)data, strlen(data)); +} + + +size_t AsyncUDP::sendTo(AsyncUDPMessage &message, const ip_addr_t *addr, uint16_t port, tcpip_adapter_if_t tcpip_if) +{ + if(!message) { + return 0; + } + return writeTo(message.data(), message.length(), addr, port, tcpip_if); +} + +size_t AsyncUDP::sendTo(AsyncUDPMessage &message, const IPAddress addr, uint16_t port, tcpip_adapter_if_t tcpip_if) +{ + if(!message) { + return 0; + } + return writeTo(message.data(), message.length(), addr, port, tcpip_if); +} + +size_t AsyncUDP::send(AsyncUDPMessage &message) +{ + if(!message) { + return 0; + } + return writeTo(message.data(), message.length(), &(_pcb->remote_ip), _pcb->remote_port); +} + +size_t AsyncUDP::broadcastTo(AsyncUDPMessage &message, uint16_t port, tcpip_adapter_if_t tcpip_if) +{ + if(!message) { + return 0; + } + return broadcastTo(message.data(), message.length(), port, tcpip_if); +} + +size_t AsyncUDP::broadcast(AsyncUDPMessage &message) +{ + if(!message) { + return 0; + } + return broadcast(message.data(), message.length()); +} + +AsyncUDP::operator bool() +{ + return _connected; +} + +bool AsyncUDP::connected() +{ + return _connected; +} + +esp_err_t AsyncUDP::lastErr() { + return _lastErr; +} + +void AsyncUDP::onPacket(AuPacketHandlerFunctionWithArg cb, void * arg) +{ + onPacket(std::bind(cb, arg, std::placeholders::_1)); +} + +void AsyncUDP::onPacket(AuPacketHandlerFunction cb) +{ + _handler = cb; +} diff --git a/libs/AsyncUDP/src/AsyncUDP.h b/libs/AsyncUDP/src/AsyncUDP.h new file mode 100644 index 0000000..31d0751 --- /dev/null +++ b/libs/AsyncUDP/src/AsyncUDP.h @@ -0,0 +1,159 @@ +#ifndef ESPASYNCUDP_H +#define ESPASYNCUDP_H + +#include "IPAddress.h" +#include "Print.h" +#include "Stream.h" +#include +extern "C" { +#include "esp_netif.h" +#include "lwip/ip_addr.h" +#include "freertos/queue.h" +#include "freertos/semphr.h" +} + +// This enum and it's uses are copied and adapted for compatibility from ESP-IDF 4- +typedef enum { + TCPIP_ADAPTER_IF_STA = 0, /**< Wi-Fi STA (station) interface */ + TCPIP_ADAPTER_IF_AP, /**< Wi-Fi soft-AP interface */ + TCPIP_ADAPTER_IF_ETH, /**< Ethernet interface */ + TCPIP_ADAPTER_IF_PPP, /**< PPP interface */ + TCPIP_ADAPTER_IF_MAX +} tcpip_adapter_if_t; + +class AsyncUDP; +class AsyncUDPPacket; +class AsyncUDPMessage; +struct udp_pcb; +struct pbuf; +struct netif; + +typedef std::function AuPacketHandlerFunction; +typedef std::function AuPacketHandlerFunctionWithArg; + +class AsyncUDPMessage : public Print +{ +protected: + uint8_t *_buffer; + size_t _index; + size_t _size; +public: + AsyncUDPMessage(size_t size=CONFIG_TCP_MSS); + virtual ~AsyncUDPMessage(); + size_t write(const uint8_t *data, size_t len); + size_t write(uint8_t data); + size_t space(); + uint8_t * data(); + size_t length(); + void flush(); + operator bool() + { + return _buffer != NULL; + } +}; + +class AsyncUDPPacket : public Stream +{ +protected: + AsyncUDP *_udp; + pbuf *_pb; + tcpip_adapter_if_t _if; + ip_addr_t _localIp; + uint16_t _localPort; + ip_addr_t _remoteIp; + uint16_t _remotePort; + uint8_t _remoteMac[6]; + uint8_t *_data; + size_t _len; + size_t _index; +public: + AsyncUDPPacket(AsyncUDPPacket &packet); + AsyncUDPPacket(AsyncUDP *udp, pbuf *pb, const ip_addr_t *addr, uint16_t port, struct netif * netif); + virtual ~AsyncUDPPacket(); + + uint8_t * data(); + size_t length(); + bool isBroadcast(); + bool isMulticast(); + bool isIPv6(); + + tcpip_adapter_if_t interface(); + + IPAddress localIP(); + IPAddress localIPv6(); + uint16_t localPort(); + IPAddress remoteIP(); + IPAddress remoteIPv6(); + uint16_t remotePort(); + void remoteMac(uint8_t * mac); + + size_t send(AsyncUDPMessage &message); + + int available(); + size_t read(uint8_t *data, size_t len); + int read(); + int peek(); + void flush(); + + size_t write(const uint8_t *data, size_t len); + size_t write(uint8_t data); +}; + +class AsyncUDP : public Print +{ +protected: + udp_pcb *_pcb; + //SemaphoreHandle_t _lock; + bool _connected; + esp_err_t _lastErr; + AuPacketHandlerFunction _handler; + + bool _init(); + void _recv(udp_pcb *upcb, pbuf *pb, const ip_addr_t *addr, uint16_t port, struct netif * netif); + +public: + AsyncUDP(); + virtual ~AsyncUDP(); + + void onPacket(AuPacketHandlerFunctionWithArg cb, void * arg=NULL); + void onPacket(AuPacketHandlerFunction cb); + + bool listen(const ip_addr_t *addr, uint16_t port); + bool listen(const IPAddress addr, uint16_t port); + bool listen(uint16_t port); + + bool listenMulticast(const ip_addr_t *addr, uint16_t port, uint8_t ttl=1, tcpip_adapter_if_t tcpip_if=TCPIP_ADAPTER_IF_MAX); + bool listenMulticast(const IPAddress addr, uint16_t port, uint8_t ttl=1, tcpip_adapter_if_t tcpip_if=TCPIP_ADAPTER_IF_MAX); + + bool connect(const ip_addr_t *addr, uint16_t port); + bool connect(const IPAddress addr, uint16_t port); + + void close(); + + size_t writeTo(const uint8_t *data, size_t len, const ip_addr_t *addr, uint16_t port, tcpip_adapter_if_t tcpip_if=TCPIP_ADAPTER_IF_MAX); + size_t writeTo(const uint8_t *data, size_t len, const IPAddress addr, uint16_t port, tcpip_adapter_if_t tcpip_if=TCPIP_ADAPTER_IF_MAX); + size_t write(const uint8_t *data, size_t len); + size_t write(uint8_t data); + + size_t broadcastTo(uint8_t *data, size_t len, uint16_t port, tcpip_adapter_if_t tcpip_if=TCPIP_ADAPTER_IF_MAX); + size_t broadcastTo(const char * data, uint16_t port, tcpip_adapter_if_t tcpip_if=TCPIP_ADAPTER_IF_MAX); + size_t broadcast(uint8_t *data, size_t len); + size_t broadcast(const char * data); + + size_t sendTo(AsyncUDPMessage &message, const ip_addr_t *addr, uint16_t port, tcpip_adapter_if_t tcpip_if=TCPIP_ADAPTER_IF_MAX); + size_t sendTo(AsyncUDPMessage &message, const IPAddress addr, uint16_t port, tcpip_adapter_if_t tcpip_if=TCPIP_ADAPTER_IF_MAX); + size_t send(AsyncUDPMessage &message); + + size_t broadcastTo(AsyncUDPMessage &message, uint16_t port, tcpip_adapter_if_t tcpip_if=TCPIP_ADAPTER_IF_MAX); + size_t broadcast(AsyncUDPMessage &message); + + IPAddress listenIP(); + IPAddress listenIPv6(); + bool connected(); + esp_err_t lastErr(); + operator bool(); + + static void _s_recv(void *arg, udp_pcb *upcb, pbuf *p, const ip_addr_t *addr, uint16_t port, struct netif * netif); +}; + +#endif diff --git a/libs/ESP32Servo/AddDoxygenToGHPages.sh b/libs/ESP32Servo/AddDoxygenToGHPages.sh new file mode 100644 index 0000000..a62ae0b --- /dev/null +++ b/libs/ESP32Servo/AddDoxygenToGHPages.sh @@ -0,0 +1,32 @@ +#!/bin/bash + +GITURL=$(git config --get remote.origin.url) + +echo $GITURL + +rm -rf html +git clone $GITURL html +cd html +if ( git checkout origin/gh-pages -b gh-pages) then + echo "Checked out $GITURL gh-pages" +else + echo "Creating out $GITURL gh-pages" + git checkout origin/master -b gh-pages + rm -r * + echo "# A simple README file for the gh-pages branch" > README.md + git add README.md + git commit -m"Replaced gh-pages html with simple readme" + git push -u origin gh-pages +fi +cd .. + +doxygen doxy.doxyfile + +cd html +git add * +git add search/* +git commit -a -m"updating the doxygen" +git push +cd .. +rm -rf html +git checkout master \ No newline at end of file diff --git a/libs/ESP32Servo/README.md b/libs/ESP32Servo/README.md new file mode 100644 index 0000000..6a77d31 --- /dev/null +++ b/libs/ESP32Servo/README.md @@ -0,0 +1,90 @@ +# Servo Library for ESP32 + +This library attempts to faithfully replicate the semantics of the +Arduino Servo library (see http://www.arduino.cc/en/Reference/Servo) +for the ESP32, with two (optional) additions. The two new functions +expose the ability of the ESP32 PWM timers to vary timer width. +# Documentation by Doxygen + +[ESP32Servo Doxygen](https://madhephaestus.github.io/ESP32Servo/annotated.html) + +## License + +Copyright (c) 2017 John K. Bennett. All right reserved. + +This library is free software; you can redistribute it and/or +modify it under the terms of the GNU Lesser General Public +License as published by the Free Software Foundation; either +version 2.1 of the License, or (at your option) any later version. + +This library is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +Lesser General Public License for more details. + +You should have received a copy of the GNU Lesser General Public +License along with this library; if not, write to the Free Software +Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA + +## Library Description: +``` +   Servo - Class for manipulating servo motors connected to ESP32 pins. + + int attach(pin ) - Attaches the given GPIO pin to the next free channel + (channels that have previously been detached are used first), + returns channel number or 0 if failure. All pin numbers are allowed, + but only pins 2,4,12-19,21-23,25-27,32-33 are recommended. + + int attach(pin, min, max ) - Attaches to a pin setting min and max + values in microseconds; enforced minimum min is 500, enforced max + is 2500. Other semantics are the same as attach(). + + void write () - Sets the servo angle in degrees; a value below 500 is + treated as a value in degrees (0 to 180). These limit are enforced, + i.e., values are constrained as follows: + Value Becomes + ----- ------- + < 0 0 + 0 - 180 value (treated as degrees) + 181 - 499 180 + 500 - (min-1) min + min-max (from attach or default) value (treated as microseconds) + (max+1) - 2500 max + + void writeMicroseconds() - Sets the servo pulse width in microseconds. + min and max are enforced (see above). + + int read() - Gets the last written servo pulse width as an angle between 0 and 180. + + int readMicroseconds() - Gets the last written servo pulse width in microseconds. + + bool attached() - Returns true if this servo instance is attached to a pin. + + void detach() - Stops an the attached servo, frees the attached pin, and frees + its channel for reuse. +``` + +### **New ESP32-specific functions** + +``` +   setTimerWidth(value) - Sets the PWM timer width (must be 16-20) (ESP32 ONLY); + as a side effect, the pulse width is recomputed. + +   int readTimerWidth() - Gets the PWM timer width (ESP32 ONLY) +``` + +### Useful Defaults: + +default min pulse width for attach(): 544us + +default max pulse width for attach(): 2400us + +default timer width 16 (if timer width is not set) + +default pulse width 1500us (servos are initialized with this value) + +MINIMUM pulse with: 500us + +MAXIMUM pulse with: 2500us + +MAXIMUM number of servos: 16 (this is the number of PWM channels in the ESP32) diff --git a/libs/ESP32Servo/doxy.doxyfile b/libs/ESP32Servo/doxy.doxyfile new file mode 100644 index 0000000..cb6481e --- /dev/null +++ b/libs/ESP32Servo/doxy.doxyfile @@ -0,0 +1,2428 @@ +# Doxyfile 1.8.11 + +# This file describes the settings to be used by the documentation system +# doxygen (www.doxygen.org) for a project. +# +# All text after a double hash (##) is considered a comment and is placed in +# front of the TAG it is preceding. +# +# All text after a single hash (#) is considered a comment and will be ignored. +# The format is: +# TAG = value [value, ...] +# For lists, items can also be appended using: +# TAG += value [value, ...] +# Values that contain spaces should be placed between quotes (\" \"). + +#--------------------------------------------------------------------------- +# Project related configuration options +#--------------------------------------------------------------------------- + +# This tag specifies the encoding used for all characters in the config file +# that follow. The default is UTF-8 which is also the encoding used for all text +# before the first occurrence of this tag. Doxygen uses libiconv (or the iconv +# built into libc) for the transcoding. See http://www.gnu.org/software/libiconv +# for the list of possible encodings. +# The default value is: UTF-8. + +DOXYFILE_ENCODING = UTF-8 + +# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by +# double-quotes, unless you are using Doxywizard) that should identify the +# project for which the documentation is generated. This name is used in the +# title of most generated pages and in a few other places. +# The default value is: My Project. + +PROJECT_NAME = "ESP32Servo" + +# The PROJECT_NUMBER tag can be used to enter a project or revision number. This +# could be handy for archiving the generated documentation or if some version +# control system is used. + +PROJECT_NUMBER = + +# Using the PROJECT_BRIEF tag one can provide an optional one line description +# for a project that appears at the top of each page and should give viewer a +# quick idea about the purpose of the project. Keep the description short. + +PROJECT_BRIEF = + +# 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 = + +# 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 = . + +# 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 +# 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. +# The default value is: NO. + +CREATE_SUBDIRS = NO + +# If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII +# characters to appear in the names of generated files. If set to NO, non-ASCII +# characters will be escaped, for example _xE3_x81_x84 will be used for Unicode +# U+3044. +# The default value is: NO. + +ALLOW_UNICODE_NAMES = NO + +# The OUTPUT_LANGUAGE tag is used to specify the language in which all +# documentation generated by doxygen is written. Doxygen will use this +# information to generate all constant output in the proper language. +# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, 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. +# The default value is: English. + +OUTPUT_LANGUAGE = English + +# If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member +# descriptions after the members that are listed in the file and class +# documentation (similar to Javadoc). Set to NO to disable this. +# The default value is: YES. + +BRIEF_MEMBER_DESC = YES + +# If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief +# description of a member or function before the detailed description +# +# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the +# brief descriptions will be completely suppressed. +# The default value is: YES. + +REPEAT_BRIEF = YES + +# This tag implements a quasi-intelligent brief description abbreviator that is +# used to form the text in various listings. Each string in this list, if found +# as the leading text of the brief description, will be stripped from the text +# and the result, after processing the whole list, is used as the annotated +# text. Otherwise, the brief description is used as-is. If left blank, the +# following values are used ($name is automatically replaced with the name of +# the entity):The $name class, The $name widget, The $name file, is, provides, +# specifies, contains, represents, a, an and the. + +ABBREVIATE_BRIEF = + +# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then +# doxygen will generate a detailed section even if there is only a brief +# description. +# The default value is: NO. + +ALWAYS_DETAILED_SEC = NO + +# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all +# inherited members of a class in the documentation of that class as if those +# members were ordinary class members. Constructors, destructors and assignment +# operators of the base classes will not be shown. +# The default value is: NO. + +INLINE_INHERITED_MEMB = NO + +# If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path +# before files name in the file list and in the header files. If set to NO the +# shortest path that makes the file name unique will be used +# The default value is: YES. + +FULL_PATH_NAMES = YES + +# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path. +# Stripping is only done if one of the specified strings matches the left-hand +# part of the path. The tag can be used to show relative paths in the file list. +# If left blank the directory from which doxygen is run is used as the path to +# strip. +# +# Note that you can specify absolute paths here, but also relative paths, which +# will be relative from the directory where doxygen is started. +# This tag requires that the tag FULL_PATH_NAMES is set to YES. + +STRIP_FROM_PATH = + +# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the +# path mentioned in the documentation of a class, which tells the reader which +# header file to include in order to use a class. If left blank only the name of +# the header file containing the class definition is used. Otherwise one should +# specify the list of include paths that are normally passed to the compiler +# using the -I flag. + +STRIP_FROM_INC_PATH = + +# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but +# less readable) file names. This can be useful is your file systems doesn't +# support long names like on DOS, Mac, or CD-ROM. +# The default value is: NO. + +SHORT_NAMES = NO + +# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the +# first line (until the first dot) of a Javadoc-style comment as the brief +# description. If set to NO, the Javadoc-style will behave just like regular Qt- +# style comments (thus requiring an explicit @brief command for a brief +# description.) +# The default value is: NO. + +JAVADOC_AUTOBRIEF = NO + +# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first +# line (until the first dot) of a Qt-style comment as the brief description. If +# set to NO, the Qt-style will behave just like regular Qt-style comments (thus +# requiring an explicit \brief command for a brief description.) +# The default value is: NO. + +QT_AUTOBRIEF = NO + +# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a +# multi-line C++ special comment block (i.e. a block of //! or /// comments) as +# a brief description. This used to be the default behavior. The new default is +# to treat a multi-line C++ comment block as a detailed description. Set this +# tag to YES if you prefer the old behavior instead. +# +# Note that setting this tag to YES also means that rational rose comments are +# not recognized any more. +# The default value is: NO. + +MULTILINE_CPP_IS_BRIEF = NO + +# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the +# documentation from any documented member that it re-implements. +# The default value is: YES. + +INHERIT_DOCS = YES + +# If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new +# page for each member. If set to NO, the documentation of a member will be part +# of the file/class/namespace that contains it. +# The default value is: NO. + +SEPARATE_MEMBER_PAGES = NO + +# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen +# uses this value to replace tabs by spaces in code fragments. +# Minimum value: 1, maximum value: 16, default value: 4. + +TAB_SIZE = 4 + +# This tag can be used to specify a number of aliases that act as commands in +# the documentation. An alias has the form: +# name=value +# For example adding +# "sideeffect=@par Side Effects:\n" +# 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. + +ALIASES = + +# This tag can be used to specify a number of word-keyword mappings (TCL only). +# A mapping has the form "name=value". For example adding "class=itcl::class" +# will allow you to use the command class in the itcl::class meaning. + +TCL_SUBST = + +# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources +# only. Doxygen will then generate output that is more tailored for C. For +# instance, some of the names that are used will be different. The list of all +# members will be omitted, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_FOR_C = YES + +# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or +# Python sources only. Doxygen will then generate output that is more tailored +# for that language. For instance, namespaces will be presented as packages, +# qualified scopes will look different, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_JAVA = NO + +# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran +# sources. Doxygen will then generate output that is tailored for Fortran. +# The default value is: NO. + +OPTIMIZE_FOR_FORTRAN = NO + +# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL +# sources. Doxygen will then generate output that is tailored for VHDL. +# The default value is: NO. + +OPTIMIZE_OUTPUT_VHDL = NO + +# Doxygen selects the parser to use depending on the extension of the files it +# parses. With this tag you can assign which parser to use for a given +# extension. Doxygen has a built-in mapping, but you can override or extend it +# using this tag. The format is ext=language, where ext is a file extension, and +# language is one of the parsers supported by doxygen: IDL, Java, Javascript, +# C#, C, C++, D, PHP, Objective-C, Python, 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), VHDL. For +# instance to make doxygen treat .inc files as Fortran files (default is PHP), +# and .f files as C (default is Fortran), use: inc=Fortran f=C. +# +# Note: For files without extension you can use no_extension as a placeholder. +# +# Note that for custom extensions you also need to set FILE_PATTERNS otherwise +# the files are not read by doxygen. + +EXTENSION_MAPPING = ino=c + +# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments +# according to the Markdown format, which allows for more readable +# documentation. See http://daringfireball.net/projects/markdown/ for details. +# The output of markdown processing is further processed by doxygen, so you can +# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in +# case of backward compatibilities issues. +# The default value is: YES. + +MARKDOWN_SUPPORT = YES + +# When enabled doxygen tries to link words that correspond to documented +# classes, or namespaces to their corresponding documentation. Such a link can +# be prevented in individual cases by putting a % sign in front of the word or +# globally by setting AUTOLINK_SUPPORT to NO. +# The default value is: YES. + +AUTOLINK_SUPPORT = YES + +# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want +# to include (a tag file for) the STL sources as input, then you should set this +# tag to YES in order to let doxygen match functions declarations and +# definitions whose arguments contain STL classes (e.g. func(std::string); +# versus func(std::string) {}). This also make the inheritance and collaboration +# diagrams that involve STL classes more complete and accurate. +# The default value is: NO. + +BUILTIN_STL_SUPPORT = NO + +# If you use Microsoft's C++/CLI language, you should set this option to YES to +# enable parsing support. +# The default value is: NO. + +CPP_CLI_SUPPORT = NO + +# Set the SIP_SUPPORT tag to YES if your project consists of sip (see: +# http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen +# will parse them like normal C++ but will assume all classes use public instead +# of private inheritance when no explicit protection keyword is present. +# The default value is: NO. + +SIP_SUPPORT = NO + +# For Microsoft's IDL there are propget and propput attributes to indicate +# getter and setter methods for a property. Setting this option to YES will make +# doxygen to replace the get and set methods by a property in the documentation. +# This will only work if the methods are indeed getting or setting a simple +# type. If this is not the case, or you want to show the methods anyway, you +# should set this option to NO. +# The default value is: YES. + +IDL_PROPERTY_SUPPORT = YES + +# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC +# tag is set to YES then doxygen will reuse the documentation of the first +# member in the group (if any) for the other members of the group. By default +# all members of a group must be documented explicitly. +# The default value is: NO. + +DISTRIBUTE_GROUP_DOC = NO + +# If one adds a struct or class to a group and this option is enabled, then also +# any nested class or struct is added to the same group. By default this option +# is disabled and one has to add nested compounds explicitly via \ingroup. +# The default value is: NO. + +GROUP_NESTED_COMPOUNDS = NO + +# Set the SUBGROUPING tag to YES to allow class member groups of the same type +# (for instance a group of public functions) to be put as a subgroup of that +# type (e.g. under the Public Functions section). Set it to NO to prevent +# subgrouping. Alternatively, this can be done per class using the +# \nosubgrouping command. +# The default value is: YES. + +SUBGROUPING = YES + +# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions +# are shown inside the group in which they are included (e.g. using \ingroup) +# instead of on a separate page (for HTML and Man pages) or section (for LaTeX +# and RTF). +# +# Note that this feature does not work in combination with +# SEPARATE_MEMBER_PAGES. +# The default value is: NO. + +INLINE_GROUPED_CLASSES = NO + +# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions +# with only public data fields or simple typedef fields will be shown inline in +# the documentation of the scope in which they are defined (i.e. file, +# namespace, or group documentation), provided this scope is documented. If set +# to NO, structs, classes, and unions are shown on a separate page (for HTML and +# Man pages) or section (for LaTeX and RTF). +# The default value is: NO. + +INLINE_SIMPLE_STRUCTS = NO + +# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or +# enum is documented as struct, union, or enum with the name of the typedef. So +# typedef struct TypeS {} TypeT, will appear in the documentation as a struct +# with name TypeT. When disabled the typedef will appear as a member of a file, +# namespace, or class. And the struct will be named TypeS. This can typically be +# useful for C code in case the coding convention dictates that all compound +# types are typedef'ed and only the typedef is referenced, never the tag name. +# The default value is: NO. + +TYPEDEF_HIDES_STRUCT = NO + +# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This +# cache is used to resolve symbols given their name and scope. Since this can be +# an expensive process and often the same symbol appears multiple times in the +# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small +# doxygen will become slower. If the cache is too large, memory is wasted. The +# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range +# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536 +# symbols. At the end of a run doxygen will report the cache usage and suggest +# the optimal cache size from a speed point of view. +# Minimum value: 0, maximum value: 9, default value: 0. + +LOOKUP_CACHE_SIZE = 0 + +#--------------------------------------------------------------------------- +# Build related configuration options +#--------------------------------------------------------------------------- + +# If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in +# documentation are documented, even if no documentation was available. Private +# class members and static file members will be hidden unless the +# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. +# Note: This will also disable the warnings about undocumented members that are +# normally produced when WARNINGS is set to YES. +# The default value is: NO. + +EXTRACT_ALL = YES + +# If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will +# be included in the documentation. +# The default value is: NO. + +EXTRACT_PRIVATE = YES + +# If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal +# scope will be included in the documentation. +# The default value is: NO. + +EXTRACT_PACKAGE = NO + +# If the EXTRACT_STATIC tag is set to YES, all static members of a file will be +# included in the documentation. +# The default value is: NO. + +EXTRACT_STATIC = YES + +# If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined +# locally in source files will be included in the documentation. If set to NO, +# only classes defined in header files are included. Does not have any effect +# for Java sources. +# The default value is: YES. + +EXTRACT_LOCAL_CLASSES = YES + +# This flag is only useful for Objective-C code. If set to YES, local methods, +# which are defined in the implementation section but not in the interface are +# included in the documentation. If set to NO, only methods in the interface are +# included. +# The default value is: NO. + +EXTRACT_LOCAL_METHODS = NO + +# If this flag is set to YES, the members of anonymous namespaces will be +# extracted and appear in the documentation as a namespace called +# 'anonymous_namespace{file}', where file will be replaced with the base name of +# the file that contains the anonymous namespace. By default anonymous namespace +# are hidden. +# The default value is: NO. + +EXTRACT_ANON_NSPACES = NO + +# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all +# undocumented members inside documented classes or files. If set to NO these +# members will be included in the various overviews, but no documentation +# section is generated. This option has no effect if EXTRACT_ALL is enabled. +# The default value is: NO. + +HIDE_UNDOC_MEMBERS = NO + +# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all +# undocumented classes that are normally visible in the class hierarchy. If set +# to NO, these classes will be included in the various overviews. This option +# has no effect if EXTRACT_ALL is enabled. +# The default value is: NO. + +HIDE_UNDOC_CLASSES = NO + +# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend +# (class|struct|union) declarations. If set to NO, these declarations will be +# included in the documentation. +# The default value is: NO. + +HIDE_FRIEND_COMPOUNDS = NO + +# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any +# documentation blocks found inside the body of a function. If set to NO, these +# blocks will be appended to the function's detailed documentation block. +# The default value is: NO. + +HIDE_IN_BODY_DOCS = NO + +# The INTERNAL_DOCS tag determines if documentation that is typed after a +# \internal command is included. If the tag is set to NO then the documentation +# will be excluded. Set it to YES to include the internal documentation. +# The default value is: NO. + +INTERNAL_DOCS = NO + +# If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file +# names in lower-case letters. If set to YES, upper-case letters are also +# allowed. This is useful if you have classes or files whose names only differ +# in case and if your file system supports case sensitive file names. Windows +# and Mac users are advised to set this option to NO. +# The default value is: system dependent. + +CASE_SENSE_NAMES = YES + +# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with +# their full class and namespace scopes in the documentation. If set to YES, the +# scope will be hidden. +# The default value is: NO. + +HIDE_SCOPE_NAMES = NO + +# If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will +# append additional text to a page's title, such as Class Reference. If set to +# YES the compound reference will be hidden. +# The default value is: NO. + +HIDE_COMPOUND_REFERENCE= NO + +# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of +# the files that are included by a file in the documentation of that file. +# The default value is: YES. + +SHOW_INCLUDE_FILES = YES + +# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each +# grouped member an include statement to the documentation, telling the reader +# which file to include in order to use the member. +# The default value is: NO. + +SHOW_GROUPED_MEMB_INC = NO + +# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include +# files with double quotes in the documentation rather than with sharp brackets. +# The default value is: NO. + +FORCE_LOCAL_INCLUDES = NO + +# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the +# documentation for inline members. +# The default value is: YES. + +INLINE_INFO = YES + +# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the +# (detailed) documentation of file and class members alphabetically by member +# name. If set to NO, the members will appear in declaration order. +# The default value is: YES. + +SORT_MEMBER_DOCS = YES + +# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief +# descriptions of file, namespace and class members alphabetically by member +# name. If set to NO, the members will appear in declaration order. Note that +# this will also influence the order of the classes in the class list. +# The default value is: NO. + +SORT_BRIEF_DOCS = NO + +# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the +# (brief and detailed) documentation of class members so that constructors and +# destructors are listed first. If set to NO the constructors will appear in the +# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS. +# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief +# member documentation. +# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting +# detailed member documentation. +# The default value is: NO. + +SORT_MEMBERS_CTORS_1ST = NO + +# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy +# of group names into alphabetical order. If set to NO the group names will +# appear in their defined order. +# The default value is: NO. + +SORT_GROUP_NAMES = NO + +# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by +# fully-qualified names, including namespaces. If set to NO, the class list will +# be sorted only by class name, not including the namespace part. +# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. +# Note: This option applies only to the class list, not to the alphabetical +# list. +# The default value is: NO. + +SORT_BY_SCOPE_NAME = NO + +# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper +# type resolution of all parameters of a function it will reject a match between +# the prototype and the implementation of a member function even if there is +# only one candidate or it is obvious which candidate to choose by doing a +# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still +# accept a match between prototype and implementation in such cases. +# The default value is: NO. + +STRICT_PROTO_MATCHING = NO + +# The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo +# list. This list is created by putting \todo commands in the documentation. +# The default value is: YES. + +GENERATE_TODOLIST = YES + +# The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test +# list. This list is created by putting \test commands in the documentation. +# The default value is: YES. + +GENERATE_TESTLIST = YES + +# The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug +# list. This list is created by putting \bug commands in the documentation. +# The default value is: YES. + +GENERATE_BUGLIST = YES + +# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO) +# the deprecated list. This list is created by putting \deprecated commands in +# the documentation. +# The default value is: YES. + +GENERATE_DEPRECATEDLIST= YES + +# The ENABLED_SECTIONS tag can be used to enable conditional documentation +# sections, marked by \if ... \endif and \cond +# ... \endcond blocks. + +ENABLED_SECTIONS = + +# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the +# initial value of a variable or macro / define can have for it to appear in the +# documentation. If the initializer consists of more lines than specified here +# it will be hidden. Use a value of 0 to hide initializers completely. The +# appearance of the value of individual variables and macros / defines can be +# controlled using \showinitializer or \hideinitializer command in the +# documentation regardless of this setting. +# Minimum value: 0, maximum value: 10000, default value: 30. + +MAX_INITIALIZER_LINES = 30 + +# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at +# the bottom of the documentation of classes and structs. If set to YES, the +# list will mention the files that were used to generate the documentation. +# The default value is: YES. + +SHOW_USED_FILES = YES + +# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This +# will remove the Files entry from the Quick Index and from the Folder Tree View +# (if specified). +# The default value is: YES. + +SHOW_FILES = YES + +# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces +# page. This will remove the Namespaces entry from the Quick Index and from the +# Folder Tree View (if specified). +# The default value is: YES. + +SHOW_NAMESPACES = YES + +# The FILE_VERSION_FILTER tag can be used to specify a program or script that +# doxygen should invoke to get the current version for each file (typically from +# the version control system). Doxygen will invoke the program by executing (via +# popen()) the command command input-file, where command is the value of the +# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided +# by doxygen. Whatever the program writes to standard output is used as the file +# version. For an example see the documentation. + +FILE_VERSION_FILTER = + +# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed +# by doxygen. The layout file controls the global structure of the generated +# output files in an output format independent way. To create the layout file +# that represents doxygen's defaults, run doxygen with the -l option. You can +# optionally specify a file name after the option, if omitted DoxygenLayout.xml +# will be used as the name of the layout file. +# +# Note that if you run doxygen from a directory containing a file called +# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE +# tag is left empty. + +LAYOUT_FILE = + +# The CITE_BIB_FILES tag can be used to specify one or more bib files containing +# the reference definitions. This must be a list of .bib files. The .bib +# extension is automatically appended if omitted. This requires the bibtex tool +# to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info. +# For LaTeX the style of the bibliography can be controlled using +# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the +# search path. See also \cite for info how to create references. + +CITE_BIB_FILES = + +#--------------------------------------------------------------------------- +# Configuration options related to warning and progress messages +#--------------------------------------------------------------------------- + +# The QUIET tag can be used to turn on/off the messages that are generated to +# standard output by doxygen. If QUIET is set to YES this implies that the +# messages are off. +# The default value is: NO. + +QUIET = NO + +# The WARNINGS tag can be used to turn on/off the warning messages that are +# generated to standard error (stderr) by doxygen. If WARNINGS is set to YES +# this implies that the warnings are on. +# +# Tip: Turn warnings on while writing the documentation. +# The default value is: YES. + +WARNINGS = YES + +# If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate +# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag +# will automatically be disabled. +# The default value is: YES. + +WARN_IF_UNDOCUMENTED = YES + +# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for +# potential errors in the documentation, such as not documenting some parameters +# in a documented function, or documenting parameters that don't exist or using +# markup commands wrongly. +# The default value is: YES. + +WARN_IF_DOC_ERROR = 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. +# The default value is: NO. + +WARN_NO_PARAMDOC = NO + +# If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when +# a warning is encountered. +# The default value is: NO. + +WARN_AS_ERROR = NO + +# The WARN_FORMAT tag determines the format of the warning messages that doxygen +# can produce. The string should contain the $file, $line, and $text tags, which +# will be replaced by the file and line number from which the warning originated +# and the warning text. Optionally the format may contain $version, which will +# be replaced by the version of the file (if it could be obtained via +# FILE_VERSION_FILTER) +# The default value is: $file:$line: $text. + +WARN_FORMAT = "$file:$line: $text" + +# 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). + +WARN_LOGFILE = + +#--------------------------------------------------------------------------- +# Configuration options related to the input files +#--------------------------------------------------------------------------- + +# The INPUT tag is used to specify the files and/or directories that contain +# documented source files. You may enter file names like myfile.cpp or +# directories like /usr/src/myproject. Separate the files or directories with +# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING +# Note: If this tag is empty the current directory is searched. + +INPUT = + +# 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: http://www.gnu.org/software/libiconv) for the list of +# possible encodings. +# The default value is: UTF-8. + +INPUT_ENCODING = UTF-8 + +# If the value of the INPUT tag contains directories, you can use the +# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and +# *.h) to filter out the source-files in the directories. +# +# Note that for custom extensions or not directly supported extensions you also +# need to set EXTENSION_MAPPING for the extension otherwise the files are not +# read by doxygen. +# +# 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, *.py, *.pyw, *.f90, *.f, *.for, *.tcl, +# *.vhd, *.vhdl, *.ucf, *.qsf, *.as and *.js. + +FILE_PATTERNS = *.cpp *.h *.ino + +# The RECURSIVE tag can be used to specify whether or not subdirectories should +# be searched for input files as well. +# The default value is: NO. + +RECURSIVE = YES + +# The EXCLUDE tag can be used to specify files and/or directories that should be +# excluded from the INPUT source files. This way you can easily exclude a +# subdirectory from a directory tree whose root is specified with the INPUT tag. +# +# Note that relative paths are relative to the directory from which doxygen is +# run. + +EXCLUDE = + +# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or +# directories that are symbolic links (a Unix file system feature) are excluded +# from the input. +# The default value is: NO. + +EXCLUDE_SYMLINKS = NO + +# If the value of the INPUT tag contains directories, you can use the +# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude +# certain files from those directories. +# +# Note that the wildcards are matched against the file with absolute path, so to +# exclude all test directories for example use the pattern */test/* + +EXCLUDE_PATTERNS = */html/* */doc/* */Release/* *licence.txt* sloeber.ino.cpp *.sh* + + +# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names +# (namespaces, classes, functions, etc.) that should be excluded from the +# output. The symbol name can be a fully qualified name, a word, or if the +# wildcard * is used, a substring. Examples: ANamespace, AClass, +# 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/* + +EXCLUDE_SYMBOLS = + +# The EXAMPLE_PATH tag can be used to specify one or more files or directories +# that contain example code fragments that are included (see the \include +# command). + +EXAMPLE_PATH = + +# If the value of the EXAMPLE_PATH tag contains directories, you can use the +# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and +# *.h) to filter out the source-files in the directories. If left blank all +# files are included. + +EXAMPLE_PATTERNS = + +# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be +# searched for input files to be used with the \include or \dontinclude commands +# irrespective of the value of the RECURSIVE tag. +# The default value is: NO. + +EXAMPLE_RECURSIVE = NO + +# The IMAGE_PATH tag can be used to specify one or more files or directories +# that contain images that are to be included in the documentation (see the +# \image command). + +IMAGE_PATH = + +# The INPUT_FILTER tag can be used to specify a program that doxygen should +# invoke to filter for each input file. Doxygen will invoke the filter program +# by executing (via popen()) the command: +# +# +# +# where is the value of the INPUT_FILTER tag, and is the +# name of an input file. Doxygen will then use the output that the filter +# program writes to standard output. If FILTER_PATTERNS is specified, this tag +# will be ignored. +# +# Note that the filter must not add or remove lines; it is applied before the +# code is scanned, but not when the output code is generated. If lines are added +# or removed, the anchors will not be placed correctly. +# +# Note that for custom extensions or not directly supported extensions you also +# need to set EXTENSION_MAPPING for the extension otherwise the files are not +# properly processed by doxygen. + +INPUT_FILTER = + +# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern +# basis. Doxygen will compare the file name with each pattern and apply the +# filter if there is a match. The filters are a list of the form: pattern=filter +# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how +# filters are used. If the FILTER_PATTERNS tag is empty or if none of the +# patterns match the file name, INPUT_FILTER is applied. +# +# Note that for custom extensions or not directly supported extensions you also +# need to set EXTENSION_MAPPING for the extension otherwise the files are not +# properly processed by doxygen. + +FILTER_PATTERNS = *.cpp *.h *.ino + +# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using +# INPUT_FILTER) will also be used to filter the input files that are used for +# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES). +# The default value is: NO. + +FILTER_SOURCE_FILES = YES + +# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file +# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and +# it is also possible to disable source filtering for a specific pattern using +# *.ext= (so without naming a filter). +# This tag requires that the tag FILTER_SOURCE_FILES is set to YES. + +FILTER_SOURCE_PATTERNS = + +# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that +# is part of the input, its contents will be placed on the main page +# (index.html). This can be useful if you have a project on for instance GitHub +# and want to reuse the introduction page also for the doxygen output. + +USE_MDFILE_AS_MAINPAGE = + +#--------------------------------------------------------------------------- +# Configuration options related to source browsing +#--------------------------------------------------------------------------- + +# If the SOURCE_BROWSER tag is set to YES then a list of source files will be +# generated. Documented entities will be cross-referenced with these sources. +# +# Note: To get rid of all source code in the generated output, make sure that +# also VERBATIM_HEADERS is set to NO. +# The default value is: NO. + +SOURCE_BROWSER = YES + +# Setting the INLINE_SOURCES tag to YES will include the body of functions, +# classes and enums directly into the documentation. +# The default value is: NO. + +INLINE_SOURCES = NO + +# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any +# special comment blocks from generated source code fragments. Normal C, C++ and +# Fortran comments will always remain visible. +# The default value is: YES. + +STRIP_CODE_COMMENTS = YES + +# If the REFERENCED_BY_RELATION tag is set to YES then for each documented +# function all documented functions referencing it will be listed. +# The default value is: NO. + +REFERENCED_BY_RELATION = YES + +# If the REFERENCES_RELATION tag is set to YES then for each documented function +# all documented entities called/used by that function will be listed. +# The default value is: NO. + +REFERENCES_RELATION = YES + +# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set +# to YES then the hyperlinks from functions in REFERENCES_RELATION and +# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will +# link to the documentation. +# The default value is: YES. + +REFERENCES_LINK_SOURCE = YES + +# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the +# source code will show a tooltip with additional information such as prototype, +# brief description and links to the definition and documentation. Since this +# will make the HTML file larger and loading of large files a bit slower, you +# can opt to disable this feature. +# The default value is: YES. +# This tag requires that the tag SOURCE_BROWSER is set to YES. + +SOURCE_TOOLTIPS = YES + +# If the USE_HTAGS tag is set to YES then the references to source code will +# point to the HTML generated by the htags(1) tool instead of doxygen built-in +# source browser. The htags tool is part of GNU's global source tagging system +# (see http://www.gnu.org/software/global/global.html). You will need version +# 4.8.6 or higher. +# +# To use it do the following: +# - Install the latest version of global +# - Enable SOURCE_BROWSER and USE_HTAGS in the config file +# - Make sure the INPUT points to the root of the source tree +# - Run doxygen as normal +# +# Doxygen will invoke htags (and that will in turn invoke gtags), so these +# tools must be available from the command line (i.e. in the search path). +# +# The result: instead of the source browser generated by doxygen, the links to +# source code will now point to the output of htags. +# The default value is: NO. +# This tag requires that the tag SOURCE_BROWSER is set to YES. + +USE_HTAGS = NO + +# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a +# verbatim copy of the header file for each class for which an include is +# specified. Set to NO to disable this. +# See also: Section \class. +# The default value is: YES. + +VERBATIM_HEADERS = YES + +# 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 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 = + +#--------------------------------------------------------------------------- +# Configuration options related to the alphabetical class index +#--------------------------------------------------------------------------- + +# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all +# compounds will be generated. Enable this if the project contains a lot of +# classes, structs, unions or interfaces. +# The default value is: YES. + +ALPHABETICAL_INDEX = YES + +# The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in +# which the alphabetical index list will be split. +# Minimum value: 1, maximum value: 20, default value: 5. +# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. + +COLS_IN_ALPHA_INDEX = 5 + +# 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. +# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. + +IGNORE_PREFIX = + +#--------------------------------------------------------------------------- +# Configuration options related to the HTML output +#--------------------------------------------------------------------------- + +# If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output +# The default value is: YES. + +GENERATE_HTML = YES + +# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a +# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of +# it. +# The default directory is: html. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_OUTPUT = html + +# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each +# generated HTML page (for example: .htm, .php, .asp). +# The default value is: .html. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FILE_EXTENSION = .html + +# The HTML_HEADER tag can be used to specify a user-defined HTML header file for +# each generated HTML page. If the tag is left blank doxygen will generate a +# standard header. +# +# To get valid HTML the header file that includes any scripts and style sheets +# that doxygen needs, which is dependent on the configuration options used (e.g. +# the setting GENERATE_TREEVIEW). It is highly recommended to start with a +# default header using +# doxygen -w html new_header.html new_footer.html new_stylesheet.css +# YourConfigFile +# and then modify the file new_header.html. See also section "Doxygen usage" +# for information on how to generate the default header that doxygen normally +# uses. +# Note: The header is subject to change so you typically have to regenerate the +# default header when upgrading to a newer version of doxygen. For a description +# of the possible markers and block names see the documentation. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_HEADER = + +# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each +# generated HTML page. If the tag is left blank doxygen will generate a standard +# footer. See HTML_HEADER for more information on how to generate a default +# footer and what special commands can be used inside the footer. See also +# section "Doxygen usage" for information on how to generate the default footer +# that doxygen normally uses. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FOOTER = + +# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style +# sheet that is used by each HTML page. It can be used to fine-tune the look of +# the HTML output. If left blank doxygen will generate a default style sheet. +# See also section "Doxygen usage" for information on how to generate the style +# sheet that doxygen normally uses. +# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as +# it is more robust and this tag (HTML_STYLESHEET) will in the future become +# obsolete. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_STYLESHEET = + +# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined +# cascading style sheets that are included after the standard style sheets +# created by doxygen. Using this option one can overrule certain style aspects. +# This is preferred over using HTML_STYLESHEET since it does not replace the +# standard style sheet and is therefore more robust against future updates. +# Doxygen will copy the style sheet files to the output directory. +# Note: The order of the extra style sheet files is of importance (e.g. the last +# style sheet in the list overrules the setting of the previous ones in the +# list). For an example see the documentation. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_EXTRA_STYLESHEET = + +# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or +# other source files which should be copied to the HTML output directory. Note +# that these files will be copied to the base HTML output directory. Use the +# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these +# files. In the HTML_STYLESHEET file, use the file name only. Also note that the +# files will be copied as-is; there are no commands or markers available. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_EXTRA_FILES = + +# The HTML_COLORSTYLE_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 +# http://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 + +# 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 +# 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 + +# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the +# luminance component of the colors in the HTML output. Values below 100 +# gradually make the output lighter, whereas values above 100 make the output +# darker. The value divided by 100 is the actual gamma applied, so 80 represents +# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not +# change the gamma. +# Minimum value: 40, maximum value: 240, default value: 80. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_GAMMA = 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 + +# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML +# documentation will contain sections that can be hidden and shown after the +# page has loaded. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_DYNAMIC_SECTIONS = NO + +# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries +# shown in the various tree structured indices initially; the user can expand +# and collapse entries dynamically later on. Doxygen will expand the tree to +# such a level that at most the specified number of entries are visible (unless +# a fully collapsed tree already exceeds this amount). So setting the number of +# entries 1 will produce a full collapsed tree by default. 0 is a special value +# representing an infinite number of entries and will result in a full expanded +# tree by default. +# Minimum value: 0, maximum value: 9999, default value: 100. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_INDEX_NUM_ENTRIES = 100 + +# If the GENERATE_DOCSET tag is set to YES, additional index files will be +# generated that can be used as input for Apple's Xcode 3 integrated development +# environment (see: http://developer.apple.com/tools/xcode/), introduced with +# OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a +# Makefile in the HTML output directory. Running make will produce the docset in +# that directory and running make install will install the docset in +# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at +# startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html +# for more information. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_DOCSET = NO + +# This tag determines the name of the docset feed. A documentation feed provides +# an umbrella under which multiple documentation sets from a single provider +# (such as a company or product suite) can be grouped. +# The default value is: Doxygen generated docs. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_FEEDNAME = "Doxygen generated docs" + +# This tag specifies a string that should uniquely identify the documentation +# set bundle. This should be a reverse domain-name style string, e.g. +# com.mycompany.MyDocSet. Doxygen will append .docset to the name. +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_BUNDLE_ID = org.doxygen.Project + +# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify +# the documentation publisher. This should be a reverse domain-name style +# string, e.g. com.mycompany.MyDocSet.documentation. +# The default value is: org.doxygen.Publisher. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_PUBLISHER_ID = org.doxygen.Publisher + +# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. +# The default value is: Publisher. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_PUBLISHER_NAME = Publisher + +# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three +# additional HTML index files: index.hhp, index.hhc, and index.hhk. The +# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop +# (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on +# Windows. +# +# The HTML Help Workshop contains a compiler that can convert all HTML output +# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML +# files are now used as the Windows 98 help format, and will replace the old +# Windows help format (.hlp) on all Windows platforms in the future. Compressed +# HTML files also contain an index, a table of contents, and you can search for +# words in the documentation. The HTML workshop also contains a viewer for +# compressed HTML files. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_HTMLHELP = NO + +# The CHM_FILE tag can be used to specify the file name of the resulting .chm +# file. You can add a path in front of the file if the result should not be +# written to the html output directory. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +CHM_FILE = + +# The HHC_LOCATION tag can be used to specify the location (absolute path +# including file name) of the HTML help compiler (hhc.exe). If non-empty, +# doxygen will try to run the HTML help compiler on the generated index.hhp. +# The file has to be specified with full path. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +HHC_LOCATION = + +# The GENERATE_CHI flag controls if a separate .chi index file is generated +# (YES) or that it should be included in the master .chm file (NO). +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +GENERATE_CHI = NO + +# The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc) +# and project file content. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +CHM_INDEX_ENCODING = + +# The BINARY_TOC flag controls whether a binary table of contents is generated +# (YES) or a normal table of contents (NO) in the .chm file. Furthermore it +# enables the Previous and Next buttons. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +BINARY_TOC = NO + +# The TOC_EXPAND flag can be set to YES to add extra items for group members to +# the table of contents of the HTML help documentation and to the tree view. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +TOC_EXPAND = NO + +# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and +# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that +# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help +# (.qch) of the generated HTML documentation. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_QHP = NO + +# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify +# the file name of the resulting .qch file. The path specified is relative to +# the HTML output folder. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QCH_FILE = + +# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help +# Project output. For more information please see Qt Help Project / Namespace +# (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace). +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_NAMESPACE = org.doxygen.Project + +# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt +# Help Project output. For more information please see Qt Help Project / Virtual +# Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual- +# folders). +# The default value is: doc. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_VIRTUAL_FOLDER = doc + +# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom +# filter to add. For more information please see Qt Help Project / Custom +# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- +# filters). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_CUST_FILTER_NAME = + +# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the +# custom filter to add. For more information please see Qt Help Project / Custom +# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- +# filters). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_CUST_FILTER_ATTRS = + +# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this +# project's filter section matches. Qt Help Project / Filter Attributes (see: +# http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_SECT_FILTER_ATTRS = + +# The QHG_LOCATION tag can be used to specify the location of Qt's +# qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the +# generated .qhp file. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHG_LOCATION = + +# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be +# generated, together with the HTML files, they form an Eclipse help plugin. To +# install this plugin and make it available under the help contents menu in +# Eclipse, the contents of the directory containing the HTML and XML files needs +# to be copied into the plugins directory of eclipse. The name of the directory +# within the plugins directory should be the same as the ECLIPSE_DOC_ID value. +# After copying Eclipse needs to be restarted before the help appears. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_ECLIPSEHELP = NO + +# A unique identifier for the Eclipse help plugin. When installing the plugin +# the directory name containing the HTML and XML files should also have this +# name. Each documentation set should have its own identifier. +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES. + +ECLIPSE_DOC_ID = org.doxygen.Project + +# If you want full control over the layout of the generated HTML pages it might +# be necessary to disable the index and replace it with your own. The +# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top +# of each HTML page. A value of NO enables the index and the value YES disables +# it. Since the tabs in the index contain the same information as the navigation +# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +DISABLE_INDEX = NO + +# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index +# structure should be generated to display hierarchical information. If the tag +# value is set to YES, a side panel will be generated containing a tree-like +# index structure (just like the one that is generated for HTML Help). For this +# to work a browser that supports JavaScript, DHTML, CSS and frames is required +# (i.e. any modern browser). Windows users are probably better off using the +# HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can +# further fine-tune the look of the index. 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 = NO + +# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that +# doxygen will group on one line in the generated HTML documentation. +# +# Note that a value of 0 will completely suppress the enum values from appearing +# in the overview section. +# Minimum value: 0, maximum value: 20, default value: 4. +# This tag requires that the tag GENERATE_HTML is set to YES. + +ENUM_VALUES_PER_LINE = 4 + +# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used +# to set the initial width (in pixels) of the frame in which the tree is shown. +# Minimum value: 0, maximum value: 1500, default value: 250. +# This tag requires that the tag GENERATE_HTML is set to YES. + +TREEVIEW_WIDTH = 250 + +# If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to +# external symbols imported via tag files in a separate window. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +EXT_LINKS_IN_WINDOW = NO + +# Use this tag to change the font size of LaTeX formulas included as images in +# the HTML documentation. When you change the font size after a successful +# doxygen run you need to manually remove any form_*.png images from the HTML +# output directory to force them to be regenerated. +# Minimum value: 8, maximum value: 50, default value: 10. +# This tag requires that the tag GENERATE_HTML is set to YES. + +FORMULA_FONTSIZE = 10 + +# Use the FORMULA_TRANPARENT 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 + +# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see +# http://www.mathjax.org) which uses client side Javascript for the rendering +# instead of using pre-rendered bitmaps. Use this if you do not have LaTeX +# installed or if you want to formulas look prettier in the HTML output. When +# enabled you may also need to install MathJax separately and configure the path +# to it using the MATHJAX_RELPATH option. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +USE_MATHJAX = NO + +# 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/latest/output.html) for more details. +# Possible values are: HTML-CSS (which is slower, but has the best +# compatibility), NativeMML (i.e. MathML) and SVG. +# The default value is: HTML-CSS. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_FORMAT = HTML-CSS + +# When MathJax is enabled you need to specify the location relative to the HTML +# output directory using the MATHJAX_RELPATH option. The destination directory +# should contain the MathJax.js script. For instance, if the mathjax directory +# is located at the same level as the HTML output directory, then +# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax +# Content Delivery Network so you can quickly see the result without installing +# MathJax. However, it is strongly recommended to install a local copy of +# MathJax from http://www.mathjax.org before deployment. +# The default value is: http://cdn.mathjax.org/mathjax/latest. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest + +# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax +# extension names that should be enabled during MathJax rendering. For example +# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_EXTENSIONS = + +# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces +# of code that will be used on startup of the MathJax code. See the MathJax site +# (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an +# example see the documentation. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_CODEFILE = + +# When the SEARCHENGINE tag is enabled doxygen will generate a search box for +# the HTML output. The underlying search engine uses javascript and DHTML and +# should work on any modern browser. Note that when using HTML help +# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) +# there is already a search function so this one should typically be disabled. +# For large projects the javascript based search engine can be slow, then +# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to +# search using the keyboard; to jump to the search box use + S +# (what the is depends on the OS and browser, but it is typically +# , /