Functioning web server to pilot a GPO

.github/workflows/platformio.yml

@@ -0,0 +1,29 @@
+name: Project build plan
+
+on: [push]
+
+jobs:
+  build:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [ubuntu-latest, macOS-latest]
+
+    steps:
+      - name: Setup Python
+        uses: actions/setup-python@master
+        with:
+          python-version: '3.x'
+
+      - name: Installing dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -U platformio
+          pio lib --global install WiFiManager
+
+      - name: Checkout
+        uses: actions/checkout@master
+
+      - name: Build Project
+        run: pio run
+

.github/workflows/tests.yml

@@ -0,0 +1,43 @@
+name: Project tests
+
+on: [push]
+
+jobs:
+  build:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [ubuntu-latest, macOS-latest]
+
+    steps:
+      - name: Installing dependencies (Ubuntu)
+        if: matrix.os == 'ubuntu-latest'
+        run: |
+          set -x
+          sudo apt-get update
+          sudo apt-get install doxygen graphviz
+
+      - name: Installing dependencies (macOS)
+        if: matrix.os == 'macOS-latest'
+        run: |
+          set -x
+          brew update
+          brew install doxygen graphviz
+
+      - name: Checkout
+        uses: actions/checkout@v1
+
+      - name: Create build directory
+        run: mkdir build
+
+      - name: CMake generation
+        working-directory: build
+        run: cmake ..
+
+      - name: Build tests
+        working-directory: build
+        run: make
+
+      - name: CTest execution
+        working-directory: build/software/tests/
+        run: ctest -VV

.gitignore

@@ -4,8 +4,7 @@ build*/
 Testing*/
 image_*/
 output/
-
-
+libdeps/
 
 # CMake related files ---------------------------
 Makefile
@@ -28,6 +27,7 @@ CMakeScripts/
 html/
 latex/
 man/
+Doxyfile
 
 # MS Office related files -----------------------
 ~*
@@ -42,3 +42,25 @@ src_file_list*.txt
 
 # pkg-config generated files --------------------
 *.pc
+
+# Binary files ----------------------------------
+a.out
+*.exe
+*.dll
+*.dylib
+*.a
+*.so
+*.o
+
+web-example
+!web-example/
+
+# macOS files -----------------------------------
+.DS_Store
+
+# PlatformIO IDE files --------------------------
+.pio
+.vscode/.browse.c_cpp.db*
+.vscode/c_cpp_properties.json
+.vscode/launch.json
+.vscode/ipch

CMakeLists.txt

@@ -0,0 +1,103 @@
+# 
+#          Copyright (C) 2019 Clovis Durand <[email protected]>
+# 
+# -----------------------------------------------------------------------------
+
+# CMake version required ----------------------------------
+cmake_minimum_required(VERSION 3.0)
+project(LTBL)
+
+if(NOT DEFINED PRJ_VERSION)
+    set(PRJ_VERSION "1.0.0")
+endif(NOT DEFINED PRJ_VERSION)
+
+# Build type
+if(NOT CMAKE_BUILD_TYPE)
+set(CMAKE_BUILD_TYPE Debug CACHE STRING
+    "Choose the type of build, options are: None Debug Release RelWithDebInfo MinSizeRel."
+    FORCE)
+endif(NOT CMAKE_BUILD_TYPE)
+
+# CASE OF C PROJECT
+set(CMAKE_C_STANDARD 99)
+if(NOT CMAKE_C_FLAGS)
+    set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -Wall -Wextra -Wformat-security" CACHE STRING "C99 compilation flags" FORCE)
+endif(NOT CMAKE_C_FLAGS)
+
+# CASE OF CPP PROJECT
+set(CMAKE_CXX_STANDARD 17)
+if(NOT CMAKE_CXX_FLAGS)
+    set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -Wall -Wextra -Wformat-security" CACHE STRING "C++11 compilation flags" FORCE)
+endif(NOT CMAKE_CXX_FLAGS)
+
+#------------------------------------------------------------------------------
+# Project definition, variable and dependencies 
+#------------------------------------------------------------------------------
+
+set(CMAKE_PROJECT_NAME ${PROJECT_NAME})
+set(CMAKE_SYSTEM_NAME ESP8266)
+
+set(CMAKE_PROJECT_BRIEF "LTBL")
+
+# Allow CTest
+enable_testing()
+
+find_package(Doxygen)
+option(ENABLE_DOCS "Build API documentation" ${DOXYGEN_FOUND})
+
+#------------------------------------------------------------------------------
+# Project version
+#------------------------------------------------------------------------------
+
+# Get the latest abbreviated commit hash of the working branch
+execute_process(
+    COMMAND git log -1 --format=%h
+    WORKING_DIRECTORY ${CMAKE_SOURCE_DIR}
+    OUTPUT_VARIABLE GIT_COMMIT_HASH
+    OUTPUT_STRIP_TRAILING_WHITESPACE
+)
+
+string(REGEX REPLACE
+    "^([\\.0-9]+).*"
+    "\\1"
+    tmp_VERSION
+    "${PRJ_VERSION}"
+)
+
+string(REGEX REPLACE
+    "^([0-9]+)\\..*"
+    "\\1"
+    tmp_SOVERSION
+    "${tmp_VERSION}"
+)
+
+# Major version is for product/marketing purpose
+# Minor version is incremented everytime it gets public
+set(MAJ_MIN_VERSION ${tmp_VERSION} CACHE STRING "Major and minor version" FORCE)
+
+# Release version is incremented everytime it gets use inside the company
+set(RELEASE_VERSION ${tmp_SOVERSION} CACHE STRING "Release version" FORCE)
+
+# Build version is generated using the hash of the current commit build with
+set(BUILD_VERSION ${GIT_COMMIT_HASH} CACHE STRING "Build version" FORCE)
+
+#------------------------------------------------------------------------------
+# pkgconfig
+#------------------------------------------------------------------------------
+
+#------------------------------------------------------------------------------
+# Project configuration 
+#------------------------------------------------------------------------------
+
+add_definitions(-DUNIX)
+
+#------------------------------------------------------------------------------
+# Sub-directories 
+#------------------------------------------------------------------------------
+
+# Main build
+# add_subdirectory(src) # TODO : Build main project w/ CMake
+
+add_subdirectory(software/tests)
+add_subdirectory(software/docs)
+add_subdirectory(examples)

README.md

@@ -1,3 +1,23 @@
-# Lämp
+# Let There Be Light !
 
-Connected lamp project
+This project aims to create a web-connected lamp controled by both a physical switch and a web page.
+
+# Ressources & Links
+
+- https://www.instructables.com/id/Controlling-AC-light-using-Arduino-with-relay-modu/
+- https://tttapa.github.io/ESP8266/Chap01%20-%20ESP8266.html
+- https://forum.arduino.cc/index.php?topic=590593.0
+- https://developer.myconstellation.io/tutorials/creer-une-prise-connectee-avec-un-esp8266/
+- https://randomnerdtutorials.com/wifimanager-with-esp8266-autoconnect-custom-parameter-and-manage-your-ssid-and-password/
+
+# Logger class
+The logger class is inspired from https://abrushforeachkeyboard.wordpress.com/2014/06/17/arduino-adding-a-logger-class-with-a-c-style-print-of-messages/
+___
+
+# Contributors
+
+Many thanks to the project contributors ! 
+
+Thanks to :
+- [Simon Pavy](https://github.com/simon44530)
+- [Clovis Durand](https://github.com/Clovel)

docs/notes.md

@@ -0,0 +1,6 @@
+# Serial port read w/ terminal
+`sudo cu -l /dev/cu.usbserial-1420 -s 115200`
+
+# Prohibited functions/classes
+`std::string::erase` - `Fatal exception 9(LoadStoreAlignmentCause)`
+`std::stringstream` - `Fatal exception 9(LoadStoreAlignmentCause)`

examples/CMakeLists.txt

@@ -0,0 +1,6 @@
+# 
+#          Copyright (C) 2019 Clovis Durand <[email protected]>
+# 
+# -----------------------------------------------------------------------------
+
+add_subdirectory(logger_example)

examples/logger_example/CMakeLists.txt

@@ -0,0 +1,48 @@
+# 
+#        Copyright (C) 2019 Clovis Durand <cd.clovel19²gmail.com>
+# 
+# -----------------------------------------------------------------------------
+
+set(CMAKE_PROJECT_NAME logger-example)
+set(CMAKE_SYSTEM_NAME Linux)
+
+set(CMAKE_PROJECT_BRIEF "Logger class example")
+
+#------------------------------------------------------------------------------
+# Target configuration for tests
+#------------------------------------------------------------------------------
+
+# Header files --------------------------------------------
+include_directories(
+    ${CMAKE_SOURCE_DIR}/software/inc
+    ${CMAKE_SOURCE_DIR}/examples/logger_example
+)
+
+file(GLOB EXAMPLE_HEADERS
+    ${CMAKE_SOURCE_DIR}/examples/logger_example/*.h
+    ${CMAKE_SOURCE_DIR}/examples/logger_example/*.hpp
+)
+
+set(HEADERS
+    ${CMAKE_SOURCE_DIR}/software/inc/Logger.hpp
+    ${CMAKE_SOURCE_DIR}/software/inc/def.h
+    ${EXAMPLE_HEADERS}
+)
+
+# Source files --------------------------------------------
+file(GLOB EXAMPLE_SOURCES
+    ${CMAKE_SOURCE_DIR}/examples/logger_example/*.c
+    ${CMAKE_SOURCE_DIR}/examples/logger_example/*.cpp
+)
+
+set(SOURCES
+    ${CMAKE_SOURCE_DIR}/software/src/Logger.cpp
+    ${EXAMPLE_SOURCES}
+)
+
+# Target definition ---------------------------------------
+add_definitions(-DTESTS)
+
+add_executable(logger-example
+    ${SOURCES}
+)

examples/logger_example/main.cpp

@@ -0,0 +1,27 @@
+/**
+ * Let There Be Light project
+ * 
+ * @brief Main source file of the Logger example. 
+ * 
+ * @file main.cpp
+ */
+
+/* Includes -------------------------------------------- */
+#include "Logger.hpp"
+
+/* Defines --------------------------------------------- */
+
+/* Global variables ------------------------------------ */
+//static Logger &sLogger = Logger::instance();
+
+/* main ------------------------------------------------ */
+int main(const int argc, const char * const * const argv) {
+    (void)argc;
+    (void)argv;
+
+    Logger &lLogger = Logger::instance();
+
+    lLogger << "[TEST ] Testing logger capabilities !" << endlog;
+
+    return 0;
+}

platformio.ini

@@ -0,0 +1,33 @@
+; PlatformIO Project Configuration File
+;
+;   Build options: build flags, source filter, extra scripting
+;   Upload options: custom port, speed and extra flags
+;   Library options: dependencies, extra library storages
+;
+; Please visit documentation for the other options and examples
+; http://docs.platformio.org/page/projectconf.html
+
+[platformio]
+default_envs = nodemcuv2
+workspace_dir = software/
+include_dir = software/inc/
+src_dir = software/src/
+
+[env:nodemcuv2]
+platform = espressif8266
+framework = arduino
+board = nodemcuv2
+build_flags =
+    -DESP8266
+    -DESP8266_NODEMCU
+    -DDEBUG_ESP_CORE
+    -DDEBUG_ESP_WIFI
+    -DDEBUG_ESP_HTTP_UPDATE
+    -DDEBUG_ESP_UPDATER
+    -DDEBUG_ESP_OTA
+    -DDEBUG_ESP_PORT=Serial
+    ; -DDEBUG_ESP_OOM -include "umm_malloc/umm_malloc_cfg.h"
+    -Wall
+    -Wextra
+monitor_speed = 115200
+lib_deps = WiFiManager