last update before handover
This commit is contained in:
154
sample_interface/HELP.md
Normal file
154
sample_interface/HELP.md
Normal file
@@ -0,0 +1,154 @@
|
||||
# Table of Contents
|
||||
|
||||
1. [Overview](#overview)
|
||||
2. [Navigation](#navigation)
|
||||
3. [Main Sections](#main-sections)
|
||||
- [Rainfall Monitor](#rainfall-monitor)
|
||||
- [Graph View](#graph-view)
|
||||
- [Utility](#utility)
|
||||
- [Calibration](#calibration)
|
||||
- [Flash Memory](#flash-memory)
|
||||
- [Settings](#settings)
|
||||
4. [Keyboard Shortcuts](#keyboard-shortcuts)
|
||||
5. [Display Modes](#display-modes)
|
||||
|
||||
---
|
||||
|
||||
# Overview
|
||||
|
||||
The RTU V5 Interface is a web-based monitoring and configuration system for rainfall monitoring stations. It provides real-time data visualization, configuration settings, and system management capabilities.
|
||||
|
||||
---
|
||||
|
||||
# Navigation
|
||||
|
||||
## Sidebar Navigation
|
||||
|
||||
The left sidebar contains all main navigation items:
|
||||
|
||||
| Menu Item | Description |
|
||||
|-----------|-------------|
|
||||
| **RAINFALL** | Main dashboard showing rainfall data |
|
||||
| **GRAPH** | Visual charts of various sensor data |
|
||||
| **UTILITY** | Configuration settings for station |
|
||||
| **CALIBRATION** | Sensor calibration tools |
|
||||
| **FLASH MEMORY** | Data storage management |
|
||||
| **SETTINGS** | System display and configuration |
|
||||
| **LOGIN** | User authentication |
|
||||
|
||||
## Up/Down Navigation Buttons
|
||||
|
||||
- **Right side buttons**: Use the Up/Down arrow buttons on the right side to scroll through content
|
||||
- **Keyboard**: Use `Page Up` / `Page Down` or `Arrow Up` / `Arrow Down` keys
|
||||
|
||||
---
|
||||
|
||||
# Main Sections
|
||||
|
||||
## Rainfall Monitor
|
||||
|
||||
The main dashboard displays:
|
||||
|
||||
- **Today**: Current day's rainfall total
|
||||
- **Hourly**: Current hour's rainfall
|
||||
- **MAR Acc**: Monthly Accumulated rainfall
|
||||
- **Yearly Acc**: Yearly Accumulated rainfall
|
||||
|
||||
Also shows:
|
||||
- Current date/time
|
||||
- Communication status (signal strength in ASU and dBm)
|
||||
|
||||
## Graph View
|
||||
|
||||
Displays visual charts for:
|
||||
|
||||
1. **Rainfall** - Bar chart showing rainfall over 24 hours
|
||||
2. **Voltage** - Line chart showing solar and battery voltage
|
||||
3. **Signal Strength** - Area chart showing signal quality
|
||||
4. **Water Level** - Line chart showing water level data
|
||||
5. **ADC Channels** - Multi-line chart for ADC sensor channels
|
||||
6. **Temperature** - Area chart showing temperature data
|
||||
|
||||
Each chart card shows current values and statistics.
|
||||
|
||||
### Navigation in Graph View
|
||||
|
||||
- Use Up/Down buttons or keyboard to scroll through charts
|
||||
- Each click scrolls approximately 2 charts at a time
|
||||
|
||||
## Utility
|
||||
|
||||
Configuration submenus:
|
||||
|
||||
| Setting | Description |
|
||||
|---------|-------------|
|
||||
| **Station Info** | Station identification and metadata |
|
||||
| **Date/Time** | Set date, time, and timezone |
|
||||
| **Mobile Setting** | Mobile network configuration |
|
||||
| **ADC Setting** | ADC channel configuration |
|
||||
| **Rainfall Setting** | Rain gauge parameters |
|
||||
| **EVAP Setting** | Evaporation sensor settings |
|
||||
| **GPRS Setting** | GPRS/GSM communication config |
|
||||
| **Level Setting** | Water level sensor config |
|
||||
| **SIREN Setting** | Alarm/siren configuration |
|
||||
| **Network Setup** | Network connection settings |
|
||||
|
||||
## Calibration
|
||||
|
||||
Tools for calibrating various sensors:
|
||||
- Rainfall sensor
|
||||
- Water level sensors
|
||||
- Temperature sensors
|
||||
|
||||
## Flash Memory
|
||||
|
||||
- View stored data logs
|
||||
- Export data files
|
||||
- Memory usage information
|
||||
|
||||
## Settings
|
||||
|
||||
### Display Settings
|
||||
|
||||
- **Light/Dark Mode**: Toggle between light and dark themes
|
||||
- **Auto Brightness**: Automatic brightness adjustment
|
||||
- **Screen Timeout**: Display timeout configuration
|
||||
|
||||
### System Settings
|
||||
|
||||
- Auto Update toggle
|
||||
- Data Logging toggle
|
||||
- System Alerts toggle
|
||||
|
||||
### System Actions
|
||||
|
||||
- Backup Configuration
|
||||
- Restore Configuration
|
||||
- Factory Reset
|
||||
- Reboot System
|
||||
|
||||
---
|
||||
|
||||
# Keyboard Shortcuts
|
||||
|
||||
| Key | Action |
|
||||
|-----|--------|
|
||||
| `Page Up` | Scroll up one page |
|
||||
| `Page Down` | Scroll down one page |
|
||||
| `Arrow Up` | Scroll up |
|
||||
| `Arrow Down` | Scroll down |
|
||||
|
||||
---
|
||||
|
||||
# Display Modes
|
||||
|
||||
The interface supports two display modes:
|
||||
|
||||
1. **Remote Mode** (`display-mode-remote`): For remote monitoring via browser
|
||||
2. **Kiosk Mode** (`display-mode-kiosk`): For dedicated display kiosks
|
||||
|
||||
The display mode affects certain UI element sizing and layout.
|
||||
|
||||
---
|
||||
|
||||
*For technical support, please refer to the SUPPORT section.*
|
||||
Reference in New Issue
Block a user