You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: TankAlarm-112025-Client-BluesOpta/README.md
+4-22Lines changed: 4 additions & 22 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -84,14 +84,10 @@ The client creates a default configuration on first boot. You can update configu
84
84
-**Low Alarm**: Threshold in inches for low level alert
85
85
-**Analog Pin**: Arduino Opta analog input (A0-A7, I1-I8)
86
86
-**Sensor Type**: "voltage" (0-10V), "current" (4-20mA), or "digital" (float switch)
87
-
-**Min Value**: Minimum sensor value (e.g., 0.0V or 4.0mA)
88
-
-**Max Value**: Maximum sensor value (e.g., 10.0V or 20.0mA)
89
-
-**Min Inches**: Tank level in inches at minimum sensor value
90
-
-**Max Inches**: Tank level in inches at maximum sensor value
91
87
92
88
### 4-20mA Current Loop Sensor Configuration
93
89
94
-
For 4-20mA current loop sensors, two mounting options are supported. The implementation uses the sensor's **native measurement range** (sensorRangeMin/Max/Unit) for accurate conversions, making `maxValue`**optional** (used only for clamping/validation).
90
+
For 4-20mA current loop sensors, two mounting options are supported. The implementation uses the sensor's **native measurement range** (sensorRangeMin/Max/Unit) for accurate pressure-to-height conversions.
95
91
96
92
#### Pressure Sensor (Bottom-Mounted)
97
93
Used for sensors like the Dwyer 626-06-CB-P1-E5-S1 (0-5 PSI) mounted near the bottom of the tank.
@@ -105,7 +101,6 @@ Used for sensors like the Dwyer 626-06-CB-P1-E5-S1 (0-5 PSI) mounted near the bo
105
101
-`sensorRangeMax`: Maximum pressure at 20mA (e.g., 5 for 0-5 PSI)
106
102
-`sensorRangeUnit`: Pressure unit - "PSI", "bar", "kPa", "mbar", or "inH2O"
107
103
-**Sensor Mount Height**: Height of sensor above tank bottom (usually 0-2 inches)
108
-
-**Max Value**: **Optional** - Maximum expected tank level for clamping (0 to disable clamping)
109
104
110
105
**Pressure-to-Height Conversion:**
111
106
The system automatically converts pressure to inches using these factors:
@@ -118,16 +113,12 @@ The system automatically converts pressure to inches using these factors:
118
113
**Example Configuration** (0-5 PSI sensor on 120" tank):
119
114
- Sensor mounted 2 inches above tank bottom
120
115
- Max sensor range = 5 PSI = ~138 inches of water column
121
-
- Tank capacity = 120 inches
122
-
- Configuration (minimal - no maxValue needed):
116
+
- Configuration:
123
117
-`currentLoopType`: "pressure"
124
118
-`sensorRangeMin`: 0
125
119
-`sensorRangeMax`: 5
126
120
-`sensorRangeUnit`: "PSI"
127
121
-`sensorMountHeight`: 2.0
128
-
-`maxValue`: 0 (or omit entirely - not required for 4-20mA sensors)
129
-
130
-
> **Note:** For 4-20mA sensors, `maxValue` is **completely optional**. The sensor's native range (`sensorRangeMin`/`sensorRangeMax`/`sensorRangeUnit`) provides all the information needed to calculate the liquid level. Set `maxValue` only if you want to clamp readings to a maximum tank capacity.
131
122
132
123
**How It Works:**
133
124
1. 4mA → 0 PSI → 0 inches of liquid above sensor
@@ -146,7 +137,6 @@ Used for sensors like the Siemens Sitrans LU240 mounted on top of the tank looki
146
137
-`sensorRangeMax`: Maximum distance at 20mA (e.g., 10m)
147
138
-`sensorRangeUnit`: Distance unit - "m", "cm", "ft", or "in"
148
139
-**Sensor Mount Height**: Distance from sensor to tank bottom when tank is empty (in inches)
149
-
-**Max Value**: **Optional** - Maximum expected liquid level for clamping (0 to disable)
150
140
151
141
**Distance Unit Conversion:**
152
142
The system automatically converts distance to inches using:
@@ -156,14 +146,12 @@ The system automatically converts distance to inches using:
156
146
157
147
**Example Configuration** (ultrasonic sensor with 0.5-10m range on 10-foot tank):
158
148
- Sensor mounted 124 inches above tank bottom (tank is 120" + 4" clearance)
@@ -190,7 +178,7 @@ Float switches can be configured as either normally-open (NO) or normally-closed
190
178
191
179
### Analog Voltage Sensor Configuration
192
180
193
-
For analog voltage sensors (like the Dwyer 626 series with voltage output), the system now supports the same native range configuration as 4-20mA sensors. This allows you to specify both the voltage range and pressure range for accurate pressure-to-height conversion.
181
+
For analog voltage sensors (like the Dwyer 626 series with voltage output), the system supports the same native range configuration as 4-20mA sensors. This allows you to specify both the voltage range and pressure range for accurate pressure-to-height conversion.
194
182
195
183
**Supported Voltage Output Configurations:**
196
184
- 0-10V (default)
@@ -206,7 +194,6 @@ For analog voltage sensors (like the Dwyer 626 series with voltage output), the
206
194
-`sensorRangeMin` / `sensorRangeMax`: Pressure range in native units
207
195
-`sensorRangeUnit`: Pressure unit - "PSI", "bar", "kPa", "mbar", or "inH2O"
208
196
-`sensorMountHeight`: Height of sensor above tank bottom (inches)
209
-
-`maxValue`: **Optional** - Maximum expected tank level for clamping (0 to disable)
210
197
211
198
**Example Configuration** (Dwyer 626 with 1-5V output, 0-5 PSI range):
212
199
- Configuration:
@@ -217,11 +204,6 @@ For analog voltage sensors (like the Dwyer 626 series with voltage output), the
217
204
-`sensorRangeMax`: 5
218
205
-`sensorRangeUnit`: "PSI"
219
206
-`sensorMountHeight`: 2.0
220
-
-`maxValue`: 0 (or omit entirely - not required)
221
-
222
-
> **Note:** For analog voltage sensors with native range configured, `maxValue` is **completely optional**. The sensor's voltage range and pressure range provide all the information needed to calculate the liquid level. Set `maxValue` only if you want to clamp readings to a maximum tank capacity.
223
-
224
-
**Legacy Mode:** If `analogVoltageMin`/`analogVoltageMax` and `sensorRangeMin`/`sensorRangeMax` are not configured, the system falls back to the legacy behavior where `maxValue` directly represents the tank height.
0 commit comments