commit 040f0e83f33ec25339dcb80b4c7a4bb228555942 Author: XupaMisto Date: Wed Jan 28 21:32:28 2026 +0000 initial commit - ESP32 Bus Pirate (PlatformIO, multi-target) diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..b9f3806 --- /dev/null +++ b/.gitignore @@ -0,0 +1,2 @@ +.pio +.vscode diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..3e4c433 --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2025 + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..ca2fdc3 --- /dev/null +++ b/README.md @@ -0,0 +1,168 @@ +# ESP32 Bus Pirate + +![Logo banner of the ESP32 Bus Pirate firmware](images/logo_protocols_banner_small.png) + + +**ESP32 Bus Pirate** is an open-source firmware that turns your device into a multi-protocol hacker's tool, inspired by the [legendary Bus Pirate](https://buspirate.com/). + +It supports sniffing, sending, scripting, and interacting with various digital protocols (I2C, UART, 1-Wire, SPI, etc.) via a serial terminal or web-based CLI. It also communicates with radio protocols like Bluetooth, Wi-Fi, Sub-GHz and RFID. + +Use the [ESP32 Bus Pirate Web Flasher](https://geo-tp.github.io/ESP32-Bus-Pirate/webflasher/) to install the firmware in one click. See the [Wiki](https://github.com/geo-tp/ESP32-Bus-Pirate/wiki) for step-by-step guides on every mode and command. Check [ESP32 Bus Pirate Scripts](https://github.com/geo-tp/ESP32-Bus-Pirate-Scripts) for a collection of scripts. + +![Demo showing the different mode of the ESP32 Bus Pirate firmware](images/help.gif) +![Demo showing the LittleFS file system of the ESP32 Bus Pirate firmware](images/littlefs.gif) + +## Features + +- Interactive command-line interface (CLI) via **USB Serial or WiFi Web**. +- **Modes for:** + - [HiZ](https://github.com/geo-tp/ESP32-Bus-Pirate/wiki/01-HiZ) (default) + - [I2C](https://github.com/geo-tp/ESP32-Bus-Pirate/wiki/05-I2C) (scan, glitch, slave mode, dump, eeprom) + - [SPI](https://github.com/geo-tp/ESP32-Bus-Pirate/wiki/06-SPI) (eeprom, flash, sdcard, slave mode) + - [UART](https://github.com/geo-tp/ESP32-Bus-Pirate/wiki/03-UART) / [Half-Duplex UART](https://github.com/geo-tp/ESP32-Bus-Pirate/wiki/04-HDUART) (bridge, read, write) + - [1WIRE](https://github.com/geo-tp/ESP32-Bus-Pirate/wiki/02-1WIRE) (ibutton, eeprom) + - [2WIRE](https://github.com/geo-tp/ESP32-Bus-Pirate/wiki/07-2WIRE) (sniff, smartcard) / [3WIRE](https://github.com/geo-tp/ESP32-Bus-Pirate/wiki/08-3WIRE) (eeprom) + - [DIO](https://github.com/geo-tp/ESP32-Bus-Pirate/wiki/09-DIO) (Digital I/O, read, pullup, set, pwm) + - [Infrared](https://github.com/geo-tp/ESP32-Bus-Pirate/wiki/11-INFRARED) (device-b-gone, universal remote) + - [USB](https://github.com/geo-tp/ESP32-Bus-Pirate/wiki/12-USB) (HID, mouse, keyboard, gamepad, storage) + - [Bluetooth](https://github.com/geo-tp/ESP32-Bus-Pirate/wiki/13-BLUETOOTH) (BLE HID, scan, spoofing, sniffing) + - [Wi-Fi](https://github.com/geo-tp/ESP32-Bus-Pirate/wiki/14-WIFI) / [Ethernet](https://github.com/geo-tp/ESP32-Bus-Pirate/wiki/18-ETHERNET) (sniff, deauth, nmap, netcat) + - [JTAG](https://github.com/geo-tp/ESP32-Bus-Pirate/wiki/15-JTAG) (scan pinout, SWD) + - [LED](https://github.com/geo-tp/ESP32-Bus-Pirate/wiki/10-LED) (animations, set LEDs) + - [I2S](https://github.com/geo-tp/ESP32-Bus-Pirate/wiki/16-I2S) (test speakers, mic, play sound) + - [CAN](https://github.com/geo-tp/ESP32-Bus-Pirate/wiki/17-CAN) (sniff, send and receive frames) + - [SUBGHZ](https://github.com/geo-tp/ESP32-Bus-Pirate/wiki/19-SUBGHZ) (sniff, scan, replay) + - [RFID](https://github.com/geo-tp/ESP32-Bus-Pirate/wiki/20-RFID) (read, write, clone) + - [RF24](https://github.com/geo-tp/ESP32-Bus-Pirate/wiki/21-RF24) (scan, sniff) + + +- **Protocol sniffers** for I2C, SPI, 1Wire, 2wire, CAN, Wi-Fi, Bluetooth, SubGhz. +- Baudrate **auto-detection**, AT commands and various tools for UART. +- Registers manipulation, **EEPROM dump tools**, identify devices for I2C. +- Read all sort of **EEPROM, Flash** and various others tools for SPI. +- Scripting using **Bus Pirate-style bytecode** instructions or **Python**. +- Device-B-Gone command with more than **80 supported INFRARED protocols**. +- Direct I/O management, **PWM, servo**, pulse. +- Analyze radio signals and frequencies **on every bands**. +- Near than **50 addressable LEDs protocols** supported. +- **Ethernet and WiFi** are supported to access networks. +- Import and export data with the **LittleFS over HTTP.** + +## Supported Devices + + +| Device | | Description | +|-----------------------|------------------------------------------|---------------------------------------------------| +| **ESP32 S3 Dev Kit** | ![Photo of the ESP32 S3 Dev Kit](/images/s3-devkit_s.jpg) | More than 20 available GPIO, 1 button | +| **M5 Cardputer** | ![Photo of the M5 Cardputer](/images/cardputer_s.png) | 2 GPIO (Grove), screen, keyboard, mic, speaker, IR TX, SD card, battery, [standalone mode](#standalone-mode-for-the-cardputer) | +| **M5 Cardputer ADV** | ![Photo of the M5 Cardputer ADV](/images/cardputer-adv_s.jpg) | 12 GPIO (Grove, Header), screen, keyboard, mic, speaker, IR TX, SD card, IMU, battery, [standalone mode](#standalone-mode-for-the-cardputer) | +| **M5 Stick C Plus 2** | ![Photo of the M5 Stick C Plus 2](/images/m5stick_s.jpg) | 5 GPIO (Grove, Header), screen, mic, buzzer, IR TX, IMU, 3 buttons, battery | +| **M5 Stick S3** | ![Photo of the M5 Stick S3](/images/m5sticks3_s.jpg) | 13 GPIO (Grove, Header), screen, mic, speaker, IR TX, IR RX, IMU, 3 buttons, battery | +| **M5 StampS3** | ![Photo of the M5 StampS3](/images/stamps3_s.jpg) | 9 GPIO (exposed pins), 1 button | +| **M5 AtomS3 Lite** | ![Photo of the M5 Atom S3 Lite](/images/atom_s.jpg) | 8 GPIO (Grove, Header), IR TX, 1 buttton | +| **LILYGO T-Embed** | ![Photo of the LILYGO T-Embed](/images/tembed_s.jpg) | 9 GPIO (Grove, Header), screen, encoder, speaker, mic, SD card | +| **LILYGO T-Embed CC1101** | ![Photo of the LILYGO T-Embed CC1101](/images/tembedcc1101_s.jpg) | 4 GPIO (2x Qwiic), screen, encoder, speaker, mic, SD Card, CC1101, PN532, IR TX, IR RX , battery | +| **Seeed Studio Xiao S3** | ![Photo of the Seeed Studio Xiao ESP32-S3](/images/xiaos3_s.jpg) | 9 GPIO (exposed pins), 1 button + +- **Other ESP32-S3-based Boards** + + - All boards based on the **ESP32-S3 can be supported**, provided they have at least **8 MB of flash.** + + - You can **flash the s3 dev-kit firmware onto any ESP32-S3 board.** + + - Keep in mind that the **default pin mapping in the firmware may not match** your specific board. + +## Getting Started + +[![Banner of the ESP32 Bus Pirate web flasher](images/flasher.jpg)](https://geo-tp.github.io/ESP32-Bus-Pirate/webflasher/) + +1. 🔧 Flash the firmware + - Use the [ESP32 Bus Pirate Web Flasher](https://geo-tp.github.io/ESP32-Bus-Pirate/webflasher/) to burn the firmware directly from a web browser. + - You can also burn it on [M5Burner](https://docs.m5stack.com/en/download), in the M5stick, AtomS3, M5StampS3 or Cardputer category. + +2. 🔌 Connect via Serial or Web + - Serial: any terminal app (see [Connect via Serial](https://github.com/geo-tp/ESP32-Bus-Pirate/wiki/99-Serial)) + - Web: configure Wi-Fi and access the CLI via browser (see [Wi-Fi Connection](https://github.com/geo-tp/ESP32-Bus-Pirate/wiki/00-Terminal)) + +3. 🧪 Use commands like: + ```bash + mode + help + scan + sniff + ... + ``` + +## Wiki + +[![Banner of the ESP32 Bus Pirate Wiki page](images/bus_pirate_wiki.png)](https://github.com/geo-tp/ESP32-Bus-Pirate/wiki/) + +📚 Visit the **[Wiki](https://github.com/geo-tp/ESP32-Bus-Pirate/wiki)** for detailed documentation on every mode and command. + +Includes: +- [Terminal mode](https://github.com/geo-tp/ESP32-Bus-Pirate/wiki/00-Terminal) - About serial and web terminal. +- [Mode overviews](https://github.com/geo-tp/ESP32-Bus-Pirate/wiki) - Browse supported modes. +- [Instruction syntax](https://github.com/geo-tp/ESP32-Bus-Pirate/wiki/99-Instructions) - Master the instructions. +- [Serial setup](https://github.com/geo-tp/ESP32-Bus-Pirate/wiki/99-Serial) - Serial access via USB. + +The wiki is the best place to learn how everything works. + +## Scripting + +[![Banner of the ESP32 Bus Pirate Scripts page](images/bus_pirate_scripts.png)](https://github.com/geo-tp/ESP32-Bus-Pirate-Scripts/) + +🛠️ You can [automate interactions with the ESP32 Bus Pirate](https://github.com/geo-tp/ESP32-Bus-Pirate/wiki/99-Python) using **Python scripts over serial.** + +**Examples and ready-to-use scripts** are available in the repository: [ESP32 Bus Pirate Scripts](https://github.com/geo-tp/ESP32-Bus-Pirate-Scripts). + +**Including:** Logging data in a file, eeprom and flash dump, interracting with GPIOs, LED animation... + +## ESP32 Bus Pirate on M5 Devices +![A photo of the ESP32 Bus Pirate firmware running on M5 Stack devices](images/m5buspirate_s.jpg) + +## ESP32 Bus Pirate on T-Embed +![A photo of the ESP32 Bus Pirate firmware running on Lilygo device](images/tembedbuspirate_s.jpg) + +## Command-Line Interfaces + +The ESP32 Bus Pirate firmware provides three command-line interface (CLI) modes: + +| Interface | Advantages | Ideal for... | +|------------------|-----------------------------------------------------------------------------|----------------------------------------| +| **Web Interface** | - Accessible from any browser
- PC, tablets, mobiles
- Works over Wi-Fi
- No cables needed | Quick tests, demos, headless setups | +| **Serial Interface** | - Faster performance
- Instant responsiveness
- Handles large data smoothly | Intensive sessions, frequent interactions | +| **Standalone** | - Only for the Cardputer
- On device keyboard
- On device screen | Portable sessions, Quick tests | + + +All interfaces share the same command structure and can be used interchangeably ([more details](https://github.com/geo-tp/ESP32-Bus-Pirate/wiki/00-Terminal)). + +## Mobile Web Interface over WiFi +![An iPhone screenshot showing the Bus Pirate firmware web interface](images/presentation_mobile.png) + +## Standalone Mode for the Cardputer +![A Cardputer running the ESP32 Bus pirate in standalone mode](images/standalonemode_s.png) + +## Using the ESP32 Bus Pirate to speak UART over WiFi +![A demo Using the ESP32 Bus pirate firmware with UART](images/demo2.gif) + +## Contribute +See [How To Contribute](https://github.com/geo-tp/ESP32-Bus-Pirate/wiki/99-Contribute) section, which outlines a **simple way to add a new command** to any mode. + +## Visuals Assets + +#### [![Small logo of the ESP32 Bus Pirate firmware](images/logo_square_small.png)](https://github.com/geo-tp/ESP32-Bus-Pirate/wiki/99-Visual-Assets) + +See [images, logo, presentations, photo, video, illustrations](https://github.com/geo-tp/ESP32-Bus-Pirate/wiki/99-Visual-Assets). These visuals can be **freely used in blog posts, documentation, videos, or articles** to help explain and promote the firmware. + + +## Warning +> ⚠️ **Voltage Warning**: Devices should only operate at **3.3V** or **5V**. +> - Do **not** connect peripherals using other voltage levels — doing so may **damage your ESP32**. + +> ⚠️ **Usage Warning**: This firmware is provided for **educational, diagnostic, and interoperability testing purposes only**. +> - Do not use it to interfere with, probe, or manipulate devices without proper authorization. +> - Avoid any unauthorized RF transmissions (e.g., sub-GHz) that could violate local regulations or disrupt networks and communications. +> - The authors are not responsible for any misuse of this software or hardware, including legal consequences resulting from unauthorized access or signal emission. +> - Always stay within the bounds of your country’s laws and responsible disclosure policies. + + diff --git a/images/2wiresmartcard.gif b/images/2wiresmartcard.gif new file mode 100644 index 0000000..7716396 Binary files /dev/null and b/images/2wiresmartcard.gif differ diff --git a/images/assets/capture_mobile1.png b/images/assets/capture_mobile1.png new file mode 100644 index 0000000..3a55b3c Binary files /dev/null and b/images/assets/capture_mobile1.png differ diff --git a/images/assets/capture_serial_cli.png b/images/assets/capture_serial_cli.png new file mode 100644 index 0000000..013224d Binary files /dev/null and b/images/assets/capture_serial_cli.png differ diff --git a/images/assets/capture_web_cli.png b/images/assets/capture_web_cli.png new file mode 100644 index 0000000..e5d1068 Binary files /dev/null and b/images/assets/capture_web_cli.png differ diff --git a/images/assets/capute_mobile2.png b/images/assets/capute_mobile2.png new file mode 100644 index 0000000..a8747e3 Binary files /dev/null and b/images/assets/capute_mobile2.png differ diff --git a/images/assets/caputre_mobile3.png b/images/assets/caputre_mobile3.png new file mode 100644 index 0000000..5c45e7d Binary files /dev/null and b/images/assets/caputre_mobile3.png differ diff --git a/images/assets/illustration1.png b/images/assets/illustration1.png new file mode 100644 index 0000000..b28cfc7 Binary files /dev/null and b/images/assets/illustration1.png differ diff --git a/images/assets/illustration10.png b/images/assets/illustration10.png new file mode 100644 index 0000000..d87b2f1 Binary files /dev/null and b/images/assets/illustration10.png differ diff --git a/images/assets/illustration4.png b/images/assets/illustration4.png new file mode 100644 index 0000000..721567f Binary files /dev/null and b/images/assets/illustration4.png differ diff --git a/images/assets/illustration8.png b/images/assets/illustration8.png new file mode 100644 index 0000000..5cce20d Binary files /dev/null and b/images/assets/illustration8.png differ diff --git a/images/assets/illustration9.png b/images/assets/illustration9.png new file mode 100644 index 0000000..8691968 Binary files /dev/null and b/images/assets/illustration9.png differ diff --git a/images/assets/illustrations2.png b/images/assets/illustrations2.png new file mode 100644 index 0000000..a823cc4 Binary files /dev/null and b/images/assets/illustrations2.png differ diff --git a/images/assets/illustrations3.png b/images/assets/illustrations3.png new file mode 100644 index 0000000..19088e7 Binary files /dev/null and b/images/assets/illustrations3.png differ diff --git a/images/assets/illustrations5.png b/images/assets/illustrations5.png new file mode 100644 index 0000000..4c795cb Binary files /dev/null and b/images/assets/illustrations5.png differ diff --git a/images/assets/illustrations6.png b/images/assets/illustrations6.png new file mode 100644 index 0000000..ffedd66 Binary files /dev/null and b/images/assets/illustrations6.png differ diff --git a/images/assets/illustrations7.png b/images/assets/illustrations7.png new file mode 100644 index 0000000..931fc1d Binary files /dev/null and b/images/assets/illustrations7.png differ diff --git a/images/assets/logo_b.png b/images/assets/logo_b.png new file mode 100644 index 0000000..6cccd4d Binary files /dev/null and b/images/assets/logo_b.png differ diff --git a/images/assets/logo_banner.png b/images/assets/logo_banner.png new file mode 100644 index 0000000..11d2cf5 Binary files /dev/null and b/images/assets/logo_banner.png differ diff --git a/images/assets/logo_banner_transparent.png b/images/assets/logo_banner_transparent.png new file mode 100644 index 0000000..68e2ec9 Binary files /dev/null and b/images/assets/logo_banner_transparent.png differ diff --git a/images/assets/logo_banner_transparent_gs.png b/images/assets/logo_banner_transparent_gs.png new file mode 100644 index 0000000..ec4adc9 Binary files /dev/null and b/images/assets/logo_banner_transparent_gs.png differ diff --git a/images/assets/logo_bp.png b/images/assets/logo_bp.png new file mode 100644 index 0000000..8f6bbda Binary files /dev/null and b/images/assets/logo_bp.png differ diff --git a/images/assets/logo_protocols_banner.png b/images/assets/logo_protocols_banner.png new file mode 100644 index 0000000..476df75 Binary files /dev/null and b/images/assets/logo_protocols_banner.png differ diff --git a/images/assets/logo_protocols_square.png b/images/assets/logo_protocols_square.png new file mode 100644 index 0000000..4d3a37a Binary files /dev/null and b/images/assets/logo_protocols_square.png differ diff --git a/images/assets/logo_speaks_all_protocols.png b/images/assets/logo_speaks_all_protocols.png new file mode 100644 index 0000000..b432b17 Binary files /dev/null and b/images/assets/logo_speaks_all_protocols.png differ diff --git a/images/assets/logo_speaks_all_protocols_banner.png b/images/assets/logo_speaks_all_protocols_banner.png new file mode 100644 index 0000000..c7fd5ec Binary files /dev/null and b/images/assets/logo_speaks_all_protocols_banner.png differ diff --git a/images/assets/logo_speaks_all_protocols_gs.png b/images/assets/logo_speaks_all_protocols_gs.png new file mode 100644 index 0000000..80d5e98 Binary files /dev/null and b/images/assets/logo_speaks_all_protocols_gs.png differ diff --git a/images/assets/logo_speaks_all_protocols_square.png b/images/assets/logo_speaks_all_protocols_square.png new file mode 100644 index 0000000..0417a6f Binary files /dev/null and b/images/assets/logo_speaks_all_protocols_square.png differ diff --git a/images/assets/logo_square.png b/images/assets/logo_square.png new file mode 100644 index 0000000..718f2ad Binary files /dev/null and b/images/assets/logo_square.png differ diff --git a/images/assets/logo_square_transparent.png b/images/assets/logo_square_transparent.png new file mode 100644 index 0000000..c5b1e35 Binary files /dev/null and b/images/assets/logo_square_transparent.png differ diff --git a/images/assets/logo_square_transparent_gs.png b/images/assets/logo_square_transparent_gs.png new file mode 100644 index 0000000..a447f26 Binary files /dev/null and b/images/assets/logo_square_transparent_gs.png differ diff --git a/images/assets/photo1.JPG b/images/assets/photo1.JPG new file mode 100644 index 0000000..e375c1a Binary files /dev/null and b/images/assets/photo1.JPG differ diff --git a/images/assets/photo2.jpg b/images/assets/photo2.jpg new file mode 100644 index 0000000..0e78ac7 Binary files /dev/null and b/images/assets/photo2.jpg differ diff --git a/images/assets/photo3.jpg b/images/assets/photo3.jpg new file mode 100644 index 0000000..f5f8c82 Binary files /dev/null and b/images/assets/photo3.jpg differ diff --git a/images/assets/photo4.JPG b/images/assets/photo4.JPG new file mode 100644 index 0000000..b2d1c88 Binary files /dev/null and b/images/assets/photo4.JPG differ diff --git a/images/assets/photo5.JPG b/images/assets/photo5.JPG new file mode 100644 index 0000000..c41a9f6 Binary files /dev/null and b/images/assets/photo5.JPG differ diff --git a/images/assets/photo6.jpg b/images/assets/photo6.jpg new file mode 100644 index 0000000..22cb132 Binary files /dev/null and b/images/assets/photo6.jpg differ diff --git a/images/assets/presentation_all_transparent.png b/images/assets/presentation_all_transparent.png new file mode 100644 index 0000000..306ed2d Binary files /dev/null and b/images/assets/presentation_all_transparent.png differ diff --git a/images/assets/presentation_cli.png b/images/assets/presentation_cli.png new file mode 100644 index 0000000..11a602b Binary files /dev/null and b/images/assets/presentation_cli.png differ diff --git a/images/assets/presentation_features.png b/images/assets/presentation_features.png new file mode 100644 index 0000000..c54d4aa Binary files /dev/null and b/images/assets/presentation_features.png differ diff --git a/images/assets/presentation_flasher_scripts_transparent.png b/images/assets/presentation_flasher_scripts_transparent.png new file mode 100644 index 0000000..b7eb913 Binary files /dev/null and b/images/assets/presentation_flasher_scripts_transparent.png differ diff --git a/images/assets/presentation_mobile.png b/images/assets/presentation_mobile.png new file mode 100644 index 0000000..bbc9308 Binary files /dev/null and b/images/assets/presentation_mobile.png differ diff --git a/images/assets/presentation_mobile2.png b/images/assets/presentation_mobile2.png new file mode 100644 index 0000000..e349352 Binary files /dev/null and b/images/assets/presentation_mobile2.png differ diff --git a/images/assets/presentation_mobile_transparent.png b/images/assets/presentation_mobile_transparent.png new file mode 100644 index 0000000..2ee8b14 Binary files /dev/null and b/images/assets/presentation_mobile_transparent.png differ diff --git a/images/assets/presentation_serial_wifi_cli.png b/images/assets/presentation_serial_wifi_cli.png new file mode 100644 index 0000000..af77758 Binary files /dev/null and b/images/assets/presentation_serial_wifi_cli.png differ diff --git a/images/assets/presentation_serial_wifi_cli_transparent.png b/images/assets/presentation_serial_wifi_cli_transparent.png new file mode 100644 index 0000000..56327ae Binary files /dev/null and b/images/assets/presentation_serial_wifi_cli_transparent.png differ diff --git a/images/atom.jpg b/images/atom.jpg new file mode 100644 index 0000000..6a38e37 Binary files /dev/null and b/images/atom.jpg differ diff --git a/images/atom_s.jpg b/images/atom_s.jpg new file mode 100644 index 0000000..a451ce4 Binary files /dev/null and b/images/atom_s.jpg differ diff --git a/images/bt.gif b/images/bt.gif new file mode 100644 index 0000000..eafc279 Binary files /dev/null and b/images/bt.gif differ diff --git a/images/bus_pirate_firmware.png b/images/bus_pirate_firmware.png new file mode 100644 index 0000000..2b24216 Binary files /dev/null and b/images/bus_pirate_firmware.png differ diff --git a/images/bus_pirate_m5burner.jpg b/images/bus_pirate_m5burner.jpg new file mode 100644 index 0000000..63eaecf Binary files /dev/null and b/images/bus_pirate_m5burner.jpg differ diff --git a/images/bus_pirate_mobile.png b/images/bus_pirate_mobile.png new file mode 100644 index 0000000..5c45e7d Binary files /dev/null and b/images/bus_pirate_mobile.png differ diff --git a/images/bus_pirate_scripts.png b/images/bus_pirate_scripts.png new file mode 100644 index 0000000..f66ad2f Binary files /dev/null and b/images/bus_pirate_scripts.png differ diff --git a/images/bus_pirate_wiki.png b/images/bus_pirate_wiki.png new file mode 100644 index 0000000..7badfde Binary files /dev/null and b/images/bus_pirate_wiki.png differ diff --git a/images/cardputer-adv.jpg b/images/cardputer-adv.jpg new file mode 100644 index 0000000..063544d Binary files /dev/null and b/images/cardputer-adv.jpg differ diff --git a/images/cardputer-adv_s.jpg b/images/cardputer-adv_s.jpg new file mode 100644 index 0000000..ce4cae3 Binary files /dev/null and b/images/cardputer-adv_s.jpg differ diff --git a/images/cardputer.jpg b/images/cardputer.jpg new file mode 100644 index 0000000..21b5538 Binary files /dev/null and b/images/cardputer.jpg differ diff --git a/images/cardputer_s.png b/images/cardputer_s.png new file mode 100644 index 0000000..0dcce42 Binary files /dev/null and b/images/cardputer_s.png differ diff --git a/images/demo.gif b/images/demo.gif new file mode 100644 index 0000000..930955d Binary files /dev/null and b/images/demo.gif differ diff --git a/images/demo10.gif b/images/demo10.gif new file mode 100644 index 0000000..bf183ee Binary files /dev/null and b/images/demo10.gif differ diff --git a/images/demo11.gif b/images/demo11.gif new file mode 100644 index 0000000..74e21aa Binary files /dev/null and b/images/demo11.gif differ diff --git a/images/demo12.gif b/images/demo12.gif new file mode 100644 index 0000000..298129a Binary files /dev/null and b/images/demo12.gif differ diff --git a/images/demo13.gif b/images/demo13.gif new file mode 100644 index 0000000..ff95c98 Binary files /dev/null and b/images/demo13.gif differ diff --git a/images/demo14.gif b/images/demo14.gif new file mode 100644 index 0000000..89ca598 Binary files /dev/null and b/images/demo14.gif differ diff --git a/images/demo15.gif b/images/demo15.gif new file mode 100644 index 0000000..e124376 Binary files /dev/null and b/images/demo15.gif differ diff --git a/images/demo16.gif b/images/demo16.gif new file mode 100644 index 0000000..60fd401 Binary files /dev/null and b/images/demo16.gif differ diff --git a/images/demo2.gif b/images/demo2.gif new file mode 100644 index 0000000..b3924e1 Binary files /dev/null and b/images/demo2.gif differ diff --git a/images/demo3.gif b/images/demo3.gif new file mode 100644 index 0000000..59cc7bb Binary files /dev/null and b/images/demo3.gif differ diff --git a/images/demo4.gif b/images/demo4.gif new file mode 100644 index 0000000..16e5824 Binary files /dev/null and b/images/demo4.gif differ diff --git a/images/demo5.gif b/images/demo5.gif new file mode 100644 index 0000000..de2f1b3 Binary files /dev/null and b/images/demo5.gif differ diff --git a/images/demo6.gif b/images/demo6.gif new file mode 100644 index 0000000..a7c2978 Binary files /dev/null and b/images/demo6.gif differ diff --git a/images/demo7.gif b/images/demo7.gif new file mode 100644 index 0000000..8986df7 Binary files /dev/null and b/images/demo7.gif differ diff --git a/images/demo8.gif b/images/demo8.gif new file mode 100644 index 0000000..6fbb53f Binary files /dev/null and b/images/demo8.gif differ diff --git a/images/demo9.gif b/images/demo9.gif new file mode 100644 index 0000000..ead3c66 Binary files /dev/null and b/images/demo9.gif differ diff --git a/images/dio.gif b/images/dio.gif new file mode 100644 index 0000000..796b4da Binary files /dev/null and b/images/dio.gif differ diff --git a/images/flasher.jpg b/images/flasher.jpg new file mode 100644 index 0000000..a686375 Binary files /dev/null and b/images/flasher.jpg differ diff --git a/images/help.gif b/images/help.gif new file mode 100644 index 0000000..4a4c1c9 Binary files /dev/null and b/images/help.gif differ diff --git a/images/i2c.gif b/images/i2c.gif new file mode 100644 index 0000000..7b9c50f Binary files /dev/null and b/images/i2c.gif differ diff --git a/images/infrared.gif b/images/infrared.gif new file mode 100644 index 0000000..3fdf1fb Binary files /dev/null and b/images/infrared.gif differ diff --git a/images/littlefs.gif b/images/littlefs.gif new file mode 100644 index 0000000..9a0ed09 Binary files /dev/null and b/images/littlefs.gif differ diff --git a/images/logo_protocols_banner_small.png b/images/logo_protocols_banner_small.png new file mode 100644 index 0000000..625c1ed Binary files /dev/null and b/images/logo_protocols_banner_small.png differ diff --git a/images/logo_square_small.png b/images/logo_square_small.png new file mode 100644 index 0000000..fcbacff Binary files /dev/null and b/images/logo_square_small.png differ diff --git a/images/m5buspirate.jpg b/images/m5buspirate.jpg new file mode 100644 index 0000000..121f1a4 Binary files /dev/null and b/images/m5buspirate.jpg differ diff --git a/images/m5buspirate_s.jpg b/images/m5buspirate_s.jpg new file mode 100644 index 0000000..5213866 Binary files /dev/null and b/images/m5buspirate_s.jpg differ diff --git a/images/m5stick.jpg b/images/m5stick.jpg new file mode 100644 index 0000000..54cdab1 Binary files /dev/null and b/images/m5stick.jpg differ diff --git a/images/m5stick_s.jpg b/images/m5stick_s.jpg new file mode 100644 index 0000000..6556647 Binary files /dev/null and b/images/m5stick_s.jpg differ diff --git a/images/m5sticks3.jpg b/images/m5sticks3.jpg new file mode 100644 index 0000000..40b190e Binary files /dev/null and b/images/m5sticks3.jpg differ diff --git a/images/m5sticks3_s.jpg b/images/m5sticks3_s.jpg new file mode 100644 index 0000000..bd90c33 Binary files /dev/null and b/images/m5sticks3_s.jpg differ diff --git a/images/mobile.jpg b/images/mobile.jpg new file mode 100644 index 0000000..a7a52a6 Binary files /dev/null and b/images/mobile.jpg differ diff --git a/images/mobile_s.jpg b/images/mobile_s.jpg new file mode 100644 index 0000000..32f1a36 Binary files /dev/null and b/images/mobile_s.jpg differ diff --git a/images/presentation_mobile.png b/images/presentation_mobile.png new file mode 100644 index 0000000..98d37e0 Binary files /dev/null and b/images/presentation_mobile.png differ diff --git a/images/rf24.gif b/images/rf24.gif new file mode 100644 index 0000000..c6f71e9 Binary files /dev/null and b/images/rf24.gif differ diff --git a/images/rfid.gif b/images/rfid.gif new file mode 100644 index 0000000..f3384b6 Binary files /dev/null and b/images/rfid.gif differ diff --git a/images/s3-devkit.jpg b/images/s3-devkit.jpg new file mode 100644 index 0000000..fde2a6d Binary files /dev/null and b/images/s3-devkit.jpg differ diff --git a/images/s3-devkit_s.jpg b/images/s3-devkit_s.jpg new file mode 100644 index 0000000..c3fad74 Binary files /dev/null and b/images/s3-devkit_s.jpg differ diff --git a/images/spiflash.gif b/images/spiflash.gif new file mode 100644 index 0000000..12ca1bb Binary files /dev/null and b/images/spiflash.gif differ diff --git a/images/stamps3.jpg b/images/stamps3.jpg new file mode 100644 index 0000000..3faa4d6 Binary files /dev/null and b/images/stamps3.jpg differ diff --git a/images/stamps3_s.jpg b/images/stamps3_s.jpg new file mode 100644 index 0000000..b6805bd Binary files /dev/null and b/images/stamps3_s.jpg differ diff --git a/images/standalonemode_s.png b/images/standalonemode_s.png new file mode 100644 index 0000000..1e168f9 Binary files /dev/null and b/images/standalonemode_s.png differ diff --git a/images/subghz.gif b/images/subghz.gif new file mode 100644 index 0000000..26492f1 Binary files /dev/null and b/images/subghz.gif differ diff --git a/images/system.gif b/images/system.gif new file mode 100644 index 0000000..a26f0e5 Binary files /dev/null and b/images/system.gif differ diff --git a/images/tembed.jpg b/images/tembed.jpg new file mode 100644 index 0000000..0436e6e Binary files /dev/null and b/images/tembed.jpg differ diff --git a/images/tembed_s.jpg b/images/tembed_s.jpg new file mode 100644 index 0000000..276bdaa Binary files /dev/null and b/images/tembed_s.jpg differ diff --git a/images/tembedbuspirate.jpg b/images/tembedbuspirate.jpg new file mode 100644 index 0000000..5276690 Binary files /dev/null and b/images/tembedbuspirate.jpg differ diff --git a/images/tembedbuspirate_s.jpg b/images/tembedbuspirate_s.jpg new file mode 100644 index 0000000..c80e7ec Binary files /dev/null and b/images/tembedbuspirate_s.jpg differ diff --git a/images/tembedcc1101.jpg b/images/tembedcc1101.jpg new file mode 100644 index 0000000..a64cf2f Binary files /dev/null and b/images/tembedcc1101.jpg differ diff --git a/images/tembedcc1101_s.jpg b/images/tembedcc1101_s.jpg new file mode 100644 index 0000000..417beaf Binary files /dev/null and b/images/tembedcc1101_s.jpg differ diff --git a/images/xiaos3.jpg b/images/xiaos3.jpg new file mode 100644 index 0000000..0cd6e1a Binary files /dev/null and b/images/xiaos3.jpg differ diff --git a/images/xiaos3_s.jpg b/images/xiaos3_s.jpg new file mode 100644 index 0000000..d03dfe1 Binary files /dev/null and b/images/xiaos3_s.jpg differ diff --git a/lib/93cx6/93Cx6.c b/lib/93cx6/93Cx6.c new file mode 100644 index 0000000..8835e05 --- /dev/null +++ b/lib/93cx6/93Cx6.c @@ -0,0 +1,272 @@ +/* + 93Cx6.c - Library for the Three-wire Serial EEPROM chip +*/ +#include +#include + +#include "freertos/FreeRTOS.h" +#include "freertos/task.h" +#include "driver/gpio.h" +#include "esp_log.h" + +#include "93Cx6.h" + +#define DELAY_CS 0 +#define DELAY_READ 1 +#define DELAY_WRITE 1 +#define DELAY_WAIT 1 + +#define _DEBUG_ 0 + +enum OP { // Operations + CONTROL = 0x00, + WRITE = 0x01, + READ = 0x02, + ERASE = 0x03 +}; +enum CC { // Control Codes + EW_DISABLE = 0x00, + WRITE_ALL = 0x01, + ERASE_ALL = 0x02, + EW_ENABLE = 0x03 +}; + +// Open Memory Device +// model:EEPROM model(46/56/66/76/86) +// org:Organization Select(1=8Bit/2=16Bit) +int eeprom_open(EEPROM_T * dev, int16_t model, int16_t org, int16_t GPIO_CS, int16_t GPIO_SK, int16_t GPIO_DI, int16_t GPIO_DO) +{ + ESP_LOGI(__FUNCTION__, "GPIO_CS=%d",GPIO_CS); + //gpio_pad_select_gpio( GPIO_CS ); + gpio_reset_pin( GPIO_CS ); + gpio_set_direction( GPIO_CS, GPIO_MODE_OUTPUT ); + gpio_set_level( GPIO_CS, LOW ); + + ESP_LOGI(__FUNCTION__, "GPIO_SK=%d",GPIO_SK); + //gpio_pad_select_gpio( GPIO_SK ); + gpio_reset_pin( GPIO_SK ); + gpio_set_direction( GPIO_SK, GPIO_MODE_OUTPUT ); + + ESP_LOGI(__FUNCTION__, "GPIO_DI=%d",GPIO_DI); + //gpio_pad_select_gpio( GPIO_DI ); + gpio_reset_pin( GPIO_DI ); + gpio_set_direction( GPIO_DI, GPIO_MODE_OUTPUT ); + + ESP_LOGI(__FUNCTION__, "GPIO_DO=%d",GPIO_DO); + //gpio_pad_select_gpio( GPIO_DO ); + gpio_reset_pin( GPIO_DO ); + gpio_set_direction( GPIO_DO, GPIO_MODE_INPUT ); + + dev->_CS = GPIO_CS; + dev->_SK = GPIO_SK; + dev->_DI = GPIO_DI; + dev->_DO = GPIO_DO; + dev->_ew = false; + dev->_org = org; + dev->_model = model; + dev->_bytes = getBytesByModel(dev->_org, dev->_model); + dev->_addr = getAddrByModel(dev->_org, dev->_model); + dev->_mask = getMaskByModel(dev->_org, dev->_model); + ESP_LOGI(__FUNCTION__, "dev->_bytes=%d dev->_addr=%d dev->_mask=%x", dev->_bytes, dev->_addr, dev->_mask); + return dev->_bytes; +}; + + +// Erase/Write Enable +// Required Clock Cycle : 9-13 +void eeprom_ew_enable(EEPROM_T *dev) +{ + gpio_set_level(dev->_CS, HIGH); + usleep(DELAY_CS); + send_bits(dev, HIGH, 1); + //uint16_t value = CONTROL<_addr | EW_ENABLE<<(dev->_addr-2); + //ESP_LOGI(__FUNCTION__, "eeprom_ew_enable value=%04x", value); + send_bits(dev, CONTROL<_addr | EW_ENABLE<<(dev->_addr-2), dev->_addr + 2); + gpio_set_level(dev->_CS, LOW); + dev->_ew = true; +}; + +// Erase/Write Disable +// Required Clock Cycle : 9-13 +void eeprom_ew_disable(EEPROM_T *dev) +{ + gpio_set_level(dev->_CS, HIGH); + usleep(DELAY_CS); + send_bits(dev, HIGH, 1); + send_bits(dev, CONTROL<_addr | EW_DISABLE<<(dev->_addr-2), dev->_addr + 2); + gpio_set_level(dev->_CS, LOW); + dev->_ew = false; +} + +// Check Erase/Write Enable +bool eeprom_is_ew_enabled(EEPROM_T *dev) +{ + return dev->_ew; +} + +// Erase All Memory +// Required Clock Cycle : 9-13 +void eeprom_erase_all(EEPROM_T *dev) +{ + if(!eeprom_is_ew_enabled(dev)) return; + gpio_set_level(dev->_CS, HIGH); + usleep(DELAY_CS); + send_bits(dev, HIGH, 1); + //uint16_t value = CONTROL<_addr | ERASE_ALL<<(dev->_addr-2); + //ESP_LOGI(__FUNCTION__, "eeprom_erase_all value=%04x", value); + send_bits(dev, CONTROL<_addr | ERASE_ALL<<(dev->_addr-2), dev->_addr + 2); + gpio_set_level(dev->_CS, LOW); + wait_ready(dev); +} + +// Erase Byte or Word +// Required Clock Cycle : 9-13 +void eeprom_erase(EEPROM_T *dev, uint16_t addr) +{ + if(!eeprom_is_ew_enabled(dev)) return; + gpio_set_level(dev->_CS, HIGH); + usleep(DELAY_CS); + send_bits(dev, HIGH, 1); + if(dev->_org == EEPROM_MODE_16BIT) { + send_bits(dev, ERASE<_addr | (addr & dev->_mask), dev->_addr + 2); + } else { + send_bits(dev, ERASE<_addr | (addr & dev->_mask), dev->_addr + 2); + } + + gpio_set_level(dev->_CS, LOW); + wait_ready(dev); +} + + +// Write All Memory with same Data +// Required Clock Cycle : 25-29 +void eeprom_write_all(EEPROM_T *dev, uint16_t value) +{ + if(!eeprom_is_ew_enabled(dev)) return; + gpio_set_level(dev->_CS, HIGH); + usleep(DELAY_CS); + send_bits(dev, HIGH, 1); + send_bits(dev, CONTROL<_addr | WRITE_ALL<<(dev->_addr-2), dev->_addr + 2); + if(dev->_org == EEPROM_MODE_16BIT) { + send_bits(dev, 0xFFFF & value, 16); + } else { + send_bits(dev, 0xFF & value, 8); + } + gpio_set_level(dev->_CS, LOW); + wait_ready(dev); +} + +// Write Data to Memory +// Required Clock Cycle : 25-29 +void eeprom_write(EEPROM_T *dev, uint16_t addr, uint16_t value) +{ + if(!eeprom_is_ew_enabled(dev)) return; + gpio_set_level(dev->_CS, HIGH); + usleep(DELAY_CS); + send_bits(dev, HIGH, 1); + if(dev->_org == EEPROM_MODE_16BIT) { + send_bits(dev, WRITE<_addr | (addr & dev->_mask), dev->_addr + 2); + send_bits(dev, 0xFFFF & value, 16); + } else { + send_bits(dev, WRITE<_addr | (addr & dev->_mask), dev->_addr + 2); + send_bits(dev, 0xFF & value, 8); + } + gpio_set_level(dev->_CS, LOW); + wait_ready(dev); +} + +// Read Data from Memory +uint16_t eeprom_read(EEPROM_T *dev, uint16_t addr) +{ + uint16_t val = 0; + gpio_set_level(dev->_CS, HIGH); + usleep(DELAY_CS); + send_bits(dev, HIGH, 1); // Start bit + + int amtBits; + if(dev->_org == EEPROM_MODE_16BIT) { + send_bits(dev, READ<_addr | (addr & dev->_mask), dev->_addr + 2); + amtBits = 16; + } else { + send_bits(dev, READ<_addr | (addr & dev->_mask), dev->_addr + 2); + amtBits = 8; + } + // Read bits + for(int i = amtBits; i>0; i--) { + gpio_set_level(dev->_SK, HIGH); + usleep(DELAY_READ); + int in = gpio_get_level(dev->_DO) ? 1 : 0; + gpio_set_level(dev->_SK, LOW); + usleep(DELAY_READ); + val |= (in << (i-1)); + } + gpio_set_level(dev->_CS, LOW); + return val; +} + + +void send_bits(EEPROM_T *dev, uint16_t value, int len) +{ + ESP_LOGD(__FUNCTION__, "send_bits value=0x%04x len=%d",value, len); + for(int i = len-1; i>=0; i--) + { + bool toSend = (value & 1<_DI, HIGH); + if (!toSend) gpio_set_level(dev->_DI, LOW); + usleep(DELAY_WRITE); + gpio_set_level(dev->_SK, HIGH); + usleep(DELAY_WRITE); + gpio_set_level(dev->_SK, LOW); + usleep(DELAY_WRITE); + } +} + +void wait_ready(EEPROM_T *dev) +{ + //Wait until action is done. + gpio_set_level(dev->_CS, HIGH); + while(gpio_get_level(dev->_DO) != HIGH) { + usleep(DELAY_WAIT); + //vTaskDelay(1); + } + gpio_set_level(dev->_CS, LOW); +} + + +int getBytesByModel(int org, int model) +{ + int byte = 0; + if (org == EEPROM_MODE_8BIT) byte = 128; + if (org == EEPROM_MODE_16BIT) byte = 64; + if (model == 56) byte = byte * 2; // 256/128 + if (model == 66) byte = byte * 4; // 512/256 + if (model == 76) byte = byte * 8; // 1024/256 + if (model == 86) byte = byte * 16; // 2048/1024 + return byte; +} + +int getAddrByModel(int org, int model) +{ + int addr = 0; + if (org == EEPROM_MODE_8BIT) addr = 7; + if (org == EEPROM_MODE_16BIT) addr = 6; + if (model == 56) addr = addr + 2; // 9/8 + if (model == 66) addr = addr + 2; // 9/8 + if (model == 76) addr = addr + 4; // 11/10 + if (model == 86) addr = addr + 4; // 11/10 + return addr; +} + +uint16_t getMaskByModel(int org, int model) +{ + uint16_t mask = 0; + if (org == EEPROM_MODE_8BIT) mask = 0x7f; + if (org == EEPROM_MODE_16BIT) mask = 0x3f; + if (model == 56) mask = (mask<<2) + 0x03; // 0x1ff/0xff + if (model == 66) mask = (mask<<2) + 0x03; // 0x1ff/0xff + if (model == 76) mask = (mask<<4) + 0x0f; // 0x7ff/0x3ff + if (model == 86) mask = (mask<<4) + 0x0f; // 0x7ff/0x3ff + return mask; +} + diff --git a/lib/93cx6/93Cx6.h b/lib/93cx6/93Cx6.h new file mode 100644 index 0000000..daa65f3 --- /dev/null +++ b/lib/93cx6/93Cx6.h @@ -0,0 +1,45 @@ +/* + 93Cx6.h - Library for the Three-wire Serial EEPROM chip +*/ +#ifndef _93CX6_H_ +#define _93CX6_H_ + +#define EEPROM_MODE_UNKNOWN 0 +#define EEPROM_MODE_8BIT 1 +#define EEPROM_MODE_16BIT 2 + +#define LOW 0 +#define HIGH 1 + +typedef struct +{ + int16_t _CS; + int16_t _SK; + int16_t _DI; + int16_t _DO; + bool _ew; + int16_t _org; // eeprom Organization(8bit/16bit) + int16_t _model; // eeprom model(46/56/66/76/86) + int16_t _bytes; // eeprom memory size(byte) + int16_t _addr; // number of address bit + uint16_t _mask; // address mask +} EEPROM_T; + + +int eeprom_open(EEPROM_T * dev, int16_t model, int16_t org, int16_t GPIO_CS, int16_t GPIO_SK, int16_t GPIO_DI, int16_t GPIO_DO); +void eeprom_ew_disable(EEPROM_T * dev); +void eeprom_ew_enable(EEPROM_T * dev); +bool eeprom_is_ew_enabled(EEPROM_T * dev); +void eeprom_erase_all(EEPROM_T * dev); +void eeprom_erase(EEPROM_T * dev, uint16_t addr); +void eeprom_write_all(EEPROM_T * dev, uint16_t value); +void eeprom_write(EEPROM_T * dev, uint16_t addr, uint16_t value); +uint16_t eeprom_read(EEPROM_T * dev, uint16_t addr); +void send_bits(EEPROM_T * dev, uint16_t value, int len); +void wait_ready(EEPROM_T * dev); +int getBytesByModel(int bit, int model); +int getAddrByModel(int bit, int model); +uint16_t getMaskByModel(int bit, int model); + +#endif + diff --git a/lib/EEPROM_SPI_WE/.piopm b/lib/EEPROM_SPI_WE/.piopm new file mode 100644 index 0000000..3fda9c9 --- /dev/null +++ b/lib/EEPROM_SPI_WE/.piopm @@ -0,0 +1 @@ +{"type": "library", "name": "EEPROM_SPI_WE", "version": "1.1.5", "spec": {"owner": "wollewald", "id": 13697, "name": "EEPROM_SPI_WE", "requirements": null, "uri": null}} \ No newline at end of file diff --git a/lib/EEPROM_SPI_WE/LICENSE b/lib/EEPROM_SPI_WE/LICENSE new file mode 100644 index 0000000..8c5e394 --- /dev/null +++ b/lib/EEPROM_SPI_WE/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2022 Wolfgang (Wolle) Ewald + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/lib/EEPROM_SPI_WE/README.md b/lib/EEPROM_SPI_WE/README.md new file mode 100644 index 0000000..7b0a07e --- /dev/null +++ b/lib/EEPROM_SPI_WE/README.md @@ -0,0 +1,18 @@ +# EEPROM_SPI_WE +Arduino library for SPI based EEPROMs + +With this library you can write data to and read data from SPI based EEPROMs of the 25 series, including small EEPROMs like the 25LC0x0A or ST950x0 with x = 1,2,4,8. Although it uses page writing, you don't have to worry about the page limits. You can directly write bytes, integers, floats and arrays. Furthermore, I have implemented functions to read and write strings. I have adopted the method of handling different variable types for put() and get() from Sparkfun's great library SparkFun_External_EEPROM_Arduino_Library for I2C EEPROMs. + +I have implemented the protection options for the storage and and the status register. + +The functions for erasing pages or sectors only work with the larger EEPROMs. Check the data sheet if you are not sure. + +I have tested several EEPROMs (25LC512, 25A512, 25LC640, 25LC040A) using various MCU boards, such as the ESP32 development board, WEMOS D1 mini (ESP8266) and the Arduino Nano. + +The library can now also deal with EEPROMs that use 24 bit addressing such as the 25CSM04. You need to set the memory size before accessing the EEPROM using the method `setMemorySize`. Note that this particular EEPROM25CSM04 does not support erase operations. + +Here you find the detailed documentation: + +https://wolles-elektronikkiste.de/en/eeprom-part-3-external-spi-eeproms (English) + +https://wolles-elektronikkiste.de/eeprom-teil-3-externe-spi-eeproms (German) diff --git a/lib/EEPROM_SPI_WE/examples/EEPROM_SPI_WE_basic_read_write/EEPROM_SPI_WE_basic_read_write.ino b/lib/EEPROM_SPI_WE/examples/EEPROM_SPI_WE_basic_read_write/EEPROM_SPI_WE_basic_read_write.ino new file mode 100644 index 0000000..4b6bc77 --- /dev/null +++ b/lib/EEPROM_SPI_WE/examples/EEPROM_SPI_WE_basic_read_write/EEPROM_SPI_WE_basic_read_write.ino @@ -0,0 +1,106 @@ +/******************************************************************************* +* This is an example sketch for the EEPROM_SPI_WE library +* +* It shows how to write data to and read data from the EEPROM. +* +* Written by Wolfgang (Wolle) Ewald. +* +* Here you find the detailed documentation: +* https://wolles-elektronikkiste.de/en/eeprom-part-3-external-spi-eeproms (English) +* https://wolles-elektronikkiste.de/eeprom-teil-3-externe-spi-eeproms (German) +* +********************************************************************************/ + +#include +#include +const int csPin = 10; // Chip select pin +const int wpPin = 9; // Write protect pin (optional) + +/* There are different options to create your EEPROM_SPI_WE object: + * EEPROM_SPI_WE myEEP = EEPROM_SPI_WE(csPin, wpPin, spiClockSpeed); // e.g. uint32t spiClockSpeed = 4000000 + * EEPROM_SPI_WE myEEP = EEPROM_SPI_WE(csPin, wpPin); + * EEPROM_SPI_WE myEEP = EEPROM_SPI_WE(csPin); + * EEPROM_SPI_WE myEEP = EEPROM_SPI_WE(&SPI, csPin, wpPin, spiClockSpeed); + * EEPROM_SPI_WE myEEP = EEPROM_SPI_WE(&SPI, csPin, wpPin); + * EEPROM_SPI_WE myEEP = EEPROM_SPI_WE(&SPI, csPin); + * If you don't define the wpPin and you connect it to GND or VCC, + * then protectStatusRegister() is the only function that won't work. + * Passing the SPI object allows you, for example, to use both SPI + * interfaces on the ESP32. + */ + EEPROM_SPI_WE myEEP = EEPROM_SPI_WE(csPin, wpPin); + +void setup(){ + Serial.begin(9600); + if(myEEP.init()){ + Serial.println("EEPROM connected"); + } + else{ + Serial.println("EEPROM does not respond"); + while(1); + } + /* You can change the SPI clock speed also after you have created your + * object. The default is 8 MHz. Check the data sheet which clock speed is + * allowed. The frequency limit migh also depend on the voltage. + */ + //myEEP.setSPIClockSpeed(4000000); // use AFTER init()! + + /* Select the page size of your EEPROM. + * Choose EEPROM_PAGE_SIZE_xxx, + * with xxx = 16, 32, 64, 128 or 256 + */ + myEEP.setPageSize(EEPROM_PAGE_SIZE_32); + + byte byteToWrite = 42; + myEEP.write(10, byteToWrite); // write a byte to EEPROM address 10 + byte byteToRead = myEEP.read(10); + Serial.print("Byte read: "); + Serial.println(byteToRead); + + int intToWrite = -4242; + int intToRead = 0; + myEEP.put(10, intToWrite); // write an integer to EEPROM address 10 + myEEP.get(10, intToRead); + Serial.print("Integer read: "); + Serial.println(intToRead); + + float floatToWrite = 42.42; + float floatToRead = 0.0; + myEEP.put(10, floatToWrite); + myEEP.get(10, floatToRead); + Serial.print("Float read: "); + Serial.println(floatToRead); + + char charArrayToWrite[] = "This is no poetry, I am just a simple char array"; + myEEP.put(110, charArrayToWrite); // write stringToWrite to address 110 + char charArrayToRead[60] = ""; // reserve sufficient space + myEEP.get(110, charArrayToRead); + Serial.print("Char array read: "); + Serial.println(charArrayToRead); + + String stringToWrite = "Hello, I am a test string"; + unsigned int nextAddr = myEEP.putString(200, stringToWrite); // String objects need a different put function + + String stringToRead = ""; + myEEP.getString(200, stringToRead); + Serial.print("String read: "); + Serial.println(stringToRead); + Serial.print("Next free address: "); + Serial.println(nextAddr); + + int intArrayToWrite[20]; + int intArrayToRead[20]; + for(unsigned int i=0; i<(sizeof(intArrayToWrite)/sizeof(int)); i++){ + intArrayToWrite[i] = 10*i; + } + myEEP.put(250, intArrayToWrite); + myEEP.get(250, intArrayToRead); + for(unsigned int i=0; i<(sizeof(intArrayToRead)/sizeof(int)); i++){ + Serial.print("intArrayToRead["); + Serial.print(i); + Serial.print("]: "); + Serial.println(intArrayToRead[i]); + } +} + +void loop(){} diff --git a/lib/EEPROM_SPI_WE/examples/EEPROM_SPI_WE_continuous_put/EEPROM_SPI_WE_continuous_put.ino b/lib/EEPROM_SPI_WE/examples/EEPROM_SPI_WE_continuous_put/EEPROM_SPI_WE_continuous_put.ino new file mode 100644 index 0000000..5980371 --- /dev/null +++ b/lib/EEPROM_SPI_WE/examples/EEPROM_SPI_WE_continuous_put/EEPROM_SPI_WE_continuous_put.ino @@ -0,0 +1,161 @@ +/******************************************************************************* +* This is an example sketch for the EEPROM_SPI_WE library +* +* It shows how to write data continuously and how to use the hold pin. +* +* Written by Wolfgang (Wolle) Ewald. +* +* Here you find the detailed documentation: +* https://wolles-elektronikkiste.de/en/eeprom-part-3-external-spi-eeproms (English) +* https://wolles-elektronikkiste.de/eeprom-teil-3-externe-spi-eeproms (German) +* +********************************************************************************/ + +#include +#include +const int csPin = 10; // Chip select pin +const int wpPin = 9; // Write protect pin (optional) +const int holdPin = 5; // Hold pin, pauses SPI transaction if LOW + +/* There are different options to create your EEPROM_SPI_WE object: + * EEPROM_SPI_WE myEEP = EEPROM_SPI_WE(csPin, wpPin, spiClockSpeed); // e.g. uint32t spiClockSpeed = 4000000 + * EEPROM_SPI_WE myEEP = EEPROM_SPI_WE(csPin, wpPin); + * EEPROM_SPI_WE myEEP = EEPROM_SPI_WE(csPin); + * EEPROM_SPI_WE myEEP = EEPROM_SPI_WE(&SPI, csPin, wpPin, spiClockSpeed); + * EEPROM_SPI_WE myEEP = EEPROM_SPI_WE(&SPI, csPin, wpPin); + * EEPROM_SPI_WE myEEP = EEPROM_SPI_WE(&SPI, csPin); + * If you don't define the wpPin and you connect it to GND or VCC, + * then protectStatusRegister() is the only function that won't work. + * Passing the SPI object allows you, for example, to use both SPI + * interfaces on the ESP32. + */ +EEPROM_SPI_WE myEEP = EEPROM_SPI_WE(csPin, wpPin); + +void setup(){ + Serial.begin(9600); + pinMode(holdPin,OUTPUT); + digitalWrite(holdPin, HIGH); + if(myEEP.init()){ + Serial.println("EEPROM connected"); + } + else{ + Serial.println("EEPROM does not respond"); + while(1); + } + /* You can change the SPI clock speed also after you have created your + * object. The default is 8 MHz. Check the data sheet which clock speed is + * allowed. The frequency limit migh also depend on the voltage. + */ + //myEEP.setSPIClockSpeed(4000000); // use AFTER init()! + + /* Select the page size of your EEPROM. + * Choose EEPROM_PAGE_SIZE_xxx, + * with xxx = 16, 32, 64, 128 or 256 + */ + myEEP.setPageSize(EEPROM_PAGE_SIZE_128); + + unsigned int address = 0; + unsigned long writeDuration = 0; + unsigned long startTime = millis(); + + /* Conventional way of writing: + * For each call of put() you have to wait the write cycle + * time (~4 ms). + */ + myEEP.put(125,0); + myEEP.put(127, 1111); + myEEP.put(129, 2222); + myEEP.put(131, 3333); + myEEP.put(133, 4444); + myEEP.put(135, 5555); + myEEP.put(137, 6666); + myEEP.put(139, 7777); + myEEP.put(141, 8888); + myEEP.put(143, 9999); + writeDuration = millis() - startTime; + Serial.print("Time needed for discontinuous writing [ms]: "); + Serial.println(writeDuration); + + /* Continuous writing: + * You only need to wait the write cycle time when a page is + * completed and when calling continuousPutDisable(). + * In this example the page is completed after writing to address 127. + */ + address = 125; + startTime = millis(); + myEEP.continuousPutEnable(address); // start address + myEEP.continuousPut(9999); + myEEP.continuousPut(8888); + myEEP.continuousPut(7777); + myEEP.continuousPut(6666); + myEEP.continuousPut(5555); + myEEP.continuousPut(4444); + myEEP.continuousPut(3333); + myEEP.continuousPut(2222); + myEEP.continuousPut(1111); + myEEP.continuousPut(0); + myEEP.continuousPutDisable(); + writeDuration = millis() - startTime; + + Serial.print("Time needed for continuous writing incl. page change [ms]: "); + Serial.println(writeDuration); + /* Just to check that writing worked fine: */ + int intToRead; + address = 125; + for(unsigned int i=0; i<10; i++){ + myEEP.get(address, intToRead); + address += sizeof(int); + Serial.println(intToRead); + } + + + /* Another continuous writing: + * Here writing starts at address 0. If your page size is >= 32 you will write + * everything into one page. So, only one write cycle waiting time is needed at + * the end. + */ + address = 0; + startTime = millis(); + myEEP.continuousPutEnable(address); + myEEP.continuousPut(0); + myEEP.continuousPut(1111); + myEEP.continuousPut(2222); + myEEP.continuousPut(3333); + myEEP.continuousPut(4444); + myEEP.continuousPut(5555); + myEEP.continuousPut(6666); + myEEP.continuousPut(7777); + myEEP.continuousPut(8888); + myEEP.continuousPut(9999); + myEEP.continuousPutDisable(); + writeDuration = millis() - startTime; + Serial.print("Time needed for continuous writing without page change [ms]: "); + Serial.println(writeDuration); + + /* The next example shows how to use the hold pin */ + address = 0; + myEEP.continuousPutEnable(address); + myEEP.continuousPut(999); + myEEP.continuousPut(888); + myEEP.continuousPut(777); + myEEP.continuousPut(666); + digitalWrite(holdPin,LOW); + /* With the hold pin low you can now use the SPI lines to control other + devices. The current SPI transaction with the EEPOM is just paused + (CS pin is still LOW). After the hold Pin is back to HIGH you can continue + the former transaction. + */ + digitalWrite(holdPin,HIGH); + myEEP.continuousPut(555); + myEEP.continuousPut(444); + myEEP.continuousPutDisable(); + /* Just to show that writing worked fine: */ + address = 0; + for(unsigned int i=0; i<10; i++){ + myEEP.get(address, intToRead); + address += sizeof(int); + Serial.println(intToRead); + } +} + +void loop(){} diff --git a/lib/EEPROM_SPI_WE/examples/EEPROM_SPI_WE_erase/EEPROM_SPI_WE_erase.ino b/lib/EEPROM_SPI_WE/examples/EEPROM_SPI_WE_erase/EEPROM_SPI_WE_erase.ino new file mode 100644 index 0000000..6a378a6 --- /dev/null +++ b/lib/EEPROM_SPI_WE/examples/EEPROM_SPI_WE_erase/EEPROM_SPI_WE_erase.ino @@ -0,0 +1,100 @@ +/****************************************************************************** +* This is an example sketch for the EEPROM_SPI_WE library. +* +* Here you learn the different how to erase pages, sectors or the +* entire EEPROM. +* +* THESE FUNCTIONS ARE ONLY AVAILABLE ON BIGGER EEPROMS. Check the +* data sheet! +* +* Written by Wolfgang (Wolle) Ewald. +* +* Here you find the detailed documentation: +* https://wolles-elektronikkiste.de/en/eeprom-part-3-external-spi-eeproms (English) +* https://wolles-elektronikkiste.de/eeprom-teil-3-externe-spi-eeproms (German) +* +*******************************************************************************/ + +#include +#include +const int csPin = 10; // Chip select pin +const int wpPin = 9; // Write protect pin (optional) + +/* There are different options to create your EEPROM_SPI_WE object: + * EEPROM_SPI_WE myEEP = EEPROM_SPI_WE(csPin, wpPin, spiClockSpeed); // e.g. uint32t spiClockSpeed = 4000000 + * EEPROM_SPI_WE myEEP = EEPROM_SPI_WE(csPin, wpPin); + * EEPROM_SPI_WE myEEP = EEPROM_SPI_WE(csPin); + * EEPROM_SPI_WE myEEP = EEPROM_SPI_WE(&SPI, csPin, wpPin, spiClockSpeed); + * EEPROM_SPI_WE myEEP = EEPROM_SPI_WE(&SPI, csPin, wpPin); + * EEPROM_SPI_WE myEEP = EEPROM_SPI_WE(&SPI, csPin); + * If you don't define the wpPin and you connect it to GND or VCC, + * then protectStatusRegister() is the only function that won't work. + * Passing the SPI object allows you, for example, to use both SPI + * interfaces on the ESP32. + */ + EEPROM_SPI_WE myEEP = EEPROM_SPI_WE(csPin, wpPin); + +void setup(){ + Serial.begin(9600); + if(myEEP.init()){ + Serial.println("EEPROM connected"); + } + else{ + Serial.println("EEPROM does not respond"); + while(1); + } + /* You can change the SPI clock speed also after you have created your + * object. The default is 8 MHz. Check the data sheet which clock speed is + * allowed. The frequency limit migh also depend on the voltage. + */ + //myEEP.setSPIClockSpeed(4000000); // use AFTER init()! + + /* Select the page size of your EEPROM. + * Choose EEPROM_PAGE_SIZE_xxx, + * with xxx = 16, 32, 64, 128 or 256 + */ + myEEP.setPageSize(EEPROM_PAGE_SIZE_128); + + int testInt = 42; + myEEP.put(10, testInt); + myEEP.get(10, testInt); + Serial.print("testInt: "); + Serial.println(testInt); + Serial.println("Erasing page...."); + myEEP.erasePage(3); // choose any address within the page you want to erase + myEEP.get(10, testInt); + Serial.print("testInt: "); + Serial.println(testInt); + Serial.println(""); + + testInt = 42; + myEEP.put(10, testInt); + myEEP.get(10, testInt); + Serial.print("testInt: "); + Serial.println(testInt); + Serial.println("Erasing sector...."); + myEEP.eraseSector(7); // choose any address within the sector you want to erase + myEEP.get(10, testInt); + Serial.print("testInt: "); + Serial.println(testInt); + Serial.println(""); + + testInt = 42; + myEEP.put(10, testInt); + myEEP.get(10, testInt); + Serial.print("testInt: "); + Serial.println(testInt); + Serial.println("Erasing complete EEPROM...."); + myEEP.eraseCompleteEEPROM(); + myEEP.get(10, testInt); + Serial.print("testInt: "); + Serial.println(testInt); + + Serial.print("testInt, MSB: "); + Serial.println(myEEP.read(10), BIN); + Serial.print("testInt, LSB: "); + Serial.println(myEEP.read(11), BIN); + Serial.println("Erasing means writing 0xFF to all addresses"); +} + +void loop(){} diff --git a/lib/EEPROM_SPI_WE/examples/EEPROM_SPI_WE_sleep_and_protect/EEPROM_SPI_WE_sleep_and_protect.ino b/lib/EEPROM_SPI_WE/examples/EEPROM_SPI_WE_sleep_and_protect/EEPROM_SPI_WE_sleep_and_protect.ino new file mode 100644 index 0000000..a3df096 --- /dev/null +++ b/lib/EEPROM_SPI_WE/examples/EEPROM_SPI_WE_sleep_and_protect/EEPROM_SPI_WE_sleep_and_protect.ino @@ -0,0 +1,107 @@ +/****************************************************************************** +* This is an example sketch for the EEPROM_SPI_WE library. +* +* It shows how to apply the deep power down mode and different +* methods for write protection and protection of the status register. +* +* Written by Wolfgang (Wolle) Ewald. +* +* Here you find the detailed documentation: +* https://wolles-elektronikkiste.de/en/eeprom-part-3-external-spi-eeproms (English) +* https://wolles-elektronikkiste.de/eeprom-teil-3-externe-spi-eeproms (German) +* +*******************************************************************************/ + +#include +#include +const int csPin = 10; // Chip select pin +const int wpPin = 9; // Write protect pin (needed for this sketch) + +/* There are different options to create your EEPROM_SPI_WE object: + * EEPROM_SPI_WE myEEP = EEPROM_SPI_WE(csPin, wpPin, spiClockSpeed); // e.g. uint32t spiClockSpeed = 4000000 + * EEPROM_SPI_WE myEEP = EEPROM_SPI_WE(csPin, wpPin); + * EEPROM_SPI_WE myEEP = EEPROM_SPI_WE(csPin); + * EEPROM_SPI_WE myEEP = EEPROM_SPI_WE(&SPI, csPin, wpPin, spiClockSpeed); + * EEPROM_SPI_WE myEEP = EEPROM_SPI_WE(&SPI, csPin, wpPin); + * EEPROM_SPI_WE myEEP = EEPROM_SPI_WE(&SPI, csPin); + * If you don't define the wpPin and you connect it to GND or VCC, + * then protectStatusRegister() is the only function that won't work. + * Passing the SPI object allows you, for example, to use both SPI + * interfaces on the ESP32. + */ + EEPROM_SPI_WE myEEP = EEPROM_SPI_WE(csPin, wpPin); + +void setup(){ + Serial.begin(9600); + if(myEEP.init()){ + Serial.println("EEPROM connected"); + } + else{ + Serial.println("EEPROM does not respond"); + while(1); + } + /* You can change the SPI clock speed also after you have created your + * object. The default is 8 MHz. Check the data sheet which clock speed is + * allowed. The frequency limit migh also depend on the voltage. + */ + //myEEP.setSPIClockSpeed(4000000); // use AFTER init()! + + /* Select the page size of your EEPROM. + * Choose EEPROM_PAGE_SIZE_xxx, + * with xxx = 16, 32, 64, 128 or 256 + */ + myEEP.setPageSize(EEPROM_PAGE_SIZE_128); + + int testInt = 42; + myEEP.put(50, testInt); + Serial.print("testInt: "); + Serial.println(testInt); + Serial.println("Going in deep power down mode..."); + myEEP.deepPowerDown(); + Serial.println("Trying to read testInt... "); + myEEP.get(50, testInt); + Serial.print("testInt: "); + Serial.println(testInt); + Serial.println("Releasing from deep power down mode..."); + byte id = myEEP.powerUpAndReadID(); + Serial.print("testInt: "); + myEEP.get(50, testInt); + Serial.println(testInt); + Serial.print("Device ID: 0x"); + Serial.println(id, HEX); + Serial.println(""); + +/* You can write protect the device. The following options are available: + * PROTECT_ALL Complete write protection; + * PROTECT_UPPER_QUARTER Protect the upper quarter; + * PROTECT_UPPER_HALF Protect the upper half; + * PROTECT_NONE No write protection + */ + myEEP.writeProtect(PROTECT_ALL); + Serial.println("Protecting Device, trying to overwrite testInt..."); + myEEP.put(50, 4321); + myEEP.writeProtect(PROTECT_NONE); + Serial.print("testInt: "); + myEEP.get(50, testInt); + Serial.println(testInt); + Serial.println("Protection removed, trying to overwrite testInt again..."); + myEEP.put(50, 4321); + myEEP.get(50, testInt); + Serial.print("testInt: "); + Serial.println(testInt); + Serial.println(""); + + Serial.println("Protecting status register..."); + myEEP.protectStatusRegister(true); //protects the non-volatile bits of status register + Serial.println("Trying to protect device..."); + myEEP.writeProtect(PROTECT_ALL); + Serial.println("Now overwriting testInt..."); + myEEP.put(50, 1234); + myEEP.get(50, testInt); + Serial.print("testInt: "); + Serial.println(testInt); + Serial.println("Status register protection prevented changing the device protection!"); + myEEP.protectStatusRegister(false); +} + +void loop(){} diff --git a/lib/EEPROM_SPI_WE/examples/EEPROM_SPI_WE_small_eeproms/EEPROM_SPI_WE_small_eeproms.ino b/lib/EEPROM_SPI_WE/examples/EEPROM_SPI_WE_small_eeproms/EEPROM_SPI_WE_small_eeproms.ino new file mode 100644 index 0000000..aea76b0 --- /dev/null +++ b/lib/EEPROM_SPI_WE/examples/EEPROM_SPI_WE_small_eeproms/EEPROM_SPI_WE_small_eeproms.ino @@ -0,0 +1,125 @@ +/******************************************************************************* +* This is an example sketch for the EEPROM_SPI_WE library +* +* It shows how to use small EEPROMs of 128, 256, 512 or 1024 bytes. These types +* have typically a designation .....0x0y with x = 1, 2, 4 or 8, e.g. 25LC040A or +* ST95020. +* +* Be aware that small EEPROMs might not support all functions. If in doubt, check +* the data sheet. +* +* Written by Wolfgang (Wolle) Ewald. +* +* Here you find the detailed documentation: +* https://wolles-elektronikkiste.de/en/eeprom-part-3-external-spi-eeproms (English) +* https://wolles-elektronikkiste.de/eeprom-teil-3-externe-spi-eeproms (German) +* +********************************************************************************/ + +#include +#include +const int csPin = 10; // Chip select pin +const int wpPin = 9; // Write protect pin (optional) + +/* There are different options to create your EEPROM_SPI_WE object: + * EEPROM_SPI_WE myEEP = EEPROM_SPI_WE(csPin, wpPin, spiClockSpeed); // e.g. uint32t spiClockSpeed = 4000000 + * EEPROM_SPI_WE myEEP = EEPROM_SPI_WE(csPin, wpPin); + * EEPROM_SPI_WE myEEP = EEPROM_SPI_WE(csPin); + * EEPROM_SPI_WE myEEP = EEPROM_SPI_WE(&SPI, csPin, wpPin, spiClockSpeed); + * EEPROM_SPI_WE myEEP = EEPROM_SPI_WE(&SPI, csPin, wpPin); + * EEPROM_SPI_WE myEEP = EEPROM_SPI_WE(&SPI, csPin); + * If you don't define the wpPin and you connect it to GND or VCC, + * then protectStatusRegister() is the only function that won't work. + * Passing the SPI object allows you, for example, to use both SPI + * interfaces on the ESP32. + */ + EEPROM_SPI_WE myEEP = EEPROM_SPI_WE(csPin, wpPin); + +void setup(){ + Serial.begin(9600); + if(myEEP.init()){ + Serial.println("EEPROM connected"); + } + else{ + Serial.println("EEPROM does not respond"); + while(1); + } + + /* You can change the SPI clock speed also after you have created your + * object. The default is 8 MHz. Check the data sheet which clock speed is + * allowed. The frequency limit migh also depend on the voltage. + */ + myEEP.setSPIClockSpeed(2000000); // use AFTER init()! + + /* Function to set small EEPROMs */ + myEEP.setSmallEEPROM(); + + /* Select the page size of your EEPROM. + * Choose EEPROM_PAGE_SIZE_xxx, + * with xxx = 16, 32, 64, 128 or 256 + */ + myEEP.setPageSize(EEPROM_PAGE_SIZE_16); + + /* Small EEPROMs do not have an embedded instruction to erase + * the complete chip. Therefore, the eraseCompleteEEPROM function will + * override every byte with 0. For this, you need to specify the + * EEPROM size in kbits. You can choose: + * EEPROM_KBITS_x with x = 2, 4, 8, 16, 32, 64, 128, 256, 512, 1024 or 2048 + */ + // myEEP.setMemorySize(EEPROM_KBITS_2); // adjust and uncomment + // Serial.print("Memory size in kbits: "); + // Serial.println(myEEP.getMemorySize()); + // myEEP.eraseCompleteEEPROM(); + + byte byteToWrite = 42; + myEEP.write(10, byteToWrite); // write a byte to EEPROM address 10 + byte byteToRead = myEEP.read(10); + Serial.print("Byte read: "); + Serial.println(byteToRead); + + int intToWrite = -4242; + int intToRead = 0; + myEEP.put(10, intToWrite); // write an integer to EEPROM address 10 + myEEP.get(10, intToRead); + Serial.print("Integer read: "); + Serial.println(intToRead); + + float floatToWrite = 42.42; + float floatToRead = 0.0; + myEEP.put(10, floatToWrite); + myEEP.get(10, floatToRead); + Serial.print("Float read: "); + Serial.println(floatToRead); + + char charArrayToWrite[] = "This is no poetry, I am just a simple char array"; + myEEP.put(10, charArrayToWrite); // write stringToWrite to address 10 + char charArrayToRead[60] = ""; // reserve sufficient space + myEEP.get(10, charArrayToRead); + Serial.print("Char array read: "); + Serial.println(charArrayToRead); + + String stringToWrite = "Hello, I am a test string"; + unsigned int nextAddr = myEEP.putString(105, stringToWrite); // String objects need a different put function + String stringToRead = ""; + myEEP.getString(105, stringToRead); // String objects need a different get function + Serial.print("String read: "); + Serial.println(stringToRead); + Serial.print("Next free address: "); + Serial.println(nextAddr); + + int intArrayToWrite[10]; + int intArrayToRead[10]; + for(unsigned int i=0; i<(sizeof(intArrayToWrite)/sizeof(int)); i++){ + intArrayToWrite[i] = 10*i; + } + myEEP.put(105, intArrayToWrite); + myEEP.get(105, intArrayToRead); + for(unsigned int i=0; i<(sizeof(intArrayToRead)/sizeof(int)); i++){ + Serial.print("intArrayToRead["); + Serial.print(i); + Serial.print("]: "); + Serial.println(intArrayToRead[i]); + } +} + +void loop(){} diff --git a/lib/EEPROM_SPI_WE/keywords.txt b/lib/EEPROM_SPI_WE/keywords.txt new file mode 100644 index 0000000..6e8b96a --- /dev/null +++ b/lib/EEPROM_SPI_WE/keywords.txt @@ -0,0 +1,70 @@ +####################################### +# Syntax Coloring Map For EEPROM_SPI_WE +####################################### + +####################################### +# Datatypes (KEYWORD1) +####################################### + +EEPROM_SPI_WE KEYWORD1 + +# ENUM TYPES +eeprom_pageSize KEYWORD1 +EEPROM_PAGE_SIZE KEYWORD1 +eeprom_writeProtect KEYWORD1 +EEPROM_WRITE_PROTECT KEYWORD1 + +####################################### +# Methods and Functions (KEYWORD2) +####################################### + +init KEYWORD2 +setPageSize KEYWORD2 +setMemorySize KEYWORD2 +getMemorySize KEYWORD2 +deepPowerDown KEYWORD2 +powerUpAndReadID KEYWORD2 +erasePage KEYWORD2 +eraseSector KEYWORD2 +eraseCompleteEEPROM KEYWORD2 +write KEYWORD2 +read KEYWORD2 +writeProtect KEYWORD2 +protectStatusRegister KEYWORD2 +get KEYWORD2 +put KEYWORD2 +isBusy KEYWORD2 +eepromReadStatusReg KEYWORD2 +setSPIClockSpeed KEYWORD2 +continuousPutEnable KEYWORD2 +continuousPut KEYWORD2 +continuousPutDisable KEYWORD2 +getString KEYWORD2 +putString KEYWORD2 +setSmallEEPROM KEYWORD2 + +####################################### +# Constants (LITERAL1) +####################################### + +# ENUM VALUES +EEPROM_KBITS_2 LITERAL1 +EEPROM_KBITS_4 LITERAL1 +EEPROM_KBITS_8 LITERAL1 +EEPROM_KBITS_16 LITERAL1 +EEPROM_KBITS_32 LITERAL1 +EEPROM_KBITS_64 LITERAL1 +EEPROM_KBITS_128 LITERAL1 +EEPROM_KBITS_256 LITERAL1 +EEPROM_KBITS_512 LITERAL1 +EEPROM_KBITS_1024 LITERAL1 +EEPROM_KBITS_2048 LITERAL1 +EEPROM_PAGE_SIZE_16 LITERAL1 +EEPROM_PAGE_SIZE_32 LITERAL1 +EEPROM_PAGE_SIZE_64 LITERAL1 +EEPROM_PAGE_SIZE_128 LITERAL1 +EEPROM_PAGE_SIZE_256 LITERAL1 +PROTECT_NONE LITERAL1 +PROTECT_UPPER_QUARTER LITERAL1 +PROTECT_UPPER_HALF LITERAL1 +PROTECT_ALL LITERAL1 \ No newline at end of file diff --git a/lib/EEPROM_SPI_WE/library.properties b/lib/EEPROM_SPI_WE/library.properties new file mode 100644 index 0000000..ad1c60b --- /dev/null +++ b/lib/EEPROM_SPI_WE/library.properties @@ -0,0 +1,10 @@ +name=EEPROM_SPI_WE +version=1.1.5 +author=Wolfgang Ewald +maintainer=Wolfgang Ewald +sentence=Library for external SPI based EEPROMs +paragraph=With this library you can directly write various variable types to the EEPROM, including large arrays. Although it does page writing, you don't have to take care about the page limits. Tested on AVR-, ESP32- and ESP8266 Boards. +category=Data Storage +url=https://github.com/wollewald/EEPROM_SPI_WE +architectures=* +includes=EEPROM_SPI_WE.h diff --git a/lib/EEPROM_SPI_WE/src/EEPROM_SPI_WE.cpp b/lib/EEPROM_SPI_WE/src/EEPROM_SPI_WE.cpp new file mode 100644 index 0000000..d4e094e --- /dev/null +++ b/lib/EEPROM_SPI_WE/src/EEPROM_SPI_WE.cpp @@ -0,0 +1,396 @@ +/***************************************************************************** +* This is a library for SPI EEPROMs like the 25LCxxx, 25Axxx, etc. +* +* In case you like it would be cool if you give it a star. +* +* If you find bugs, please inform me! +* +* Written by Wolfgang (Wolle) Ewald +* +* Here you find the detailed documentation: +* https://wolles-elektronikkiste.de/en/eeprom-part-3-external-spi-eeproms (English) +* https://wolles-elektronikkiste.de/eeprom-teil-3-externe-spi-eeproms (German) +* +*******************************************************************************/ + +#include "EEPROM_SPI_WE.h" + +/************ Basic settings ************/ + +bool EEPROM_SPI_WE::init(uint8_t sckPin, uint8_t misoPin, uint8_t mosiPin, uint8_t cs, uint8_t wp) { + csPin = cs; + wpPin = wp; + + _spi->begin(sckPin, misoPin, mosiPin, csPin); + mySPISettings = SPISettings(spiClock, MSBFIRST, SPI_MODE0); + pinMode(csPin, OUTPUT); + digitalWrite(csPin, HIGH); + contAddr = 0; + smallEEPROM = false; + memSize = 0; + + if (wpPin != 999) { + pinMode(wpPin, OUTPUT); + digitalWrite(wpPin, HIGH); + } + + pageSize = 16; + writeProtect(PROTECT_NONE); + eepromWriteStatusReg(EEP_WREN); + + if (eepromReadStatusReg() & 0x02) { + eepromWriteStatusReg(EEP_WRDI); + return true; + } else { + return false; + } +} + +bool EEPROM_SPI_WE::probe() { + eepromWriteStatusReg(EEP_WREN); + + if (eepromReadStatusReg() & 0x02) { + eepromWriteStatusReg(EEP_WRDI); + return true; + } else { + return false; + } +} + +void EEPROM_SPI_WE::setPageSize(eeprom_pageSize eps){ + pageSize = 16 << eps; +} + +void EEPROM_SPI_WE::setMemorySize(eeprom_size_t size){ + memSize = size; +} + +uint32_t EEPROM_SPI_WE::getMemorySize(){ + return memSize; +} + +void EEPROM_SPI_WE::deepPowerDown(){ + eepromWriteStatusReg(EEP_DPD); +} + +uint8_t EEPROM_SPI_WE::powerUpAndReadID(){ + uint8_t id = 0; + _spi->beginTransaction(mySPISettings); + digitalWrite(csPin, LOW); + _spi->transfer(EEP_RDID); + _spi->transfer(0xFF); // dummy address + _spi->transfer(0xFF); + id = _spi->transfer(0x00); + digitalWrite(csPin, HIGH); + _spi->endTransaction(); + while(isBusy()){} + return id; +} + +/************ read and write ************/ + +void EEPROM_SPI_WE::erasePage(uint32_t addr){ + eepromWriteEnable(); + + _spi->beginTransaction(mySPISettings); + digitalWrite(csPin, LOW); + _spi->transfer(EEP_PE); + if (memSize > EEPROM_KBITS_512) { + _spi->transfer(static_cast(addr>>16)); + } + _spi->transfer(static_cast(addr>>8)); + _spi->transfer(static_cast(addr&0xFF)); + digitalWrite(csPin, HIGH); + _spi->endTransaction(); + + while(isBusy()){} +} + +void EEPROM_SPI_WE::eraseSector(uint32_t addr){ + eepromWriteEnable(); + + _spi->beginTransaction(mySPISettings); + digitalWrite(csPin, LOW); + _spi->transfer(EEP_SE); + if (memSize > EEPROM_KBITS_512) { + _spi->transfer(static_cast(addr>>16)); + } + _spi->transfer(static_cast(addr>>8)); + _spi->transfer(static_cast(addr&0xFF)); + digitalWrite(csPin, HIGH); + _spi->endTransaction(); + + while(isBusy()){} +} + +void EEPROM_SPI_WE::eraseCompleteEEPROM(){ + if (smallEEPROM){ + //No EEP_CE instruction set available on small eeproms + for (uint32_t i = 0; i < memSize; i++) { + write(i, 0); + } + } else { + eepromWriteEnable(); + _spi->beginTransaction(mySPISettings); + digitalWrite(csPin, LOW); + _spi->transfer(EEP_CE); + digitalWrite(csPin, HIGH); + _spi->endTransaction(); + while(isBusy()){} + } +} + +void EEPROM_SPI_WE::write(uint32_t addr, uint8_t val){ + if (read(addr) != val) + writeEEPROM(addr, &val, 1); + while(isBusy()){} +} + +uint8_t EEPROM_SPI_WE::read(uint32_t addr){ + uint8_t byteVal; + readEEPROM(addr, &byteVal, 1); + return byteVal; +} + +void EEPROM_SPI_WE::writeProtect(eeprom_writeProtect sectors){ + eepromWriteEnable(); + + _spi->beginTransaction(mySPISettings); + digitalWrite(csPin, LOW); + _spi->transfer(EEP_WRSR); + _spi->transfer((sectors << 2) | 0x80); + digitalWrite(csPin, HIGH); + _spi->endTransaction(); + while(isBusy()){} +} + +void EEPROM_SPI_WE::protectStatusRegister(bool protect){ + uint8_t statusReg = eepromReadStatusReg(); + if(!protect && (wpPin != 999)){ + digitalWrite(wpPin, HIGH); + } + else if(protect && (wpPin != 999)){ + statusReg |= 0x80; + eepromWriteEnable(); + eepromWriteStatusReg(statusReg); + digitalWrite(wpPin, LOW); + } +} + +uint32_t EEPROM_SPI_WE::putString(uint32_t addr, String &strToWrite){ + int strLen = strToWrite.length() + 1; + writeEEPROM(addr, (uint8_t*)strToWrite.c_str(), strLen); + return addr + strLen; +} + +void EEPROM_SPI_WE::getString(uint32_t addr, String &strToRead){ + if(strToRead.length()){ + strToRead.remove(0,strToRead.length()); + } + uint8_t tmp = 65; // dummy + uint8_t *tmpPtr; + tmpPtr = &tmp; + while(tmp != 0){ + readEEPROM(addr, tmpPtr, 1); + if(tmp != 0){ + strToRead += static_cast(tmp); + } + addr++; + } +} + +uint8_t EEPROM_SPI_WE::eepromReadStatusReg(){ + uint8_t statusReg = 0; + + _spi->beginTransaction(mySPISettings); + digitalWrite(csPin, LOW); + _spi->transfer(EEP_RDSR); + statusReg = _spi->transfer(0x00); + digitalWrite(csPin, HIGH); + _spi->endTransaction(); + + return statusReg; +} + +bool EEPROM_SPI_WE::isBusy(){ + delayMicroseconds(50); + uint8_t statusReg = eepromReadStatusReg(); + return (statusReg & 0x01); +} + +void EEPROM_SPI_WE::setSPIClockSpeed(unsigned long clock){ + mySPISettings = SPISettings(clock, MSBFIRST, SPI_MODE0); +} + +void EEPROM_SPI_WE::setSmallEEPROM(){ + smallEEPROM = true; +} + +/************************************************ + Private Functions +*************************************************/ + +void EEPROM_SPI_WE::eepromWriteEnable(){ + eepromWriteStatusReg(EEP_WREN); +} + +void EEPROM_SPI_WE::eepromWriteStatusReg(uint8_t cmd){ + _spi->beginTransaction(mySPISettings); + digitalWrite(csPin, LOW); + _spi->transfer(cmd); + digitalWrite(csPin, HIGH); + _spi->endTransaction(); + + while(isBusy()){} +} + +void EEPROM_SPI_WE::writeEEPROM(uint32_t addr, const uint8_t *buf, uint16_t sizeOfBuf){ + uint16_t noOfBytesStillToWrite = sizeOfBuf; + uint16_t arrayIndex = 0; + + while((noOfBytesStillToWrite != 0)){ + uint16_t chunk = noOfBytesStillToWrite; + uint16_t positionInPage = addr % pageSize; + uint16_t spaceLeftInPage = pageSize - positionInPage; + + if(spaceLeftInPage < noOfBytesStillToWrite){ + chunk = spaceLeftInPage; + } + + eepromWriteEnable(); + + _spi->beginTransaction(mySPISettings); + digitalWrite(csPin, LOW); + if(!smallEEPROM){ + _spi->transfer(EEP_WRITE); + if (memSize > EEPROM_KBITS_512) { + _spi->transfer(static_cast(addr>>16)); + } + _spi->transfer(static_cast(addr>>8)); + _spi->transfer(static_cast(addr&0xFF)); + } + else{ + if(addr>>8){ + if(addr>>9){ + _spi->transfer(EEP_READ | EEP_A8 | EEP_A9); + } + else{ + _spi->transfer(EEP_READ | EEP_A8); + } + } + else { + _spi->transfer(EEP_WRITE); + } + _spi->transfer(static_cast(addr)); + } + + for(uint16_t i=arrayIndex; i<(arrayIndex + chunk); i++){ + _spi->transfer(static_cast(buf[i])); + } + + digitalWrite(csPin, HIGH); + _spi->endTransaction(); + + addr += chunk; + arrayIndex += chunk; + noOfBytesStillToWrite -= chunk; + while(isBusy()){} + } +} + +void EEPROM_SPI_WE::continuousPutEnable(uint32_t addr){ + contAddr = addr; + eepromWriteEnable(); + _spi->beginTransaction(mySPISettings); + digitalWrite(csPin, LOW); + if(!smallEEPROM){ + _spi->transfer(EEP_WRITE); + if (memSize > EEPROM_KBITS_512) { + _spi->transfer(static_cast(addr>>16)); + } + _spi->transfer(static_cast(addr>>8)); + _spi->transfer(static_cast(addr&0xFF)); + } + else{ + if(addr>>8){ + _spi->transfer(EEP_WRITE | EEP_A8); + } + else { + _spi->transfer(EEP_WRITE); + } + _spi->transfer(static_cast(addr)); + } +} + +void EEPROM_SPI_WE::continuousPutDisable(){ + digitalWrite(csPin, HIGH); + _spi->endTransaction(); + while(isBusy()); +} + +void EEPROM_SPI_WE::continuousWriteEEPROM(const uint8_t *buf, uint16_t sizeOfBuf){ + uint16_t noOfBytesStillToWrite = sizeOfBuf; + uint16_t arrayIndex = 0; + + while((noOfBytesStillToWrite != 0)){ + uint16_t chunk = noOfBytesStillToWrite; + uint16_t positionInPage = contAddr % pageSize; + uint16_t spaceLeftInPage = pageSize - positionInPage; + bool pageEnd = false; + + if(spaceLeftInPage < noOfBytesStillToWrite){ + chunk = spaceLeftInPage; + pageEnd = true; + } + + for(uint16_t i=arrayIndex; i<(arrayIndex + chunk); i++){ + _spi->transfer(static_cast(buf[i])); + } + + contAddr += chunk; + arrayIndex += chunk; + noOfBytesStillToWrite -= chunk; + if(pageEnd){ + digitalWrite(csPin, HIGH); + _spi->endTransaction(); + while(isBusy()){} + continuousPutEnable(contAddr); + pageEnd = false; + } + } +} + +void EEPROM_SPI_WE::readEEPROM(uint32_t addr, uint8_t *buf, uint16_t sizeOfBuf){ + _spi->beginTransaction(mySPISettings); + digitalWrite(csPin, LOW); + if(!smallEEPROM){ + _spi->transfer(EEP_READ); + if (memSize > EEPROM_KBITS_512) { + _spi->transfer(static_cast(addr>>16)); + } + _spi->transfer(static_cast(addr>>8)); + _spi->transfer(static_cast(addr&0xFF)); + } + else{ + if(addr>>8){ + if(addr>>9){ + _spi->transfer(EEP_READ | EEP_A8 | EEP_A9); + } + else{ + _spi->transfer(EEP_READ | EEP_A8); + } + } + else { + _spi->transfer(EEP_READ); + } + _spi->transfer(static_cast(addr)); + } + for(uint16_t i=0; itransfer(0x00); + } + digitalWrite(csPin, HIGH); + _spi->endTransaction(); +} + + + diff --git a/lib/EEPROM_SPI_WE/src/EEPROM_SPI_WE.h b/lib/EEPROM_SPI_WE/src/EEPROM_SPI_WE.h new file mode 100644 index 0000000..1e95102 --- /dev/null +++ b/lib/EEPROM_SPI_WE/src/EEPROM_SPI_WE.h @@ -0,0 +1,137 @@ +/****************************************************************************** +* This is a library for SPI EEPROMs like the 25LCxxx, 25Axxx, etc. +* +* In case you like it would be cool if you give it a star. +* +* If you find bugs, please inform me! +* +* Written by Wolfgang (Wolle) Ewald +* +* Here you find the detailed documentation: +* https://wolles-elektronikkiste.de/en/eeprom-part-3-external-spi-eeproms (English) +* https://wolles-elektronikkiste.de/eeprom-teil-3-externe-spi-eeproms (German) +* +********************************************************************************/ + +#ifndef EEPROM_SPI_WE_H_ +#define EEPROM_SPI_WE_H_ + +#if ARDUINO < 100 +#include +#else +#include +#endif + +#include + +typedef enum EEPROM_WE_PAGE_SIZE { + EEPROM_PAGE_SIZE_16, EEPROM_PAGE_SIZE_32, EEPROM_PAGE_SIZE_64, EEPROM_PAGE_SIZE_128, EEPROM_PAGE_SIZE_256 +} eeprom_pageSize; + +typedef enum EEPROM_WE_WRITE_PROTECT { + PROTECT_NONE, PROTECT_UPPER_QUARTER, PROTECT_UPPER_HALF, PROTECT_ALL +} eeprom_writeProtect; + +enum eeprom_size_t { + EEPROM_KBITS_2 = 256, + EEPROM_KBITS_4 = 512, + EEPROM_KBITS_8 = 1024, + EEPROM_KBITS_16 = 2028, + EEPROM_KBITS_32 = 4096, + EEPROM_KBITS_64 = 8192, + EEPROM_KBITS_128 = 16384, + EEPROM_KBITS_256 = 32768, + EEPROM_KBITS_512 = 65536, + EEPROM_KBITS_1024 = 131072, + EEPROM_KBITS_2048 = 262144, + EEPROM_KBITS_4096 = 524288, +}; + +class EEPROM_SPI_WE +{ + public: + static constexpr uint8_t EEP_READ {0x03}; // write + static constexpr uint8_t EEP_WRITE{0x02}; // read + static constexpr uint8_t EEP_WREN {0x06}; // write enable + static constexpr uint8_t EEP_WRDI {0x04}; // write disable + static constexpr uint8_t EEP_RDSR {0x05}; // read status register + static constexpr uint8_t EEP_WRSR {0x01}; // write status register + static constexpr uint8_t EEP_PE {0x42}; // page erase + static constexpr uint8_t EEP_SE {0xD8}; // sector erase + static constexpr uint8_t EEP_CE {0xC7}; // chip erase + static constexpr uint8_t EEP_RDID {0xAB}; // release from deep power down and read electronic signature + static constexpr uint8_t EEP_DPD {0xB9}; // deep power down mode + static constexpr uint8_t EEP_A8 {0x08}; // A8 address bit for small EEPROMs + static constexpr uint8_t EEP_A9 {0x10}; // A9 address bit for small EEPROMs + + EEPROM_SPI_WE(uint16_t cs, uint16_t wp = 999, uint32_t sc = 8000000) : _spi{&SPI}, csPin{cs}, wpPin{wp}, spiClock{sc} {} + EEPROM_SPI_WE(SPIClass *s, uint16_t cs, uint16_t wp = 999, uint32_t sc = 8000000) : _spi{s}, csPin{cs}, wpPin{wp}, spiClock{sc} {} + EEPROM_SPI_WE() : _spi{&SPI}, csPin{5}, wpPin{999}, spiClock{8000000} {} + bool init(uint8_t sckPin, uint8_t misoPin, uint8_t mosiPin, uint8_t cs, uint8_t wp); + bool probe(); + uint32_t getMemorySize(); //neu + void setPageSize(eeprom_pageSize eps); + void setMemorySize(eeprom_size_t size); // neu + void deepPowerDown(); + uint8_t powerUpAndReadID(); + void erasePage(uint32_t addr); + void eraseSector(uint32_t addr); + void eraseCompleteEEPROM(); + void write(uint32_t addr, uint8_t val); + uint8_t read(uint32_t addr); + void writeProtect(eeprom_writeProtect sectors); + void protectStatusRegister(bool protect = true); + + template + T &get(uint32_t addr, T &t){ + uint8_t *data = (uint8_t *)&t; + readEEPROM(addr, data, sizeof(T)); + return t; + } + + template + const T &put(uint32_t addr, const T &t){ + const uint8_t *data = (const uint8_t *)&t; + writeEEPROM(addr, data, sizeof(T)); + return t; + } + + uint32_t putString(uint32_t addr, String &strToWrite); + void getString(uint32_t addr, String &strToRead); + + void continuousPutEnable(uint32_t addr); + void continuousPutDisable(); + + template + const T &continuousPut(const T &t){ + const uint8_t *data = (const uint8_t *)&t; + continuousWriteEEPROM(data, sizeof(T)); + return t; + } + + bool isBusy(); + uint8_t eepromReadStatusReg(); + void setSPIClockSpeed(unsigned long clock); + void setSmallEEPROM(); + + protected: + SPIClass *_spi; + SPISettings mySPISettings; + uint16_t csPin; + uint16_t wpPin; + uint32_t spiClock; + uint16_t pageSize; + uint32_t contAddr; + bool smallEEPROM; + uint32_t memSize; + + void eepromWriteEnable(); + void eepromWriteStatusReg(uint8_t cmd); + void writeEEPROM(uint32_t addr, const uint8_t *buf, uint16_t sizeOfBuf); + void continuousWriteEEPROM(const uint8_t *buf, uint16_t sizeOfBuf); + void readEEPROM(uint32_t addr, uint8_t *buf, uint16_t sizeOfBuf); +}; + +#endif + + diff --git a/lib/IRremote/.github/ISSUE_TEMPLATE/bug_report.yml b/lib/IRremote/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 0000000..95c4245 --- /dev/null +++ b/lib/IRremote/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,227 @@ +name: "🐛 Bug Report" +description: Only if something isn't working as expected 🤔, otherwise please open a discussion. +title: "[Bug]: " + +body: + - type: markdown + attributes: + value: | + **Thanks for reporting an issue!** + + **Issues are expected to lead to changes in the repository, like code or documentation improvements or bug fixes.** + If you have handling problems or questions, consider to post in [Discussions](../discussions) instead. + + # Environment + + - type: dropdown + id: Board + attributes: + label: The type of board you are using. + options: + - Arduino ATmega328* board (Uno, Nano, etc.) + - Arduino ATmega2560 board (Mega) + - Arduino ATmega32U4 board (Leonardo, etc.) + - Arduino ATmega4809 megaAVR board (NanoEvery) + - Arduino SAM board (Due) + - Arduino SAMD board (Zero, MKR*) + - ATtiny85 board (ATTinyCore by Spence Conde) + - Digispark board + - ATtiny3217 board (TinyCore) + - ESP32 board - first check https://github.com/crankyoldgit/IRremoteESP8266 + - STM32F1 board (BluePill) + - Teensy board + - Other - please specify below + validations: + required: true + + - type: input + id: Other_board_NAME_FQBN + attributes: + label: The boards name or FQBN (e.g. esp8266:esp8266:d1_mini:eesz=4M3M,xtal=80) for unspecified board. + validations: + required: false + + - type: input + id: Other_board_URL + attributes: + label: The board manager URL used for unspecified board. + value: "https://" + validations: + required: false + + - type: dropdown + id: IDE + attributes: + label: What IDE are you using? + options: + - Arduino IDE + - Arduino Web Editor + - Arduino Pro IDE + - Sloeber IDE + - PlatformIO IDE + - Other - please specify below + multiple: false + validations: + required: true + + - type: dropdown + id: IR_Protocol + attributes: + label: What IR protocol are you using? + options: + - Unknown + - BoseWave + - Denon + - Dish + - FAST + - JVC + - Lego + - LG + - NEC + - Panasonic + - RC5, RC6 + - Samsung + - Sharp + - Sony + - Whynter + - Other - please specify below + multiple: true + validations: + required: true + + - type: input + id: IR_Pin + attributes: + label: Pin(s) used for IR-receive, if not default. + value: "Arduino pin number: default" + validations: + required: false + + - type: checkboxes + id: Checked_examples + attributes: + label: Example(s) you have checked while hunting the bug. + description: Please do not submit a bug report without testing at least one or more examples! + options: + - label: SimpleReceiver + - label: ReceiveDemo + - label: SendRawDemo + - label: ReceiverTimingAnalysis + - label: TinyReceiver + - label: TinySender + - label: ReceiveAndSend + - label: SimpleSender + - label: SendDemo + - label: SendLGAirConditionerDemo + - label: UnitTest + - label: Other - please specify below + - label: I checked, if at least one of the examples was working. + required: true + + - type: checkboxes + id: Failed_examples + attributes: + label: Example(s) to reproduce the issue. + description: Select only the examples which shows your error. + options: + - label: SimpleReceiver + - label: ReceiveDemo + - label: SendRawDemo + - label: ReceiverTimingAnalysis + - label: TinyReceiver + - label: TinySender + - label: ReceiveAndSend + - label: SimpleSender + - label: SendDemo + - label: SendLGAirConditionerDemo + - label: UnitTest + - label: Other - please specify below + + - type: checkboxes + id: Version + attributes: + label: The library version you are working with. + description: | + You may use the latest repo version, which is not (yet) released, but may contain some bugfixes. + Your current library version number can be found with *Arduino > Tools > Manage Libraries..* (Ctrl+Shift+I) + and is printed to serial output at the startup of every example. + options: + - label: I use the [latest Arduino library version](../releases) and verified this! + - label: I use the latest repo version ([download link](../archive/master.zip)) and verified this! + + - type: markdown + attributes: + value: | + # Bug descripion + + - type: textarea + id: bug-steps + attributes: + label: What are the steps to reproduce this issue? + placeholder: | + 1. + 2. + 3. + 4. See error + validations: + required: true + + - type: textarea + id: bug-description + attributes: + label: What happens? + description: A clear and concise description of what the bug is. + validations: + required: true + + - type: textarea + id: bug-logs + attributes: + label: The serial output which indicates the error happened. + description: | + Please copy and paste any relevant serial output. This will be automatically formatted into code, so no need for backticks. + render: shell + validations: + required: false + + - type: textarea + id: bug-expectation + attributes: + label: What were you expecting to happen? + description: A clear and concise description of what was supposed to happen. + validations: + required: false + + - type: textarea + id: bug-context + attributes: + label: Additional context. + description: Add any other context you can provide about the problem here. + validations: + required: false + + - type: markdown + attributes: + value: | + # Checklist + + - type: checkboxes + id: Commitments + attributes: + label: Final checklist for the bug report. + options: + - label: I have **read** the README.md file thoroughly + required: true + - label: I have searched existing issues to see if there is anything I have missed. + required: true + - label: I have browsed the examples for one, that matches my use case. + required: true + - label: The title of the issue is helpful and relevant. + required: true + + - type: markdown + attributes: + value: | + ** We will start to close or delete issues that do not follow these guidelines + as it doesn't help the contributors who spend time trying to solve issues if the community ignores guidelines!** + diff --git a/lib/IRremote/.github/ISSUE_TEMPLATE/config.yml b/lib/IRremote/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..3ba13e0 --- /dev/null +++ b/lib/IRremote/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1 @@ +blank_issues_enabled: false diff --git a/lib/IRremote/.github/workflows/LibraryBuild.yml b/lib/IRremote/.github/workflows/LibraryBuild.yml new file mode 100644 index 0000000..c6dbb9b --- /dev/null +++ b/lib/IRremote/.github/workflows/LibraryBuild.yml @@ -0,0 +1,312 @@ +# https://github.com/Arduino-IRremote/Arduino-IRremote/blob/master/.github/workflows/LibraryBuild.yml +# Github workflow script to test compile all examples of an Arduino library repository. +# +# Copyright (C) 2020-2023 Armin Joachimsmeyer +# https://github.com/ArminJo/Github-Actions +# +# Before being able to push to my .github\workflows directories, +# I had to create a new personal token with workflow enabled at https://github.com/settings/tokens + +# This is the name of the workflow, visible on GitHub UI. +name: LibraryBuild +on: + workflow_dispatch: # To run it manually + description: 'manual build check' + push: # see: https://help.github.com/en/actions/reference/events-that-trigger-workflows#pull-request-event-pull_request + paths: + - '**.ino' + - '**.cpp' + - '**.hpp' + - '**.h' + - '**LibraryBuild.yml' + pull_request: + paths: + - '**.ino' + - '**.cpp' + - '**.hpp' + - '**.h' + - '**LibraryBuild.yml' + +jobs: + build: + name: ${{ matrix.arduino-boards-fqbn }} - test compiling examples + + runs-on: ubuntu-22.04 # I picked Ubuntu to use shell scripts. + + strategy: + matrix: + # The matrix will produce one job for each configuration parameter of type `arduino-boards-fqbn` + # In the Arduino IDE, the fqbn is printed in the first line of the verbose output for compilation as parameter -fqbn=... for the "arduino-builder -dump-prefs" command + # + # Examples: arduino:avr:uno, arduino:avr:leonardo, arduino:avr:nano, arduino:avr:mega + # arduino:sam:arduino_due_x, arduino:samd:arduino_zero_native" + # ATTinyCore:avr:attinyx5:chip=85,clock=1internal + # STMicroelectronics:stm32:GenF1:pnum=BLUEPILL_F103C8 + # esp8266:esp8266:huzzah:eesz=4M3M,xtal=80, esp32:esp32:featheresp32:FlashFreq=80 + # You may add a suffix behind the fqbn with "|" to specify one board for e.g. different compile options like arduino:avr:uno|trace + ############################################################################################################# + arduino-boards-fqbn: + - arduino:avr:uno + - arduino:avr:uno|DEBUG + - arduino:avr:uno|USE_NO_SEND_PWM + - arduino:avr:uno|SEND_PWM_BY_TIMER + - arduino:avr:uno|USE_OPEN_DRAIN_OUTPUT_FOR_SEND_PIN + - arduino:avr:mega:cpu=atmega2560 + - arduino:avr:leonardo + - arduino:megaavr:nona4809:mode=off + - arduino:samd:arduino_zero_native + - arduino:renesas_uno:unor4wifi + - adafruit:samd:adafruit_metro_m4:cache=on,speed=120,opt=small,maxqspi=50,usbstack=arduino,debug=off + - arduino:mbed:nano33ble + - arduino:mbed_rp2040:pico + - rp2040:rp2040:arduino_nano_connect +# - ATTinyCore:avr:attinyx5micr:LTO=enable,sketchclock=16pll +# - ATTinyCore:avr:attinyx7micr:LTO=enable,sketchclock=16external,pinmapping=new,millis=enabled +# - ATTinyCore:avr:attinyx8micr:LTO=enable,sketchclock=16external,pinmapping=mhtiny,millis=enabled # ATtiny88 China clone board @16 MHz + - MegaCore:avr:128:bootloader=no_bootloader,eeprom=keep,BOD=2v7,LTO=Os_flto,clock=8MHz_internal # ATmega128 + - SparkFun:avr:promicro +# - megaTinyCore:megaavr:atxy4:chip=1604,clock=16internal # https://github.com/SpenceKonde/megaTinyCore/issues/935 +# - megaTinyCore:megaavr:atxy7:chip=3217,clock=16internal # https://github.com/SpenceKonde/megaTinyCore/issues/935 + - esp8266:esp8266:d1_mini:eesz=4M3M,xtal=80 + - esp32:esp32:featheresp32:FlashFreq=80 + - esp32:esp32:esp32c3 + - STMicroelectronics:stm32:GenF1:pnum=BLUEPILL_F103C8 + - STMicroelectronics:stm32:GenL0:pnum=THUNDERPACK_L072 + - stm32duino:STM32F1:genericSTM32F103C + - sandeepmistry:nRF5:BBCmicrobit + - Seeeduino:samd:seeed_XIAO_m0:usbstack=arduino,debug=off,sercom4=include + + # Specify parameters for each board. + # With sketches-exclude you may exclude specific examples for a board. Use a comma separated list. + ############################################################################################################# + include: + - arduino-boards-fqbn: arduino:avr:uno + build-properties: # the flags were put in compiler.cpp.extra_flags + ReceiveDemo: -DIR_REMOTE_DISABLE_RECEIVE_COMPLETE_CALLBACK + IRremoteExtensionTest: -DRAW_BUFFER_LENGTH=1200 -DIR_SEND_PIN=3 + + - arduino-boards-fqbn: arduino:avr:uno|DEBUG + build-properties: # the flags were put in compiler.cpp.extra_flags + IRremoteExtensionTest: -DRAW_BUFFER_LENGTH=750 -DIR_SEND_PIN=3 + TinyReceiver: -DUSE_CALLBACK_FOR_TINY_RECEIVER + All: -DEBUG + + - arduino-boards-fqbn: arduino:avr:uno|USE_NO_SEND_PWM + build-properties: # the flags were put in compiler.cpp.extra_flags + IRremoteExtensionTest: -DRAW_BUFFER_LENGTH=750 -DIR_SEND_PIN=3 + TinyReceiver: -DUSE_FAST_PROTOCOL + TinySender: -DUSE_FAST_PROTOCOL + All: -DUSE_NO_SEND_PWM + + - arduino-boards-fqbn: arduino:avr:uno|SEND_PWM_BY_TIMER + sketches-exclude: UnitTest + build-properties: # the flags were put in compiler.cpp.extra_flags + IRremoteExtensionTest: -DRAW_BUFFER_LENGTH=750 -DIR_SEND_PIN=3 -DSEND_PWM_BY_TIMER + ReceiveDemo: -DDECODE_ONKYO + TinyReceiver: -DUSE_ONKYO_PROTOCOL + TinySender: -DUSE_ONKYO_PROTOCOL + All: -DSEND_PWM_BY_TIMER + + - arduino-boards-fqbn: arduino:avr:uno|USE_OPEN_DRAIN_OUTPUT_FOR_SEND_PIN + build-properties: # the flags were put in compiler.cpp.extra_flags + IRremoteExtensionTest: -DRAW_BUFFER_LENGTH=750 -DIR_SEND_PIN=3 -DUSE_OPEN_DRAIN_OUTPUT_FOR_SEND_PIN + SimpleSender: -DSEND_PWM_BY_TIMER + TinyReceiver: -DENABLE_NEC2_REPEATS + TinySender: -DENABLE_NEC2_REPEATS + All: -DUSE_OPEN_DRAIN_OUTPUT_FOR_SEND_PIN + + - arduino-boards-fqbn: arduino:avr:mega:cpu=atmega2560 + build-properties: # the flags were put in compiler.cpp.extra_flags + IRremoteExtensionTest: -DRAW_BUFFER_LENGTH=750 + SimpleSender: -DSEND_PWM_BY_TIMER + TinyReceiver: -DDISABLE_PARITY_CHECKS + TinySender: -DDISABLE_PARITY_CHECKS + + - arduino-boards-fqbn: arduino:avr:leonardo + build-properties: # the flags were put in compiler.cpp.extra_flags + IRremoteExtensionTest: -DRAW_BUFFER_LENGTH=750 + TinyReceiver: -DNO_LED_FEEDBACK_CODE + TinySender: -DNO_LED_FEEDBACK_CODE +# sketches-exclude: ReceiveAndSend # Not enough RAM for default RAW_BUFFER_LENGTH + + - arduino-boards-fqbn: arduino:megaavr:nona4809:mode=off + sketches-exclude: TinyReceiver,IRDispatcherDemo + build-properties: # the flags were put in compiler.cpp.extra_flags + IRremoteExtensionTest: -DRAW_BUFFER_LENGTH=750 + SimpleSender: -DSEND_PWM_BY_TIMER + TinyReceiver: -DUSE_ONKYO_PROTOCOL -DENABLE_NEC2_REPEATS -DNO_LED_FEEDBACK_CODE -DUSE_CALLBACK_FOR_TINY_RECEIVER + TinySender: -DUSE_ONKYO_PROTOCOL -DENABLE_NEC2_REPEATS -DNO_LED_FEEDBACK_CODE + + - arduino-boards-fqbn: arduino:samd:arduino_zero_native + sketches-exclude: TinyReceiver,IRDispatcherDemo + build-properties: # the flags were put in compiler.cpp.extra_flags + IRremoteExtensionTest: -DRAW_BUFFER_LENGTH=750 + + - arduino-boards-fqbn: arduino:renesas_uno:unor4wifi + sketches-exclude: TinyReceiver,IRDispatcherDemo + build-properties: # the flags were put in compiler.cpp.extra_flags + IRremoteExtensionTest: -DRAW_BUFFER_LENGTH=750 + + - arduino-boards-fqbn: adafruit:samd:adafruit_metro_m4:cache=on,speed=120,opt=small,maxqspi=50,usbstack=arduino,debug=off + platform-url: https://adafruit.github.io/arduino-board-index/package_adafruit_index.json + sketches-exclude: TinyReceiver,IRDispatcherDemo + build-properties: # the flags were put in compiler.cpp.extra_flags + IRremoteExtensionTest: -DRAW_BUFFER_LENGTH=750 + + - arduino-boards-fqbn: arduino:mbed:nano33ble + build-properties: # the flags were put in compiler.cpp.extra_flags + IRremoteExtensionTest: -DRAW_BUFFER_LENGTH=750 + SimpleSender: -DSEND_PWM_BY_TIMER + +# +# RP2040 +# + - arduino-boards-fqbn: arduino:mbed_rp2040:pico + build-properties: # the flags were put in compiler.cpp.extra_flags + IRremoteExtensionTest: -DRAW_BUFFER_LENGTH=750 + SimpleSender: -DSEND_PWM_BY_TIMER + + - arduino-boards-fqbn: rp2040:rp2040:arduino_nano_connect + platform-url: https://github.com/earlephilhower/arduino-pico/releases/download/global/package_rp2040_index.json + build-properties: # the flags were put in compiler.cpp.extra_flags + IRremoteExtensionTest: -DSEND_PWM_BY_TIMER + SimpleSender: -DSEND_PWM_BY_TIMER + All: -DRAW_BUFFER_LENGTH=750 + +# +# megaTinyCore +# +# https://github.com/SpenceKonde/megaTinyCore/issues/935 +# - arduino-boards-fqbn: megaTinyCore:megaavr:atxy4:chip=1604,clock=16internal +# arduino-platform: megaTinyCore:megaavr +# platform-url: http://drazzy.com/package_drazzy.com_index.json +# sketches-exclude: AllProtocolsOnLCD +# build-properties: # the flags were put in compiler.cpp.extra_flags +# IRremoteExtensionTest: -DRAW_BUFFER_LENGTH=360 + +# https://github.com/SpenceKonde/megaTinyCore/issues/935 +# - arduino-boards-fqbn: megaTinyCore:megaavr:atxy7:chip=3217,clock=16internal +# arduino-platform: megaTinyCore:megaavr +# platform-url: http://drazzy.com/package_drazzy.com_index.json +# sketches-exclude: AllProtocolsOnLCD +# build-properties: # the flags were put in compiler.cpp.extra_flags +# IRremoteExtensionTest: -DRAW_BUFFER_LENGTH=360 + +# +# ATTinyCore +# +# - arduino-boards-fqbn: ATTinyCore:avr:attinyx5micr:LTO=enable,sketchclock=16pll +# platform-url: http://drazzy.com/package_drazzy.com_index.json +# required-libraries: ATtinySerialOut +# sketch-names: TinyReceiver.ino,IRremoteInfo.ino,SimpleReceiver.ino,ReceiveDemo.ino,ControlRelay.ino,SimpleSender.ino,SendDemo.ino,SendRawDemo.ino,SendAndReceive.ino +# build-properties: # the flags were put in compiler.cpp.extra_flags +# SimpleSender: -DSEND_PWM_BY_TIMER + +# - arduino-boards-fqbn: ATTinyCore:avr:attinyx7micr:LTO=enable,sketchclock=16external,pinmapping=new,millis=enabled +# platform-url: http://drazzy.com/package_drazzy.com_index.json +# required-libraries: ATtinySerialOut +# sketch-names: TinyReceiver.ino,IRremoteInfo.ino,SimpleReceiver.ino,ReceiveDemo.ino,ControlRelay.ino,SimpleSender.ino,SendDemo.ino,SendRawDemo.ino,SendAndReceive.ino +# build-properties: # the flags were put in compiler.cpp.extra_flags +# SimpleSender: -DSEND_PWM_BY_TIMER + +# - arduino-boards-fqbn: ATTinyCore:avr:attinyx8micr:LTO=enable,sketchclock=16external,pinmapping=mhtiny,millis=enabled # ATtiny88 China clone board @16 MHz +# platform-url: http://drazzy.com/package_drazzy.com_index.json +# required-libraries: ATtinySerialOut +# sketch-names: TinyReceiver.ino,IRremoteInfo.ino,SimpleReceiver.ino,ReceiveDemo.ino,ControlRelay.ino,SimpleSender.ino,SendDemo.ino,SendRawDemo.ino,SendAndReceive.ino +# build-properties: # the flags were put in compiler.cpp.extra_flags +# SimpleSender: -DSEND_PWM_BY_TIMER + +# +# MegaCore +# + - arduino-boards-fqbn: MegaCore:avr:128:bootloader=no_bootloader,eeprom=keep,BOD=2v7,LTO=Os_flto,clock=8MHz_internal + platform-url: https://mcudude.github.io/MegaCore/package_MCUdude_MegaCore_index.json + arduino-platform: arduino:avr,MegaCore:avr # gcc is taken from arduino:avr + build-properties: # the flags were put in compiler.cpp.extra_flags + SimpleSender: -DSEND_PWM_BY_TIMER + All: -DRAW_BUFFER_LENGTH=750 + +# +# ESP +# + - arduino-boards-fqbn: esp8266:esp8266:d1_mini:eesz=4M3M,xtal=80 + platform-url: https://arduino.esp8266.com/stable/package_esp8266com_index.json + sketches-exclude: TinyReceiver + build-properties: # the flags were put in compiler.cpp.extra_flags + All: -DRAW_BUFFER_LENGTH=750 + + - arduino-boards-fqbn: esp32:esp32:featheresp32:FlashFreq=80 + platform-url: https://raw.githubusercontent.com/espressif/arduino-esp32/gh-pages/package_esp32_index.json + arduino-platform: esp32:esp32@2.0.17 # latest 2.x version as of 5/2024 + sketches-exclude: TinyReceiver # undefined reference to `TwoWire::onReceive(void (*)(int))' + build-properties: # the flags were put in compiler.cpp.extra_flags. SEND_PWM_BY_TIMER is always enabled! + IRremoteExtensionTest: -Wno-error=maybe-uninitialized + All: -DRAW_BUFFER_LENGTH=750 -Wno-error=maybe-uninitialized # https://github.com/espressif/arduino-esp32/issues/7024 + + - arduino-boards-fqbn: esp32:esp32:esp32c3 + platform-url: https://raw.githubusercontent.com/espressif/arduino-esp32/gh-pages/package_esp32_index.json + arduino-platform: esp32:esp32@2.0.17 # latest 2.x version as of 5/2024 + sketches-exclude: TinyReceiver # undefined reference to `TwoWire::onReceive(void (*)(int))' + build-properties: # the flags were put in compiler.cpp.extra_flags. SEND_PWM_BY_TIMER is always enabled! + IRremoteExtensionTest: -Wno-error=maybe-uninitialized + All: -DRAW_BUFFER_LENGTH=750 -Wno-error=maybe-uninitialized # https://github.com/espressif/arduino-esp32/issues/7024 + +# +# STM +# + - arduino-boards-fqbn: STMicroelectronics:stm32:GenF1:pnum=BLUEPILL_F103C8 # ST version + platform-url: https://raw.githubusercontent.com/stm32duino/BoardManagerFiles/main/package_stmicroelectronics_index.json + sketches-exclude: TinyReceiver + build-properties: # the flags were put in compiler.cpp.extra_flags + All: -DRAW_BUFFER_LENGTH=750 + + - arduino-boards-fqbn: STMicroelectronics:stm32:GenL0:pnum=THUNDERPACK_L072 # ST version + platform-url: https://raw.githubusercontent.com/stm32duino/BoardManagerFiles/main/package_stmicroelectronics_index.json + sketches-exclude: TinyReceiver,IRDispatcherDemo + build-properties: # the flags were put in compiler.cpp.extra_flags + All: -DRAW_BUFFER_LENGTH=750 + + - arduino-boards-fqbn: stm32duino:STM32F1:genericSTM32F103C # Roger Clark version + platform-url: http://dan.drown.org/stm32duino/package_STM32duino_index.json + sketches-exclude: TinyReceiver + build-properties: # the flags were put in compiler.cpp.extra_flags + All: -DRAW_BUFFER_LENGTH=750 + +# +# Others +# + - arduino-boards-fqbn: SparkFun:avr:promicro + arduino-platform: arduino:avr,SparkFun:avr + platform-url: https://raw.githubusercontent.com/sparkfun/Arduino_Boards/master/IDE_Board_Manager/package_sparkfun_index.json # Arduino URL is not required here + build-properties: # the flags were put in compiler.cpp.extra_flags. SEND_PWM_BY_TIMER is always enabled! + All: -DRAW_BUFFER_LENGTH=750 + + - arduino-boards-fqbn: sandeepmistry:nRF5:BBCmicrobit + platform-url: https://sandeepmistry.github.io/arduino-nRF5/package_nRF5_boards_index.json + sketches-exclude: IRDispatcherDemo,MicroGirs,TinyReceiver + build-properties: # the flags were put in compiler.cpp.extra_flags + All: -DRAW_BUFFER_LENGTH=750 + + - arduino-boards-fqbn: Seeeduino:samd:seeed_XIAO_m0:usbstack=arduino,debug=off,sercom4=include + platform-url: https://files.seeedstudio.com/arduino/package_seeeduino_boards_index.json + sketches-exclude: AllProtocolsOnLCD,UnitTest,ReceiveAndSendDistanceWidth # No print(uint64_t,.) available + build-properties: # the flags were put in compiler.cpp.extra_flags + All: -DRAW_BUFFER_LENGTH=750 + +# fail-fast: false # false -> do not cancel all jobs / architectures if one job fails + + steps: + - name: Checkout + uses: actions/checkout@master + + - name: Compile all examples using the arduino-test-compile action + uses: ArminJo/arduino-test-compile@master + with: + arduino-board-fqbn: ${{ matrix.arduino-boards-fqbn }} + arduino-platform: ${{ matrix.arduino-platform }} + platform-url: ${{ matrix.platform-url }} + required-libraries: ${{ matrix.required-libraries }} + sketch-names: ${{ matrix.sketch-names }} + sketches-exclude: ${{ matrix.sketches-exclude }} + build-properties: ${{ toJson(matrix.build-properties) }} + cli-version: 0.33.0 # to avoid errors for ATTinyCore diff --git a/lib/IRremote/.github/workflows/PlatformIoPublish.yml b/lib/IRremote/.github/workflows/PlatformIoPublish.yml new file mode 100644 index 0000000..cc9b32a --- /dev/null +++ b/lib/IRremote/.github/workflows/PlatformIoPublish.yml @@ -0,0 +1,43 @@ +# PlatformIoPublish.yml +# Github workflow script to publish a release to PlatformIo. +# +# Copyright (C) 2021-2023 Armin Joachimsmeyer +# https://github.com/ArminJo/Github-Actions +# + +# This is the name of the workflow, visible on GitHub UI. +name: PlatformIo publishing +on: + workflow_dispatch: # To run it manually + description: manual PlatformIo publishing + release: # see: https://docs.github.com/en/actions/learn-github-actions/events-that-trigger-workflows#example-using-multiple-events-with-activity-types-or-configuration + types: + - created + +jobs: + publish: + runs-on: ubuntu-latest + steps: + + - name: Checkout + uses: actions/checkout@master + + - name: Set up Python + uses: actions/setup-python@master + with: + python-version: '3.x' + + - name: Install dependencies + run: | + python -m pip install --upgrade pip + pip install platformio + + - name: Build and publish + env: + PLATFORMIO_AUTH_TOKEN: ${{ secrets.PLATFORMIO_TOKEN }} + run: | + pio package publish --owner arminjo --non-interactive +# run: | +# pio package pack +# pio package publish --owner arminjo --non-interactive + \ No newline at end of file diff --git a/lib/IRremote/.gitignore b/lib/IRremote/.gitignore new file mode 100644 index 0000000..0c91411 --- /dev/null +++ b/lib/IRremote/.gitignore @@ -0,0 +1,4 @@ +nbproject +api-doc +*~ +docs diff --git a/lib/IRremote/.piopm b/lib/IRremote/.piopm new file mode 100644 index 0000000..780e0a0 --- /dev/null +++ b/lib/IRremote/.piopm @@ -0,0 +1 @@ +{"type": "library", "name": "IRremote", "version": "4.4.1", "spec": {"owner": "z3t0", "id": 4, "name": "IRremote", "requirements": null, "uri": null}} \ No newline at end of file diff --git a/lib/IRremote/Contributing.md b/lib/IRremote/Contributing.md new file mode 100644 index 0000000..4424f80 --- /dev/null +++ b/lib/IRremote/Contributing.md @@ -0,0 +1,47 @@ +# Contributing +This library is the culmination of the expertise of many members of the open source community who have dedicated their time and hard work. + +If you want to contribute to this project: +- Report bugs and errors +- Ask for enhancements +- Create issues and pull requests +- Tell other people about this library +- Contribute new protocols + +## Guidelines +The following are some guidelines to observe when creating discussions / PRs: +#### Be friendly +It is important that we can all enjoy a safe space as we are all working on the same project and **it is okay for people to have different ideas**. +#### Use reasonable titles +Refrain from using overly long or capitalized titles as they are usually annoying and do little to encourage others to help :smile:. +#### Use the formatting style +We use the original [C Style by Kerninghan / Ritchie](https://en.wikipedia.org/wiki/Indentation_style#K&R_style) in [variant: 1TBS (OTBS)](https://en.wikipedia.org/wiki/Indentation_style#Variant:_1TBS_(OTBS)).
+In short: 4 spaces indentation, no tabs, opening braces on the same line, braces are mandatory on all if/while/do, no hard line length limit.
+To beautify your code, you may use the online formatter [here](https://www.freecodeformat.com/c-format.php). +#### Cover **all** occurences of the problem / addition you address with your PR + Do not forget the documentation like it is done for existing code. Code changes without proper documentation will be rejected! + +## Adding new protocols +To add a new protocol is quite straightforward. Best is too look at the existing protocols to find a similar one and modify it.
+As a rule of thumb, it is easier to work with a description of the protocol rather than trying to entirely reverse-engineer the protocol. +Please include a link to the description in the header, if you found one.
+The **durations** you receive are likely to be longer for marks and shorter for spaces than the protocol suggests, +but this depends on the receiver circuit in use. Most protocols use multiples of one time-unit for marks and spaces like e.g. [NEC](https://github.com/Arduino-IRremote/Arduino-IRremote/blob/master/src/ir_NEC.hpp#L62). It's easy to be off-by-one with the last bit, since the last space is not recorded by IRremote. + +Try to make use of the template functions `decodePulseDistanceData()` and `sendPulseDistanceData()`. +If your protocol supports address and code fields, try to reflect this in your api like it is done in [`sendNEC(uint16_t aAddress, uint8_t aCommand, int_fast8_t aNumberOfRepeats, bool aIsRepeat)`](https://github.com/Arduino-IRremote/Arduino-IRremote/blob/master/src/ir_NEC.hpp#L96) +and [`decodeNEC()`](https://github.com/Arduino-IRremote/Arduino-IRremote/blob/master/src/ir_NEC.hpp#L194).
+ +### Integration +To integrate your protocol, you need to extend the two functions `decode()` and `getProtocolString()` in *IRreceice.hpp*, +add macros and function declarations for sending and receiving and extend the `enum decode_type_t` in *IRremote.h*.
+And at least it would be wonderful if you can provide an example how to use the new protocol. +A detailed description can be found in the [ir_Template.hpp](https://github.com/Arduino-IRremote/Arduino-IRremote/blob/master/src/ir_Template.hpp#L11) file. + +### Creating API documentation +To generate the API documentation, Doxygen, as well as [Graphviz](http://www.graphviz.org/) should be installed. +(Note that on Windows, it is useful to specify the installer to add Graphviz to PATH or to do it manually. +With Doxygen and Graphviz installed, issue the command +`doxygen` from the command line in the main project directory, which will +generate the API documentation in HTML format. +The just generated `docs/index.html` can now be opened in a browser. \ No newline at end of file diff --git a/lib/IRremote/Contributors.md b/lib/IRremote/Contributors.md new file mode 100644 index 0000000..40c0404 --- /dev/null +++ b/lib/IRremote/Contributors.md @@ -0,0 +1,36 @@ +## Contributors +These are the active contributors of this project that you may contact if there is anything you need help with or if you have suggestions. + +- [ArminJo](https://github.com/ArminJo) Maintainer +- [z3t0](https://github.com/z3t0) the main contributor until version 2.4.0. + * Email: zetoslab@gmail.com +- [shirriff](https://github.com/shirriff): An amazing person who worked to create this awesome library and provide unending support +- [Informatic](https://github.com/Informatic) +- [fmeschia](https://github.com/fmeschia) +- [PaulStoffregen](https://github.com/paulstroffregen) +- [crash7](https://github.com/crash7) +- [Neco777](https://github.com/neco777) +- [Lauszus](https://github.com/lauszus) +- [csBlueChip](https://github.com/csbluechip) contributed major and vital changes to the code base. +- [Sebazzz](https://github.com/sebazz) +- [lumbric](https://github.com/lumbric) +- [ElectricRCAircraftGuy](https://github.com/electricrcaircraftguy) +- [philipphenkel](https://github.com/philipphenkel) +- [MCUdude](https://github.com/MCUdude) +- [adamlhumphreys](https://github.com/adamlhumphreys) (code space improvements) +- [marcmerlin](https://github.com/marcmerlin) (ESP32 port) +- [MrBryonMiller](https://github.com/MrBryonMiller) +- [bengtmartensson](https://github.com/bengtmartensson) providing support +- [AnalysIR](https:/github.com/AnalysIR) providing support +- [eshicks4](https://github.com/eshicks4) +- [Jim-2249](https://github.com/Jim-2249) +- [pmalasp](https://github.com/pmalasp ) +- [ElectronicsArchiver}(https://github.com/ElectronicsArchiver) improving documentation +- [Stephen Humphries](https://github.com/sjahu)Fix for: Prevent long delay caused by overflow when frame duration < repeat period #1028 +- [Daniel Wallner](https://github.com/danielwallner) Bang & Olufsen protocol. +- [slott](https://stackoverflow.com/users/11680056/sklott) Seeduino print(unsigned long long...) support. +- [Joe Ostrander](https://github.com/joeostrander) Added support for attiny1614. +- [Buzzerb](https://github.com/Buzzerb) Added Extended NEC protocol to TinyIR and making it more consistent. +- [akellai](https://github.com/akellai) Added ESP 3.0 support. + +Note: Please let [ArminJo](https://github.com/ArminJo) know if you have been missed. diff --git a/lib/IRremote/Doxyfile b/lib/IRremote/Doxyfile new file mode 100644 index 0000000..a879240 --- /dev/null +++ b/lib/IRremote/Doxyfile @@ -0,0 +1,2500 @@ +# Doxyfile 1.8.18 + +# 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 configuration +# file that follow. The default is UTF-8 which is also the encoding used for all +# text before the first occurrence of this tag. Doxygen uses libiconv (or the +# iconv built into libc) for the transcoding. See +# https://www.gnu.org/software/libiconv/ for the list of possible encodings. +# The default value is: UTF-8. + +DOXYFILE_ENCODING = UTF-8 + +# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by +# double-quotes, unless you are using Doxywizard) that should identify the +# project for which the documentation is generated. This name is used in the +# title of most generated pages and in a few other places. +# The default value is: My Project. + +PROJECT_NAME = "IRremote" + +# 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 = E:\WORKSPACE_ARDUINO\lib\Arduino-IRremote_gh-pages + +# 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 + +# The OUTPUT_TEXT_DIRECTION tag is used to specify the direction in which all +# documentation generated by doxygen is written. Doxygen will use this +# information to generate all generated output in the proper direction. +# Possible values are: None, LTR, RTL and Context. +# The default value is: None. + +OUTPUT_TEXT_DIRECTION = None + +# If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member +# descriptions after the members that are listed in the file and class +# documentation (similar to Javadoc). Set to NO to disable this. +# 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 = YES + +# If the JAVADOC_BANNER tag is set to YES then doxygen will interpret a line +# such as +# /*************** +# as being the beginning of a Javadoc-style comment "banner". If set to NO, the +# Javadoc-style will behave just like regular comments and it will not be +# interpreted by doxygen. +# The default value is: NO. + +JAVADOC_BANNER = NO + +# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first +# line (until the first dot) of a Qt-style comment as the brief description. If +# set to NO, the Qt-style will behave just like regular Qt-style comments (thus +# requiring an explicit \brief command for a brief description.) +# The default value is: NO. + +QT_AUTOBRIEF = NO + +# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a +# multi-line C++ special comment block (i.e. a block of //! or /// comments) as +# a brief description. This used to be the default behavior. The new default is +# to treat a multi-line C++ comment block as a detailed description. Set this +# tag to YES if you prefer the old behavior instead. +# +# Note that setting this tag to YES also means that rational rose comments are +# not recognized any more. +# The default value is: NO. + +MULTILINE_CPP_IS_BRIEF = NO + +# 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 (in the resulting output). You can put ^^ in the value part of an +# alias to insert a newline as if a physical newline was in the original file. +# When you need a literal { or } or , in the value part of an alias you have to +# escape them by means of a backslash (\), this can lead to conflicts with the +# commands \{ and \} for these it is advised to use the version @{ and @} or use +# a double escape (\\{ and \\}) + +ALIASES = + +# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources +# only. Doxygen will then generate output that is more tailored for C. For +# instance, some of the names that are used will be different. The list of all +# members will be omitted, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_FOR_C = NO + +# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or +# Python sources only. Doxygen will then generate output that is more tailored +# for that language. For instance, namespaces will be presented as packages, +# qualified scopes will look different, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_JAVA = NO + +# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran +# sources. Doxygen will then generate output that is tailored for Fortran. +# The default value is: NO. + +OPTIMIZE_FOR_FORTRAN = NO + +# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL +# sources. Doxygen will then generate output that is tailored for VHDL. +# The default value is: NO. + +OPTIMIZE_OUTPUT_VHDL = NO + +# Set the OPTIMIZE_OUTPUT_SLICE tag to YES if your project consists of Slice +# sources only. Doxygen will then generate output that is more tailored for that +# language. For instance, namespaces will be presented as modules, types will be +# separated into more groups, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_SLICE = NO + +# Doxygen selects the parser to use depending on the extension of the files it +# parses. With this tag you can assign which parser to use for a given +# extension. Doxygen has a built-in mapping, but you can override or extend it +# using this tag. The format is ext=language, where ext is a file extension, and +# language is one of the parsers supported by doxygen: IDL, Java, JavaScript, +# Csharp (C#), C, C++, D, PHP, md (Markdown), Objective-C, Python, Slice, VHDL, +# Fortran (fixed format Fortran: FortranFixed, free formatted Fortran: +# FortranFree, unknown formatted Fortran: Fortran. In the later case the parser +# tries to guess whether the code is fixed or free formatted code, this is the +# default for Fortran type files). For instance to make doxygen treat .inc files +# as Fortran files (default is PHP), and .f files as C (default is Fortran), +# use: inc=Fortran f=C. +# +# Note: For files without extension you can use no_extension as a placeholder. +# +# Note that for custom extensions you also need to set FILE_PATTERNS otherwise +# the files are not read by doxygen. + +EXTENSION_MAPPING = ino=C++ cpp=C++ h=C++ hpp=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 https://daringfireball.net/projects/markdown/ for details. +# The output of markdown processing is further processed by doxygen, so you can +# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in +# case of backward compatibilities issues. +# The default value is: YES. + +MARKDOWN_SUPPORT = YES + +# When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up +# to that level are automatically included in the table of contents, even if +# they do not have an id attribute. +# Note: This feature currently applies only to Markdown headings. +# Minimum value: 0, maximum value: 99, default value: 5. +# This tag requires that the tag MARKDOWN_SUPPORT is set to YES. + +TOC_INCLUDE_HEADINGS = 0 + +# 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: +# https://www.riverbankcomputing.com/software/sip/intro) sources only. Doxygen +# will parse them like normal C++ but will assume all classes use public instead +# of private inheritance when no explicit protection keyword is present. +# The default value is: NO. + +SIP_SUPPORT = NO + +# For Microsoft's IDL there are propget and propput attributes to indicate +# getter and setter methods for a property. Setting this option to YES will make +# doxygen to replace the get and set methods by a property in the documentation. +# This will only work if the methods are indeed getting or setting a simple +# type. If this is not the case, or you want to show the methods anyway, you +# should set this option to NO. +# The default value is: YES. + +IDL_PROPERTY_SUPPORT = YES + +# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC +# tag is set to YES then doxygen will reuse the documentation of the first +# member in the group (if any) for the other members of the group. By default +# all members of a group must be documented explicitly. +# The default value is: NO. + +DISTRIBUTE_GROUP_DOC = NO + +# If one adds a struct or class to a group and this option is enabled, then also +# any nested class or struct is added to the same group. By default this option +# is disabled and one has to add nested compounds explicitly via \ingroup. +# The default value is: NO. + +GROUP_NESTED_COMPOUNDS = NO + +# Set the SUBGROUPING tag to YES to allow class member groups of the same type +# (for instance a group of public functions) to be put as a subgroup of that +# type (e.g. under the Public Functions section). Set it to NO to prevent +# subgrouping. Alternatively, this can be done per class using the +# \nosubgrouping command. +# The default value is: YES. + +SUBGROUPING = YES + +# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions +# are shown inside the group in which they are included (e.g. using \ingroup) +# instead of on a separate page (for HTML and Man pages) or section (for LaTeX +# and RTF). +# +# Note that this feature does not work in combination with +# SEPARATE_MEMBER_PAGES. +# The default value is: NO. + +INLINE_GROUPED_CLASSES = NO + +# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions +# with only public data fields or simple typedef fields will be shown inline in +# the documentation of the scope in which they are defined (i.e. file, +# namespace, or group documentation), provided this scope is documented. If set +# to NO, structs, classes, and unions are shown on a separate page (for HTML and +# Man pages) or section (for LaTeX and RTF). +# The default value is: NO. + +INLINE_SIMPLE_STRUCTS = NO + +# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or +# enum is documented as struct, union, or enum with the name of the typedef. So +# typedef struct TypeS {} TypeT, will appear in the documentation as a struct +# with name TypeT. When disabled the typedef will appear as a member of a file, +# namespace, or class. And the struct will be named TypeS. This can typically be +# useful for C code in case the coding convention dictates that all compound +# types are typedef'ed and only the typedef is referenced, never the tag name. +# The default value is: NO. + +TYPEDEF_HIDES_STRUCT = NO + +# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This +# cache is used to resolve symbols given their name and scope. Since this can be +# an expensive process and often the same symbol appears multiple times in the +# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small +# doxygen will become slower. If the cache is too large, memory is wasted. The +# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range +# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536 +# symbols. At the end of a run doxygen will report the cache usage and suggest +# the optimal cache size from a speed point of view. +# Minimum value: 0, maximum value: 9, default value: 0. + +LOOKUP_CACHE_SIZE = 0 + +#--------------------------------------------------------------------------- +# Build related configuration options +#--------------------------------------------------------------------------- + +# If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in +# documentation are documented, even if no documentation was available. Private +# class members and static file members will be hidden unless the +# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. +# Note: This will also disable the warnings about undocumented members that are +# normally produced when WARNINGS is set to YES. +# The default value is: NO. + +EXTRACT_ALL = YES + +# If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will +# be included in the documentation. +# The default value is: NO. + +EXTRACT_PRIVATE = NO + +# If the EXTRACT_PRIV_VIRTUAL tag is set to YES, documented private virtual +# methods of a class will be included in the documentation. +# The default value is: NO. + +EXTRACT_PRIV_VIRTUAL = NO + +# If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal +# scope will be included in the documentation. +# The default value is: NO. + +EXTRACT_PACKAGE = NO + +# If the EXTRACT_STATIC tag is set to YES, all static members of a file will be +# included in the documentation. +# The default value is: NO. + +EXTRACT_STATIC = 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 +# 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 +# (including Cygwin) ands 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 = YES + +# 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 https://en.wikipedia.org/wiki/BibTeX for more info. +# For LaTeX the style of the bibliography can be controlled using +# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the +# search path. See also \cite for info how to create references. + +CITE_BIB_FILES = + +#--------------------------------------------------------------------------- +# Configuration options related to warning and progress messages +#--------------------------------------------------------------------------- + +# The QUIET tag can be used to turn on/off the messages that are generated to +# standard output by doxygen. If QUIET is set to YES this implies that the +# messages are off. +# The default value is: NO. + +QUIET = NO + +# The WARNINGS tag can be used to turn on/off the warning messages that are +# generated to standard error (stderr) by doxygen. If WARNINGS is set to YES +# this implies that the warnings are on. +# +# Tip: Turn warnings on while writing the documentation. +# The default value is: YES. + +WARNINGS = YES + +# If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate +# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag +# will automatically be disabled. +# The default value is: YES. + +WARN_IF_UNDOCUMENTED = YES + +# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for +# potential errors in the documentation, such as 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. If +# EXTRACT_ALL is set to YES then this flag will automatically be disabled. +# 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 = src \ + src/private \ + . + +# This tag can be used to specify the character encoding of the source files +# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses +# libiconv (or the iconv built into libc) for the transcoding. See the libiconv +# documentation (see: https://www.gnu.org/software/libiconv/) for the list of +# possible encodings. +# 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 (to be provided as doxygen C comment), +# *.doc (to be provided as doxygen C comment), *.txt (to be provided as doxygen +# C comment), *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, *.f18, *.f, *.for, *.vhd, +# *.vhdl, *.ucf, *.qsf and *.ice. + +FILE_PATTERNS = *.ino *.cpp *.c *.h *.hpp *.md + +# The RECURSIVE tag can be used to specify whether or not subdirectories should +# be searched for input files as well. +# The default value is: NO. + +RECURSIVE = NO + +# 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 = + +# 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 = + +# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using +# INPUT_FILTER) will also be used to filter the input files that are used for +# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES). +# The default value is: NO. + +FILTER_SOURCE_FILES = NO + +# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file +# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and +# it is also possible to disable source filtering for a specific pattern using +# *.ext= (so without naming a filter). +# This tag requires that the tag FILTER_SOURCE_FILES is set to YES. + +FILTER_SOURCE_PATTERNS = + +# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that +# is part of the input, its contents will be placed on the main page +# (index.html). This can be useful if you have a project on for instance GitHub +# and want to reuse the introduction page also for the doxygen output. + +USE_MDFILE_AS_MAINPAGE = README.md + +#--------------------------------------------------------------------------- +# 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 +# entity all documented functions referencing it will be listed. +# The default value is: NO. + +REFERENCED_BY_RELATION = NO + +# If the REFERENCES_RELATION tag is set to YES then for each documented function +# all documented entities called/used by that function will be listed. +# The default value is: NO. + +REFERENCES_RELATION = NO + +# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set +# to YES then the hyperlinks from functions in REFERENCES_RELATION and +# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will +# link to the documentation. +# The default value is: YES. + +REFERENCES_LINK_SOURCE = YES + +# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the +# source code will show a tooltip with additional information such as prototype, +# brief description and links to the definition and documentation. Since this +# will make the HTML file larger and loading of large files a bit slower, you +# can opt to disable this feature. +# The default value is: YES. +# This tag requires that the tag SOURCE_BROWSER is set to YES. + +SOURCE_TOOLTIPS = YES + +# If the USE_HTAGS tag is set to YES then the references to source code will +# point to the HTML generated by the htags(1) tool instead of doxygen built-in +# source browser. The htags tool is part of GNU's global source tagging system +# (see https://www.gnu.org/software/global/global.html). You will need version +# 4.8.6 or higher. +# +# To use it do the following: +# - Install the latest version of global +# - Enable SOURCE_BROWSER and USE_HTAGS in the configuration file +# - Make sure the INPUT points to the root of the source tree +# - Run doxygen as normal +# +# Doxygen will invoke htags (and that will in turn invoke gtags), so these +# tools must be available from the command line (i.e. in the search path). +# +# The result: instead of the source browser generated by doxygen, the links to +# source code will now point to the output of htags. +# The default value is: NO. +# This tag requires that the tag SOURCE_BROWSER is set to YES. + +USE_HTAGS = NO + +# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a +# verbatim copy of the header file for each class for which an include is +# specified. Set to NO to disable this. +# See also: Section \class. +# The default value is: YES. + +VERBATIM_HEADERS = YES + +#--------------------------------------------------------------------------- +# Configuration options related to the alphabetical class index +#--------------------------------------------------------------------------- + +# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all +# compounds will be generated. Enable this if the project contains a lot of +# classes, structs, unions or interfaces. +# The default value is: YES. + +ALPHABETICAL_INDEX = NO + +# 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 = docs + +# 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 +# https://en.wikipedia.org/wiki/Hue for more information. For instance the value +# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 +# purple, and 360 is red again. +# Minimum value: 0, maximum value: 359, default value: 220. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_HUE = 220 + +# 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 = YES + +# If the HTML_DYNAMIC_MENUS tag is set to YES then the generated HTML +# documentation will contain a main index with vertical navigation menus that +# are dynamically created via JavaScript. If disabled, the navigation index will +# consists of multiple levels of tabs that are statically embedded in every HTML +# page. Disable this option to support browsers that do not have JavaScript, +# like the Qt help browser. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_DYNAMIC_MENUS = YES + +# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML +# documentation will contain sections that can be hidden and shown after the +# page has loaded. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_DYNAMIC_SECTIONS = NO + +# 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: https://developer.apple.com/xcode/), introduced with OSX +# 10.5 (Leopard). To create a documentation set, doxygen will generate a +# Makefile in the HTML output directory. Running make will produce the docset in +# that directory and running make install will install the docset in +# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at +# startup. See https://developer.apple.com/library/archive/featuredarticles/Doxy +# genXcode/_index.html for more information. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_DOCSET = NO + +# This tag determines the name of the docset feed. A documentation feed provides +# an umbrella under which multiple documentation sets from a single provider +# (such as a company or product suite) can be grouped. +# The default value is: Doxygen generated docs. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_FEEDNAME = "Doxygen generated docs" + +# This tag 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: https://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: https://doc.qt.io/archives/qt-4.8/qthelpproject.html#namespace). +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_NAMESPACE = org.doxygen.Project + +# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt +# Help Project output. For more information please see Qt Help Project / Virtual +# Folders (see: https://doc.qt.io/archives/qt-4.8/qthelpproject.html#virtual- +# folders). +# The default value is: doc. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_VIRTUAL_FOLDER = doc + +# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom +# filter to add. For more information please see Qt Help Project / Custom +# Filters (see: https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom- +# filters). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_CUST_FILTER_NAME = + +# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the +# custom filter to add. For more information please see Qt Help Project / Custom +# Filters (see: https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom- +# filters). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_CUST_FILTER_ATTRS = + +# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this +# project's filter section matches. Qt Help Project / Filter Attributes (see: +# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#filter-attributes). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_SECT_FILTER_ATTRS = + +# The QHG_LOCATION tag can be used to specify the location 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 = YES + +# 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 + +# If the HTML_FORMULA_FORMAT option is set to svg, doxygen will use the pdf2svg +# tool (see https://github.com/dawbarton/pdf2svg) or inkscape (see +# https://inkscape.org) to generate formulas as SVG images instead of PNGs for +# the HTML output. These images will generally look nicer at scaled resolutions. +# Possible values are: png The default and svg Looks nicer but requires the +# pdf2svg tool. +# The default value is: png. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FORMULA_FORMAT = png + +# Use this tag to change the font size of LaTeX formulas included as images in +# the HTML documentation. When you change the font size after a successful +# doxygen run you need to manually remove any form_*.png images from the HTML +# output directory to force them to be regenerated. +# Minimum value: 8, maximum value: 50, default value: 10. +# This tag requires that the tag GENERATE_HTML is set to YES. + +FORMULA_FONTSIZE = 10 + +# Use the FORMULA_TRANSPARENT tag to determine whether or not the images +# generated for formulas are transparent PNGs. Transparent PNGs are not +# supported properly for IE 6.0, but are supported on all modern browsers. +# +# Note that when changing this option you need to delete any form_*.png files in +# the HTML output directory before the changes have effect. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +FORMULA_TRANSPARENT = YES + +# The FORMULA_MACROFILE can contain LaTeX \newcommand and \renewcommand commands +# to create new LaTeX commands to be used in formulas as building blocks. See +# the section "Including formulas" for details. + +FORMULA_MACROFILE = + +# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see +# https://www.mathjax.org) which uses client side JavaScript for the rendering +# instead of using pre-rendered bitmaps. Use this if you do not have LaTeX +# installed or if you want to formulas look prettier in the HTML output. When +# enabled you may also need to install MathJax separately and configure the path +# to it using the MATHJAX_RELPATH option. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +USE_MATHJAX = NO + +# 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 https://www.mathjax.org before deployment. +# The default value is: https://cdn.jsdelivr.net/npm/mathjax@2. +# 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 +# , /