Skip to content

Commit e20141d

Browse files
Copilotdorkmo
andcommitted
Update README documentation for float switch NO/NC modes
Co-authored-by: dorkmo <[email protected]>
1 parent 5813f71 commit e20141d

File tree

1 file changed

+13
-1
lines changed

1 file changed

+13
-1
lines changed

TankAlarm-112025-Client-BluesOpta/README.md

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -83,12 +83,24 @@ The client creates a default configuration on first boot. You can update configu
8383
- **High Alarm**: Threshold in inches for high level alert
8484
- **Low Alarm**: Threshold in inches for low level alert
8585
- **Analog Pin**: Arduino Opta analog input (A0-A7, I1-I8)
86-
- **Sensor Type**: "voltage" (0-10V) or "current" (4-20mA)
86+
- **Sensor Type**: "voltage" (0-10V), "current" (4-20mA), or "digital" (float switch)
8787
- **Min Value**: Minimum sensor value (e.g., 0.0V or 4.0mA)
8888
- **Max Value**: Maximum sensor value (e.g., 10.0V or 20.0mA)
8989
- **Min Inches**: Tank level in inches at minimum sensor value
9090
- **Max Inches**: Tank level in inches at maximum sensor value
9191

92+
### Float Switch Configuration (Digital Sensors)
93+
Float switches can be configured as either normally-open (NO) or normally-closed (NC):
94+
95+
- **Digital Switch Mode**: "NO" (normally-open) or "NC" (normally-closed)
96+
- **NO (Normally-Open)**: Switch is open by default, closes when fluid reaches the switch position
97+
- **NC (Normally-Closed)**: Switch is closed by default, opens when fluid reaches the switch position
98+
- **Digital Trigger**: When to trigger the alarm
99+
- "activated": Alarm when switch is activated (fluid present for NO, fluid absent for NC)
100+
- "not_activated": Alarm when switch is not activated
101+
102+
**Wiring Note**: For both NO and NC float switches, connect the switch between the digital input pin and GND. The Arduino uses an internal pull-up resistor, and the software interprets the signal based on your configured switch mode. The wiring is the same for both modes - only the software interpretation changes.
103+
92104
## Operation
93105

94106
### Normal Operation

0 commit comments

Comments
 (0)