Skip to content

Commit f0478e6

Browse files
committed
"Update documentation: enhance README.md, MQTT.md, and AUTOMATION.md with additional details; add images for MQTT and Automation setup; update platformio.ini upload port configuration"
1 parent b700016 commit f0478e6

File tree

6 files changed

+22
-14
lines changed

6 files changed

+22
-14
lines changed

AUTOMATION.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@ The Device Firmware comes with integrated Automations.
55
- Pump and Fill
66
- Fill
77

8+
![img.png](assets/img/automation.png)
9+
810
### Pump and Fill
911

1012
In this Mode the Device will enable <code>Relay 2</code> if the Level is between the given <code>max</code> and <code>

MQTT.md

Lines changed: 15 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2,20 +2,26 @@
22

33
The current MQTT Implementation is compatible with the latest 3.1.1 Protocol.
44

5+
### Setup
6+
7+
![img.png](assets/img/mqtt.png)
8+
9+
When enabling MQTT make sure, the Device can reach the MQTT Server.
10+
511
### Structure
612

713
- <prefix\>
814
- channel
9-
- 1
10-
- state
11-
- duration
12-
- 2
13-
- state
14-
- duration
15+
- 1
16+
- state
17+
- duration
18+
- 2
19+
- state
20+
- duration
1521
- voltage
1622
- cpu
1723
- status
1824
- operation
19-
- mode
20-
- fill
21-
- pump
25+
- mode
26+
- fill
27+
- pump

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# ByteWaterlevel
22

33
ByteWaterlevel in Short (BYTELEVEL) is an Device to Monitor Wells, Cisterns and co.
4-
It uses an TL136 Sensor to monitor the Fluid Level.
4+
It uses an TL136 Sensor to monitor the Fluid Level, but it works with all 4-20mA Sensors.
55

66
It comes with two Relais to control Pumps, Sirens or other Appliances.
77

@@ -62,14 +62,14 @@ An OP-Amp is used to amplify the Voltage Drop on a 120-Ohm Resistor.
6262

6363
The Sensor is tied directly to VCC In, so please use a good power supply otherwise the measurement tolerance can be big.
6464

65-
6665
## Setup
6766

6867
For Setup please have a Look into <a href="./SETUP.md">SETUP.md</a>.
6968

7069
## Automation
7170

72-
The Device comes with integrated Automation Functions for more Information look at <a href="./AUTOMATION.md">AUTOMATION.md</a>.
71+
The Device comes with integrated Automation Functions for more Information look at <a href="./AUTOMATION.md">
72+
AUTOMATION.md</a>.
7373

7474
## Factory reset:
7575

assets/img/automation.png

14.2 KB
Loading

assets/img/mqtt.png

17.5 KB
Loading

platformio.ini

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,5 +30,5 @@ lib_ignore =
3030
ESPAsyncTCP
3131

3232
upload_protocol = espota
33-
upload_port = 10.10.10.1
34-
#upload_port = 192.168.1.94
33+
#upload_port = 10.10.10.1
34+
upload_port = 192.168.1.94

0 commit comments

Comments
 (0)