v0.25.0: Styling & Doxygen Code Documentation

Downloads

libraries_v0.25.0.zip contains this version of ModularSensors and the proper versions of all of its dependencies.

Installing on the Arduino IDE:

In your the Arduino Software (IDE), import the library zip file following the instructions for "Manual Installation" from https://www.arduino.cc/en/Guide/Libraries#toc5. You cannot directly import the zip using the Arduino Library Manager because it contains multiple libraries.

Installing for PlatformIO:

Extract the contents of library zip to your project's 'lib' folder.

Change Log

New Features:

• Automated code documentation using Doxygen, now available at https://envirodiy.github.io/ModularSensors/

Improvements:

• Improved C++ code styling elements in every file in the library, to:
  • Better take advantage of the Clang compiler and code error linter tool;
  • Generally follow Clang Format and Google's coding style guides used with cpplint linter, which:
    • includes massive white space changes to improve readability while not changing how the code is executed
  • Support Doxygen documentation.
• Encapsulated modem wake check logic into a function and checking for status using a quick AT ping if no other option is available.
  • This will only affect modems/breakouts that depend on a pulse on their wake pin to turn on or off but for whatever reason don't have a separate status pin connected to the mcu. I do not recommend this configuration.
• Always re-set the pin mode of a sensor power pin before attempting to turn it on.
  • This could come into play when first attempting to power on a sensor before the initial setup if the pin mode on the sensor power pin was set to input by whatever program the mcu had run prior to running ModularSensors code.

Bug Fixes

• Fixed issue where the Digi XBee LTE-M modem did not wake during normal logging mode to transmit data to the publisher. See #309 (comment)

For more details, see Pull Request #309: The style sheet