Initial commit

.gitignore

@@ -0,0 +1,38 @@
+# ---> C++
+# Prerequisites
+*.d
+
+# Compiled Object files
+*.slo
+*.lo
+*.o
+*.obj
+
+# Precompiled Headers
+*.gch
+*.pch
+
+# Compiled Dynamic libraries
+*.so
+*.dylib
+*.dll
+
+# Fortran module files
+*.mod
+*.smod
+
+# Compiled Static libraries
+*.lai
+*.la
+*.a
+*.lib
+
+# Executables
+*.exe
+*.out
+*.app
+
+# ---> VisualStudioCode
+.pio
+.vscode
+*.code-workspace

.travis.yml

@@ -0,0 +1,67 @@
+# Continuous Integration (CI) is the practice, in software
+# engineering, of merging all developer working copies with a shared mainline
+# several times a day < https://docs.platformio.org/page/ci/index.html >
+#
+# Documentation:
+#
+# * Travis CI Embedded Builds with PlatformIO
+#   < https://docs.travis-ci.com/user/integration/platformio/ >
+#
+# * PlatformIO integration with Travis CI
+#   < https://docs.platformio.org/page/ci/travis.html >
+#
+# * User Guide for `platformio ci` command
+#   < https://docs.platformio.org/page/userguide/cmd_ci.html >
+#
+#
+# Please choose one of the following templates (proposed below) and uncomment
+# it (remove "# " before each line) or use own configuration according to the
+# Travis CI documentation (see above).
+#
+
+
+#
+# Template #1: General project. Test it using existing `platformio.ini`.
+#
+
+# language: python
+# python:
+#     - "2.7"
+#
+# sudo: false
+# cache:
+#     directories:
+#         - "~/.platformio"
+#
+# install:
+#     - pip install -U platformio
+#     - platformio update
+#
+# script:
+#     - platformio run
+
+
+#
+# Template #2: The project is intended to be used as a library with examples.
+#
+
+# language: python
+# python:
+#     - "2.7"
+#
+# sudo: false
+# cache:
+#     directories:
+#         - "~/.platformio"
+#
+# env:
+#     - PLATFORMIO_CI_SRC=path/to/test/file.c
+#     - PLATFORMIO_CI_SRC=examples/file.ino
+#     - PLATFORMIO_CI_SRC=path/to/test/directory
+#
+# install:
+#     - pip install -U platformio
+#     - platformio update
+#
+# script:
+#     - platformio ci --lib="." --board=ID_1 --board=ID_2 --board=ID_N

LICENSE

@@ -0,0 +1,14 @@
+DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
+
+Version 2, December 2004
+
+Copyright (C) 2004 Sam Hocevar <sam@hocevar.net>
+
+Everyone is permitted to copy and distribute verbatim or modified copies of
+this license document, and changing it is allowed as long as the name is changed.
+
+DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
+
+TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+
+   0. You just DO WHAT THE FUCK YOU WANT TO.

README.md

@@ -0,0 +1,2 @@
+# JackHome-LightSwitch
+

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

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

platformio.ini

@@ -0,0 +1,16 @@
+; 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:esp12e]
+platform = espressif8266
+board = esp12e
+framework = arduino
+board_build.f_cpu = 160000000L
+board_build.ldscript = eagle.flash.2m512.ld

src/button.cpp

@@ -0,0 +1,15 @@
+#include "button.h"
+
+#include <Arduino.h>
+
+namespace lightswitch
+{
+    Button::Button(unsigned short int pin)
+        : pin_(pin),
+          pressed_(false) {}
+
+    void Button::Setup()
+    {
+        pinMode(pin_, INPUT);
+    }
+} // namespace lightswitch

src/button.h

@@ -0,0 +1,16 @@
+#ifndef LIGHTSWITCH_BUTTON_H_
+#define LIGHTSWITCH_BUTTON_H_
+
+namespace lightswitch
+{
+    class Button
+    {
+    public:
+        Button(unsigned short int pin);
+        void Setup();
+        unsigned short int pin_;
+        volatile bool pressed_;
+    };
+} // namespace lightswitch
+
+#endif // LIGHTSWITCH_BUTTON_H_

src/main.cpp

@@ -0,0 +1,77 @@
+#include <Arduino.h>
+#include <PubSubClient.h>
+
+#include "button.h"
+#include "relay.h"
+#include "wireless.h"
+
+const char *name = "LivingRoom";
+const char *ssid = "JackHome";
+const char *wpa2 = "JackHomeIOT";
+
+lightswitch::Button button(5);
+lightswitch::Relay relay(15);
+lightswitch::Wireless wireless(ssid, wpa2);
+
+WiFiClient wifi_client;
+IPAddress mqtt_broker(192,168,4,1);
+PubSubClient mqtt_client(mqtt_broker, 1883, wifi_client);
+
+void IRAM_ATTR ButtonCallback()
+{
+    button.pressed_ = true;
+}
+
+void MQTTCallback(char *topic, byte *payload, unsigned int length)
+{
+    // This is hacky and just for debug purposes at the moment.
+    if (length == 1 && !strcmp(topic, "lights/LivingRoom/1"))
+    {
+        if (payload[0] == '0')
+        {
+            relay.Off();
+        }
+        else if (payload[0] == '1')
+        {
+            relay.On();
+        }
+    }
+}
+
+void setup()
+{
+    // Setup pins.
+    button.Setup();
+    relay.Setup();
+
+    // Configure callbacks. Without std::function() we're stuck with using global functions.
+    attachInterrupt(button.pin_, ButtonCallback, FALLING);
+    mqtt_client.setCallback(MQTTCallback);
+    
+    // Connect to WiFi.
+    wireless.Connect();
+}
+
+void loop()
+{
+    // Move this to an MQTT class at some point.
+    if (!mqtt_client.connected())
+    {
+        // (Re)connect to MQTT broker.
+        if (mqtt_client.connect(name))
+        {
+            // This is dirty. Find a way to cleanly subscribe to a list of MQTT topics.
+            mqtt_client.subscribe("lights/LivingRoom/1");
+        }
+    }
+
+    // Process MQTT messages.
+    mqtt_client.loop();
+
+    // Handle button press. Find a way to handle 
+    if (button.pressed_)
+    {
+        button.pressed_ = false;
+        relay.Toggle();
+    }
+}

src/relay.cpp

@@ -0,0 +1,32 @@
+#include "relay.h"
+
+#include <Arduino.h>
+
+namespace lightswitch
+{
+    Relay::Relay(unsigned short int pin)
+        : pin_(pin),
+          state_(false) {}
+
+    void Relay::Setup()
+    {
+        pinMode(pin_, OUTPUT);
+    }
+
+    void Relay::Toggle()
+    {
+        state_ ? Relay::Off() : Relay::On();
+    }
+
+    void Relay::On()
+    {
+        state_ = true;
+        digitalWrite(pin_, HIGH);
+    }
+
+    void Relay::Off()
+    {
+        state_ = false;
+        digitalWrite(pin_, LOW);
+    }
+} // namespace relay

src/relay.h

@@ -0,0 +1,21 @@
+#ifndef LIGHTSWITCH_RELAY_H_
+#define LIGHTSWITCH_RELAY_H_
+
+namespace lightswitch
+{
+    class Relay
+    {
+    private:
+        unsigned short int pin_;
+        bool state_;
+        
+    public:
+        Relay(unsigned short int pin);
+        void Setup();
+        void Toggle();
+        void On();
+        void Off();
+    };
+} // namespace lightswitch
+
+#endif // LIGHTSWITCH_RELAY_H_

src/wireless.cpp

@@ -0,0 +1,16 @@
+#include "wireless.h"
+
+#include <ESP8266WiFi.h>
+
+namespace lightswitch
+{
+    Wireless::Wireless(const char *ssid, const char *password)
+        : ssid_(ssid),
+          password_(password) {}
+
+    void Wireless::Connect()
+    {
+        WiFi.mode(WIFI_STA);
+        password_ ? WiFi.begin(ssid_, password_) : WiFi.begin(ssid_);
+    }
+} // namespace lightswitch

src/wireless.h

@@ -0,0 +1,20 @@
+#ifndef LIGHTSWITCH_WIRELESS_H_
+#define LIGHTSWITCH_WIRELESS_H_
+
+#include <ESP8266WiFi.h>
+
+namespace lightswitch
+{
+    class Wireless
+    {
+    private:
+        const char *ssid_;
+        const char *password_;
+        
+    public:
+        Wireless(const char *ssid, const char *password = nullptr);
+        void Connect();
+    };
+} // namespace lightswitch
+
+#endif // LIGHTSWITCH_WIRELESS_H_

test/README

@@ -0,0 +1,11 @@
+
+This directory is intended for PIO 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 PIO Unit Testing:
+- https://docs.platformio.org/page/plus/unit-testing.html