Remove travis and update build script

Author: Erriez

.auto-build.sh

@@ -1,59 +1,105 @@
-#/bin/bash
+#!/bin/bash
+#
+#  MIT License
+#
+#  Copyright (c) 2020-2022 Erriez
+#
+#  Permission is hereby granted, free of charge, to any person obtaining a copy
+#  of this software and associated documentation files (the "Software"), to deal
+#  in the Software without restriction, including without limitation the rights
+#  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+#  copies of the Software, and to permit persons to whom the Software is
+#  furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+#
+
+# Automatic build script
+#
+# To run locally, execute:
+# sudo apt install doxygen graphviz texlive-latex-base texlive-latex-recommended texlive-pictures texlive-latex-extra
 
 # Exit immediately if a command exits with a non-zero status.
 set -e
 
+DOXYGEN_PDF="ErriezMHZ19B.pdf"
+
+
 echo "Starting auto-build script..."
 
+function setup_virtualenv()
+{
+    if [ ! -d ".venv" ]; then
+        virtualenv .venv
+        source .venv/bin/activate
+        pip3 install platformio==6.1.4
+        deactivate
+    fi
+
+    source .venv/bin/activate
+}
 
 function autobuild()
 {
     # Set environment variables
     BOARDS_AVR="--board uno --board micro --board pro16MHzatmega328 --board pro8MHzatmega328 --board megaatmega2560 --board leonardo"
     BOARDS_ARM="--board due"
-    BOARDS_ESP8266="--board d1_mini --board nodemcuv2"
+    BOARDS_ESP8266="--board nodemcuv2"
     BOARDS_ESP32="--board lolin_d32"
 
     echo "Installing library dependencies"
-    platformio lib --global install https://github.com/Erriez/ErriezTM1637
-    platformio lib --global install https://github.com/Erriez/ErriezRobotDyn4DigitDisplay
-    platformio lib --global install https://github.com/knolleary/pubsubclient
+    pio pkg install --global --library https://github.com/Erriez/ErriezTM1637
+    pio pkg install --global --library https://github.com/Erriez/ErriezRobotDyn4DigitDisplay
+    pio pkg install --global --library https://github.com/knolleary/pubsubclient
 
     echo "Install ESPSoftwareSerial into framework-arduinoespressif32 to prevent conflicts with generic name SoftwareSerial"
     mkdir -p ~/.platformio/packages/framework-arduinoespressif32/libraries
-    platformio lib --storage-dir ~/.platformio/packages/framework-arduinoespressif32/libraries install "ESPSoftwareSerial"
+    platformio lib --storage-dir ~/.platformio/packages/framework-arduinoespressif32/libraries install "EspSoftwareSerial@6.16.1"
+    # Cannot upgrade to pio pkg install command: https://github.com/platformio/platformio-core/issues/4410
+    #pio pkg install --storage-dir ~/.platformio/packages/framework-arduinoespressif32/libraries --library "EspSoftwareSerial@6.16.1"
+    
+    echo "Building examples..."
 
-    echo "Build examples"
-    platformio ci --lib="." ${BOARDS_AVR} ${BOARDS_ARM} ${BOARDS_ESP8266} ${BOARDS_ESP32} examples/ErriezMHZ19B7SegmentDisplay/ErriezMHZ19B7SegmentDisplay.ino
-    platformio ci --lib="." ${BOARDS_AVR} ${BOARDS_ARM} ${BOARDS_ESP8266} ${BOARDS_ESP32} examples/ErriezMHZ19BGettingStarted/ErriezMHZ19BGettingStarted.ino
-    platformio ci --lib="." ${BOARDS_AVR} ${BOARDS_ARM} ${BOARDS_ESP8266} ${BOARDS_ESP32} examples/ErriezMHZ19BSerialPlottter/ErriezMHZ19BSerialPlottter.ino
-    platformio ci --lib="."                             ${BOARDS_ESP8266}                 examples/ErriezMHZ19BESP8266MQTT/ErriezMHZ19BESP8266MQTT.ino
+    # Use option -O "lib_ldf_mode=chain+" to parse defines
+    pio ci -O "lib_ldf_mode=chain+" --lib="." ${BOARDS_AVR} ${BOARDS_ARM} ${BOARDS_ESP8266} ${BOARDS_ESP32} examples/ErriezMHZ19B7SegmentDisplay/ErriezMHZ19B7SegmentDisplay.ino
+    pio ci -O "lib_ldf_mode=chain+" --lib="." ${BOARDS_AVR} ${BOARDS_ARM} ${BOARDS_ESP8266} ${BOARDS_ESP32} examples/ErriezMHZ19BGettingStarted/ErriezMHZ19BGettingStarted.ino
+    pio ci -O "lib_ldf_mode=chain+" --lib="." ${BOARDS_AVR} ${BOARDS_ARM} ${BOARDS_ESP8266} ${BOARDS_ESP32} examples/ErriezMHZ19BSerialPlottter/ErriezMHZ19BSerialPlottter.ino
+    pio ci -O "lib_ldf_mode=chain+" --lib="."                             ${BOARDS_ESP8266}                 examples/ErriezMHZ19BESP8266MQTT/ErriezMHZ19BESP8266MQTT.ino
 }
 
 function generate_doxygen()
 {
-    echo "Generate Doxygen HTML..."
-
-    DOXYGEN_PDF="ErriezMHZ19B.pdf"
+    if [ ! -f Doxyfile ]; then
+        return
+    fi
 
-    # Cleanup
-    rm -rf html latex
+    echo "Generate Doxygen HTML..."
 
     # Generate Doxygen HTML and Latex
     doxygen Doxyfile
 
-    # Allow filenames starting with an underscore    
-    echo "" > html/.nojekyll
+    # Allow filenames starting with an underscore
+    echo "" > docs/html/.nojekyll
 
-    # Generate PDF when script is not running on Travis-CI
-    if [[ -z ${TRAVIS_BUILD_DIR} ]]; then
-        # Generate Doxygen PDF
-        make -C latex
+    # Generate Doxygen PDF
+    make -C docs/latex
 
-        # Copy PDF to root directory
-        cp latex/refman.pdf ./${DOXYGEN_PDF}
-    fi
+    # Copy PDF to root directory
+    cp docs/latex/refman.pdf ./${DOXYGEN_PDF}
+
+    # Cleanup
+    #rm -rf docs
 }
 
+setup_virtualenv
 autobuild
 generate_doxygen

.gitattributes

@@ -5,5 +5,4 @@
 # Ignore the following files when creating a release
 /.gitattributes export-ignore
 /.gitignore export-ignore
-/.travis.yml export-ignore
 /.*.sh export-ignore

.gitignore

@@ -32,4 +32,4 @@
 *.app
 
 .idea/
-platformio/
+docs/

.travis.yml

@@ -58,7 +58,7 @@ PROJECT_LOGO           = extras/MHZ19B.png
 # entered, it will be relative to the location where doxygen was started. If
 # left blank the current directory will be used.
 
-OUTPUT_DIRECTORY       = 
+OUTPUT_DIRECTORY       = docs
 
 # If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub-
 # directories (in 2 levels) under the output directory of each output format and

Doxyfile

@@ -1,6 +1,10 @@
-# Erriez MH-Z19B CO2 sensor library for Arduino
+[![Licence MIT](https://img.shields.io/badge/license-MIT-green)](https://github.com/Erriez/ErriezMHZ19B/blob/master/LICENSE)
+[![Language C/C++](https://img.shields.io/badge/language-C%2FC%2B%2B-informational)](https://github.com/Erriez/ErriezMHZ19B)
+[![Release tag](https://img.shields.io/github/v/release/Erriez/ErriezMHZ19B?display_name=tag)](https://github.com/Erriez/ErriezMHZ19B/releases)
+[![Open issue](https://shields.io/github/issues-raw/Erriez/ErriezMHZ19B)](https://github.com/Erriez/ErriezMHZ19B/issues)
+[![PlatformIO CI](https://github.com/Erriez/ErriezMHZ19B/actions/workflows/actions.yml/badge.svg)](https://github.com/Erriez/ErriezMHZ19B/actions/workflows/actions.yml)
 
-[![Build Status](https://travis-ci.org/Erriez/ErriezMHZ19B.svg?branch=master)](https://travis-ci.org/Erriez/ErriezMHZ19B)
+# Erriez MH-Z19B CO2 sensor library for Arduino
 
 This is a MH-Z19B CO2 sensor library for Arduino. It has been built from scratch to support hardware 
 and software serial with a small footprint.