Skip to content

Commit 26f9f99

Browse files
committed
Add console restrictions documentation and update client console HTML
Added CONSOLE_RESTRICTIONS.md to document which hardware-related settings are locked in the client console and how to change them. Updated CLIENT_CONSOLE_HTML in the main firmware to match the latest UI and restrictions, ensuring hardware configuration fields are properly described and handled.
1 parent 61707cf commit 26f9f99

File tree

2 files changed

+55
-1
lines changed

2 files changed

+55
-1
lines changed
Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
# Console Restrictions & Hardware Configuration
2+
3+
The **Client Console** web interface allows remote configuration of alarm thresholds, reporting schedules, and site metadata. However, settings that define the **physical hardware interface** (wiring, sensors, pins) are **locked** in the console to prevent accidental misconfiguration that could disable monitoring or require a site visit to fix.
4+
5+
These settings must be defined in the initial configuration file uploaded to the device (e.g., via USB or SD card) or compiled into the firmware.
6+
7+
## Locked Settings (Hardware Dependent)
8+
9+
The following settings are visible in the console but cannot be edited:
10+
11+
### 1. Clear Button Configuration
12+
* **Clear Button Pin**: The physical GPIO pin connected to the external push-button.
13+
* **Button Active State**: The electrical logic level (Active HIGH vs Active LOW) determined by the wiring (pull-up vs pull-down resistors).
14+
15+
### 2. Tank Sensor Configuration
16+
* **Sensor Type**: The class of sensor hardware installed (e.g., `Analog` 4-20mA, `Digital` Float Switch, `Current Loop`). Changing this requires different physical wiring and often different driver circuitry.
17+
* **Primary Pin**: The main GPIO or Analog pin where the sensor signal is read.
18+
* **Secondary Pin**: Used for differential readings or complex sensors.
19+
* **Loop Channel**: For multiplexed current loop sensors (e.g., using an external ADC or Mux).
20+
21+
## How to Change Hardware Settings
22+
23+
To modify these settings, you must update the device configuration file directly.
24+
25+
1. **Create/Edit Config File**: Generate a `client_config.json` file with the correct hardware parameters.
26+
2. **Upload**:
27+
* **Option A (SD Card)**: Save the file to an SD card and insert it into the device. Reboot to load.
28+
* **Option B (USB)**: Connect via USB Serial and use the CLI command `config set <json_payload>`.
29+
* **Option C (Firmware)**: If using a fixed fleet deployment, update the default configuration in `TankAlarm-112025-Client-BluesOpta.ino` and re-flash the device.
30+
31+
## Why are these locked?
32+
33+
* **Safety**: Changing a pin assignment remotely to a pin that is driving a relay or other actuator could cause hardware damage.
34+
* **Reliability**: Incorrect sensor types will result in false alarms or zero readings.
35+
* **Stability**: These settings rarely change after installation. Locking them prevents "fat-finger" errors during routine threshold adjustments.

0 commit comments

Comments
 (0)