diff options
| -rw-r--r-- | .gitignore | 2 | ||||
| -rw-r--r-- | README.md | 8 | ||||
| -rw-r--r-- | include/README | 39 | ||||
| -rw-r--r-- | lib/README | 46 | ||||
| -rw-r--r-- | platformio.ini | 15 | ||||
| -rw-r--r-- | src/local.h.tmpl | 8 | ||||
| -rw-r--r-- | src/main.cpp | 55 | ||||
| -rw-r--r-- | src/mosquitto.conf | 2 | ||||
| -rw-r--r-- | test/README | 11 |
9 files changed, 186 insertions, 0 deletions
diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..1cd2420 --- /dev/null +++ b/.gitignore @@ -0,0 +1,2 @@ +.pio +src/local.h diff --git a/README.md b/README.md new file mode 100644 index 0000000..89c17cd --- /dev/null +++ b/README.md @@ -0,0 +1,8 @@ +# bark-button + +the code for the bark button - a button that barks. + +it uses a DOIT ESP32 DEVKIT v1, with platform.io and the arduino framework. +when a button gets pressed, it connects to mqtt and publishes a message to `sound/g1/play`, where the message is `barks/[random number from 0 to n_barks]`. + +to flash, install platformio and run `pio run -t upload`. you may need to hold boot as you plug the board in to get it ready to flash. diff --git a/include/README b/include/README new file mode 100644 index 0000000..194dcd4 --- /dev/null +++ b/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 diff --git a/lib/README b/lib/README new file mode 100644 index 0000000..6debab1 --- /dev/null +++ b/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 diff --git a/platformio.ini b/platformio.ini new file mode 100644 index 0000000..d1e0198 --- /dev/null +++ b/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 = esp32doit-devkit-v1 +framework = arduino +lib_deps = knolleary/PubSubClient@^2.8 diff --git a/src/local.h.tmpl b/src/local.h.tmpl new file mode 100644 index 0000000..488b2bf --- /dev/null +++ b/src/local.h.tmpl @@ -0,0 +1,8 @@ +#pragma once + +const char *ssid = ""; +const char *password = ""; +const char *mqtt_broker = ""; +const int mqtt_port = 1883; +const char *mqtt_topic = ""; +const int n_bark_sounds = 1; diff --git a/src/main.cpp b/src/main.cpp new file mode 100644 index 0000000..3b4d531 --- /dev/null +++ b/src/main.cpp @@ -0,0 +1,55 @@ +#include <WiFi.h> +#include <PubSubClient.h> +#include <Arduino.h> +#include "./local.h" // defines ssid and password + +WiFiClient wifiClient; +PubSubClient mqttClient(wifiClient); + +long lastMsg = 0; + +// Reconnect to the wifi / MQTT if required +void reconnect() { + if (WiFi.status() != WL_CONNECTED) { + WiFi.begin(ssid, password); + } + while (WiFi.status() != WL_CONNECTED) { + delay(500); + Serial.print("waiting for wifi, status="); + Serial.println(WiFi.status()); + } + + while (!mqttClient.connected()) { + mqttClient.setServer(mqtt_broker, mqtt_port); + if (!mqttClient.connect("Bark-Button")) { + Serial.print("failed to connect to mqtt, rc="); + Serial.println(mqttClient.state()); + delay(2000); + } + } +} + +// On button press, send a message to the MQTT broker +void buttonPress() { + char buf[40]; + reconnect(); + + sprintf(buf, "barks/%d", random(n_bark_sounds)); + mqttClient.publish("sound/g1/play", buf); + + // Don't waste cycles staying awake to send heartbeats + mqttClient.disconnect(); +} + +void setup() { + Serial.begin(9600); + reconnect(); + // TODO: Setup button press input +} + +// Wait for button press +void loop() { + // TODO: Wait for button press lol + delay(1000); + buttonPress(); +} diff --git a/src/mosquitto.conf b/src/mosquitto.conf new file mode 100644 index 0000000..c8348ac --- /dev/null +++ b/src/mosquitto.conf @@ -0,0 +1,2 @@ +listener 1883 +allow_anonymous true diff --git a/test/README b/test/README new file mode 100644 index 0000000..9b1e87b --- /dev/null +++ b/test/README @@ -0,0 +1,11 @@ + +This directory is intended for PlatformIO Test Runner 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/en/latest/advanced/unit-testing/index.html |