Merge branch 'firmware_dev'

.gitignore

@@ -0,0 +1,7 @@
+.pio
+CMakeListsPrivate.txt
+cmake-build-*/ 
+
+
+# IDE
+./.idea

.idea/.gitignore

@@ -0,0 +1,8 @@
+# Default ignored files
+/shelf/
+/workspace.xml
+# Editor-based HTTP Client requests
+/httpRequests/
+# Datasource local storage ignored files
+/dataSources/
+/dataSources.local.xml

.idea/misc.xml

@@ -0,0 +1,12 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="CMakeWorkspace" PROJECT_DIR="$PROJECT_DIR$/firmware">
+    <contentRoot DIR="$PROJECT_DIR$" />
+  </component>
+  <component name="CidrRootsConfiguration">
+    <sourceRoots>
+      <file path="$PROJECT_DIR$/firmware/src" />
+      <file path="$PROJECT_DIR$/src" />
+    </sourceRoots>
+  </component>
+</project>

.idea/modules.xml

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="ProjectModuleManager">
+    <modules>
+      <module fileurl="file://$PROJECT_DIR$/.idea/untitled.iml" filepath="$PROJECT_DIR$/.idea/untitled.iml" />
+    </modules>
+  </component>
+</project>

.idea/untitled.iml

@@ -0,0 +1,2 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<module classpath="CMake" type="CPP_MODULE" version="4" />

.idea/vcs.xml

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="VcsDirectoryMappings">
+    <mapping directory="$PROJECT_DIR$" vcs="Git" />
+  </component>
+</project>

README.md

@@ -0,0 +1 @@
+#Climate GO 

firmware/CMakeLists.txt

@@ -0,0 +1,33 @@
+# !!! WARNING !!! AUTO-GENERATED FILE, PLEASE DO NOT MODIFY IT AND USE
+# https://docs.platformio.org/page/projectconf/section_env_build.html#build-flags
+#
+# If you need to override existing CMake configuration or add extra,
+# please create `CMakeListsUser.txt` in the root of project.
+# The `CMakeListsUser.txt` will not be overwritten by PlatformIO.
+
+cmake_minimum_required(VERSION 3.13)
+set(CMAKE_SYSTEM_NAME Generic)
+set(CMAKE_C_COMPILER_WORKS 1)
+set(CMAKE_CXX_COMPILER_WORKS 1)
+
+project("new_climte_go" C CXX)
+
+include(CMakeListsPrivate.txt)
+
+if(EXISTS ${CMAKE_CURRENT_SOURCE_DIR}/CMakeListsUser.txt)
+include(CMakeListsUser.txt)
+endif()
+
+add_custom_target(
+    Production ALL
+    COMMAND platformio -c clion run "$<$<NOT:$<CONFIG:All>>:-e${CMAKE_BUILD_TYPE}>"
+    WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}
+)
+
+add_custom_target(
+    Debug ALL
+    COMMAND platformio -c clion debug "$<$<NOT:$<CONFIG:All>>:-e${CMAKE_BUILD_TYPE}>"
+    WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}
+)
+
+add_executable(Z_DUMMY_TARGET ${SRC_LIST})

firmware/include/README

@@ -0,0 +1,39 @@
+
+This directory is intended for project header files.
+
+A header file is a file containing C declarations and macro definitions
+to be shared between several project source files. You request the use of a
+header file in your project source file (C, C++, etc) located in `src` folder
+by including it, with the C preprocessing directive `#include'.
+
+```src/main.c
+
+#include "header.h"
+
+int main (void)
+{
+ ...
+}
+```
+
+Including a header file produces the same results as copying the header file
+into each source file that needs it. Such copying would be time-consuming
+and error-prone. With a header file, the related declarations appear
+in only one place. If they need to be changed, they can be changed in one
+place, and programs that include the header file will automatically use the
+new version when next recompiled. The header file eliminates the labor of
+finding and changing all the copies as well as the risk that a failure to
+find one copy will result in inconsistencies within a program.
+
+In C, the usual convention is to give header files names that end with `.h'.
+It is most portable to use only letters, digits, dashes, and underscores in
+header file names, and at most one dot.
+
+Read more about using header files in official GCC documentation:
+
+* Include Syntax
+* Include Operation
+* Once-Only Headers
+* Computed Includes
+
+https://gcc.gnu.org/onlinedocs/cpp/Header-Files.html

firmware/lib/README

@@ -0,0 +1,46 @@
+
+This directory is intended for project specific (private) libraries.
+PlatformIO will compile them to static libraries and link into executable file.
+
+The source code of each library should be placed in a an own separate directory
+("lib/your_library_name/[here are source files]").
+
+For example, see a structure of the following two libraries `Foo` and `Bar`:
+
+|--lib
+|  |
+|  |--Bar
+|  |  |--docs
+|  |  |--examples
+|  |  |--src
+|  |     |- Bar.c
+|  |     |- Bar.h
+|  |  |- library.json (optional, custom build options, etc) https://docs.platformio.org/page/librarymanager/config.html
+|  |
+|  |--Foo
+|  |  |- Foo.c
+|  |  |- Foo.h
+|  |
+|  |- README --> THIS FILE
+|
+|- platformio.ini
+|--src
+   |- main.c
+
+and a contents of `src/main.c`:
+```
+#include <Foo.h>
+#include <Bar.h>
+
+int main (void)
+{
+  ...
+}
+
+```
+
+PlatformIO Library Dependency Finder will find automatically dependent
+libraries scanning project source files.
+
+More information about PlatformIO Library Dependency Finder
+- https://docs.platformio.org/page/librarymanager/ldf.html

firmware/platformio.ini

@@ -0,0 +1,15 @@
+; PlatformIO Project Configuration File
+;
+;   Build options: build flags, source filter
+;   Upload options: custom upload port, speed and extra flags
+;   Library options: dependencies, extra library storages
+;   Advanced options: extra scripting
+;
+; Please visit documentation for the other options and examples
+; https://docs.platformio.org/page/projectconf.html
+
+[env:esp32dev]
+platform = espressif32
+board = esp32dev
+framework = arduino
+lib_deps = adafruit/Adafruit BMP280 Library@^2.6.1

firmware/src/ble/BluetoothServer.cpp

@@ -0,0 +1,92 @@
+#include <BLEDevice.h>
+#include <BLEServer.h>
+#include <BLE2902.h>
+#include "BluetoothServer.h"
+
+#define INTERNAL_LED_PIN 2
+#define BLE_SERVER_NAME "ClimateGO"
+#define SERVICE_UUID "2150123c-af53-4038-bc92-ba3d0870a9e4"
+#define TEMPERATURE_CHARACTERISTIC_UUID "cba1d466-344c-4be3-ab3f-189f80dd7518"
+#define PRESSURE_CHARACTERISTIC_UUID "ca73b3ba-39f6-4ab3-91ae-186dc9577d99"
+
+//Setup callbacks onConnect and onDisconnect
+class ServerCallbacks : public BLEServerCallbacks {
+    void onConnect(BLEServer *pServer) override {
+        Serial.println("New device connected.");
+        digitalWrite(INTERNAL_LED_PIN, HIGH);
+    };
+
+    void onDisconnect(BLEServer *pServer) override {
+        Serial.println("Device disconnected.");
+        digitalWrite(INTERNAL_LED_PIN, LOW);
+        //restart advertising on device disconnect
+        pServer->getAdvertising()->start();
+    }
+};
+
+/**
+ * Represents the Bluetooth server that handles all interactions
+ */
+BluetoothServer::BluetoothServer() {
+    // Create the BLE Device
+    BLEDevice::init(BLE_SERVER_NAME);
+
+    // Create the BLE Server
+    this->bleServer = BLEDevice::createServer();
+    bleServer->setCallbacks(new ServerCallbacks());
+
+    // Create the BLE Service
+    this->sensorService = bleServer->createService(SERVICE_UUID);
+
+    //create characteristics that will enable data sharing
+    BLECharacteristic *temperatureCharacteristic = sensorService->createCharacteristic(
+            TEMPERATURE_CHARACTERISTIC_UUID,
+            BLECharacteristic::PROPERTY_READ
+    );
+    BLECharacteristic *pressureCharacteristic = sensorService->createCharacteristic(
+            PRESSURE_CHARACTERISTIC_UUID,
+            BLECharacteristic::PROPERTY_READ
+    );
+
+    //set initial values
+    temperatureCharacteristic->setValue("NA");
+    pressureCharacteristic->setValue("NA");
+}
+
+/**
+ * Method to start the Bluetooth server and enable advertising to allow other devices to connect
+ */
+void BluetoothServer::startServer() {
+    // Start the service
+    this->sensorService->start();
+
+    // Start advertising
+    BLEAdvertising *pAdvertising = BLEDevice::getAdvertising();
+    pAdvertising->addServiceUUID(SERVICE_UUID);
+    this->bleServer->getAdvertising()->start();
+    Serial.println("Started BLE Server.");
+}
+
+/**
+ * TODO: Convert temperature to string somehow
+ * Publish a new temperature to the appropriate characteristic
+ * @param temperature the new temperature
+ */
+void BluetoothServer::setTemperature(float temperature) {
+    sensorService
+            ->getCharacteristic(TEMPERATURE_CHARACTERISTIC_UUID)
+            ->setValue(temperature);
+}
+
+/**
+ * TODO: Convert pressure to string somehow
+ * Publish a new pressure to the appropriate characteristic
+ * @param pressure the new pressure
+ */
+void BluetoothServer::setPressure(float pressure) {
+    sensorService
+            ->getCharacteristic(PRESSURE_CHARACTERISTIC_UUID)
+            ->setValue(pressure);
+}
+
+

firmware/src/ble/BluetoothServer.h

@@ -0,0 +1,25 @@
+#ifndef NEW_CLIMTE_GO_BLUETOOTHSERVER_H
+#define NEW_CLIMTE_GO_BLUETOOTHSERVER_H
+
+#include <BLEDevice.h>
+#include <BLEServer.h>
+#include <BLEUtils.h>
+#include <BLE2902.h>
+#include <Arduino.h>
+
+#define temperatureCelsius
+
+class BluetoothServer {
+private:
+    BLEService *sensorService;
+    BLEServer *bleServer;
+public:
+    BluetoothServer();
+
+    void startServer();
+    void setTemperature(float temperature);
+    void setPressure(float pressure);
+};
+
+
+#endif //NEW_CLIMTE_GO_BLUETOOTHSERVER_H

firmware/src/main.cpp

@@ -0,0 +1,28 @@
+#include <Arduino.h>
+#include <sensors/BmpSensor.h>
+#include <ble/BluetoothServer.h>
+
+#define SLEEP_TIME 2
+#define BAUD_RATE 112500
+#define INTERNAL_LED_PIN 2
+
+
+Sensor *bmpSensor;
+BluetoothServer *server;
+
+void setup() {
+    Serial.begin(BAUD_RATE);
+    pinMode(INTERNAL_LED_PIN, OUTPUT);
+
+    bmpSensor = new BmpSensor();
+
+    server = new BluetoothServer();
+    server->startServer();
+}
+
+void loop() {
+    sensor_data_t sample = ((BmpSensor *) bmpSensor)->sampleLowEnergy();
+    server->setPressure(sample.pressure);
+    server->setTemperature(sample.temperature);
+    delay(SLEEP_TIME * 1000);
+}

firmware/src/sensors/BmpSensor.cpp

@@ -0,0 +1,89 @@
+#include <Arduino.h>
+#include <Wire.h>
+#include <Adafruit_BMP280.h>
+#include "BmpSensor.h"
+
+/**
+ * Creates a new BMP Sensor and initializes it
+ */
+BmpSensor::BmpSensor() {
+    this->BmpSensor::sensor_setup();
+    this->state = SensorState::ASLEEP;
+}
+
+/**
+ * Function responsible for setting up the sensor and the I2C connection
+ */
+void BmpSensor::sensor_setup() {
+    while (!Serial) delay(100);   // wait for native usb
+
+    unsigned status = this->bmp.begin(0x76); //set the correct I2C port
+
+    //query status and reboot the board if no sensor is detected
+    if (!status)
+        ESP.restart();
+
+    //put sensor to standby mode
+    this->enableStandbyMode();
+}
+
+/**
+ * Function to wake sensor up from standby mode
+ */
+void BmpSensor::wakeUp() {
+    this->bmp.setSampling(Adafruit_BMP280::MODE_NORMAL,     /* Operating Mode. */
+                          Adafruit_BMP280::SAMPLING_X2,     /* Temp. oversampling */
+                          Adafruit_BMP280::SAMPLING_X16,    /* Pressure oversampling */
+                          Adafruit_BMP280::FILTER_X16,      /* Filtering. */
+                          Adafruit_BMP280::STANDBY_MS_500 /* Standby time. */
+    );
+}
+
+/**
+ * Function to put sensor to standby mode
+ */
+void BmpSensor::enableStandbyMode() {
+    this->bmp.setSampling(Adafruit_BMP280::MODE_SLEEP,     /* Operating Mode. */
+                          Adafruit_BMP280::SAMPLING_X2,     /* Temp. oversampling */
+                          Adafruit_BMP280::SAMPLING_X16,    /* Pressure oversampling */
+                          Adafruit_BMP280::FILTER_X16,      /* Filtering. */
+                          Adafruit_BMP280::STANDBY_MS_500 /* Standby time. */
+    );
+}
+
+/**
+ * read a sample from the sensor
+ * @return a struct containing all necessary sensor data
+ */
+sensor_data_t BmpSensor::sample() {
+    //wake sensor up if it is in standby mode
+    if (this->state == SensorState::ASLEEP)
+        this->wakeUp();
+
+    //sample pressure and temperature
+    sensors_event_t temp_event, pressure_event;
+    this->bmp_temp->getEvent(&temp_event);
+    this->bmp_pressure->getEvent(&pressure_event);
+
+
+    return sensor_data_t
+            {
+                    temp_event.temperature,
+                    pressure_event.pressure
+            };
+}
+
+/**
+ * Read a sample and put sensor to standby mode.
+ * !!! Do not use this if sampling time is <= 500ms !!!
+ * @return the sample read
+ */
+sensor_data_t BmpSensor::sampleLowEnergy() {
+    //read sample
+    sensor_data_t sampledData = this->sample();
+    //put sensor to standby
+    this->enableStandbyMode();
+    return sampledData;
+}
+
+

firmware/src/sensors/BmpSensor.h

@@ -0,0 +1,29 @@
+#ifndef NEW_CLIMTE_GO_BMPSENSOR_H
+#define NEW_CLIMTE_GO_BMPSENSOR_H
+
+#include "Sensor.h"
+#include "Adafruit_BMP280.h"
+
+class BmpSensor : public Sensor {
+private:
+    Adafruit_BMP280 bmp; // use I2C interface
+    Adafruit_Sensor *bmp_temp = bmp.getTemperatureSensor();
+    Adafruit_Sensor *bmp_pressure = bmp.getPressureSensor();
+
+public:
+    BmpSensor();
+
+    sensor_data_t sample() override;
+    sensor_data_t sampleLowEnergy();
+
+    void enableStandbyMode() override;
+
+    void wakeUp() override;
+
+protected:
+    void sensor_setup() override;
+
+};
+
+#endif //NEW_CLIMTE_GO_BMPSENSOR_H
+

firmware/src/sensors/Sensor.h

@@ -0,0 +1,25 @@
+#ifndef NEW_CLIMTE_GO_SENSOR_H
+#define NEW_CLIMTE_GO_SENSOR_H
+
+#include <sensors/sensor_data_t.h>
+
+enum class SensorState : unsigned short {
+    AWAKE, ASLEEP
+};
+
+class Sensor {
+public:
+    virtual sensor_data_t sample() = 0;
+
+    virtual void wakeUp() = 0;
+
+    virtual void enableStandbyMode() = 0;
+
+protected:
+    SensorState state = SensorState::ASLEEP;
+
+    virtual void sensor_setup() = 0;
+
+};
+
+#endif //NEW_CLIMTE_GO_SENSOR_H

firmware/src/sensors/sensor_data_t.h

@@ -0,0 +1,16 @@
+#ifndef NEW_CLIMTE_GO_SENSOR_DATA_T_H
+#define NEW_CLIMTE_GO_SENSOR_DATA_T_H
+
+#include <types.h>
+
+/**
+ * This struct represents data read from any sensor.
+ * This implies, reading temperature from e.g. the CO2 Sensor
+ * does not make any sense
+ */
+struct sensor_data_t {
+    float temperature;
+    float pressure;
+};
+
+#endif

firmware/test/README

@@ -0,0 +1,11 @@
+
+This directory is intended for PlatformIO Unit Testing and project tests.
+
+Unit Testing is a software testing method by which individual units of
+source code, sets of one or more MCU program modules together with associated
+control data, usage procedures, and operating procedures, are tested to
+determine whether they are fit for use. Unit testing finds problems early
+in the development cycle.
+
+More information about PlatformIO Unit Testing:
+- https://docs.platformio.org/page/plus/unit-testing.html