Merge pull request #112 from SenaxInc/copilot/make-float-switch-selectable

Add NO/NC mode selection for float switches

Author: dorkmo

TankAlarm-112025-Client-BluesOpta/README.md

@@ -83,12 +83,24 @@ The client creates a default configuration on first boot. You can update configu
 - **High Alarm**: Threshold in inches for high level alert
 - **Low Alarm**: Threshold in inches for low level alert
 - **Analog Pin**: Arduino Opta analog input (A0-A7, I1-I8)
-- **Sensor Type**: "voltage" (0-10V) or "current" (4-20mA)
+- **Sensor Type**: "voltage" (0-10V), "current" (4-20mA), or "digital" (float switch)
 - **Min Value**: Minimum sensor value (e.g., 0.0V or 4.0mA)
 - **Max Value**: Maximum sensor value (e.g., 10.0V or 20.0mA)
 - **Min Inches**: Tank level in inches at minimum sensor value
 - **Max Inches**: Tank level in inches at maximum sensor value
 
+### Float Switch Configuration (Digital Sensors)
+Float switches can be configured as either normally-open (NO) or normally-closed (NC):
+
+- **Digital Switch Mode**: "NO" (normally-open) or "NC" (normally-closed)
+  - **NO (Normally-Open)**: Switch is open by default, closes when fluid reaches the switch position
+  - **NC (Normally-Closed)**: Switch is closed by default, opens when fluid reaches the switch position
+- **Digital Trigger**: When to trigger the alarm
+  - "activated": Alarm when switch is activated (fluid present)
+  - "not_activated": Alarm when switch is not activated (fluid absent)
+
+**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.
+
 ## Operation
 
 ### Normal Operation

TankAlarm-112025-Client-BluesOpta/TankAlarm-112025-Client-BluesOpta.ino

@@ -250,6 +250,7 @@ struct TankConfig {
   RelayMode relayMode;     // How long relay stays on (momentary, until_clear, manual_reset)
   // Digital sensor (float switch) specific settings
   char digitalTrigger[16]; // 'activated' or 'not_activated' - when to trigger alarm for digital sensors
+  char digitalSwitchMode[4]; // 'NO' for normally-open, 'NC' for normally-closed (default: NO)
 };
 
 struct ClientConfig {
@@ -631,6 +632,7 @@ static void createDefaultConfig(ClientConfig &cfg) {
   cfg.tanks[0].relayTrigger = RELAY_TRIGGER_ANY; // Default: trigger on any alarm
   cfg.tanks[0].relayMode = RELAY_MODE_MOMENTARY; // Default: momentary 30 min activation
   cfg.tanks[0].digitalTrigger[0] = '\0'; // Not a digital sensor by default
+  strlcpy(cfg.tanks[0].digitalSwitchMode, "NO", sizeof(cfg.tanks[0].digitalSwitchMode)); // Default: normally-open
 }
 
 static bool loadConfigFromFlash(ClientConfig &cfg) {
@@ -759,6 +761,13 @@ static bool loadConfigFromFlash(ClientConfig &cfg) {
     // Load digital sensor trigger state (for float switches)
     const char *digitalTriggerStr = t["digitalTrigger"].as<const char *>();
     strlcpy(cfg.tanks[i].digitalTrigger, digitalTriggerStr ? digitalTriggerStr : "", sizeof(cfg.tanks[i].digitalTrigger));
+    // Load digital switch mode (NO = normally-open, NC = normally-closed)
+    const char *digitalSwitchModeStr = t["digitalSwitchMode"].as<const char *>();
+    if (digitalSwitchModeStr && strcmp(digitalSwitchModeStr, "NC") == 0) {
+      strlcpy(cfg.tanks[i].digitalSwitchMode, "NC", sizeof(cfg.tanks[i].digitalSwitchMode));
+    } else {
+      strlcpy(cfg.tanks[i].digitalSwitchMode, "NO", sizeof(cfg.tanks[i].digitalSwitchMode)); // Default: normally-open
+    }
   }
 
   return true;
@@ -827,6 +836,8 @@ static bool saveConfigToFlash(const ClientConfig &cfg) {
     if (cfg.tanks[i].digitalTrigger[0] != '\0') {
       t["digitalTrigger"] = cfg.tanks[i].digitalTrigger;
     }
+    // Save digital switch mode (NO/NC)
+    t["digitalSwitchMode"] = cfg.tanks[i].digitalSwitchMode;
   }
 
   #if defined(ARDUINO_OPTA) || defined(ARDUINO_ARCH_MBED)
@@ -1260,6 +1271,15 @@ static void applyConfigUpdate(const JsonDocument &doc) {
                 digitalTriggerStr ? digitalTriggerStr : "",
                 sizeof(gConfig.tanks[i].digitalTrigger));
       }
+      // Handle digital switch mode (NO/NC) for float switches
+      if (t.containsKey("digitalSwitchMode")) {
+        const char *digitalSwitchModeStr = t["digitalSwitchMode"].as<const char *>();
+        if (digitalSwitchModeStr && strcmp(digitalSwitchModeStr, "NC") == 0) {
+          strlcpy(gConfig.tanks[i].digitalSwitchMode, "NC", sizeof(gConfig.tanks[i].digitalSwitchMode));
+        } else {
+          strlcpy(gConfig.tanks[i].digitalSwitchMode, "NO", sizeof(gConfig.tanks[i].digitalSwitchMode));
+        }
+      }
     }
   }
 
@@ -1408,15 +1428,30 @@ static float readTankSensor(uint8_t idx) {
   switch (cfg.sensorType) {
     case SENSOR_DIGITAL: {
       // Float switch sensor - returns activated/not-activated state
-      // This implementation assumes normally-open (NO) float switches with INPUT_PULLUP:
-      // - Default state is HIGH (switch open, no fluid)
-      // - When fluid is present, switch closes and pulls pin LOW
-      // For normally-closed (NC) switches, invert the trigger condition in config
+      // The digitalSwitchMode field controls how the hardware is interpreted:
+      // - "NO" (normally-open): Switch is open by default, closes when fluid is present
+      //   - With INPUT_PULLUP: HIGH = switch open (no fluid), LOW = switch closed (fluid present)
+      //   - activated when pin is LOW
+      // - "NC" (normally-closed): Switch is closed by default, opens when fluid is present
+      //   - With INPUT_PULLUP: LOW = switch closed (no fluid), HIGH = switch open (fluid present)
+      //   - activated when pin is HIGH
       int pin = (cfg.primaryPin >= 0 && cfg.primaryPin < 255) ? cfg.primaryPin : (2 + idx);
       pinMode(pin, INPUT_PULLUP);
       int level = digitalRead(pin);
-      // Return activated value when switch is closed (LOW), not-activated when open (HIGH)
-      return (level == LOW) ? DIGITAL_SENSOR_ACTIVATED_VALUE : DIGITAL_SENSOR_NOT_ACTIVATED_VALUE;
+      
+      // Determine if switch is configured as normally-closed
+      bool isNormallyClosed = (strcmp(cfg.digitalSwitchMode, "NC") == 0);
+      
+      // For NO switches: LOW = activated (switch closed, fluid present)
+      // For NC switches: HIGH = activated (switch opened, fluid present)
+      bool isActivated;
+      if (isNormallyClosed) {
+        isActivated = (level == HIGH); // NC switch opens (goes HIGH) when activated
+      } else {
+        isActivated = (level == LOW);  // NO switch closes (goes LOW) when activated
+      }
+      
+      return isActivated ? DIGITAL_SENSOR_ACTIVATED_VALUE : DIGITAL_SENSOR_NOT_ACTIVATED_VALUE;
     }
     case SENSOR_ANALOG: {
       // Use explicit bounds check for channel (A0602 has channels 0-7)

TankAlarm-112025-Server-BluesOpta/TankAlarm-112025-Server-BluesOpta.ino

@@ -730,13 +730,20 @@ static const char CONFIG_GENERATOR_HTML[] PROGMEM = R"HTML(
                 ${optaPins.map(p => `<option value="${p.value}">${p.label}</option>`).join('')}
               </select>
             </label>
+            <label class="field switch-mode-field" style="display: none;"><span>Switch Mode<span class="tooltip-icon" tabindex="0" data-tooltip="NO (Normally-Open): Switch is open by default, closes when fluid is present. NC (Normally-Closed): Switch is closed by default, opens when fluid is present. The wiring is the same - only the software interpretation changes.">?</span></span>
+              <select class="switch-mode">
+                <option value="NO">Normally-Open (NO)</option>
+                <option value="NC">Normally-Closed (NC)</option>
+              </select>
+            </label>
             <label class="field pulses-per-rev-field" style="display: none;"><span>Pulses/Rev</span><input type="number" class="pulses-per-rev" value="1" min="1" max="255"></label>
             <label class="field height-field"><span><span class="height-label">Height (in)</span><span class="tooltip-icon height-tooltip" tabindex="0" data-tooltip="Maximum height or capacity of the tank in inches. Used to calculate fill percentage and set alarm thresholds relative to tank size.">?</span></span><input type="number" class="tank-height" value="120"></label>
           </div>
           
           <!-- Digital sensor info box (shown only for float switches) -->
           <div class="digital-sensor-info" style="display: none; background: var(--chip); border: 1px solid var(--card-border); border-radius: 8px; padding: 12px; margin-top: 8px; font-size: 0.9rem; color: var(--muted);">
-            <strong>Float Switch Mode:</strong> This sensor only detects whether fluid has reached the switch position. It does not measure actual fluid level. The alarm will trigger when the switch is activated (fluid present) or not activated (fluid absent).
+            <strong>Float Switch Mode:</strong> This sensor only detects whether fluid has reached the switch position. It does not measure actual fluid level. The alarm will trigger when the switch is activated (fluid present) or not activated (fluid absent).<br><br>
+            <strong>Wiring Note:</strong> For both NO and NC switches, connect the switch between the input pin and GND. The software uses an internal pull-up resistor and interprets the signal based on your selected switch mode.
           </div>
           
           <button type="button" class="add-section-btn add-alarm-btn" onclick="toggleAlarmSection(${id})">+ Add Alarm</button>
@@ -995,13 +1002,16 @@ static const char CONFIG_GENERATOR_HTML[] PROGMEM = R"HTML(
       const digitalAlarmGrid = card.querySelector('.digital-alarm-grid');
       const alarmSectionTitle = card.querySelector('.alarm-section-title');
       const pulsesPerRevField = card.querySelector('.pulses-per-rev-field');
+      const switchModeField = card.querySelector('.switch-mode-field');
       
       // Digital Input (Float Switch) - type === 0
       if (type === 0) {
         // Hide height field (not applicable for float switches)
         heightField.style.display = 'none';
         // Show digital sensor info box
         digitalInfoBox.style.display = 'block';
+        // Show switch mode selector for digital sensors
+        switchModeField.style.display = 'flex';
         // Update alarm section for digital sensors
         alarmThresholdsGrid.style.display = 'none';
         digitalAlarmGrid.style.display = 'grid';
@@ -1012,6 +1022,7 @@ static const char CONFIG_GENERATOR_HTML[] PROGMEM = R"HTML(
         heightLabel.textContent = 'Max RPM';
         heightTooltip.setAttribute('data-tooltip', 'Maximum expected RPM value. Used for alarm threshold reference.');
         digitalInfoBox.style.display = 'none';
+        switchModeField.style.display = 'none';
         alarmThresholdsGrid.style.display = 'grid';
         digitalAlarmGrid.style.display = 'none';
         alarmSectionTitle.textContent = 'Alarm Thresholds';
@@ -1022,6 +1033,7 @@ static const char CONFIG_GENERATOR_HTML[] PROGMEM = R"HTML(
         heightLabel.textContent = 'Height (in)';
         heightTooltip.setAttribute('data-tooltip', 'Maximum height or capacity of the tank in inches. Used to calculate fill percentage and set alarm thresholds relative to tank size.');
         digitalInfoBox.style.display = 'none';
+        switchModeField.style.display = 'none';
         alarmThresholdsGrid.style.display = 'grid';
         digitalAlarmGrid.style.display = 'none';
         alarmSectionTitle.textContent = 'Alarm Thresholds';
@@ -1087,6 +1099,7 @@ static const char CONFIG_GENERATOR_HTML[] PROGMEM = R"HTML(
         
         const sensor = sensorKeyFromValue(type);
         const pulsesPerRev = Math.max(1, Math.min(255, parseInt(card.querySelector('.pulses-per-rev').value) || 1));
+        const switchMode = card.querySelector('.switch-mode').value; // 'NO' or 'NC'
 
         // Check if alarm section is enabled
         const alarmSectionVisible = card.querySelector('.alarm-section').classList.contains('visible');
@@ -1110,6 +1123,11 @@ static const char CONFIG_GENERATOR_HTML[] PROGMEM = R"HTML(
           upload: true
         };
 
+        // Add switch mode for digital sensors (float switches)
+        if (sensor === 'digital') {
+          tank.digitalSwitchMode = switchMode;  // 'NO' or 'NC'
+        }
+
         // Handle alarms differently based on sensor type
         if (alarmSectionVisible) {
           if (sensor === 'digital') {