Skip to content

Commit 9452259

Browse files
committed
update docs
1 parent 57176be commit 9452259

File tree

1 file changed

+54
-9
lines changed

1 file changed

+54
-9
lines changed

README.md

+54-9
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,68 @@
11
# 🪴 Plant
22

3+
## [📈 Dashboard](https://plant.etinaude.dev)
4+
5+
### [plant.etinaude.dev](https://plant.etinaude.dev)
6+
7+
### ✔️ Prerequisite
8+
9+
- [BunJs](https://bunjs.dev) or npm
10+
- Set up Firebase with a real-time database
11+
- Add firebase keys to `webapp/src/keys.json`
12+
13+
### 📚 Install Libraries
14+
15+
`bun i`
16+
17+
### 🏃 Run
18+
19+
`bun run dev`
20+
321
## ⚡ Electronics
422

5-
[Easy EDA design](https://easyeda.com/editor#id=12a974c2c440434495f13cfdb8ba623a)
23+
### [Easy EDA design](https://easyeda.com/editor#id=12a974c2c440434495f13cfdb8ba623a)
24+
25+
### 🔋 Components
26+
27+
| 🧮 Logic | ➡️ Input | Output ➡️ |
28+
| ----------------------------- | ------------------------------------- | ----------- |
29+
| Wemos S2 mini Microcontroller | CCS811 Air quality sensor | 5v Pump |
30+
| uln2003 Transistor IC | DHT22 Temperature and Humidity Sensor | 5v Leds |
31+
| 5v 3A PSU | Capacity soil moisture sensor | 5v 40mm fan |
32+
| | LDR | |
33+
34+
## 💾 Embedded System
35+
36+
### ✔️ Prerequisite
637

38+
- Arduino IDE
39+
- ESP-32 board manger
740

8-
## 📈 Dashboard
41+
### 📚 Install Libraries
942

10-
[plant.etinaude.dev](https://plant.etinaude.dev)
43+
Install these libraries:
1144

12-
### Install
45+
- CCS811-SOLDERED
46+
- Wire
47+
- DHT22
48+
- Ewma
49+
- ESP32Firebase
50+
- WiFi
1351

14-
#### Prerequisite
52+
### 🏃 Run
1553

16-
- [BunJs](https://bunjs.dev)
54+
add `embedded/keys.h` with this content:
1755

56+
```cpp
57+
#define SSID "" // WiFi SSID
58+
#define PASSWORD "" // WiFi Password
59+
#define REFERENCE_URL "" // Firebase realtime database reference URL
60+
```
1861
19-
<!-- TODO -->
62+
Upload the code to the Wemos S2. Make sure it has Arduino firmware flashed.
2063
21-
OLD:
64+
## 📸 Images
2265
23-
[Thing Speak](https://thingspeak.com/channels/2333205/private_show)
66+
| 🔋 PCB | ⚡ Electronics | 📈 Dashboard |
67+
| ------------------------- | ----------------------------------------- | ----------------------------- |
68+
| ![PCB](./images/pcb.jpeg) | ![Electronics](./images/electronics.jpeg) | ![graph](./images/graph.jpeg) |

0 commit comments

Comments
 (0)