Merge branch 'feature/app'

.github/workflows/doxygen-gh-pages.yml

@@ -0,0 +1,18 @@
+name: Doxygen GitHub Pages Deploy Action
+
+on:
+  push:
+    branches:
+      - main
+  workflow_dispatch:
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: DenverCoder1/[email protected]
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          branch: gh-pages
+          folder: hw_api_docs/html
+          config_file: Software/ESP32/Doxyfile

README.md

@@ -42,21 +42,39 @@ These are made of LED panels, enclosure and drivers, so these could be hacked to
 * [LoRa RA-02](https://uk.banggood.com/433MHZ-SX1278-LoRa-Module-433M-10KM-Ra-02-Wireless-Spread-Spectrum-Transmission-Board-2_4G-IPX-Antenna-for-Smart-Home-p-1939044.html?utm_source=googleshopping&utm_medium=cpc_organic&gmcCountry=GB&utm_content=minha&utm_campaign=minha-gbg-en-pc&currency=GBP&cur_warehouse=CN&createTmp=1&utm_source=googleshopping&utm_medium=cpc_us&utm_campaign=jeff-co-pmax-ukbg-allcat-uk-220412&utm_content=jeff&ad_id=)
 module mount is provided which has connections to the ESP 32. This chip can be used for long range radio communications.
 
-## TODO
+## Setting up secrets
 
-### Software
+### For the Esp32
 
-- [x] Code hardware drivers
-- [ ] Test code with hardware
-- [ ] Code control/sensing stack
-- [ ] Code management stack
-- [ ] Integration tests
+* Syncing timer with NTC will require WiFi credentials which can be set up following the instructions below.
+* Firebase logging will also require firebase credentials. Which can be set up using [this](https://randomnerdtutorials.com/esp32-data-logging-firebase-realtime-database/) article from Random Nerd tutorials.
+* Add a `secrets.h` file in `Software/ESP32/include` and fill in the details.
 
-### Hardware
+```cpp
+#ifndef _SECRETS_H_
+#define _SECRETS_H_
 
-- [x] Circuit design
-- [x] Calibrate sensors
-- [ ] Soldering
-- [ ] Designing parts for grow chamber
-- [ ] Printing / making parts for grow chamber
-- [ ] Assembly
+#define WIFI_SSID ""
+#define WIFI_PASSWORD ""
+#define FIREBASE_TOKEN ""
+#define FIREBASE_USER_EMAIL ""
+#define FIREBASE_USER_PASSWORD ""
+#define FIREBASE_URL ""
+
+#endif
+```
+
+## For the phone
+
+* Follow [this](https://firebase.google.com/docs/flutter/setup?platform=android) to register the android app. Switch to IOS if you have to set this up on IOS device.
+
+>****NOTE**** This project has been only tested with an android app and I'm (MRo47) a noob at flutter or in general app development. So contributions are welcome here.
+
+## Install
+
+* **Build the project in Platform.io:**
+Currently the main file is selected in platformio.ini (commented out in the build_src_filter)
+* **Upload to ESP32:**
+Upload by clicking the upload button while press and holding the boot button on ESP32.
+* **Test modules individually:**
+Uncomment the `-<main.cpp>` line and comment out the test cpps for each module, one at a time. Then do step 1 and 2

Software/ESP32/.gitignore

@@ -1,3 +1,4 @@
 .pio
-.vscode/
-include/secrets.h
+.vscode
+include/secrets.h
+logs