diff --git a/CHANGELOG.md b/CHANGELOG.md index 5cd519d..735c77e 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,11 +1,51 @@ # Changelog * Unreleased +* 1.7.1 (2023-06-15) + * This is a maintenance release, to update the list of supported boards, + and update the documentation. + * No functional change. + * Add [MemoryBenchmark](examples/MemoryBenchmark) to collect flash and + static memory usage. + * For consistency with my other arduino libraries. + * Also enables an automated script to verify that AUnit compiles under + various microcontrollers. + * Update supported boards and tiers + * Update [Flash.h](src/aunit/Flash.h) to work better with Teensyduino, + Adafruit SAMD, and Seeeduino SAMD boards by hacking around their bugs + and inconsistent APIs + * Add SAMD21 and SAMD51 boards to Tier 1 + * Add 2 SAMD boards from 2 different companies, to test their + Arduino Core software: + * Seeeduino XIAO M0 (SAMD21 48MHz ARM Cortex-M0+) + * Adafruit ItsyBitsy M4 (SAMD51 120MHz ARM Cortex-M4) + * SAMD21 and SAMD51 boards are back in Tier 1, as long as they use + the traditional Arduino API instead of the new + [ArduinoCore-API](https://github.com/arduino/ArduinoCore-api). + * Fortunately most third party SAMD21 and SAMD51 boards continue to + use the traditional Arduino API. + * Move Teensy 3.2 to Tier 2 ("Should work but not tested often") + * This board is entering end-of-life. + * As well, the Teensyduino environment integrates with the Arduino + IDE and CLI in a way that's different than all other third-party + Arduino boards. Some of my automation scripts do not work with + Teensyduino, so it becomes very time consuming to test the Teensy + boards. + * All Teensy boards are now in Tier 2. + * The various tiers are documented in the + [README.md](README.md#Hardware). + * Upgrade tool chain. + * Arduino CLI from 0.19.2 to 0.33.0 + * Arduino AVR Core from 1.8.4 to 1.8.6 + * STM32duino from 2.2.0 to 2.5.0 + * ESP32 Core from 2.0.2 to 2.0.9 + * Teensyduino from 1.56 to 1.57 (unable to install 1.58) * 1.7.0 (2022-12-08) - * **Potentially Breaking** Change format of assertion failure message from: - * "Assertion failed: (expected=3) == (counter=4), file AUnitTest.ino, - line 134.", to - * "AUnitTest.ino:134: Assertion failed: (expected=3) == (counter=4)." + * **Potentially Breaking** Change format of assertion failure message + * from: `Assertion failed: (expected=3) == (counter=4), file + AUnitTest.ino, line 134.` + * to: `AUnitTest.ino:134: Assertion failed: (expected=3) == + (counter=4).` * This format is compatible with various Linux/MacOS/Unix command line tools, in particular, the `vim` editor. * When used with EpoxyDuino, this message format allows the `vim` editor diff --git a/README.md b/README.md index c2a78b7..cba4553 100644 --- a/README.md +++ b/README.md @@ -4,23 +4,25 @@ A unit testing framework for Arduino platforms inspired by by [ArduinoUnit](https://github.com/mmurdoch/arduinounit) and [Google -Test](https://github.com/google/googletest/). The unit tests usually run on the -embedded controller which allows detection of architecture-specific problems. -But for faster development, many unit tests can be compiled and executed -natively on Linux or MacOS using the -[EpoxyDuino](https://github.com/bxparks/EpoxyDuino) companion project. - -AUnit is almost a drop-in replacement of ArduinoUnit with some advantages. AUnit -supports timeouts and test fixtures. It sometimes consumes 50% less flash memory -on the AVR platform, and it has been tested to work on the AVR, SAMD21, STM32, -ESP8266, ESP32 and Teensy platforms. Another companion project -[AUniter](https://github.com/bxparks/AUniter) project provides command line -tools to verify, upload and validate the unit tests to the microcontroller, -instead of having to go through the Arduino IDE. Both the AUniter and -EpoxyDuino tools can be used in a continuous integration system like Jenkins, -or with [GitHub Actions](https://github.com/features/actions). - -**Version**: 1.7.0 (2022-12-08) +Test](https://github.com/google/googletest/). AUnit is almost a drop-in +replacement of ArduinoUnit (v2.2) with some advantages. AUnit supports timeouts +and test fixtures. It sometimes consumes 50% less flash memory on the AVR +platform, and it has been tested to work on the AVR, SAMD21, STM32, ESP8266, +ESP32 and Teensy platforms. The assertion error messages were updated in v1.7 to +provide seamless integration with Unix tools like `vim`. + +Originally, the AUnit tests were designed to run on the embedded controller +itself which allows detection of architecture-specific problems. But the +uploading, flashing, and execution process is often slow and flaky, causing the +iteration cycle to take too much time. It is often more effective to execute the +AUnit tests natively on a host machine (running Linux, MacOS, or FreeBSD) using +the [EpoxyDuino](https://github.com/bxparks/EpoxyDuino) companion project. Once +the unit tests are running on the Linux or MacOS host machine, they can be +incorporated into a continuous integration system like +[Jenkins](https://www.jenkins.io/) system or a cloud-based system like [GitHub +Actions](https://github.com/features/actions). + +**Version**: 1.7.1 (2023-06-15) **Changelog**: [CHANGELOG.md](CHANGELOG.md) @@ -78,6 +80,8 @@ or with [GitHub Actions](https://github.com/features/actions). * [Class Hierarchy](#ClassHierarchy) * [Testing Private Helper Methods](#PrivateHelperMethods) * [Benchmarks](#Benchmarks) + * [Memory Benchmark](#MemoryBenchmark) + * [Compared with ArduinoUnit](#CompareArduinoUnit) * [System Requirements](#SystemRequirements) * [Hardware](#Hardware) * [Tool Chain](#ToolChains) @@ -248,36 +252,66 @@ The source files are organized as follows: The `examples/` directory has a number of examples: -* `advanced` - how to subclass `Test` and `TestOnce` manually -* `basic` - using the `test()` macro -* `continuous` - using the `testing()` macro -* `filter` - how to filter tests using `TestRunner::include()` and - `TestRunner::exclude()` -* `fixture` - how to use the `testF()` macro with test fixtures -* `meta_asserts` - how to use `assertTestXxx()` and `checkTestXxx()` - -In the `tests/` directory: - -* `AUnitTest` - the unit test for core `AUnit` functions, -* `AUnitMetaTest` - the unit test for meta assertions and `extern*()` macros -* `FilterTest` - manual tests for `include()` and `exclude()` filters -* `SetupAndTeardownTest` - tests to verify that `setup()` and `teardown()` are - called properly by the finite state machine - -Perhaps the best way to see AUnit in action through real life examples. All my -libraries use AUnit for testing and for continuous integration through -EpoxyDuino. Here are some examples: +* Basic + * [basic](examples/basic) + * using the `test()` macro + * [fixture](examples/fixture) + * how to use the `testF()` macro with test fixtures +* Intermediate + * [filter](examples/filter) + * how to filter tests using `TestRunner::include()` and + `TestRunner::exclude()` + * [meta_asserts](examples/meta_asserts) + * how to use `assertTestXxx()` and `checkTestXxx()` +* Advanced + * [advanced](examples/advanced/) + * how to subclass `Test` and `TestOnce` manually + * [continuous](examples/continuous) + * using the `testing()` macro +* Benchmarks + * These are internal benchmark programs, not meant as examples (they are in + the `examples/` directory because of the Arduino IDE). + * [MemoryBenchmark](examples/MemoryBenchmark) + * Determines the flash and static memory consumption of AUnit for + various microcontroller + +In the `tests/` directory, there are unit tests to test the AUnit framework +itself: + +* [AUnitTest](tests/AUnitTest) + * the unit test for core `AUnit` functions +* [AUnitMoreTest](tests/AUnitMoreTest) + * more tests +* [AUnitMetaTest](tests/AUnitMetaTest) + * the unit test for meta assertions and `extern*()` macros +* [CompareTest](tests/CompareTest) + * tests for the low-level compare functions +* [FailingTest](tests/FailingTest) + * tests that are expected to fail +* [FilterTest](tests/FilterTest) + * manual tests for `include()` and `exclude()` filters +* [Print64Test](tests/Print64Test) + * manual tests for `include()` and `exclude()` filters +* [SetupAndTeardownTest](tests/SetupAndTeardownTest) + * tests to verify that `setup()` and `teardown()` are called properly by the + finite state machine +* [tests/Makefile](tests/Makefile) + * Runs the tests on a Linux or Mac machine using EpoxyDuino + +Perhaps the best way to see AUnit in action is through real life examples. All +my libraries use AUnit for testing and for continuous integration through +EpoxyDuino. Here are some of my libraries: * [AceButton](https://github.com/bxparks/AceButton) * My first Arduino library, which originally used ArduinoUnit 2.2. * I kept many of the original ArduinoUnit tests for backwards compatibility - testing. But over time, I started to use nore AUnit features. + testing. But over time, I started to use more AUnit features so I'm not + sure if they work with ArduinoUnit anymore. * [AceCRC](https://github.com/bxparks/AceCRC) * [AceCommon](https://github.com/bxparks/AceCommon) * [AceRoutine](https://github.com/bxparks/AceRoutine) * [AceSegment](https://github.com/bxparks/AceSegment) * [AceSorting](https://github.com/bxparks/AceSorting) -* [AceTimeClock](https://github.com/bxparks/AceTimeClock) * [AceTime](https://github.com/bxparks/AceTime) @@ -518,7 +552,7 @@ SampleTest.ino:10: Assertion failed: (2) == (1) The format of the assertion failure messages was changed in v1.7 to the following: ``` -{filName}:{lineNumber}: Assertion failed: {expression} +{fileName}:{lineNumber}: Assertion failed: {expression} ``` This format is a widely used in many other programs, for example, the C compiler @@ -1476,9 +1510,6 @@ copied from the `AUniter/README.md` file: * list the available serial ports and devices * `$ auniter verify nano Blink.ino` * verify (compile) `Blink.ino` using the `env:nano` environment -* `$ auniter verify nano,esp8266,esp32 Blink.ino` - * verify `Blink.ino` on 3 target environments (`env:nano`, `env:esp8266`, - `env:esp32`) * `$ auniter upload nano:/dev/ttyUSB0 Blink.ino` * upload `Blink.ino` to the `env:nano` target environment connected to `/dev/ttyUSB0` @@ -1486,11 +1517,9 @@ copied from the `AUniter/README.md` file: * compile and upload `BlinkTest.ino` using the `env:nano` environment, upload it to the board at `/dev/ttyUSB0`, then validate the output of the [AUnit](https://github.com/bxparks/AUnit) unit test -* `$ auniter test nano:USB0,esp8266:USB1,esp32:USB2 BlinkTest/ ClockTest/` +* `$ auniter test nano:USB0 BlinkTest/ ClockTest/` * upload and verify the 2 unit tests (`BlinkTest/BlinkTest.ino`, - `ClockTest/ClockTest.ino`) on 3 target environments (`env:nano`, - `env:esp8266`, `env:esp32`) located at the 3 respective ports - (`/dev/ttyUSB0`, `/dev/ttyUSB1`, `/dev/ttyUSB2`) + `ClockTest/ClockTest.ino`) on the target environment (`env:nano`) * `$ auniter upmon nano:USB0 Blink.ino` * upload the `Blink.ino` sketch and monitor the serial port using a user-configurable terminal program (e.g. `picocom`) on `/dev/ttyUSB0` @@ -1528,10 +1557,22 @@ For real Arduino boards, you get more reliable unit tests if you add a necessary, so I recommend calling this only on real Arduino boards, like this: ```C++ void setup() { -#ifdef ARDUINO +#if ! defined(EPOXY_DUINO) delay(1000); // Wait for stability on some boards, otherwise garage on Serial #endif + + Serial.begin(115200); + while (! Serial); // Wait until Serial is ready - Leonardo/Micro + +#if defined(EPOXY_DUINO) + Serial.setLineModeUnix(); // use Unix line terminator instead of DOS +#endif ... +} + +void loop() { + aunit::TestRunner::run(); +} ``` **Exit() Status Code** @@ -1881,13 +1922,50 @@ testF(TargetTest, helper) { ``` The tricky part is that `Target.h` must have forward declarations of the various -auto-generated AUnit test classes. And within the `Target` class itsef, the +auto-generated AUnit test classes. And within the `Target` class itself, the `friend` declarations need to have a global scope `::` specifier before the name of the test class. ## Benchmarks + +### MemoryBenchmark + +The [MemoryBenchmark](examples/MemoryBenchmark/) directory collects the flash +and static RAM usage of the AUnit library on various microcontroller boards, and +renders the results as tables embedded in the README.md file. Here are 2 +highlights: + +**Arduino Nano (8-bit)** + +``` ++---------------------------------------------------------------------+ +| Functionality | flash/ ram | delta | +|----------------------------------------+--------------+-------------| +| Baseline | 1586/ 185 | 0/ 0 | +|----------------------------------------+--------------+-------------| +| AUnit Single Test | 4456/ 366 | 2870/ 181 | +| AUnit Single Test Verbose | 4500/ 366 | 2914/ 181 | ++---------------------------------------------------------------------+ +``` + +**ESP8266 (32-bit)** + +``` ++---------------------------------------------------------------------+ +| Functionality | flash/ ram | delta | +|----------------------------------------+--------------+-------------| +| Baseline | 264949/27984 | 0/ 0 | +|----------------------------------------+--------------+-------------| +| AUnit Single Test | 268021/28148 | 3072/ 164 | +| AUnit Single Test Verbose | 268081/28148 | 3132/ 164 | ++---------------------------------------------------------------------+ +``` + + +### Compared to ArduinoUnit 2.2 + AUnit consumes as much as 65% less flash memory than ArduinoUnit 2.2 on an AVR platform (e.g. Arduino UNO, Nano), and 30% less flash on the Teensy-ARM platform (e.g. Teensy LC ). (ArduinoUnit 2.3 reduces the flash memory by 30% or so, which @@ -1929,34 +2007,52 @@ AUnit, but a savings of 30-50% seems to be common. ### Hardware -The library is tested on the following boards: +**Tier 1: Fully supported** + +These boards are tested on each release: * Arduino Nano clone (16 MHz ATmega328P) * SparkFun Pro Micro clone (16 MHz ATmega32U4) -* SAMD21 M0 Mini board (Arduino Zero compatible, 48 MHz ARM Cortex-M0+) +* Seeeduino XIAO M0 (SAMD21, 48 MHz ARM Cortex-M0+) * STM32 Blue Pill (STM32F103C8, 72 MHz ARM Cortex-M3) +* Adafruit ItsyBitsy M4 (SAMD51, 120 MHz ARM Cortext-M4) * NodeMCU 1.0 (ESP-12E module, 80 MHz ESP8266) * WeMos D1 Mini (ESP-12E module, 80 MHz ESP8266) * ESP32 dev board (ESP-WROOM-32 module, 240 MHz dual core Tensilica LX6) -* Teensy 3.2 (96 MHz ARM Cortex-M4) -I will occasionally test on the following hardware as a sanity check: +**Tier 2: Should work** + +These boards should work but I don't test them as often: * Arduino Pro Mini (16 MHz ATmega328P) * Mini Mega 2560 (Arduino Mega 2560 compatible, 16 MHz ATmega2560) * Teensy LC (48 MHz ARM Cortex-M0+) +* Teensy 3.2 (96 MHz ARM Cortex-M4) + +**Tier 3: May work, but not supported** -The following boards are **not** supported: +* Other 3rd party SAMD21 and SAMD51 boards *may* work if their board software + uses the traditional Arduino API, instead of the + [ArduinoCore-API](https://github.com/arduino/ArduinoCore-api) -* Any platform using the ArduinoCore-API - (https://github.com/arduino/ArduinoCore-api), such as: - * megaAVR (e.g. Nano Every) using ArduinoCore-megaavr - (https://github.com/arduino/ArduinoCore-megaavr/) - * SAMD21 boards (e.g. MKRZero) using ArduinoCore-samd - (https://github.com/arduino/ArduinoCore-samd) starting with - `arduino:samd` version >= 1.8.10 - * Raspberry Pi Pico (RP2040) using Arduino-Pico - (https://github.com/earlephilhower/arduino-pico) +**Tier Blacklisted** + +The following boards are *not* supported and are explicitly blacklisted to allow +the compiler to print useful error messages instead of hundreds of lines of +compiler errors: + +* Any platform using the + [ArduinoCore-API](https://github.com/arduino/ArduinoCore-api), such as: + * Arduino-branded megaAVR using + [ArduinoCore-megaavr](https://github.com/arduino/ArduinoCore-megaavr/) + * Nano Every + * Arduino-branded SAMD21 or SAMD51 boards using + [ArduinoCore-samd](https://github.com/arduino/ArduinoCore-samd) after + version >= 1.8.10 + * MKRZero + * Nano 33 IoT + * Raspberry Pi Pico (RP2040) using + [Arduino-Pico](https://github.com/earlephilhower/arduino-pico) ### Tool Chain @@ -1964,15 +2060,16 @@ The following boards are **not** supported: This library was validated using: * [Arduino IDE 1.8.19](https://www.arduino.cc/en/Main/Software) -* [Arduino CLI 0.19.2](https://arduino.github.io/arduino-cli) -* [Arduino AVR Boards 1.8.4](https://github.com/arduino/ArduinoCore-avr) +* [Arduino CLI 0.33.0](https://arduino.github.io/arduino-cli) +* [Arduino AVR Boards 1.8.6](https://github.com/arduino/ArduinoCore-avr) * [Arduino SAMD Boards 1.8.9](https://github.com/arduino/ArduinoCore-samd) + (versions >= 1.8.10 not supported) * [SparkFun AVR Boards 1.1.13](https://github.com/sparkfun/Arduino_Boards) * [SparkFun SAMD Boards 1.8.6](https://github.com/sparkfun/Arduino_Boards) -* [STM32duino 2.2.0](https://github.com/stm32duino/Arduino_Core_STM32) +* [STM32duino 2.5.0](https://github.com/stm32duino/Arduino_Core_STM32) * [ESP8266 Arduino 3.0.2](https://github.com/esp8266/Arduino) -* [ESP32 Arduino 2.0.2](https://github.com/espressif/arduino-esp32) -* [Teensyduino 1.56](https://www.pjrc.com/teensy/td_download.html) +* [ESP32 Arduino 2.0.9](https://github.com/espressif/arduino-esp32) +* [Teensyduino 1.57](https://www.pjrc.com/teensy/td_download.html) This library is *not* compatible with: diff --git a/docs/doxygen.cfg b/docs/doxygen.cfg index aeaddbb..1f0cb58 100644 --- a/docs/doxygen.cfg +++ b/docs/doxygen.cfg @@ -1,4 +1,4 @@ -# Doxyfile 1.8.17 +# Doxyfile 1.9.1 # This file describes the settings to be used by the documentation system # doxygen (www.doxygen.org) for a project. @@ -32,13 +32,13 @@ DOXYFILE_ENCODING = UTF-8 # title of most generated pages and in a few other places. # The default value is: My Project. -PROJECT_NAME = "AUnit" +PROJECT_NAME = AUnit # 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 = 1.7.0 +PROJECT_NUMBER = 1.7.1 # 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 @@ -227,6 +227,14 @@ QT_AUTOBRIEF = NO MULTILINE_CPP_IS_BRIEF = NO +# By default Python docstrings are displayed as preformatted text and doxygen's +# special commands cannot be used. By setting PYTHON_DOCSTRING to NO the +# doxygen's special commands can be used and the contents of the docstring +# documentation blocks is shown as doxygen documentation. +# The default value is: YES. + +PYTHON_DOCSTRING = YES + # If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the # documentation from any documented member that it re-implements. # The default value is: YES. @@ -263,12 +271,6 @@ TAB_SIZE = 4 ALIASES = -# This tag can be used to specify a number of word-keyword mappings (TCL only). -# A mapping has the form "name=value". For example adding "class=itcl::class" -# will allow you to use the command class in the itcl::class meaning. - -TCL_SUBST = - # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources # only. Doxygen will then generate output that is more tailored for C. For # instance, some of the names that are used will be different. The list of all @@ -310,18 +312,21 @@ OPTIMIZE_OUTPUT_SLICE = NO # extension. Doxygen has a built-in mapping, but you can override or extend it # using this tag. The format is ext=language, where ext is a file extension, and # language is one of the parsers supported by doxygen: IDL, Java, JavaScript, -# Csharp (C#), C, C++, D, PHP, md (Markdown), Objective-C, Python, Slice, +# 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), VHDL, tcl. 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. +# 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. +# the files are not read by doxygen. When specifying no_extension you should add +# * to the FILE_PATTERNS. +# +# Note see also the list of default file extension mappings. EXTENSION_MAPPING = @@ -455,6 +460,19 @@ TYPEDEF_HIDES_STRUCT = NO LOOKUP_CACHE_SIZE = 0 +# The NUM_PROC_THREADS specifies the number threads doxygen is allowed to use +# during processing. When set to 0 doxygen will based this on the number of +# cores available in the system. You can set it explicitly to a value larger +# than 0 to get more control over the balance between CPU load and processing +# speed. At this moment only the input processing can be done using multiple +# threads. Since this is still an experimental feature the default is set to 1, +# which efficively disables parallel processing. Please report any issues you +# encounter. Generating dot graphs in parallel is controlled by the +# DOT_NUM_THREADS setting. +# Minimum value: 0, maximum value: 32, default value: 1. + +NUM_PROC_THREADS = 1 + #--------------------------------------------------------------------------- # Build related configuration options #--------------------------------------------------------------------------- @@ -518,6 +536,13 @@ EXTRACT_LOCAL_METHODS = NO EXTRACT_ANON_NSPACES = NO +# If this flag is set to YES, the name of an unnamed parameter in a declaration +# will be determined by the corresponding definition. By default unnamed +# parameters remain unnamed in the output. +# The default value is: YES. + +RESOLVE_UNNAMED_PARAMS = YES + # If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all # undocumented members inside documented classes or files. If set to NO these # members will be included in the various overviews, but no documentation @@ -555,11 +580,18 @@ HIDE_IN_BODY_DOCS = 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. +# With the correct setting of option CASE_SENSE_NAMES doxygen will better be +# able to match the capabilities of the underlying filesystem. In case the +# filesystem is case sensitive (i.e. it supports files in the same directory +# whose names only differ in casing), the option must be set to YES to properly +# deal with such files in case they appear in the input. For filesystems that +# are not case sensitive the option should be be set to NO to properly deal with +# output files written for symbols that only differ in casing, such as for two +# classes, one named CLASS and the other named Class, and to also support +# references to files without having to specify the exact matching casing. On +# Windows (including Cygwin) and MacOS, users should typically set this option +# to NO, whereas on Linux or other Unix flavors it should typically be set to +# YES. # The default value is: system dependent. CASE_SENSE_NAMES = YES @@ -798,7 +830,10 @@ WARN_IF_DOC_ERROR = YES WARN_NO_PARAMDOC = NO # If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when -# a warning is encountered. +# a warning is encountered. If the WARN_AS_ERROR tag is set to FAIL_ON_WARNINGS +# then doxygen will continue running as if WARN_AS_ERROR tag is set to NO, but +# at the end of the doxygen process doxygen will return with a non-zero status. +# Possible values are: NO, YES and FAIL_ON_WARNINGS. # The default value is: NO. WARN_AS_ERROR = NO @@ -834,8 +869,8 @@ INPUT = ../src # 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. +# documentation (see: +# https://www.gnu.org/software/libiconv/) for the list of possible encodings. # The default value is: UTF-8. INPUT_ENCODING = UTF-8 @@ -848,13 +883,15 @@ INPUT_ENCODING = UTF-8 # need to set EXTENSION_MAPPING for the extension otherwise the files are not # read by doxygen. # +# Note the list of default checked file patterns might differ from the list of +# default file extension mappings. +# # If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.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, *.f, *.for, *.tcl, *.vhd, -# *.vhdl, *.ucf, *.qsf and *.ice. +# *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, *.f18, *.f, *.for, *.vhd, *.vhdl, +# *.ucf, *.qsf and *.ice. FILE_PATTERNS = *.c \ *.cc \ @@ -1112,16 +1149,22 @@ USE_HTAGS = NO VERBATIM_HEADERS = YES # If the CLANG_ASSISTED_PARSING tag is set to YES then doxygen will use the -# clang parser (see: http://clang.llvm.org/) for more accurate parsing at the -# cost of reduced performance. This can be particularly helpful with template -# rich C++ code for which doxygen's built-in parser lacks the necessary type -# information. +# clang parser (see: +# http://clang.llvm.org/) for more accurate parsing at the cost of reduced +# performance. This can be particularly helpful with template rich C++ code for +# which doxygen's built-in parser lacks the necessary type information. # Note: The availability of this option depends on whether or not doxygen was # generated with the -Duse_libclang=ON option for CMake. # The default value is: NO. CLANG_ASSISTED_PARSING = NO +# If clang assisted parsing is enabled and the CLANG_ADD_INC_PATHS tag is set to +# YES then doxygen will add the directory of each input to the include path. +# The default value is: YES. + +CLANG_ADD_INC_PATHS = YES + # If clang assisted parsing is enabled you can provide the compiler with command # line options that you would normally use when invoking the compiler. Note that # the include paths will already be set by doxygen for the files and directories @@ -1131,10 +1174,13 @@ CLANG_ASSISTED_PARSING = NO CLANG_OPTIONS = # If clang assisted parsing is enabled you can provide the clang parser with the -# path to the compilation database (see: -# http://clang.llvm.org/docs/HowToSetupToolingForLLVM.html) used when the files -# were built. This is equivalent to specifying the "-p" option to a clang tool, -# such as clang-check. These options will then be passed to the parser. +# path to the directory containing a file called compile_commands.json. This +# file is the compilation database (see: +# http://clang.llvm.org/docs/HowToSetupToolingForLLVM.html) containing the +# options used when the source files were built. This is equivalent to +# specifying the -p option to a clang tool, such as clang-check. These options +# will then be passed to the parser. Any options specified with CLANG_OPTIONS +# will be added as well. # Note: The availability of this option depends on whether or not doxygen was # generated with the -Duse_libclang=ON option for CMake. @@ -1151,13 +1197,6 @@ CLANG_DATABASE_PATH = ALPHABETICAL_INDEX = YES -# The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in -# which the alphabetical index list will be split. -# Minimum value: 1, maximum value: 20, default value: 5. -# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. - -COLS_IN_ALPHA_INDEX = 5 - # In case all classes in a project start with a common prefix, all classes will # be put under the same header in the alphabetical index. The IGNORE_PREFIX tag # can be used to specify a prefix (or a list of prefixes) that should be ignored @@ -1328,10 +1367,11 @@ 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 +# 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. @@ -1373,8 +1413,8 @@ 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. +# (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 @@ -1404,7 +1444,7 @@ CHM_FILE = 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). +# (YES) or that it should be included in the main .chm file (NO). # The default value is: NO. # This tag requires that the tag GENERATE_HTMLHELP is set to YES. @@ -1449,7 +1489,8 @@ 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). +# (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. @@ -1457,8 +1498,8 @@ 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). +# 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. @@ -1466,16 +1507,16 @@ 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). +# 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). +# 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 = @@ -1487,9 +1528,9 @@ QHP_CUST_FILTER_ATTRS = 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. +# The QHG_LOCATION tag can be used to specify the location (absolute path +# including file name) of Qt's qhelpgenerator. If non-empty doxygen will try to +# run qhelpgenerator on the generated .qhp file. # This tag requires that the tag GENERATE_QHP is set to YES. QHG_LOCATION = @@ -1566,6 +1607,17 @@ TREEVIEW_WIDTH = 250 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 or inkscape tool). +# The default value is: png. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FORMULA_FORMAT = png + # Use this tag to change the font size of LaTeX formulas included as images in # the HTML documentation. When you change the font size after a successful # doxygen run you need to manually remove any form_*.png images from the HTML @@ -1605,7 +1657,7 @@ 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. +# http://docs.mathjax.org/en/v2.7-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. @@ -1621,7 +1673,7 @@ MATHJAX_FORMAT = HTML-CSS # 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://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/. +# 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 @@ -1635,7 +1687,8 @@ 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 +# (see: +# http://docs.mathjax.org/en/v2.7-latest/output.html) for more details. For an # example see the documentation. # This tag requires that the tag USE_MATHJAX is set to YES. @@ -1682,7 +1735,8 @@ SERVER_BASED_SEARCH = NO # # Doxygen ships with an example indexer (doxyindexer) and search engine # (doxysearch.cgi) which are based on the open source search engine library -# Xapian (see: https://xapian.org/). +# Xapian (see: +# https://xapian.org/). # # See the section "External Indexing and Searching" for details. # The default value is: NO. @@ -1695,8 +1749,9 @@ EXTERNAL_SEARCH = NO # # Doxygen ships with an example indexer (doxyindexer) and search engine # (doxysearch.cgi) which are based on the open source search engine library -# Xapian (see: https://xapian.org/). See the section "External Indexing and -# Searching" for details. +# Xapian (see: +# https://xapian.org/). See the section "External Indexing and Searching" for +# details. # This tag requires that the tag SEARCHENGINE is set to YES. SEARCHENGINE_URL = @@ -1860,9 +1915,11 @@ LATEX_EXTRA_FILES = PDF_HYPERLINKS = YES -# If the USE_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate -# the PDF file directly from the LaTeX files. Set this option to YES, to get a -# higher quality PDF documentation. +# If the USE_PDFLATEX tag is set to YES, doxygen will use the engine as +# specified with LATEX_CMD_NAME to generate the PDF file directly from the LaTeX +# files. Set this option to YES, to get a higher quality PDF documentation. +# +# See also section LATEX_CMD_NAME for selecting the engine. # The default value is: YES. # This tag requires that the tag GENERATE_LATEX is set to YES. @@ -2373,10 +2430,32 @@ UML_LOOK = NO # but if the number exceeds 15, the total amount of fields shown is limited to # 10. # Minimum value: 0, maximum value: 100, default value: 10. -# This tag requires that the tag HAVE_DOT is set to YES. +# This tag requires that the tag UML_LOOK is set to YES. UML_LIMIT_NUM_FIELDS = 10 +# If the DOT_UML_DETAILS tag is set to NO, doxygen will show attributes and +# methods without types and arguments in the UML graphs. If the DOT_UML_DETAILS +# tag is set to YES, doxygen will add type and arguments for attributes and +# methods in the UML graphs. If the DOT_UML_DETAILS tag is set to NONE, doxygen +# will not generate fields with class member information in the UML graphs. The +# class diagrams will look similar to the default class diagrams but using UML +# notation for the relationships. +# Possible values are: NO, YES and NONE. +# The default value is: NO. +# This tag requires that the tag UML_LOOK is set to YES. + +DOT_UML_DETAILS = NO + +# The DOT_WRAP_THRESHOLD tag can be used to set the maximum number of characters +# to display on a single line. If the actual line length exceeds this threshold +# significantly it will wrapped across multiple lines. Some heuristics are apply +# to avoid ugly line breaks. +# Minimum value: 0, maximum value: 1000, default value: 17. +# This tag requires that the tag HAVE_DOT is set to YES. + +DOT_WRAP_THRESHOLD = 17 + # If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and # collaboration graphs will show the relations between templates and their # instances. @@ -2568,9 +2647,11 @@ DOT_MULTI_TARGETS = NO GENERATE_LEGEND = YES -# If the DOT_CLEANUP tag is set to YES, doxygen will remove the intermediate dot +# If the DOT_CLEANUP tag is set to YES, doxygen will remove the intermediate # files that are used to generate the various graphs. +# +# Note: This setting is not only used for dot files but also for msc and +# plantuml temporary files. # The default value is: YES. -# This tag requires that the tag HAVE_DOT is set to YES. DOT_CLEANUP = YES diff --git a/docs/html/AUnitVerbose_8h.html b/docs/html/AUnitVerbose_8h.html index db5752b..d24e1de 100644 --- a/docs/html/AUnitVerbose_8h.html +++ b/docs/html/AUnitVerbose_8h.html @@ -22,7 +22,7 @@
AUnit -  1.7.0 +  1.7.1
Unit testing framework for Arduino platforms inspired by ArduinoUnit and Google Test.
@@ -123,10 +123,10 @@

Macros

-#define AUNIT_VERSION   10700 +#define AUNIT_VERSION   10701   -#define AUNIT_VERSION_STRING   "1.7.0" +#define AUNIT_VERSION_STRING   "1.7.1"  

Detailed Description

diff --git a/docs/html/AUnitVerbose_8h_source.html b/docs/html/AUnitVerbose_8h_source.html index 3724202..1e3b5d7 100644 --- a/docs/html/AUnitVerbose_8h_source.html +++ b/docs/html/AUnitVerbose_8h_source.html @@ -22,7 +22,7 @@
AUnit -  1.7.0 +  1.7.1
Unit testing framework for Arduino platforms inspired by ArduinoUnit and Google Test.
@@ -118,8 +118,8 @@
55 #include "aunit/TestMacros.h"
56 
57 // Version format: xxyyzz == "xx.yy.zz"
-
58 #define AUNIT_VERSION 10700
-
59 #define AUNIT_VERSION_STRING "1.7.0"
+
58 #define AUNIT_VERSION 10701
+
59 #define AUNIT_VERSION_STRING "1.7.1"
60 
61 #endif
AssertVerboseMacros.h
Verbose versions of the macros in AssertMacros.h.
diff --git a/docs/html/AUnit_8h.html b/docs/html/AUnit_8h.html index ccb306a..640ebdd 100644 --- a/docs/html/AUnit_8h.html +++ b/docs/html/AUnit_8h.html @@ -22,7 +22,7 @@
AUnit -  1.7.0 +  1.7.1
Unit testing framework for Arduino platforms inspired by ArduinoUnit and Google Test.
@@ -123,10 +123,10 @@

Macros

-#define AUNIT_VERSION   10700 +#define AUNIT_VERSION   10701   -#define AUNIT_VERSION_STRING   "1.7.0" +#define AUNIT_VERSION_STRING   "1.7.1"  

Detailed Description

diff --git a/docs/html/AUnit_8h_source.html b/docs/html/AUnit_8h_source.html index 3531dc4..e7d2a1a 100644 --- a/docs/html/AUnit_8h_source.html +++ b/docs/html/AUnit_8h_source.html @@ -22,7 +22,7 @@
AUnit -  1.7.0 +  1.7.1
Unit testing framework for Arduino platforms inspired by ArduinoUnit and Google Test.
@@ -118,8 +118,8 @@
65 #include "aunit/TestMacros.h"
66 
67 // Version format: xxyyzz == "xx.yy.zz"
-
68 #define AUNIT_VERSION 10700
-
69 #define AUNIT_VERSION_STRING "1.7.0"
+
68 #define AUNIT_VERSION 10701
+
69 #define AUNIT_VERSION_STRING "1.7.1"
70 
71 #endif
AssertMacros.h
Various assertion macros (assertXxx()) are defined in this header.
diff --git a/docs/html/AssertMacros_8h.html b/docs/html/AssertMacros_8h.html index 79620da..ec39b3f 100644 --- a/docs/html/AssertMacros_8h.html +++ b/docs/html/AssertMacros_8h.html @@ -22,7 +22,7 @@
AUnit -  1.7.0 +  1.7.1
Unit testing framework for Arduino platforms inspired by ArduinoUnit and Google Test.
diff --git a/docs/html/AssertMacros_8h_source.html b/docs/html/AssertMacros_8h_source.html index aa2cedd..d355aaa 100644 --- a/docs/html/AssertMacros_8h_source.html +++ b/docs/html/AssertMacros_8h_source.html @@ -22,7 +22,7 @@
AUnit -  1.7.0 +  1.7.1
Unit testing framework for Arduino platforms inspired by ArduinoUnit and Google Test.
diff --git a/docs/html/AssertVerboseMacros_8h.html b/docs/html/AssertVerboseMacros_8h.html index 896161a..1d583cc 100644 --- a/docs/html/AssertVerboseMacros_8h.html +++ b/docs/html/AssertVerboseMacros_8h.html @@ -22,7 +22,7 @@
AUnit -  1.7.0 +  1.7.1
Unit testing framework for Arduino platforms inspired by ArduinoUnit and Google Test.
diff --git a/docs/html/AssertVerboseMacros_8h_source.html b/docs/html/AssertVerboseMacros_8h_source.html index 1ee906a..b536800 100644 --- a/docs/html/AssertVerboseMacros_8h_source.html +++ b/docs/html/AssertVerboseMacros_8h_source.html @@ -22,7 +22,7 @@
AUnit -  1.7.0 +  1.7.1
Unit testing framework for Arduino platforms inspired by ArduinoUnit and Google Test.
diff --git a/docs/html/Assertion_8cpp_source.html b/docs/html/Assertion_8cpp_source.html index fd206da..31e6b04 100644 --- a/docs/html/Assertion_8cpp_source.html +++ b/docs/html/Assertion_8cpp_source.html @@ -22,7 +22,7 @@
AUnit -  1.7.0 +  1.7.1
Unit testing framework for Arduino platforms inspired by ArduinoUnit and Google Test.
diff --git a/docs/html/Assertion_8h_source.html b/docs/html/Assertion_8h_source.html index 986cecf..e4a5e0d 100644 --- a/docs/html/Assertion_8h_source.html +++ b/docs/html/Assertion_8h_source.html @@ -22,7 +22,7 @@
AUnit -  1.7.0 +  1.7.1
Unit testing framework for Arduino platforms inspired by ArduinoUnit and Google Test.
diff --git a/docs/html/Compare_8cpp_source.html b/docs/html/Compare_8cpp_source.html index bf3def3..ff799c5 100644 --- a/docs/html/Compare_8cpp_source.html +++ b/docs/html/Compare_8cpp_source.html @@ -22,7 +22,7 @@
AUnit -  1.7.0 +  1.7.1
Unit testing framework for Arduino platforms inspired by ArduinoUnit and Google Test.
diff --git a/docs/html/Compare_8h.html b/docs/html/Compare_8h.html index 078142b..2b983e3 100644 --- a/docs/html/Compare_8h.html +++ b/docs/html/Compare_8h.html @@ -22,7 +22,7 @@
AUnit -  1.7.0 +  1.7.1
Unit testing framework for Arduino platforms inspired by ArduinoUnit and Google Test.
diff --git a/docs/html/Compare_8h_source.html b/docs/html/Compare_8h_source.html index 57fedb0..9000219 100644 --- a/docs/html/Compare_8h_source.html +++ b/docs/html/Compare_8h_source.html @@ -22,7 +22,7 @@
AUnit -  1.7.0 +  1.7.1
Unit testing framework for Arduino platforms inspired by ArduinoUnit and Google Test.
diff --git a/docs/html/FCString_8cpp_source.html b/docs/html/FCString_8cpp_source.html index 09a5979..877a840 100644 --- a/docs/html/FCString_8cpp_source.html +++ b/docs/html/FCString_8cpp_source.html @@ -22,7 +22,7 @@
AUnit -  1.7.0 +  1.7.1
Unit testing framework for Arduino platforms inspired by ArduinoUnit and Google Test.
diff --git a/docs/html/FCString_8h_source.html b/docs/html/FCString_8h_source.html index 89362c1..2f33ba4 100644 --- a/docs/html/FCString_8h_source.html +++ b/docs/html/FCString_8h_source.html @@ -22,7 +22,7 @@
AUnit -  1.7.0 +  1.7.1
Unit testing framework for Arduino platforms inspired by ArduinoUnit and Google Test.
diff --git a/docs/html/FakePrint_8h_source.html b/docs/html/FakePrint_8h_source.html index fbcda20..391560d 100644 --- a/docs/html/FakePrint_8h_source.html +++ b/docs/html/FakePrint_8h_source.html @@ -22,7 +22,7 @@
AUnit -  1.7.0 +  1.7.1
Unit testing framework for Arduino platforms inspired by ArduinoUnit and Google Test.
diff --git a/docs/html/Flash_8h.html b/docs/html/Flash_8h.html index 0b612eb..eefefd6 100644 --- a/docs/html/Flash_8h.html +++ b/docs/html/Flash_8h.html @@ -22,7 +22,7 @@
AUnit -  1.7.0 +  1.7.1
Unit testing framework for Arduino platforms inspired by ArduinoUnit and Google Test.
@@ -127,12 +127,14 @@

Detailed Description

Various macros to smooth over the differences among the various platforms with regards to their support for flash strings and the various macros used to create and access them.

On AVR, flash strings are fully supported through the F() and PSTR() macros, and the (const __FlashStringHelper*) pointer. However, the useful FPSTR() macro is not defined.

-

On Teensy-ARM, flash strings are not supported, but F(), PSTR() and (const __FlashStringHelper*) are defined. The useful FPSTR() macro is not defined.

+

Seeeduino SAMD core has a broken implementation of FPSTR(). This file clobbers that implementation.

+

Adafruit's SAMD core fixes the broken FPSTR(), so we don't have to do anything.

+

Arduino's SAMD core breaks backwards compatibility after version >= 1.8.10. AUnit does not support the ArduinoCore-API, so Arduino-branded SAMD boards are explicitly blacklisted.

STM32duino seems to have forked from Teensyduino, so it too has F() and PSTR(), but no FPSTR() macro.

-

On the ESP8266 platform, flash strings are implemented, and the F(), PSTR() and __FlashStringHelper are defined, but the implementation used to be brittle and fail with obscure errors messages. For a single compilation unit, a flash string could not be defined in both an inline and non-inline contexts (see https://github.com/esp8266/Arduino/issues/3369). This bug was fixed in Dec 2018, so we can use normal F(), PSTR(), and FPSTR() macros on the ESP8266.

-

On the ESP32, flash strings are not implemented, but the various F(), PSTR() and __FlashStringHelper symbols are defined for compatibility, similar to Teensy-ARM. Unfortunately, the implementation of FPSTR() was incorrectly defined (https://github.com/espressif/arduino-esp32/issues/1371), but the bug was fixed in ESP32 Core 1.0.3 around Sept 2019. Therefore, ESP32 can now use normal F(), PSTR() and FPSTR() macros.

-

On megaAVR, the F() does not return a (const __FlashStringHelper*), but returns a (const char*). Unfortunately, this breaks AUnit (https://github.com/bxparks/AUnit/issues/56) because a lot of code is generated through macros, which assume that the F() macro returns the correct type.

-

Previously, AUnit used the F() only for the AVR platforms. But with the various fixes, I think it can be activated for ESP8266 and other platforms. Except for megaAVR whose F() returns the wrong type.

+

The ESP8266 platform used to have flash strings which were buggy and brittle, and often failed with obscure errors messages, see for example, https://github.com/esp8266/Arduino/issues/3369. This bug was fixed in Dec 2018, so the ESP8266 is fully supported.

+

The ESP32 had a broken implementation of FPSTR() (https://github.com/espressif/arduino-esp32/issues/1371), but the bug was fixed in ESP32 Core 1.0.3 around Sept 2019. ESP32 is fully supported.

+

On Teensy-ARM, flash strings are not supported, but F(), PSTR() and (const __FlashStringHelper*) are defined. The useful FPSTR() macro is not defined.

+

The megaAVR had a broken implementation of the F() macro (does not return a const __FlashStringHelper*), but returns a (const char*)). But more importantly, megaAVR uses the ArrduinoCore-api which is blacklisted by AUnit, so the megaAVR (e.g. Nano Every) is not supported.

Definition in file Flash.h.

Macro Definition Documentation

@@ -155,7 +157,7 @@

Definition at line 78 of file Flash.h.

+

Definition at line 77 of file Flash.h.

diff --git a/docs/html/Flash_8h_source.html b/docs/html/Flash_8h_source.html index 10629fa..1c7dfe7 100644 --- a/docs/html/Flash_8h_source.html +++ b/docs/html/Flash_8h_source.html @@ -22,7 +22,7 @@
AUnit -  1.7.0 +  1.7.1
Unit testing framework for Arduino platforms inspired by ArduinoUnit and Google Test.
@@ -95,86 +95,92 @@
22 SOFTWARE.
23 */
24 
-
68 #ifndef AUNIT_FLASH_H
-
69 #define AUNIT_FLASH_H
-
70 
-
71 class __FlashStringHelper;
-
72 
-
78 #define AUNIT_FPSTR(pstr) reinterpret_cast<const __FlashStringHelper *>(pstr)
-
79 
-
80 #if defined(ARDUINO_ARCH_AVR)
-
81 
-
82  #include <avr/pgmspace.h>
-
83  #define AUNIT_F(x) F(x)
-
84 
-
85 #elif defined(ARDUINO_ARCH_SAMD)
-
86 
-
87  #include <avr/pgmspace.h>
-
88  #define AUNIT_F(x) F(x)
-
89 
-
90 #elif defined(ESP8266)
-
91 
-
92  #include <pgmspace.h>
-
93  #define AUNIT_F(x) F(x)
-
94 
-
95 #elif defined(ESP32)
+
67 #ifndef AUNIT_FLASH_H
+
68 #define AUNIT_FLASH_H
+
69 
+
70 class __FlashStringHelper;
+
71 
+
77 #define AUNIT_FPSTR(pstr) reinterpret_cast<const __FlashStringHelper *>(pstr)
+
78 
+
79 #if defined(ARDUINO_ARCH_AVR)
+
80 
+
81  #include <avr/pgmspace.h>
+
82  #define AUNIT_F(x) F(x)
+
83 
+
84 // Seeeduino SAMD21 Core is buggy, so we have to hack around it. Unfortunately,
+
85 // the Seeeduino core does not define an identifier for the following boards, so
+
86 // they are not supported:
+
87 // * Wio lite MG126
+
88 // * Wio GPS Board
+
89 // * Wio LTE CAT.1
+
90 #elif defined(SEEED_XIAO_M0) \
+
91  || defined(SEEEDUINO_ZERO) \
+
92  || defined(SEEED_FEMTO_M0) \
+
93  || defined(SEEEDUINO_LORAWAN) \
+
94  || defined(SEEED_WIO_TERMINAL) \
+
95  || defined(SEEED_GROVE_UI_WIRELESS)
96 
-
97  #include <pgmspace.h>
-
98  #define AUNIT_F(x) F(x)
-
99 
-
100  // ESP32 cores don't seem to define SERIAL_PORT_MONITOR
-
101  #if ! defined(SERIAL_PORT_MONITOR)
-
102  #define SERIAL_PORT_MONITOR Serial
-
103  #endif
+
97  #include <avr/pgmspace.h>
+
98 
+
99  // Seeeduino (as of 1.8.4) provides an incorrect definition of FPSTR()
+
100  // so we have to clobber it.
+
101  #undef FPSTR
+
102  #define FPSTR(p) (reinterpret_cast<const __FlashStringHelper *>(p))
+
103  #define AUNIT_F(x) F(x)
104 
-
105 #elif defined(ARDUINO_ARCH_STM32)
-
106 
-
107  #include <avr/pgmspace.h>
-
108  #define AUNIT_F(x) F(x)
-
109 
-
110 #elif defined(EPOXY_DUINO)
-
111 
-
112  #include <pgmspace.h>
-
113  #define AUNIT_F(x) F(x)
-
114 
-
115 #elif defined(ARDUINO_ARCH_MEGAAVR)
-
116 
-
117  #error MegaAVR not supported, https://github.com/bxparks/AUnit/issues/56
+
105 // The following should work for Adafruit SAMD core, and other third party SAMD
+
106 // (SparkFun?) cores which are less buggy. The Arduino SAMD Core breaks
+
107 // backwards compatibility for versions >= 1.8.10. It is blacklisted by the time
+
108 // we get here.
+
109 #elif defined(ARDUINO_ARCH_SAMD)
+
110 
+
111  #include <avr/pgmspace.h>
+
112  #define AUNIT_F(x) F(x)
+
113 
+
114 #elif defined(ESP8266)
+
115 
+
116  #include <pgmspace.h>
+
117  #define AUNIT_F(x) F(x)
118 
-
119 #else
+
119 #elif defined(ESP32)
120 
-
121  #warning Untested platform, AUnit may still work...
-
122 
-
123  #include <avr/pgmspace.h>
-
124  #define AUNIT_F(x) F(x)
-
125 
-
126  #if ! defined(SERIAL_PORT_MONITOR)
-
127  #define SERIAL_PORT_MONITOR Serial
-
128  #endif
-
129 
-
130 #endif
-
131 
-
132 // Define SERIAL_PORT_MONITOR consistently. We should also rename this file to
-
133 // something like "compat.h".
-
134 #if defined(ARDUINO_SAMD_ZERO)
-
135  // If have a real Arduino Zero and using the "Arduino/Genuino Zero (Native
-
136  // USB Port)" configuration on the Arduino IDE, you may need to uncomment
-
137  // the following to clobber SERIAL_PORT_MONITOR to point to the correct
-
138  // SerialUSB.
-
139  //
-
140  // On the other hand, if you are using a SparkFun breakout board, or one of
-
141  // the "SAMD21 M0 Mini" clones, you should be using the SparkFun SAMD Boards,
-
142  // and selecting the "SparkFun SAMD21 Dev Breakout" or the "SparkFun SAMD21
-
143  // Mini Breakout" settings, which will set the SERIAL_PORT_MONITOR macro
-
144  // correctly to SerialUSB.
-
145  #if 0
-
146  #undef SERIAL_PORT_MONITOR
-
147  #define SERIAL_PORT_MONITOR SerialUSB
-
148  #endif
-
149 
-
150 #endif // ARDUINO_SAMD_ZERO
-
151 
-
152 #endif // AUNIT_FLASH_H
+
121  #include <pgmspace.h>
+
122  #define AUNIT_F(x) F(x)
+
123 
+
124  // ESP32 cores don't seem to define SERIAL_PORT_MONITOR
+
125  #if ! defined(SERIAL_PORT_MONITOR)
+
126  #define SERIAL_PORT_MONITOR Serial
+
127  #endif
+
128 
+
129 #elif defined(ARDUINO_ARCH_STM32)
+
130 
+
131  #include <avr/pgmspace.h>
+
132  #define AUNIT_F(x) F(x)
+
133 
+
134 #elif defined(EPOXY_DUINO)
+
135 
+
136  #include <pgmspace.h>
+
137  #define AUNIT_F(x) F(x)
+
138 
+
139 #elif defined(TEENSYDUINO)
+
140 
+
141  #include <pgmspace.h>
+
142  #define AUNIT_F(x) F(x)
+
143 
+
144 #else
+
145 
+
146  #warning Untested platform, AUnit may still work...
+
147 
+
148  #include <avr/pgmspace.h>
+
149  #define AUNIT_F(x) F(x)
+
150 
+
151  #if ! defined(SERIAL_PORT_MONITOR)
+
152  #define SERIAL_PORT_MONITOR Serial
+
153  #endif
+
154 
+
155 #endif
+
156 
+
157 #endif // AUNIT_FLASH_H
diff --git a/docs/html/MetaAssertMacros_8h.html b/docs/html/MetaAssertMacros_8h.html index 0a91880..d65ce2c 100644 --- a/docs/html/MetaAssertMacros_8h.html +++ b/docs/html/MetaAssertMacros_8h.html @@ -22,7 +22,7 @@
AUnit -  1.7.0 +  1.7.1
Unit testing framework for Arduino platforms inspired by ArduinoUnit and Google Test.
@@ -792,7 +792,7 @@

test_##name##_instance.method()))\
return;\
} while (false)
-
AUNIT_FPSTR
#define AUNIT_FPSTR(pstr)
The FPSTR() macro is defined on ESP8266 and ESP32, but not on other platforms (e.g.
Definition: Flash.h:78
+
AUNIT_FPSTR
#define AUNIT_FPSTR(pstr)
The FPSTR() macro is defined on ESP8266 and ESP32, but not on other platforms (e.g.
Definition: Flash.h:77

Internal helper macro, shouldn't be called directly by users.

diff --git a/docs/html/MetaAssertMacros_8h_source.html b/docs/html/MetaAssertMacros_8h_source.html index d19a816..742509b 100644 --- a/docs/html/MetaAssertMacros_8h_source.html +++ b/docs/html/MetaAssertMacros_8h_source.html @@ -22,7 +22,7 @@
AUnit -  1.7.0 +  1.7.1
Unit testing framework for Arduino platforms inspired by ArduinoUnit and Google Test.
diff --git a/docs/html/MetaAssertion_8cpp_source.html b/docs/html/MetaAssertion_8cpp_source.html index fb42761..8cbb6fc 100644 --- a/docs/html/MetaAssertion_8cpp_source.html +++ b/docs/html/MetaAssertion_8cpp_source.html @@ -22,7 +22,7 @@
AUnit -  1.7.0 +  1.7.1
Unit testing framework for Arduino platforms inspired by ArduinoUnit and Google Test.
diff --git a/docs/html/MetaAssertion_8h_source.html b/docs/html/MetaAssertion_8h_source.html index 35cb6c5..30413a0 100644 --- a/docs/html/MetaAssertion_8h_source.html +++ b/docs/html/MetaAssertion_8h_source.html @@ -22,7 +22,7 @@
AUnit -  1.7.0 +  1.7.1
Unit testing framework for Arduino platforms inspired by ArduinoUnit and Google Test.
diff --git a/docs/html/Printer_8cpp_source.html b/docs/html/Printer_8cpp_source.html index 126a48c..b1d55a4 100644 --- a/docs/html/Printer_8cpp_source.html +++ b/docs/html/Printer_8cpp_source.html @@ -22,7 +22,7 @@
AUnit -  1.7.0 +  1.7.1
Unit testing framework for Arduino platforms inspired by ArduinoUnit and Google Test.
diff --git a/docs/html/Printer_8h_source.html b/docs/html/Printer_8h_source.html index c8da835..78a4c42 100644 --- a/docs/html/Printer_8h_source.html +++ b/docs/html/Printer_8h_source.html @@ -22,7 +22,7 @@
AUnit -  1.7.0 +  1.7.1
Unit testing framework for Arduino platforms inspired by ArduinoUnit and Google Test.
diff --git a/docs/html/TestAgain_8cpp_source.html b/docs/html/TestAgain_8cpp_source.html index ca3e126..39ed9ae 100644 --- a/docs/html/TestAgain_8cpp_source.html +++ b/docs/html/TestAgain_8cpp_source.html @@ -22,7 +22,7 @@
AUnit -  1.7.0 +  1.7.1
Unit testing framework for Arduino platforms inspired by ArduinoUnit and Google Test.
diff --git a/docs/html/TestAgain_8h_source.html b/docs/html/TestAgain_8h_source.html index 10bcd87..cdc7168 100644 --- a/docs/html/TestAgain_8h_source.html +++ b/docs/html/TestAgain_8h_source.html @@ -22,7 +22,7 @@
AUnit -  1.7.0 +  1.7.1
Unit testing framework for Arduino platforms inspired by ArduinoUnit and Google Test.
diff --git a/docs/html/TestMacros_8h.html b/docs/html/TestMacros_8h.html index 1888b6f..089c681 100644 --- a/docs/html/TestMacros_8h.html +++ b/docs/html/TestMacros_8h.html @@ -22,7 +22,7 @@
AUnit -  1.7.0 +  1.7.1
Unit testing framework for Arduino platforms inspired by ArduinoUnit and Google Test.
diff --git a/docs/html/TestMacros_8h_source.html b/docs/html/TestMacros_8h_source.html index 558e2a1..761bb21 100644 --- a/docs/html/TestMacros_8h_source.html +++ b/docs/html/TestMacros_8h_source.html @@ -22,7 +22,7 @@
AUnit -  1.7.0 +  1.7.1
Unit testing framework for Arduino platforms inspired by ArduinoUnit and Google Test.
diff --git a/docs/html/TestOnce_8cpp_source.html b/docs/html/TestOnce_8cpp_source.html index 80a05ff..71ad440 100644 --- a/docs/html/TestOnce_8cpp_source.html +++ b/docs/html/TestOnce_8cpp_source.html @@ -22,7 +22,7 @@
AUnit -  1.7.0 +  1.7.1
Unit testing framework for Arduino platforms inspired by ArduinoUnit and Google Test.
diff --git a/docs/html/TestOnce_8h_source.html b/docs/html/TestOnce_8h_source.html index b32b44c..cbe804d 100644 --- a/docs/html/TestOnce_8h_source.html +++ b/docs/html/TestOnce_8h_source.html @@ -22,7 +22,7 @@
AUnit -  1.7.0 +  1.7.1
Unit testing framework for Arduino platforms inspired by ArduinoUnit and Google Test.
diff --git a/docs/html/TestRunner_8cpp_source.html b/docs/html/TestRunner_8cpp_source.html index ad567a8..7f2f662 100644 --- a/docs/html/TestRunner_8cpp_source.html +++ b/docs/html/TestRunner_8cpp_source.html @@ -22,7 +22,7 @@
AUnit -  1.7.0 +  1.7.1
Unit testing framework for Arduino platforms inspired by ArduinoUnit and Google Test.
diff --git a/docs/html/TestRunner_8h_source.html b/docs/html/TestRunner_8h_source.html index 7827a6b..1186c7c 100644 --- a/docs/html/TestRunner_8h_source.html +++ b/docs/html/TestRunner_8h_source.html @@ -22,7 +22,7 @@
AUnit -  1.7.0 +  1.7.1
Unit testing framework for Arduino platforms inspired by ArduinoUnit and Google Test.
diff --git a/docs/html/Test_8cpp_source.html b/docs/html/Test_8cpp_source.html index 34be8fc..c33d0cc 100644 --- a/docs/html/Test_8cpp_source.html +++ b/docs/html/Test_8cpp_source.html @@ -22,7 +22,7 @@
AUnit -  1.7.0 +  1.7.1
Unit testing framework for Arduino platforms inspired by ArduinoUnit and Google Test.
diff --git a/docs/html/Test_8h_source.html b/docs/html/Test_8h_source.html index a38944d..2e490e2 100644 --- a/docs/html/Test_8h_source.html +++ b/docs/html/Test_8h_source.html @@ -22,7 +22,7 @@
AUnit -  1.7.0 +  1.7.1
Unit testing framework for Arduino platforms inspired by ArduinoUnit and Google Test.
diff --git a/docs/html/Verbosity_8h_source.html b/docs/html/Verbosity_8h_source.html index a515aec..ffdf3d4 100644 --- a/docs/html/Verbosity_8h_source.html +++ b/docs/html/Verbosity_8h_source.html @@ -22,7 +22,7 @@
AUnit -  1.7.0 +  1.7.1
Unit testing framework for Arduino platforms inspired by ArduinoUnit and Google Test.
diff --git a/docs/html/annotated.html b/docs/html/annotated.html index 93514cf..08780b2 100644 --- a/docs/html/annotated.html +++ b/docs/html/annotated.html @@ -22,7 +22,7 @@
AUnit -  1.7.0 +  1.7.1
Unit testing framework for Arduino platforms inspired by ArduinoUnit and Google Test.
diff --git a/docs/html/classaunit_1_1Assertion-members.html b/docs/html/classaunit_1_1Assertion-members.html index c541f49..7bcf937 100644 --- a/docs/html/classaunit_1_1Assertion-members.html +++ b/docs/html/classaunit_1_1Assertion-members.html @@ -22,7 +22,7 @@
AUnit -  1.7.0 +  1.7.1
Unit testing framework for Arduino platforms inspired by ArduinoUnit and Google Test.
diff --git a/docs/html/classaunit_1_1Assertion.html b/docs/html/classaunit_1_1Assertion.html index 2898209..1ef6ea5 100644 --- a/docs/html/classaunit_1_1Assertion.html +++ b/docs/html/classaunit_1_1Assertion.html @@ -22,7 +22,7 @@
AUnit -  1.7.0 +  1.7.1
Unit testing framework for Arduino platforms inspired by ArduinoUnit and Google Test.
diff --git a/docs/html/classaunit_1_1MetaAssertion-members.html b/docs/html/classaunit_1_1MetaAssertion-members.html index 091f186..1b02383 100644 --- a/docs/html/classaunit_1_1MetaAssertion-members.html +++ b/docs/html/classaunit_1_1MetaAssertion-members.html @@ -22,7 +22,7 @@
AUnit -  1.7.0 +  1.7.1
Unit testing framework for Arduino platforms inspired by ArduinoUnit and Google Test.
diff --git a/docs/html/classaunit_1_1MetaAssertion.html b/docs/html/classaunit_1_1MetaAssertion.html index 99e287d..af4aa97 100644 --- a/docs/html/classaunit_1_1MetaAssertion.html +++ b/docs/html/classaunit_1_1MetaAssertion.html @@ -22,7 +22,7 @@
AUnit -  1.7.0 +  1.7.1
Unit testing framework for Arduino platforms inspired by ArduinoUnit and Google Test.
diff --git a/docs/html/classaunit_1_1Printer-members.html b/docs/html/classaunit_1_1Printer-members.html index 90c8774..97d026f 100644 --- a/docs/html/classaunit_1_1Printer-members.html +++ b/docs/html/classaunit_1_1Printer-members.html @@ -22,7 +22,7 @@
AUnit -  1.7.0 +  1.7.1
Unit testing framework for Arduino platforms inspired by ArduinoUnit and Google Test.
diff --git a/docs/html/classaunit_1_1Printer.html b/docs/html/classaunit_1_1Printer.html index 81d70e9..da85160 100644 --- a/docs/html/classaunit_1_1Printer.html +++ b/docs/html/classaunit_1_1Printer.html @@ -22,7 +22,7 @@
AUnit -  1.7.0 +  1.7.1
Unit testing framework for Arduino platforms inspired by ArduinoUnit and Google Test.
diff --git a/docs/html/classaunit_1_1Test-members.html b/docs/html/classaunit_1_1Test-members.html index e4ea404..e799bcd 100644 --- a/docs/html/classaunit_1_1Test-members.html +++ b/docs/html/classaunit_1_1Test-members.html @@ -22,7 +22,7 @@
AUnit -  1.7.0 +  1.7.1
Unit testing framework for Arduino platforms inspired by ArduinoUnit and Google Test.
diff --git a/docs/html/classaunit_1_1Test.html b/docs/html/classaunit_1_1Test.html index 9201b8d..ea6f36c 100644 --- a/docs/html/classaunit_1_1Test.html +++ b/docs/html/classaunit_1_1Test.html @@ -22,7 +22,7 @@
AUnit -  1.7.0 +  1.7.1
Unit testing framework for Arduino platforms inspired by ArduinoUnit and Google Test.
diff --git a/docs/html/classaunit_1_1TestAgain-members.html b/docs/html/classaunit_1_1TestAgain-members.html index 873b25e..c9e0ae4 100644 --- a/docs/html/classaunit_1_1TestAgain-members.html +++ b/docs/html/classaunit_1_1TestAgain-members.html @@ -22,7 +22,7 @@
AUnit -  1.7.0 +  1.7.1
Unit testing framework for Arduino platforms inspired by ArduinoUnit and Google Test.
diff --git a/docs/html/classaunit_1_1TestAgain.html b/docs/html/classaunit_1_1TestAgain.html index ea46652..25e00c4 100644 --- a/docs/html/classaunit_1_1TestAgain.html +++ b/docs/html/classaunit_1_1TestAgain.html @@ -22,7 +22,7 @@
AUnit -  1.7.0 +  1.7.1
Unit testing framework for Arduino platforms inspired by ArduinoUnit and Google Test.
diff --git a/docs/html/classaunit_1_1TestOnce-members.html b/docs/html/classaunit_1_1TestOnce-members.html index ed70bf8..b989bb0 100644 --- a/docs/html/classaunit_1_1TestOnce-members.html +++ b/docs/html/classaunit_1_1TestOnce-members.html @@ -22,7 +22,7 @@
AUnit -  1.7.0 +  1.7.1
Unit testing framework for Arduino platforms inspired by ArduinoUnit and Google Test.
diff --git a/docs/html/classaunit_1_1TestOnce.html b/docs/html/classaunit_1_1TestOnce.html index ac00f14..ae16d64 100644 --- a/docs/html/classaunit_1_1TestOnce.html +++ b/docs/html/classaunit_1_1TestOnce.html @@ -22,7 +22,7 @@
AUnit -  1.7.0 +  1.7.1
Unit testing framework for Arduino platforms inspired by ArduinoUnit and Google Test.
diff --git a/docs/html/classaunit_1_1TestRunner-members.html b/docs/html/classaunit_1_1TestRunner-members.html index 2c81bc3..8def119 100644 --- a/docs/html/classaunit_1_1TestRunner-members.html +++ b/docs/html/classaunit_1_1TestRunner-members.html @@ -22,7 +22,7 @@
AUnit -  1.7.0 +  1.7.1
Unit testing framework for Arduino platforms inspired by ArduinoUnit and Google Test.
diff --git a/docs/html/classaunit_1_1TestRunner.html b/docs/html/classaunit_1_1TestRunner.html index 4547bd9..b8fbdea 100644 --- a/docs/html/classaunit_1_1TestRunner.html +++ b/docs/html/classaunit_1_1TestRunner.html @@ -22,7 +22,7 @@
AUnit -  1.7.0 +  1.7.1
Unit testing framework for Arduino platforms inspired by ArduinoUnit and Google Test.
diff --git a/docs/html/classaunit_1_1Verbosity-members.html b/docs/html/classaunit_1_1Verbosity-members.html index ef2bbff..c26d4c6 100644 --- a/docs/html/classaunit_1_1Verbosity-members.html +++ b/docs/html/classaunit_1_1Verbosity-members.html @@ -22,7 +22,7 @@
AUnit -  1.7.0 +  1.7.1
Unit testing framework for Arduino platforms inspired by ArduinoUnit and Google Test.
diff --git a/docs/html/classaunit_1_1Verbosity.html b/docs/html/classaunit_1_1Verbosity.html index bf442bc..8368e89 100644 --- a/docs/html/classaunit_1_1Verbosity.html +++ b/docs/html/classaunit_1_1Verbosity.html @@ -22,7 +22,7 @@
AUnit -  1.7.0 +  1.7.1
Unit testing framework for Arduino platforms inspired by ArduinoUnit and Google Test.
diff --git a/docs/html/classaunit_1_1fake_1_1FakePrint-members.html b/docs/html/classaunit_1_1fake_1_1FakePrint-members.html index 2cdfe31..ed96797 100644 --- a/docs/html/classaunit_1_1fake_1_1FakePrint-members.html +++ b/docs/html/classaunit_1_1fake_1_1FakePrint-members.html @@ -22,7 +22,7 @@
AUnit -  1.7.0 +  1.7.1
Unit testing framework for Arduino platforms inspired by ArduinoUnit and Google Test.
diff --git a/docs/html/classaunit_1_1fake_1_1FakePrint.html b/docs/html/classaunit_1_1fake_1_1FakePrint.html index 464b20a..c912edc 100644 --- a/docs/html/classaunit_1_1fake_1_1FakePrint.html +++ b/docs/html/classaunit_1_1fake_1_1FakePrint.html @@ -22,7 +22,7 @@
AUnit -  1.7.0 +  1.7.1
Unit testing framework for Arduino platforms inspired by ArduinoUnit and Google Test.
diff --git a/docs/html/classaunit_1_1internal_1_1FCString-members.html b/docs/html/classaunit_1_1internal_1_1FCString-members.html index ce7afc7..da4b848 100644 --- a/docs/html/classaunit_1_1internal_1_1FCString-members.html +++ b/docs/html/classaunit_1_1internal_1_1FCString-members.html @@ -22,7 +22,7 @@
AUnit -  1.7.0 +  1.7.1
Unit testing framework for Arduino platforms inspired by ArduinoUnit and Google Test.
diff --git a/docs/html/classaunit_1_1internal_1_1FCString.html b/docs/html/classaunit_1_1internal_1_1FCString.html index 32c9288..dc58834 100644 --- a/docs/html/classaunit_1_1internal_1_1FCString.html +++ b/docs/html/classaunit_1_1internal_1_1FCString.html @@ -22,7 +22,7 @@
AUnit -  1.7.0 +  1.7.1
Unit testing framework for Arduino platforms inspired by ArduinoUnit and Google Test.
diff --git a/docs/html/classes.html b/docs/html/classes.html index f74ea8e..616e7df 100644 --- a/docs/html/classes.html +++ b/docs/html/classes.html @@ -22,7 +22,7 @@
AUnit -  1.7.0 +  1.7.1
Unit testing framework for Arduino platforms inspired by ArduinoUnit and Google Test.
diff --git a/docs/html/dir_000000_000001.html b/docs/html/dir_000000_000001.html index 76c845a..0157c92 100644 --- a/docs/html/dir_000000_000001.html +++ b/docs/html/dir_000000_000001.html @@ -22,7 +22,7 @@
AUnit -  1.7.0 +  1.7.1
Unit testing framework for Arduino platforms inspired by ArduinoUnit and Google Test.
diff --git a/docs/html/dir_68267d1309a1af8e8297ef4c3efbcdba.html b/docs/html/dir_68267d1309a1af8e8297ef4c3efbcdba.html index 0d135a4..35dedb4 100644 --- a/docs/html/dir_68267d1309a1af8e8297ef4c3efbcdba.html +++ b/docs/html/dir_68267d1309a1af8e8297ef4c3efbcdba.html @@ -22,7 +22,7 @@
AUnit -  1.7.0 +  1.7.1
Unit testing framework for Arduino platforms inspired by ArduinoUnit and Google Test.
diff --git a/docs/html/dir_81cd3825682eb05918933587e078c005.html b/docs/html/dir_81cd3825682eb05918933587e078c005.html index af4125c..0f972ba 100644 --- a/docs/html/dir_81cd3825682eb05918933587e078c005.html +++ b/docs/html/dir_81cd3825682eb05918933587e078c005.html @@ -22,7 +22,7 @@
AUnit -  1.7.0 +  1.7.1
Unit testing framework for Arduino platforms inspired by ArduinoUnit and Google Test.
diff --git a/docs/html/dir_9268cfe6e304750d3a96b29cda140489.html b/docs/html/dir_9268cfe6e304750d3a96b29cda140489.html index 6747243..a4d0bd3 100644 --- a/docs/html/dir_9268cfe6e304750d3a96b29cda140489.html +++ b/docs/html/dir_9268cfe6e304750d3a96b29cda140489.html @@ -22,7 +22,7 @@
AUnit -  1.7.0 +  1.7.1
Unit testing framework for Arduino platforms inspired by ArduinoUnit and Google Test.
diff --git a/docs/html/dir_dc26540604d17911199600d9c2812a4e.html b/docs/html/dir_dc26540604d17911199600d9c2812a4e.html index ed88de8..32a293e 100644 --- a/docs/html/dir_dc26540604d17911199600d9c2812a4e.html +++ b/docs/html/dir_dc26540604d17911199600d9c2812a4e.html @@ -22,7 +22,7 @@
AUnit -  1.7.0 +  1.7.1
Unit testing framework for Arduino platforms inspired by ArduinoUnit and Google Test.
diff --git a/docs/html/files.html b/docs/html/files.html index f8caa3c..2343f55 100644 --- a/docs/html/files.html +++ b/docs/html/files.html @@ -22,7 +22,7 @@
AUnit -  1.7.0 +  1.7.1
Unit testing framework for Arduino platforms inspired by ArduinoUnit and Google Test.
diff --git a/docs/html/functions.html b/docs/html/functions.html index 33e0d7b..68d7fdd 100644 --- a/docs/html/functions.html +++ b/docs/html/functions.html @@ -22,7 +22,7 @@
AUnit -  1.7.0 +  1.7.1
Unit testing framework for Arduino platforms inspired by ArduinoUnit and Google Test.
diff --git a/docs/html/functions_func.html b/docs/html/functions_func.html index 21a0023..75f7fb7 100644 --- a/docs/html/functions_func.html +++ b/docs/html/functions_func.html @@ -22,7 +22,7 @@
AUnit -  1.7.0 +  1.7.1
Unit testing framework for Arduino platforms inspired by ArduinoUnit and Google Test.
diff --git a/docs/html/functions_type.html b/docs/html/functions_type.html index 8348196..5c4775c 100644 --- a/docs/html/functions_type.html +++ b/docs/html/functions_type.html @@ -22,7 +22,7 @@
AUnit -  1.7.0 +  1.7.1
Unit testing framework for Arduino platforms inspired by ArduinoUnit and Google Test.
diff --git a/docs/html/functions_vars.html b/docs/html/functions_vars.html index 879a047..5c37a21 100644 --- a/docs/html/functions_vars.html +++ b/docs/html/functions_vars.html @@ -22,7 +22,7 @@
AUnit -  1.7.0 +  1.7.1
Unit testing framework for Arduino platforms inspired by ArduinoUnit and Google Test.
diff --git a/docs/html/globals.html b/docs/html/globals.html index 33179f0..38a101b 100644 --- a/docs/html/globals.html +++ b/docs/html/globals.html @@ -22,7 +22,7 @@
AUnit -  1.7.0 +  1.7.1
Unit testing framework for Arduino platforms inspired by ArduinoUnit and Google Test.
diff --git a/docs/html/globals_defs.html b/docs/html/globals_defs.html index 0b067eb..a8cd001 100644 --- a/docs/html/globals_defs.html +++ b/docs/html/globals_defs.html @@ -22,7 +22,7 @@
AUnit -  1.7.0 +  1.7.1
Unit testing framework for Arduino platforms inspired by ArduinoUnit and Google Test.
diff --git a/docs/html/graph_legend.html b/docs/html/graph_legend.html index 42ae0d1..7d2ba6c 100644 --- a/docs/html/graph_legend.html +++ b/docs/html/graph_legend.html @@ -22,7 +22,7 @@
AUnit -  1.7.0 +  1.7.1
Unit testing framework for Arduino platforms inspired by ArduinoUnit and Google Test.
diff --git a/docs/html/gtest_8h.html b/docs/html/gtest_8h.html index 7d2526b..d151375 100644 --- a/docs/html/gtest_8h.html +++ b/docs/html/gtest_8h.html @@ -22,7 +22,7 @@
AUnit -  1.7.0 +  1.7.1
Unit testing framework for Arduino platforms inspired by ArduinoUnit and Google Test.
diff --git a/docs/html/gtest_8h_source.html b/docs/html/gtest_8h_source.html index e4f27a5..1e0666d 100644 --- a/docs/html/gtest_8h_source.html +++ b/docs/html/gtest_8h_source.html @@ -22,7 +22,7 @@
AUnit -  1.7.0 +  1.7.1
Unit testing framework for Arduino platforms inspired by ArduinoUnit and Google Test.
diff --git a/docs/html/hierarchy.html b/docs/html/hierarchy.html index 0180125..06d288e 100644 --- a/docs/html/hierarchy.html +++ b/docs/html/hierarchy.html @@ -22,7 +22,7 @@
AUnit -  1.7.0 +  1.7.1
Unit testing framework for Arduino platforms inspired by ArduinoUnit and Google Test.
diff --git a/docs/html/index.html b/docs/html/index.html index ac6f300..f84803d 100644 --- a/docs/html/index.html +++ b/docs/html/index.html @@ -22,7 +22,7 @@
AUnit -  1.7.0 +  1.7.1
Unit testing framework for Arduino platforms inspired by ArduinoUnit and Google Test.
diff --git a/docs/html/inherits.html b/docs/html/inherits.html index f533b0a..9f7ea2b 100644 --- a/docs/html/inherits.html +++ b/docs/html/inherits.html @@ -22,7 +22,7 @@
AUnit -  1.7.0 +  1.7.1
Unit testing framework for Arduino platforms inspired by ArduinoUnit and Google Test.
diff --git a/docs/html/md__home_brian_src_AUnit_src_aunit_fake_README.html b/docs/html/md__home_brian_src_AUnit_src_aunit_fake_README.html index d9d62c7..d8733a0 100644 --- a/docs/html/md__home_brian_src_AUnit_src_aunit_fake_README.html +++ b/docs/html/md__home_brian_src_AUnit_src_aunit_fake_README.html @@ -22,7 +22,7 @@
AUnit -  1.7.0 +  1.7.1
Unit testing framework for Arduino platforms inspired by ArduinoUnit and Google Test.
diff --git a/docs/html/pages.html b/docs/html/pages.html index 1655ad8..eb38686 100644 --- a/docs/html/pages.html +++ b/docs/html/pages.html @@ -22,7 +22,7 @@
AUnit -  1.7.0 +  1.7.1
Unit testing framework for Arduino platforms inspired by ArduinoUnit and Google Test.
diff --git a/docs/html/print64_8cpp_source.html b/docs/html/print64_8cpp_source.html index 6737d1e..8232032 100644 --- a/docs/html/print64_8cpp_source.html +++ b/docs/html/print64_8cpp_source.html @@ -22,7 +22,7 @@
AUnit -  1.7.0 +  1.7.1
Unit testing framework for Arduino platforms inspired by ArduinoUnit and Google Test.
diff --git a/docs/html/print64_8h.html b/docs/html/print64_8h.html index d25a6cb..ccb57f2 100644 --- a/docs/html/print64_8h.html +++ b/docs/html/print64_8h.html @@ -22,7 +22,7 @@
AUnit -  1.7.0 +  1.7.1
Unit testing framework for Arduino platforms inspired by ArduinoUnit and Google Test.
diff --git a/docs/html/print64_8h_source.html b/docs/html/print64_8h_source.html index 73ede1a..a4f5f53 100644 --- a/docs/html/print64_8h_source.html +++ b/docs/html/print64_8h_source.html @@ -22,7 +22,7 @@
AUnit -  1.7.0 +  1.7.1
Unit testing framework for Arduino platforms inspired by ArduinoUnit and Google Test.
diff --git a/docs/html/string__util_8cpp_source.html b/docs/html/string__util_8cpp_source.html index bfe3d38..a259555 100644 --- a/docs/html/string__util_8cpp_source.html +++ b/docs/html/string__util_8cpp_source.html @@ -22,7 +22,7 @@
AUnit -  1.7.0 +  1.7.1
Unit testing framework for Arduino platforms inspired by ArduinoUnit and Google Test.
diff --git a/docs/html/string__util_8h_source.html b/docs/html/string__util_8h_source.html index 23fb44e..6deb44c 100644 --- a/docs/html/string__util_8h_source.html +++ b/docs/html/string__util_8h_source.html @@ -22,7 +22,7 @@
AUnit -  1.7.0 +  1.7.1
Unit testing framework for Arduino platforms inspired by ArduinoUnit and Google Test.
diff --git a/examples/AUnitPlatformIO/AUnitPlatformIO.ino b/examples/AUnitPlatformIO/AUnitPlatformIO.ino index 0fe45a3..56ce7d3 100644 --- a/examples/AUnitPlatformIO/AUnitPlatformIO.ino +++ b/examples/AUnitPlatformIO/AUnitPlatformIO.ino @@ -11,11 +11,14 @@ test(exampleTest) { //---------------------------------------------------------------------------- void setup() { -#if ARDUINO +#if ! defined(EPOXY_DUINO) delay(1000); // wait for stability on some boards to prevent garbage Serial #endif Serial.begin(115200); // ESP8266 default of 74880 not supported on Linux while(!Serial); // for the Arduino Leonardo/Micro only +#if defined(EPOXY_DUINO) + Serial.setLineModeUnix(); +#endif } void loop() { diff --git a/examples/AUnitPlatformIO/src/AUnitPlatformIO.ino b/examples/AUnitPlatformIO/src/AUnitPlatformIO.ino index dd20cee..2421904 100644 --- a/examples/AUnitPlatformIO/src/AUnitPlatformIO.ino +++ b/examples/AUnitPlatformIO/src/AUnitPlatformIO.ino @@ -20,11 +20,14 @@ test(exampleTest) { //---------------------------------------------------------------------------- void setup() { -#if ARDUINO +#if ! defined(EPOXY_DUINO) delay(1000); // wait for stability on some boards to prevent garbage Serial #endif Serial.begin(115200); // ESP8266 default of 74880 not supported on Linux while(!Serial); // for the Arduino Leonardo/Micro only +#if defined(EPOXY_DUINO) + Serial.setLineModeUnix(); +#endif } void loop() { diff --git a/examples/MemoryBenchmark/Makefile b/examples/MemoryBenchmark/Makefile new file mode 100644 index 0000000..cc65ff1 --- /dev/null +++ b/examples/MemoryBenchmark/Makefile @@ -0,0 +1,47 @@ +# See https://github.com/bxparks/EpoxyDuino for documentation about using +# EpoxyDuino to compile and run AUnit tests natively on Linux or MacOS. + +APP_NAME := MemoryBenchmark +ARDUINO_LIBS := AUnit +MORE_CLEAN := more_clean +include ../../../EpoxyDuino/EpoxyDuino.mk + +.PHONY: benchmarks + +TARGETS := nano.txt micro.txt samd21.txt stm32.txt samd51.txt \ + esp8266.txt esp32.txt + +README.md: $(TARGETS) generate_readme.py generate_table.awk + ./generate_readme.py > $@ + +benchmarks: $(TARGETS) + +nano.txt: + ./collect.sh --cli nano $@ + +micro.txt: + ./collect.sh --cli micro $@ + +samd21.txt: + ./collect.sh --cli xiao $@ + +stm32.txt: + ./collect.sh --cli stm32 $@ + +samd51.txt: + ./collect.sh --cli itsym4 $@ + +esp8266.txt: + ./collect.sh --cli nodemcu $@ + +esp32.txt: + ./collect.sh --cli esp32 $@ + +epoxy: + ./validate_using_epoxy_duino.sh + +more_clean: + echo "Use 'make clean_benchmarks' to remove *.txt files" + +clean_benchmarks: + rm -f $(TARGETS) diff --git a/examples/MemoryBenchmark/MemoryBenchmark.ino b/examples/MemoryBenchmark/MemoryBenchmark.ino new file mode 100644 index 0000000..b278af7 --- /dev/null +++ b/examples/MemoryBenchmark/MemoryBenchmark.ino @@ -0,0 +1,69 @@ +/* + * Determine the flash and static memory consumption of a minimal AUnit test. + */ + +#include // uint8_t +#include + +// List of features of the AUnit library that we want to examine. +#define FEATURE_BASELINE 0 +#define FEATURE_AUNIT 1 +#define FEATURE_AUNIT_VERBOSE 2 + +// Select one of the FEATURE_* parameter and compile. Then look at the flash +// and RAM usage, compared to FEATURE_BASELINE usage to determine how much +// flash and RAM is consumed by the selected feature. +// NOTE: This line is modified by a 'sed' script in collect.sh. Be careful +// when modifying its format. +#define FEATURE 0 + +#if FEATURE == FEATURE_AUNIT + #include + using namespace aunit; +#elif FEATURE == FEATURE_AUNIT_VERBOSE + #include + using namespace aunit; +#endif + +// Define SERIAL_PORT_MONITOR for ESP32 +#ifndef SERIAL_PORT_MONITOR + #define SERIAL_PORT_MONITOR Serial +#endif + +// Set this variable to prevent the compiler optimizer from removing the code +// being tested when it determines that it does nothing. +volatile uint8_t guard; + +// Define one unit test if FEATURE_AUNIT is enabled. +#if FEATURE == FEATURE_BASELINE + // pass +#elif FEATURE == FEATURE_AUNIT || FEATURE == FEATURE_AUNIT_VERBOSE +test(atest) { + guard = 1; + assertEqual(1, guard); +} +#else + #error Unknown FEATURE +#endif + +void setup() { +#if ! defined(EPOXY_DUINO) + delay(2000); +#endif + + // Setup the Serial, to force inclusion of the Print class in the Baseline, so + // that we can measure the incremental amount of code brought in by PrintStr<> + // and PrintStrN<>. + SERIAL_PORT_MONITOR.begin(115200); + while (! SERIAL_PORT_MONITOR); // Leonardo/Micro + +#if defined(EPOXY_DUINO) + SERIAL_PORT_MONITOR.setLineModeUnix(); +#endif +} + +void loop() { +#if FEATURE != FEATURE_BASELINE + aunit::TestRunner::run(); +#endif +} diff --git a/examples/MemoryBenchmark/README.md b/examples/MemoryBenchmark/README.md new file mode 100644 index 0000000..91b36a7 --- /dev/null +++ b/examples/MemoryBenchmark/README.md @@ -0,0 +1,163 @@ +# Memory Benchmark + +The `MemoryBenchmark.ino` was compiled with each `FEATURE_*` and the flash +memory and static RAM sizes were recorded. The `FEATURE_BASELINE` selection is +the baseline, and its memory usage numbers are subtracted from the subsequent +`FEATURE_*` memory usage. + +**Version**: AUnit v1.7.1 + +**DO NOT EDIT**: This file was auto-generated using `make README.md`. + +## How to Regenerate + +To regenerate this README.md: + +``` +$ make clean_benchmarks +$ make benchmarks +$ make README.md +``` + +The `make benchmarks` target uses `collect.sh` script which calls `auniter.sh` +(https://github.com/bxparks/AUniter) to invoke the Arduino IDE programmatically. +It produces a `*.txt` file with the flash and ram usage information (e.g. +`nano.txt`). + +The `make README.md` command calls the `generated_readme.py` Python script which +generates this `README.md` file. The ASCII tables below are generated by the +`generate_table.awk` script, which takes each `*.txt` file and converts it to an +ASCII table. + +## Library Size Changes + +## Arduino Nano + +* 16MHz ATmega328P +* Arduino IDE 1.8.19, Arduino CLI 0.33.0 +* Arduino AVR Boards 1.8.6 + +``` ++---------------------------------------------------------------------+ +| Functionality | flash/ ram | delta | +|----------------------------------------+--------------+-------------| +| Baseline | 1586/ 185 | 0/ 0 | +|----------------------------------------+--------------+-------------| +| AUnit Single Test | 4456/ 366 | 2870/ 181 | +| AUnit Single Test Verbose | 4500/ 366 | 2914/ 181 | ++---------------------------------------------------------------------+ + +``` + +## Sparkfun Pro Micro + +* 16 MHz ATmega32U4 +* Arduino IDE 1.8.19, Arduino CLI 0.33.0 +* SparkFun AVR Boards 1.1.13 + +``` ++---------------------------------------------------------------------+ +| Functionality | flash/ ram | delta | +|----------------------------------------+--------------+-------------| +| Baseline | 3572/ 150 | 0/ 0 | +|----------------------------------------+--------------+-------------| +| AUnit Single Test | 6410/ 329 | 2838/ 179 | +| AUnit Single Test Verbose | 6454/ 329 | 2882/ 179 | ++---------------------------------------------------------------------+ + +``` + +## SAMD21 Seeeduino XIAO M0 + +* SAMD51, 120 MHz ARM Cortex-M4 +* Arduino IDE 1.8.19, Arduino CLI 0.33.0 +* Seeeduino SAMD 1.8.4 + +``` ++---------------------------------------------------------------------+ +| Functionality | flash/ ram | delta | +|----------------------------------------+--------------+-------------| +| Baseline | 34164/ 0 | 0/ 0 | +|----------------------------------------+--------------+-------------| +| AUnit Single Test | 36436/ 0 | 2272/ 0 | +| AUnit Single Test Verbose | 36492/ 0 | 2328/ 0 | ++---------------------------------------------------------------------+ + +``` + +## STM32 Blue Pill + +* STM32F103C8, 72 MHz ARM Cortex-M3 +* Arduino IDE 1.8.19, Arduino CLI 0.33.0 +* STM32duino 2.5.0 + +``` ++---------------------------------------------------------------------+ +| Functionality | flash/ ram | delta | +|----------------------------------------+--------------+-------------| +| Baseline | 21540/ 3836 | 0/ 0 | +|----------------------------------------+--------------+-------------| +| AUnit Single Test | 23648/ 3904 | 2108/ 68 | +| AUnit Single Test Verbose | 23704/ 3904 | 2164/ 68 | ++---------------------------------------------------------------------+ + +``` + +## SAMD51 Adafruit ItsyBitsy M4 + +* SAMD51, 120 MHz ARM Cortex-M4 +* Arduino IDE 1.8.19, Arduino CLI 0.33.0 +* Adafruit SAMD 1.7.11 + +``` ++---------------------------------------------------------------------+ +| Functionality | flash/ ram | delta | +|----------------------------------------+--------------+-------------| +| Baseline | 10664/ 0 | 0/ 0 | +|----------------------------------------+--------------+-------------| +| AUnit Single Test | 12816/ 0 | 2152/ 0 | +| AUnit Single Test Verbose | 12872/ 0 | 2208/ 0 | ++---------------------------------------------------------------------+ + +``` + +## ESP8266 + +* NodeMCU 1.0, 80MHz ESP8266 +* Arduino IDE 1.8.19, Arduino CLI 0.33.0 +* ESP8266 Boards 3.0.2 + +``` ++---------------------------------------------------------------------+ +| Functionality | flash/ ram | delta | +|----------------------------------------+--------------+-------------| +| Baseline | 264949/27984 | 0/ 0 | +|----------------------------------------+--------------+-------------| +| AUnit Single Test | 268021/28148 | 3072/ 164 | +| AUnit Single Test Verbose | 268081/28148 | 3132/ 164 | ++---------------------------------------------------------------------+ + +``` + +## ESP32 + +* ESP32-01 Dev Board, 240 MHz Tensilica LX6 +* Arduino IDE 1.8.19, Arduino CLI 0.33.0 +* ESP32 Boards 2.0.9 + +``` ++---------------------------------------------------------------------+ +| Functionality | flash/ ram | delta | +|----------------------------------------+--------------+-------------| +| Baseline | 259189/22352 | 0/ 0 | +|----------------------------------------+--------------+-------------| +| AUnit Single Test | 265273/22448 | 6084/ 96 | +| AUnit Single Test Verbose | 265341/22448 | 6152/ 96 | ++---------------------------------------------------------------------+ + +``` + +RAM usage remains constant as more objects are created, which indicates that an +initial pool of a certain minimum size is created regardless of the actual RAM +usage by objects. + diff --git a/examples/MemoryBenchmark/collect.sh b/examples/MemoryBenchmark/collect.sh new file mode 100755 index 0000000..142d7b5 --- /dev/null +++ b/examples/MemoryBenchmark/collect.sh @@ -0,0 +1,114 @@ +#!/usr/bin/env bash +# +# Shell script that runs 'auniter verify ${board} MemoryBenchmark.ino', +# and collects the flash memory and static RAM usage for each of +# the FEATURE (0..13). +# +# Usage: collect.sh {board} {result_file} +# +# Creates a ${board}.out file containing: +# +# FEATURE flash max_flash ram max_ram +# 0 aa bb cc dd +# ... +# 13 aa bb cc dd + +set -eu + +PROGRAM_NAME='MemoryBenchmark.ino' +NUM_FEATURES=2 # excluding Baseline + +# Assume that https://github.com/bxparks/AUniter is installed as a +# sibling project to AceCommon. +AUNITER_CMD='../../../AUniter/tools/auniter.sh' +auniter_out_file= + +function usage() { + echo 'Usage: collect.sh {board} {result_file}' + exit 1 +} + +function cleanup() { + # Remove any temporary file + if [[ "$auniter_out_file" != '' ]]; then + rm -f $auniter_out_file + fi + + # Restore the 'FEATURE' line + sed -i -e "s/#define FEATURE [0-9]*/#define FEATURE 0/" $PROGRAM_NAME +} + +function create_temp_file() { + auniter_out_file= + auniter_out_file=$(mktemp /tmp/memory_benchmark.auniter.XXXXXX) +} + +# Usage: collect_for_board $cli_flag $board $result_file +# Sends output to $result_file. +function collect_for_board() { + local cli_flag="$1" + local board=$2 + local result_file=$3 + + for feature in $(seq 0 $NUM_FEATURES); do + echo "Collecting flash and ram usage for FEATURE $feature" + sed -i -e "s/#define FEATURE [0-9]*/#define FEATURE $feature/" \ + $PROGRAM_NAME + + if ($AUNITER_CMD "$cli_flag" verify $board $PROGRAM_NAME 2>&1) > \ + $auniter_out_file; then + extract_memory "$feature" "$result_file" + + elif grep -q 'Sketch too big' $auniter_out_file; then + # Ignore 'Sketch too big' condition, since we just want to + # collect the flash and ram usage numbers. + extract_memory "$feature" "$result_file" + + elif grep -q 'region.*overflowed by' $auniter_out_file; then + # When STM32duino overflows, it does not print any useful info. + # Print special markers to tell generate_table.awk about the + # overflow. + echo $feature -1 -1 -1 -1 >> $result_file + + else + # Can't handle the error, so echo the output and exit the script. + cat $auniter_out_file + exit 1 + fi + done +} + +function extract_memory() { + local feature=$1 + local result_file=$2 + + local flash=$(grep 'Sketch uses' $auniter_out_file | + awk '{print $3, $12}') + local memory=$(grep 'Global variables' $auniter_out_file | + awk '{print $4, $18}') + echo $feature $flash $memory >> $result_file +} + +trap "cleanup" EXIT + +# Parse flags. +cli_flag='--cli' +while [[ $# -gt 0 ]]; do + case $1 in + --cli) cli_flag='--cli' ;; + --ide) cli_flag='--ide' ;; + --help|-h) usage ;; + --) shift; break ;; + -*) echo "Unknown flag '$1'" 1>&2; usage 1>&2 ;; + *) break ;; + esac + shift +done +if [[ $# < 2 ]]; then + usage +fi + +rm -f $2 +create_temp_file +echo "==== Collecting for board: $1" +collect_for_board "$cli_flag" "$@" diff --git a/examples/MemoryBenchmark/esp32.txt b/examples/MemoryBenchmark/esp32.txt new file mode 100644 index 0000000..f5f7951 --- /dev/null +++ b/examples/MemoryBenchmark/esp32.txt @@ -0,0 +1,3 @@ +0 259189 1310720 22352 327680 +1 265273 1310720 22448 327680 +2 265341 1310720 22448 327680 diff --git a/examples/MemoryBenchmark/esp8266.txt b/examples/MemoryBenchmark/esp8266.txt new file mode 100644 index 0000000..e7e14ac --- /dev/null +++ b/examples/MemoryBenchmark/esp8266.txt @@ -0,0 +1,3 @@ +0 264949 1044464 27984 81920 +1 268021 1044464 28148 81920 +2 268081 1044464 28148 81920 diff --git a/examples/MemoryBenchmark/generate_readme.py b/examples/MemoryBenchmark/generate_readme.py new file mode 100755 index 0000000..994c324 --- /dev/null +++ b/examples/MemoryBenchmark/generate_readme.py @@ -0,0 +1,127 @@ +#!/usr/bin/python3 +# +# Python script that regenerates the README.md from the embedded template. Uses +# ./generate_table.awk to regenerate the ASCII tables from the various *.txt +# files. + +from subprocess import check_output + +nano_results = check_output( + "./generate_table.awk < nano.txt", shell=True, text=True) +micro_results = check_output( + "./generate_table.awk < micro.txt", shell=True, text=True) +samd21_results = check_output( + "./generate_table.awk < samd21.txt", shell=True, text=True) +stm32_results = check_output( + "./generate_table.awk < stm32.txt", shell=True, text=True) +samd51_results = check_output( + "./generate_table.awk < samd51.txt", shell=True, text=True) +esp8266_results = check_output( + "./generate_table.awk < esp8266.txt", shell=True, text=True) +esp32_results = check_output( + "./generate_table.awk < esp32.txt", shell=True, text=True) + +print(f"""\ +# Memory Benchmark + +The `MemoryBenchmark.ino` was compiled with each `FEATURE_*` and the flash +memory and static RAM sizes were recorded. The `FEATURE_BASELINE` selection is +the baseline, and its memory usage numbers are subtracted from the subsequent +`FEATURE_*` memory usage. + +**Version**: AUnit v1.7.1 + +**DO NOT EDIT**: This file was auto-generated using `make README.md`. + +## How to Regenerate + +To regenerate this README.md: + +``` +$ make clean_benchmarks +$ make benchmarks +$ make README.md +``` + +The `make benchmarks` target uses `collect.sh` script which calls `auniter.sh` +(https://github.com/bxparks/AUniter) to invoke the Arduino IDE programmatically. +It produces a `*.txt` file with the flash and ram usage information (e.g. +`nano.txt`). + +The `make README.md` command calls the `generated_readme.py` Python script which +generates this `README.md` file. The ASCII tables below are generated by the +`generate_table.awk` script, which takes each `*.txt` file and converts it to an +ASCII table. + +## Library Size Changes + +## Arduino Nano + +* 16MHz ATmega328P +* Arduino IDE 1.8.19, Arduino CLI 0.33.0 +* Arduino AVR Boards 1.8.6 + +``` +{nano_results} +``` + +## Sparkfun Pro Micro + +* 16 MHz ATmega32U4 +* Arduino IDE 1.8.19, Arduino CLI 0.33.0 +* SparkFun AVR Boards 1.1.13 + +``` +{micro_results} +``` + +## SAMD21 Seeeduino XIAO M0 + +* SAMD51, 120 MHz ARM Cortex-M4 +* Arduino IDE 1.8.19, Arduino CLI 0.33.0 +* Seeeduino SAMD 1.8.4 + +``` +{samd21_results} +``` + +## STM32 Blue Pill + +* STM32F103C8, 72 MHz ARM Cortex-M3 +* Arduino IDE 1.8.19, Arduino CLI 0.33.0 +* STM32duino 2.5.0 + +``` +{stm32_results} +``` + +## SAMD51 Adafruit ItsyBitsy M4 + +* SAMD51, 120 MHz ARM Cortex-M4 +* Arduino IDE 1.8.19, Arduino CLI 0.33.0 +* Adafruit SAMD 1.7.11 + +``` +{samd51_results} +``` + +## ESP8266 + +* NodeMCU 1.0, 80MHz ESP8266 +* Arduino IDE 1.8.19, Arduino CLI 0.33.0 +* ESP8266 Boards 3.0.2 + +``` +{esp8266_results} +``` + +## ESP32 + +* ESP32-01 Dev Board, 240 MHz Tensilica LX6 +* Arduino IDE 1.8.19, Arduino CLI 0.33.0 +* ESP32 Boards 2.0.9 + +``` +{esp32_results} +``` +""") diff --git a/examples/MemoryBenchmark/generate_table.awk b/examples/MemoryBenchmark/generate_table.awk new file mode 100755 index 0000000..9461814 --- /dev/null +++ b/examples/MemoryBenchmark/generate_table.awk @@ -0,0 +1,50 @@ +#!/usr/bin/gawk -f +# +# Usage: generate_table.sh < ${board}.txt +# +# Takes the file generated by collect.sh and generates an ASCII +# table that can be inserted into the README.md. + +BEGIN { + labels[0] = "Baseline" + labels[1] = "AUnit Single Test" + labels[2] = "AUnit Single Test Verbose" + record_index = 0 +} +{ + u[record_index]["flash"] = $2 + u[record_index]["ram"] = $4 + record_index++ +} +END { + NUM_ENTRIES = record_index + + base_flash = u[0]["flash"] + base_ram = u[0]["ram"] + for (i = 0; i < NUM_ENTRIES; i++) { + if (u[i]["flash"] == -1) { + u[i]["d_flash"] = -1 + u[i]["d_ram"] = -1 + } else { + u[i]["d_flash"] = u[i]["flash"] - base_flash + u[i]["d_ram"] = u[i]["ram"]- base_ram + } + } + + printf(\ + "+---------------------------------------------------------------------+\n") + printf(\ + "| Functionality | flash/ ram | delta |\n") + for (i = 0; i < NUM_ENTRIES; i++) { + if (labels[i] ~ /^Baseline/ \ + || labels[i] ~ /^AUnit Single Test$/ \ + ) { + printf(\ + "|----------------------------------------+--------------+-------------|\n") + } + printf("| %-38s | %6d/%5d | %5d/%5d |\n", + labels[i], u[i]["flash"], u[i]["ram"], u[i]["d_flash"], u[i]["d_ram"]) + } + printf(\ + "+---------------------------------------------------------------------+\n") +} diff --git a/examples/MemoryBenchmark/micro.txt b/examples/MemoryBenchmark/micro.txt new file mode 100644 index 0000000..ba723a9 --- /dev/null +++ b/examples/MemoryBenchmark/micro.txt @@ -0,0 +1,3 @@ +0 3572 28672 150 2560 +1 6410 28672 329 2560 +2 6454 28672 329 2560 diff --git a/examples/MemoryBenchmark/nano.txt b/examples/MemoryBenchmark/nano.txt new file mode 100644 index 0000000..1777800 --- /dev/null +++ b/examples/MemoryBenchmark/nano.txt @@ -0,0 +1,3 @@ +0 1586 30720 185 2048 +1 4456 30720 366 2048 +2 4500 30720 366 2048 diff --git a/examples/MemoryBenchmark/samd21.txt b/examples/MemoryBenchmark/samd21.txt new file mode 100644 index 0000000..da47a23 --- /dev/null +++ b/examples/MemoryBenchmark/samd21.txt @@ -0,0 +1,3 @@ +0 34164 262144 +1 36436 262144 +2 36492 262144 diff --git a/examples/MemoryBenchmark/samd51.txt b/examples/MemoryBenchmark/samd51.txt new file mode 100644 index 0000000..d801740 --- /dev/null +++ b/examples/MemoryBenchmark/samd51.txt @@ -0,0 +1,3 @@ +0 10664 507904 +1 12816 507904 +2 12872 507904 diff --git a/examples/MemoryBenchmark/stm32.txt b/examples/MemoryBenchmark/stm32.txt new file mode 100644 index 0000000..166e076 --- /dev/null +++ b/examples/MemoryBenchmark/stm32.txt @@ -0,0 +1,3 @@ +0 21540 131072 3836 20480 +1 23648 131072 3904 20480 +2 23704 131072 3904 20480 diff --git a/examples/MemoryBenchmark/validate_using_epoxy_duino.sh b/examples/MemoryBenchmark/validate_using_epoxy_duino.sh new file mode 100755 index 0000000..a86a5b3 --- /dev/null +++ b/examples/MemoryBenchmark/validate_using_epoxy_duino.sh @@ -0,0 +1,42 @@ +#!/bin/bash +# +# Validate compilation of each FEATURE from 0 to NUM_FEATURES on a +# Linux/MacOS/FreeBSD host machine using EpoxyDuino. This allow us to catch +# compile-time errors quickly and in the GitHub Actions CI using 'make' instead +# of compiling to the target platform. + +set -eu + +PROGRAM_NAME='MemoryBenchmark.ino' +NUM_FEATURES=2 # excluding FEATURE_BASELINE +temp_out_file= + +function cleanup() { + if [[ "$temp_out_file" != '' ]]; then + rm -f $temp_out_file + fi + sed -i -e "s/#define FEATURE [0-9]*/#define FEATURE 0/" $PROGRAM_NAME +} + +function create_temp_file() { + temp_out_file=$(mktemp /tmp/memory_benchmark.epoxy.XXXXXX) +} + +function validate() { + for feature in $(seq 0 $NUM_FEATURES); do + echo "Validating FEATURE $feature using EpoxyDuino" + sed -i -e "s/#define FEATURE [0-9]*/#define FEATURE $feature/" \ + $PROGRAM_NAME + + # Run make, redirecting output to temp file. If error, print the output. + if ! make 2>&1 > $temp_out_file; then + cat $temp_out_file + exit 1 + fi + done +} + +trap "cleanup" EXIT + +create_temp_file +validate diff --git a/examples/advanced/advanced.ino b/examples/advanced/advanced.ino index 427ad0a..6b8bb91 100644 --- a/examples/advanced/advanced.ino +++ b/examples/advanced/advanced.ino @@ -58,9 +58,14 @@ testingF(MyTestAgain, again) { //---------------------------------------------------------------------------- void setup() { +#if ! defined(EPOXY_DUINO) delay(1000); // wait for stability on some boards to prevent garbage Serial +#endif Serial.begin(115200); // ESP8266 default of 74880 not supported on Linux while (!Serial); // for the Arduino Leonardo/Micro only +#if defined(EPOXY_DUINO) + Serial.setLineModeUnix(); +#endif //TestRunner::setVerbosity(Verbosity::kAll); diff --git a/examples/basic/basic.ino b/examples/basic/basic.ino index 80789d7..0d0dbcc 100644 --- a/examples/basic/basic.ino +++ b/examples/basic/basic.ino @@ -20,9 +20,14 @@ test(incorrect) { //---------------------------------------------------------------------------- void setup() { +#if ! defined(EPOXY_DUINO) delay(1000); // wait for stability on some boards to prevent garbage Serial +#endif Serial.begin(115200); // ESP8266 default of 74880 not supported on Linux - while(!Serial); // for the Arduino Leonardo/Micro only + while (!Serial); // for the Arduino Leonardo/Micro only +#if defined(EPOXY_DUINO) + Serial.setLineModeUnix(); +#endif Serial.println(F("This test should produce the following:")); Serial.println( diff --git a/examples/basic_verbose/basic_verbose.ino b/examples/basic_verbose/basic_verbose.ino index 201485a..e15b387 100644 --- a/examples/basic_verbose/basic_verbose.ino +++ b/examples/basic_verbose/basic_verbose.ino @@ -23,9 +23,14 @@ test(incorrect) { //---------------------------------------------------------------------------- void setup() { +#if ! defined(EPOXY_DUINO) delay(1000); // wait for stability on some boards to prevent garbage Serial +#endif Serial.begin(115200); // ESP8266 default of 74880 not supported on Linux while(!Serial); // for the Arduino Leonardo/Micro only +#if defined(EPOXY_DUINO) + Serial.setLineModeUnix(); +#endif Serial.println(F("This test should produce the following:")); Serial.println( diff --git a/examples/continuous/continuous.ino b/examples/continuous/continuous.ino index 2d850c7..d02536f 100644 --- a/examples/continuous/continuous.ino +++ b/examples/continuous/continuous.ino @@ -25,9 +25,14 @@ testing(continuous) { //---------------------------------------------------------------------------- void setup() { +#if ! defined(EPOXY_DUINO) delay(1000); // wait for stability on some boards to prevent garbage Serial +#endif Serial.begin(115200); // ESP8266 default of 74880 not supported on Linux while(!Serial); // for the Arduino Leonardo/Micro only +#if defined(EPOXY_DUINO) + Serial.setLineModeUnix(); +#endif Serial.println(F("This test should produce the following:")); Serial.println( diff --git a/examples/filter/filter.ino b/examples/filter/filter.ino index d19c135..9056e47 100644 --- a/examples/filter/filter.ino +++ b/examples/filter/filter.ino @@ -19,9 +19,14 @@ test(crypto_sha256) { pass(); } //---------------------------------------------------------------------------- void setup() { +#if ! defined(EPOXY_DUINO) delay(1000); // wait for stability on some boards to prevent garbage Serial +#endif Serial.begin(115200); // ESP8266 default of 74880 not supported on Linux while(!Serial); // for the Arduino Leonardo/Micro only +#if defined(EPOXY_DUINO) + Serial.setLineModeUnix(); +#endif // all tests named net_ - something, except net_ftp TestRunner::exclude("*"); diff --git a/examples/fixture/fixture.ino b/examples/fixture/fixture.ino index 7374709..1d78585 100644 --- a/examples/fixture/fixture.ino +++ b/examples/fixture/fixture.ino @@ -97,9 +97,14 @@ testF(LogTest, insert) { //---------------------------------------------------------------------------- void setup() { +#if ! defined(EPOXY_DUINO) delay(1000); // Wait for stability on some boards, otherwise garage on Serial +#endif Serial.begin(115200); // ESP8266 default of 74880 not supported on Linux while (!Serial); // for the Arduino Leonardo/Micro only +#if defined(EPOXY_DUINO) + Serial.setLineModeUnix(); +#endif Serial.println(F("This test should produce the following:")); Serial.println( diff --git a/examples/meta_asserts/meta_asserts.ino b/examples/meta_asserts/meta_asserts.ino index 38764c6..f52d8c6 100644 --- a/examples/meta_asserts/meta_asserts.ino +++ b/examples/meta_asserts/meta_asserts.ino @@ -172,9 +172,14 @@ testing(slow_expire_monitor) { //---------------------------------------------------------------------------- void setup() { +#if ! defined(EPOXY_DUINO) delay(1000); // wait for stability on some boards to prevent garbage Serial +#endif Serial.begin(115200); // ESP8266 default of 74880 not supported on Linux while(!Serial); // for the Arduino Leonardo/Micro only +#if defined(EPOXY_DUINO) + Serial.setLineModeUnix(); +#endif Serial.println(F("This test should produce the following:")); Serial.println( diff --git a/library.properties b/library.properties index e855aa3..2904e7d 100644 --- a/library.properties +++ b/library.properties @@ -1,9 +1,9 @@ name=AUnit -version=1.7.0 +version=1.7.1 author=Brian T. Park maintainer=Brian T. Park sentence=A unit testing framework for Arduino platforms inspired by ArduinoUnit and Google Test. -paragraph=The unit tests can run on the embedded controller. They can also run on Linux, MacOS, or FreeBSD environments using EpoxyDuino, which allows AUnit to be used in a Continuous Integration environment like GitHub Workflows. AUnit is almost a drop-in replacement of ArduinoUnit with some advantages. AUnit supports timeouts and test fixtures. It somtimes consume 50% less flash memory on the AVR platform, and it has been tested to work on the AVR, STM32, ESP8266, ESP32, Teensy platforms. +paragraph=The unit tests can run on the embedded controller. They can also run on Linux, MacOS, or FreeBSD environments using EpoxyDuino, which allows AUnit to be used in a Continuous Integration environment like GitHub Workflows. AUnit is almost a drop-in replacement of ArduinoUnit with some advantages. AUnit supports timeouts and test fixtures. It somtimes consume 50% less flash memory on the AVR platform, and it has been tested to work on the AVR, SAMD21, STM32, SAMD51, ESP8266, ESP32, Teensy platforms. category=Other url=https://github.com/bxparks/AUnit architectures=* diff --git a/src/AUnit.h b/src/AUnit.h index 3793bbd..b856b20 100644 --- a/src/AUnit.h +++ b/src/AUnit.h @@ -65,7 +65,7 @@ SOFTWARE. #include "aunit/TestMacros.h" // Version format: xxyyzz == "xx.yy.zz" -#define AUNIT_VERSION 10700 -#define AUNIT_VERSION_STRING "1.7.0" +#define AUNIT_VERSION 10701 +#define AUNIT_VERSION_STRING "1.7.1" #endif diff --git a/src/AUnitVerbose.h b/src/AUnitVerbose.h index ef12536..5bf3443 100644 --- a/src/AUnitVerbose.h +++ b/src/AUnitVerbose.h @@ -55,7 +55,7 @@ SOFTWARE. #include "aunit/TestMacros.h" // Version format: xxyyzz == "xx.yy.zz" -#define AUNIT_VERSION 10700 -#define AUNIT_VERSION_STRING "1.7.0" +#define AUNIT_VERSION 10701 +#define AUNIT_VERSION_STRING "1.7.1" #endif diff --git a/src/aunit/Flash.h b/src/aunit/Flash.h index 5f33165..eb1983b 100644 --- a/src/aunit/Flash.h +++ b/src/aunit/Flash.h @@ -33,36 +33,35 @@ SOFTWARE. * and the (const __FlashStringHelper*) pointer. However, the useful FPSTR() * macro is not defined. * - * On Teensy-ARM, flash strings are *not* supported, but F(), PSTR() and (const - * __FlashStringHelper*) are defined. The useful FPSTR() macro is not defined. + * Seeeduino SAMD core has a broken implementation of FPSTR(). This file + * clobbers that implementation. + * + * Adafruit's SAMD core fixes the broken FPSTR(), so we don't have to do + * anything. + * + * Arduino's SAMD core breaks backwards compatibility after version >= 1.8.10. + * AUnit does not support the ArduinoCore-API, so Arduino-branded SAMD boards + * are explicitly blacklisted. * * STM32duino seems to have forked from Teensyduino, so it too has F() and * PSTR(), but no FPSTR() macro. * - * On the ESP8266 platform, flash strings are implemented, and the F(), PSTR() - * and __FlashStringHelper are defined, but the implementation used to be - * brittle and fail with obscure errors messages. For a single compilation - * unit, a flash string could not be defined in both an inline and non-inline - * contexts (see https://github.com/esp8266/Arduino/issues/3369). This bug was - * fixed in Dec 2018, so we can use normal F(), PSTR(), and FPSTR() macros on - * the ESP8266. + * The ESP8266 platform used to have flash strings which were buggy and brittle, + * and often failed with obscure errors messages, see for example, + * https://github.com/esp8266/Arduino/issues/3369. This bug was fixed in Dec + * 2018, so the ESP8266 is fully supported. * - * On the ESP32, flash strings are not implemented, but the various F(), PSTR() - * and __FlashStringHelper symbols are defined for compatibility, similar to - * Teensy-ARM. Unfortunately, the implementation of FPSTR() was incorrectly - * defined (https://github.com/espressif/arduino-esp32/issues/1371), but the - * bug was fixed in ESP32 Core 1.0.3 around Sept 2019. Therefore, ESP32 can now - * use normal F(), PSTR() and FPSTR() macros. + * The ESP32 had a broken implementation of FPSTR() + * (https://github.com/espressif/arduino-esp32/issues/1371), but the bug was + * fixed in ESP32 Core 1.0.3 around Sept 2019. ESP32 is fully supported. * - * On megaAVR, the F() does not return a (const __FlashStringHelper*), but - * returns a (const char*). Unfortunately, this breaks AUnit - * (https://github.com/bxparks/AUnit/issues/56) because a lot of code is - * generated through macros, which assume that the F() macro returns the - * correct type. + * On Teensy-ARM, flash strings are *not* supported, but F(), PSTR() and (const + * __FlashStringHelper*) are defined. The useful FPSTR() macro is not defined. * - * Previously, AUnit used the F() only for the AVR platforms. But with the - * various fixes, I think it can be activated for ESP8266 and other platforms. - * Except for megaAVR whose F() returns the wrong type. + * The megaAVR had a broken implementation of the F() macro (does not return a + * const __FlashStringHelper*), but returns a (const char*)). But more + * importantly, megaAVR uses the ArrduinoCore-api which is blacklisted by AUnit, + * so the megaAVR (e.g. Nano Every) is not supported. */ #ifndef AUNIT_FLASH_H @@ -82,6 +81,31 @@ class __FlashStringHelper; #include #define AUNIT_F(x) F(x) +// Seeeduino SAMD21 Core is buggy, so we have to hack around it. Unfortunately, +// the Seeeduino core does not define an identifier for the following boards, so +// they are not supported: +// * Wio lite MG126 +// * Wio GPS Board +// * Wio LTE CAT.1 +#elif defined(SEEED_XIAO_M0) \ + || defined(SEEEDUINO_ZERO) \ + || defined(SEEED_FEMTO_M0) \ + || defined(SEEEDUINO_LORAWAN) \ + || defined(SEEED_WIO_TERMINAL) \ + || defined(SEEED_GROVE_UI_WIRELESS) + + #include + + // Seeeduino (as of 1.8.4) provides an incorrect definition of FPSTR() + // so we have to clobber it. + #undef FPSTR + #define FPSTR(p) (reinterpret_cast(p)) + #define AUNIT_F(x) F(x) + +// The following should work for Adafruit SAMD core, and other third party SAMD +// (SparkFun?) cores which are less buggy. The Arduino SAMD Core breaks +// backwards compatibility for versions >= 1.8.10. It is blacklisted by the time +// we get here. #elif defined(ARDUINO_ARCH_SAMD) #include @@ -112,9 +136,10 @@ class __FlashStringHelper; #include #define AUNIT_F(x) F(x) -#elif defined(ARDUINO_ARCH_MEGAAVR) +#elif defined(TEENSYDUINO) - #error MegaAVR not supported, https://github.com/bxparks/AUnit/issues/56 + #include + #define AUNIT_F(x) F(x) #else @@ -129,24 +154,4 @@ class __FlashStringHelper; #endif -// Define SERIAL_PORT_MONITOR consistently. We should also rename this file to -// something like "compat.h". -#if defined(ARDUINO_SAMD_ZERO) - // If have a real Arduino Zero and using the "Arduino/Genuino Zero (Native - // USB Port)" configuration on the Arduino IDE, you may need to uncomment - // the following to clobber SERIAL_PORT_MONITOR to point to the correct - // SerialUSB. - // - // On the other hand, if you are using a SparkFun breakout board, or one of - // the "SAMD21 M0 Mini" clones, you should be using the SparkFun SAMD Boards, - // and selecting the "SparkFun SAMD21 Dev Breakout" or the "SparkFun SAMD21 - // Mini Breakout" settings, which will set the SERIAL_PORT_MONITOR macro - // correctly to SerialUSB. - #if 0 - #undef SERIAL_PORT_MONITOR - #define SERIAL_PORT_MONITOR SerialUSB - #endif - -#endif // ARDUINO_SAMD_ZERO - #endif // AUNIT_FLASH_H diff --git a/tests/AUnitMetaTest/AUnitMetaTest.ino b/tests/AUnitMetaTest/AUnitMetaTest.ino index 2c3d51e..0e276d9 100644 --- a/tests/AUnitMetaTest/AUnitMetaTest.ino +++ b/tests/AUnitMetaTest/AUnitMetaTest.ino @@ -339,11 +339,14 @@ testing(fixture_slow_skip_monitor) { // ------------------------------------------------------ void setup() { -#ifdef ARDUINO +#if ! defined(EPOXY_DUINO) delay(1000); // Wait for stability on some boards, otherwise garage on Serial #endif SERIAL_PORT_MONITOR.begin(115200); while (! SERIAL_PORT_MONITOR); // Wait until Serial is ready - Leonardo/Micro +#if defined(EPOXY_DUINO) + SERIAL_PORT_MONITOR.setLineModeUnix(); +#endif #if USE_AUNIT == 1 // These are useful for debugging. diff --git a/tests/AUnitMoreTest/AUnitMoreTest.ino b/tests/AUnitMoreTest/AUnitMoreTest.ino index 38fc28f..5d64794 100644 --- a/tests/AUnitMoreTest/AUnitMoreTest.ino +++ b/tests/AUnitMoreTest/AUnitMoreTest.ino @@ -84,11 +84,14 @@ test(unsignedLongLong) { // ------------------------------------------------------ void setup() { -#ifdef ARDUINO +#if ! defined(EPOXY_DUINO) delay(1000); // Wait for stability on some boards, otherwise garage on Serial #endif SERIAL_PORT_MONITOR.begin(115200); while (! SERIAL_PORT_MONITOR); // Wait until Serial is ready - Leonardo/Micro +#if defined(EPOXY_DUINO) + SERIAL_PORT_MONITOR.setLineModeUnix(); +#endif } void loop() { diff --git a/tests/AUnitTest/AUnitTest.ino b/tests/AUnitTest/AUnitTest.ino index 5a9e622..9d03001 100644 --- a/tests/AUnitTest/AUnitTest.ino +++ b/tests/AUnitTest/AUnitTest.ino @@ -567,11 +567,14 @@ CustomTestOnce myTestOnce2("customTestOnce2"); // ------------------------------------------------------ void setup() { -#ifdef ARDUINO +#if ! defined(EPOXY_DUINO) delay(1000); // Wait for stability on some boards, otherwise garage on Serial #endif SERIAL_PORT_MONITOR.begin(115200); while (! SERIAL_PORT_MONITOR); // Wait until Serial is ready - Leonardo/Micro +#if defined(EPOXY_DUINO) + SERIAL_PORT_MONITOR.setLineModeUnix(); +#endif #if USE_AUNIT == 1 // These are useful for debugging. diff --git a/tests/FailingTest/FailingTest.ino b/tests/FailingTest/FailingTest.ino index 8c8411b..4324e4b 100644 --- a/tests/FailingTest/FailingTest.ino +++ b/tests/FailingTest/FailingTest.ino @@ -259,11 +259,14 @@ testing(fixture_slow_expire_monitor) { // ------------------------------------------------------------------------- void setup() { -#ifdef ARDUINO +#if ! defined(EPOXY_DUINO) delay(1000); // Wait for stability on some boards, otherwise garage on Serial #endif SERIAL_PORT_MONITOR.begin(115200); while (! SERIAL_PORT_MONITOR); // Wait until Serial is ready - Leonardo/Micro +#if defined(EPOXY_DUINO) + SERIAL_PORT_MONITOR.setLineModeUnix(); +#endif SERIAL_PORT_MONITOR.println(F("This test should produce the following:")); SERIAL_PORT_MONITOR.println( diff --git a/tests/FilterTest/FilterTest.ino b/tests/FilterTest/FilterTest.ino index bd757a4..0bb7b73 100644 --- a/tests/FilterTest/FilterTest.ino +++ b/tests/FilterTest/FilterTest.ino @@ -100,11 +100,14 @@ test(lifeCycle) { // ----------------------------------------------------------------------- void setup() { -#ifdef ARDUINO +#if ! defined(EPOXY_DUINO) delay(1000); // Wait for stability on some boards, otherwise garage on Serial #endif SERIAL_PORT_MONITOR.begin(115200); while (! SERIAL_PORT_MONITOR); // Wait until Serial is ready - Leonardo +#if defined(EPOXY_DUINO) + SERIAL_PORT_MONITOR.setLineModeUnix(); +#endif // Verify that the include() and exclude() work as expected. The name of test // is either "test_{name}" (1-argument version of test()) or diff --git a/tests/Print64Test/Print64Test.ino b/tests/Print64Test/Print64Test.ino index fcce297..62daf98 100644 --- a/tests/Print64Test/Print64Test.ino +++ b/tests/Print64Test/Print64Test.ino @@ -91,11 +91,14 @@ test(Print64, println64_ULL) { } void setup() { -#ifdef ARDUINO +#if ! defined(EPOXY_DUINO) delay(1000); // Wait for stability on some boards, otherwise garage on Serial #endif SERIAL_PORT_MONITOR.begin(115200); while (! SERIAL_PORT_MONITOR); // Wait until Serial is ready - Leonardo +#if defined(EPOXY_DUINO) + SERIAL_PORT_MONITOR.setLineModeUnix(); +#endif } diff --git a/tests/SetupAndTeardownTest/SetupAndTeardownTest.ino b/tests/SetupAndTeardownTest/SetupAndTeardownTest.ino index b1dc2ec..9b1d736 100644 --- a/tests/SetupAndTeardownTest/SetupAndTeardownTest.ino +++ b/tests/SetupAndTeardownTest/SetupAndTeardownTest.ino @@ -78,11 +78,14 @@ testingF(CustomAgain, expire) { expire(); } testingF(CustomAgain, excluded) { fail(); } void setup() { -#ifdef ARDUINO +#if ! defined(EPOXY_DUINO) delay(1000); // Wait for stability on some boards, otherwise garage on Serial #endif SERIAL_PORT_MONITOR.begin(115200); while (! SERIAL_PORT_MONITOR); // Wait until Serial is ready - Leonardo/Micro +#if defined(EPOXY_DUINO) + SERIAL_PORT_MONITOR.setLineModeUnix(); +#endif SERIAL_PORT_MONITOR.println(F("This test should produce the following:")); SERIAL_PORT_MONITOR.println(