migrate temp_sensor project to platformio

arduino_projects.code-workspace

@@ -13,6 +13,13 @@
 		{
 			"name": "blue_remote",
 			"path": "blue_remote"
+		},
+		{
+			"name": "temp_sensor",
+			"path": "temp_sensor"
+		},
+		{
+			"path": "libraries"
 		}
 	],
 	"settings": {
@@ -28,7 +35,12 @@
 			"cmath": "cpp",
 			"cstdlib": "cpp",
 			"istream": "cpp",
-			"ostream": "cpp"
+			"ostream": "cpp",
+			"optional": "cpp",
+			"system_error": "cpp",
+			"tuple": "cpp",
+			"type_traits": "cpp",
+			"utility": "cpp"
 		}
 	}
 }

libraries/Tiny/ContactSensor.h

@@ -3,11 +3,8 @@
 #include <TinySensor.h>
 #include <RCSwitch.h>
 
-#define ID(value) (value & 0x1F)
-#define STATE(value) ((value & 0x1) << 5)
-#define VCC(value) ((value & 0x1FFF) << 6)
-
 class ContactSensor: public TinySensor {
+	SensorType sensorType = CONTACT;
 
 public:
 	ContactSensor(short id, short senderPin) :
@@ -15,10 +12,10 @@ public:
 	}
 
 	void sendStateAndVoltage(bool state) {
-		sendInfo(ID(id) | VCC(readVcc()) | STATE(!state) | TYPE(7));
+		sendInfo(ID(id) | VCC(readVcc()) | STATE(!state) | TYPE(sensorType));
 	}
 
 	void sendState(bool state) {
-		sendInfo(ID(id) | VCC(0) | STATE(!state) | TYPE(7));
+		sendInfo(ID(id) | VCC(0) | STATE(!state) | TYPE(sensorType));
 	}
 };

libraries/Tiny/TempSensor.h

@@ -3,11 +3,8 @@
 #include <TinySensor.h>
 #include <RCSwitch.h>
 
-#define ID(value) (value & 0x1F)
-#define VCC(value) ((value & 0x1FFF) << 6)
-#define TEMP(value) (((unsigned long)value & 0x1FF) << 19)
-
 class TempSensor: public TinySensor {
+	SensorType sensorType = TEMPERATURE;
 
 public:
 	TempSensor(short id, short senderPin) :
@@ -15,6 +12,10 @@ public:
 	}
 
 	void sendTempAndVoltage(int temp) {
-		sendInfo(ID(id) | VCC(readVcc()) | TEMP(temp) | TYPE(6));
+		sendInfo(ID(id) | VCC(readVcc()) | TEMP(temp) | TYPE(sensorType));
+	}
+
+	void sendTemp(int temp) {
+		sendInfo(ID(id) | TEMP(temp) | TYPE(sensorType));
 	}
 };

libraries/Tiny/TinySensor.h

@@ -2,8 +2,17 @@
 
 #include <RCSwitch.h>
 
+#define ID(value) (value & 0x1F)
+#define STATE(value) ((value & 0x1) << 5)
+#define VCC(value) ((value & 0x1FFF) << 6)
+#define TEMP(value) (((unsigned long)value & 0x1FF) << 19)
 #define TYPE(value) (((unsigned long)value & 0xF) << 28)
 
+typedef enum SensorType {
+	TEMPERATURE = 6,
+	CONTACT = 7
+};
+
 
 class TinySensor {
 protected:

temp_sensor/.gitignore

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

temp_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

temp_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

temp_sensor/platformio.ini

@@ -0,0 +1,17 @@
+; 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_extra_dirs =
+    ../libraries
+    ~/Arduino/libraries

temp_sensor/src/temp_sensor.cpp

@@ -1,4 +1,4 @@
-#include "Arduino.h"
+#include <Arduino.h>
 #include <Tiny.h>
 #include <SoftwareSerial_Tiny.h>
 
@@ -14,6 +14,8 @@
 SoftwareSerial AttinySerial(RxD, TxD);
 #endif
 
+int readTemp();
+
 TempSensor sensor = TempSensor(TEMP_SENSOR, SENDER);
 
 int counter = 0;
@@ -28,7 +30,7 @@ void setup() {
 }
 
 void loop() {
-	sensor.sendTempAndVoltage(readTemp());
+	sensor.sendTemp(readTemp());
 	delay(60000L);
 }
 

temp_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