add sonar sensor

arduino_projects.code-workspace

@@ -20,6 +20,9 @@
 		},
 		{
 			"path": "libraries"
+		},
+		{
+			"path": "oil_sensor"
 		}
 	],
 	"settings": {

libraries/Tiny/Tiny.h

@@ -28,5 +28,6 @@ enum SensorId : int {
 	WATER_SENSOR = 3,
 	TEMP_SENSOR = 4,
 	LIGHT_SENSOR = 5,
-	MOVEMENT_SENSOR = 6
+	MOVEMENT_SENSOR = 6,
+	OIL_SENSOR = 7
 };

oil_sensor/.gitignore

@@ -0,0 +1,5 @@
+.pio
+.vscode/.browse.c_cpp.db*
+.vscode/c_cpp_properties.json
+.vscode/launch.json
+.vscode/ipch

oil_sensor/README.md

@@ -0,0 +1,14 @@
+# Temperature sensor
+
+It uses a [TMP36](https://cloud.hodos.ro/wiki/ha/datasheets/TMP35_36_37.pdf) to read temperature and it is optimised for power consumption.  
+It uses watch dog that wakes every 8s and increments a counter. Once the counter reaches a certain value (e.g. equivalent to 5 mins), it will read and send temperature to the gateway.  
+Every hour the voltage is also read and sent.
+
+According to the calculator here, https://www.geekstips.com/battery-life-calculator-sleep-mode/, a cell coin battery with a capacity of `240mAh` should last for 
+`~ 3 months (108 days)`, given that:
+- Current consumption of device during sleep is `4.5uA`
+- Device wakes up every `5 mins (12 times/hour)`
+- Current consumption of device during wake is `10mA`
+- Duration of wake time is `1000 ms`
+
+![Schematics](docs/temp_sensor_bb.png)

oil_sensor/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

oil_sensor/include/SonarSensor.h

@@ -0,0 +1,19 @@
+#pragma once
+
+#include "GenericSensor.h"
+#include <NewPing.h>
+
+#define MAX_DISTANCE 200
+#define TRIGGER_PIN  PIN_B3
+#define ECHO_PIN     PIN_B4
+
+class SonarSensor : public GenericSensor {
+  private:
+    NewPing sonar{TRIGGER_PIN, ECHO_PIN, MAX_DISTANCE};
+  public:
+    SonarSensor(short id) : GenericSensor(id) {}
+
+    unsigned long scan() {
+        return sonar.ping_median();
+    }
+};

oil_sensor/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

oil_sensor/platformio.ini

@@ -0,0 +1,25 @@
+; 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:attiny85]
+platform = atmelavr
+board = attiny85
+framework = arduino
+lib_deps = 
+	teckel12/NewPing@^1.9.4
+	sui77/rc-switch @ ^2.6.4
+lib_extra_dirs = 
+	../libraries
+upload_protocol = stk500v1
+upload_flags = 
+	-P$UPLOAD_PORT
+	-b$UPLOAD_SPEED
+upload_port = /dev/ttyACM0
+upload_speed = 19200

oil_sensor/src/oil_sensor.cpp

@@ -0,0 +1,43 @@
+#include <Arduino.h>
+#include <TinyPower.h>
+#include "SonarSensor.h"
+
+#define SEND_INTERVAL 37						// 37*8s = ~5min
+#define SEND_VCC_INTERVAL (SEND_INTERVAL*6)		// every half hour
+
+// Pins
+#define SENDER PIN_B2
+
+SonarSensor oilSensor(OIL_SENSOR);
+
+volatile int counter = 0;
+volatile bool shouldSend = true;
+
+void setup() {
+	TinySwitch::setup(SENDER);
+	TinyPower::setup();
+	TinyPower::enableWdt(WDTO_8S);
+}
+
+void loop() {
+	if (shouldSend) {
+		shouldSend = false;
+		unsigned long distance = oilSensor.scan();
+		if (distance) {
+			if (counter % SEND_VCC_INTERVAL == 0) {
+				oilSensor.sendValueAndVoltage(distance);
+				counter = 0;
+			} else {
+				oilSensor.sendValue(distance);
+			}
+		}
+	}
+	TinyPower::sleep();
+}
+
+ISR(WDT_vect) {
+	counter++;
+	if (((counter + 1) % SEND_INTERVAL == 0) || ((counter + 1) % SEND_VCC_INTERVAL == 0)) {
+		shouldSend = true;
+	}
+}

oil_sensor/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