docs(quick-4): update documentation for port 9999 and dual-mode
README.md: - Update Essential files section with dual-mode default behavior - Update dual-mode display section with port 9999 as Remote HD - Update Display Modes table to include port 9999 and dual-mode note WIKI.md: - Add Remote HD Mode (Port 9999) section with full HD details - Update Start Script Options table with dev:9999 and dual-mode - Clarify port usage (8888 kiosk, 9090 legacy remote, 9999 remote HD) install_everything.sh: - Add dual-mode server information to startup message
This commit is contained in:
39
README.md
39
README.md
@@ -1,12 +1,39 @@
|
||||
# TCK RTU - Rainfall Monitoring Web Interface
|
||||
|
||||
A modern, web-based interface for Base Station/Real-Time Unit (RTU) monitoring rainfall and related sensors. Designed for 7" capacitive touchscreen display (1024x600) on Raspberry Pi Zero 2 W/3B, running via Chromium Kiosk Mode.
|
||||
A modern, web-based interface for Base Station/Real-Time Unit (RTU) monitoring rainfall and related sensors. Designed for 7" capacitive touchscreen display (1024x600) on Raspberry Pi CM5, Zero 2 W/3B, running via Chromium Kiosk Mode.
|
||||
|
||||
## QUICKSTART
|
||||
|
||||
```bash
|
||||
# ONE LINE INSTALL & RUN
|
||||
curl -sL http://gitck:3000/admin/sp80/install_everything.sh | bash
|
||||
```
|
||||
|
||||
# Essential files to run
|
||||
```bash
|
||||
# Start both servers (kiosk 8888 + remote HD 9999) - DEFAULT BEHAVIOR
|
||||
./start.sh
|
||||
|
||||
# Or start just kiosk mode on port 8888
|
||||
./start.sh dev:8888
|
||||
|
||||
# Or start just remote HD mode on port 9999
|
||||
./start.sh dev:9999
|
||||
|
||||
# Flip the display, a bug in Waveshare 1024x600 7" Touchscreen HDMI (c) LCD
|
||||
# Prerequisite: apt install -y xrandr xinput
|
||||
./flip_display.sh
|
||||
|
||||
# Run during (after) boot as systemd service
|
||||
cp rtu-dev.service /etc/systemd/system/
|
||||
systemctl daemon-reload
|
||||
systemctl enable rtu-dev.service
|
||||
systemctl start rtu-dev.service
|
||||
|
||||
# Check status of rtu-dev
|
||||
journalctl -u rtu-dev.service -f
|
||||
```
|
||||
|
||||
[View Full Wiki](WIKI.md) | [Integration with C++](INTEGRATION.md) | [Example Code](EXAMPLE_CODE.md)
|
||||
|
||||
## Features
|
||||
@@ -15,8 +42,9 @@ curl -sL http://gitck:3000/admin/sp80/install_everything.sh | bash
|
||||
- Solar and battery voltage monitoring with status indicators
|
||||
- Station information display (ID, version, communication status)
|
||||
- Dual-mode display:
|
||||
- **Kiosk mode** (port 8080): 1024x600 for local 7" touchscreen
|
||||
- **Remote mode** (port 9090): Full HD responsive for PC access
|
||||
- **Kiosk mode** (port 8888): 1024x600 for local 7" touchscreen
|
||||
- **Remote HD mode** (port 9999): Full HD responsive for PC access
|
||||
- **Remote mode** (port 9090): Standard remote access
|
||||
- Touch-friendly UI with 44px+ touch targets
|
||||
- Modern React/TypeScript architecture with Zustand state management
|
||||
|
||||
@@ -174,9 +202,12 @@ The app detects display mode by port:
|
||||
| Port | Mode | Resolution |
|
||||
|------|------|------------|
|
||||
| 8888 | Kiosk | 1024x600 (fixed, for 7" touchscreen) |
|
||||
| 9090 | Remote | Full HD (responsive, for PC access) |
|
||||
| 9090 | Remote | Standard remote access |
|
||||
| 9999 | Remote HD | Full HD (responsive, for PC access) |
|
||||
| 5173 | Dev | Development server |
|
||||
|
||||
**Note:** Running `./start.sh` without arguments starts both kiosk (8888) and remote HD (9999) servers.
|
||||
|
||||
## Bundle Size
|
||||
|
||||
- **Target**: < 170KB gzipped
|
||||
|
||||
Reference in New Issue
Block a user