Skip to content

Commit

Permalink
added secret setup to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
MRo47 committed Sep 24, 2023
1 parent 060bb14 commit 35b37d1
Showing 1 changed file with 9 additions and 19 deletions.
28 changes: 9 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,10 @@ module mount is provided which has connections to the ESP 32. This chip can be u

## Setting up secrets

### For the Esp32

* 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.

```cpp
Expand All @@ -60,6 +64,11 @@ module mount is provided which has connections to the ESP 32. This chip can be u
#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

Expand All @@ -69,22 +78,3 @@ Currently the main file is selected in platformio.ini (commented out in the buil
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

## TODO

### Software

- [x] Code hardware drivers
- [x] Test code with hardware
- [x] Code control/sensing stack
- [x] Code management stack
- [x] Integration tests

### Hardware

- [x] Circuit design
- [x] Calibrate sensors
- [x] Soldering
- [x] Designing parts for grow chamber
- [x] Printing / making parts for grow chamber
- [x] Assembly

0 comments on commit 35b37d1

Please sign in to comment.