This library contains Arduino utilities which are too small to be in separate libraries, but too high-level (with external dependencies) to be included in the AceCommon (https://github.com/bxparks/AceCommon) library. The AceCommon library must remain self-contained without any external dependencies. The utilities in AceUtils will generally have dependencies to my other libraries (e.g. AceCommon, AceTime, AceRoutine, etc) or third party libraries.

• CrcEeprom
  • #include <CrcEeprom.h>
  • using crc_eeprom::CrcEeprom
  • summary: Store data structures in EEPROM with a CRC check.
  • depends on:
    • FastCRC (https://github.com/FrankBoesing/FastCRC)
• CommandLineInterface
  • src/cli/README.md
  • #include <CommandLineInterface.h>
  • using namespace cli
  • summary: Implement a command line interface over the Serial port.
  • depends on:
    • AceRoutine (https://github.com/bxparks/AceRoutine)
    • AceCommon (https://github.com/bxparks/AceCommon)

Version: 0.3 (2020-11-01)

Changelog: CHANGELOG.md

The latest stable release will be available in the Arduino IDE Library Manager. Search for "AceUtils". Click Install.

The development version can be installed by cloning the GitHub repository, checking out the develop branch, then manually copying over the contents to the ./libraries directory used by the Arduino IDE. (The result is a directory named ./libraries/AceUtils.) The master branch contains the stable release.

• src/AceUtil.h: A bookkeeping header file that includes the version and Doxygen docs. Individual utilities have their own header files.
• src/*.h: Header file for each utility listed above.
• examples/*: Example code for various utilities.
• tests/*: Unit tests using AUnit.

The docs/ directory contains the Doxygen docs on GitHub Pages. This may be useful to navigate the various classes in this library and to lookup the signatures of the methods in those classes.

• examples/CrcEepromDemo
  • Demo of CrcEeprom class.
• examples/CommandLineShell
  • Demo of the <CommandLineInterface.h> classes to implement a command line interface that accepts a number of commands on the serial port. In other words, it is a primitive "shell". The shell is non-blocking and uses coroutines so that other coroutines continue to run.

The documentation is mostly in the code right now. I will add more as time allows.

This library was developed and tested using:

• Arduino IDE 1.8.13
• Arduino AVR Boards 1.6.23
• Arduino SAMD Boards 1.8.3
• SparkFun AVR Boards 1.1.12
• SparkFun SAMD Boards 1.6.2
• ESP8266 Arduino 2.7.4
• ESP32 Arduino 1.0.4
• Teensydino 1.46

It should work with PlatformIO but I have not tested it.

Many utilities work on Linux or MacOS (using both g++ and clang++ compilers) using the UnixHostDuino emulation layer.

I use Ubuntu 18.04 and 20.04 for the vast majority of my development. I expect that the library will work fine under MacOS and Windows, but I have not tested them.

Most utilities will work on various Arduino boards. I test most utilities on on the following boards:

• Arduino Nano clone (16 MHz ATmega328P)
• SparkFun Pro Micro clone (16 MHz ATmega32U4)
• WeMos D1 Mini clone (ESP-12E module, 80 MHz ESP8266)
• ESP32 dev board (ESP-WROOM-32 module, 240 MHz dual core Tensilica LX6)

Some utlities work only on microcontrollers with built-in WiFi. The header files for those utilities will contain preprpocessor directives using #ifdef to print out a warning if the board is not one of the following:

• ESP8266
• ESP32

I will occasionally test on the following hardware as a sanity check:

• Teensy 3.2 (72 MHz ARM Cortex-M4)
• Mini Mega 2560 (Arduino Mega 2560 compatible, 16 MHz ATmega2560)
• SAMD21 M0 Mini (48 MHz ARM Cortex-M0+) (compatible with Arduino Zero)

MIT License

If you have any questions, comments, bug reports, or feature requests, please file a GitHub ticket instead of emailing me unless the content is sensitive. (The problem with email is that I cannot reference the email conversation when other people ask similar questions later.) I'd love to hear about how this software and its documentation can be improved. I can't promise that I will incorporate everything, but I will give your ideas serious consideration.

• Created by Brian T. Park ([email protected]).