From 9f29b51c4b659fc32d503a9bc12f1858f110b7bf Mon Sep 17 00:00:00 2001 From: tck Date: Thu, 19 Mar 2026 09:47:24 +0800 Subject: [PATCH] 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 --- README.md | 39 +++++++++++++++++++++++++++++++++++---- WIKI.md | 30 ++++++++++++++++++++---------- install_everything.sh | 10 ++++++++-- 3 files changed, 63 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index 11aab8e63..71b32ed5a 100644 --- a/README.md +++ b/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 diff --git a/WIKI.md b/WIKI.md index 7394482bf..856d92c04 100644 --- a/WIKI.md +++ b/WIKI.md @@ -204,10 +204,18 @@ When the API is unavailable, mock data is automatically generated with realistic ### Remote Mode (Port 9090) - Responsive layout for any screen size -- Full HD optimized +- Standard remote access +- **For legacy remote access via network** + +### Remote HD Mode (Port 9999) + +- Full HD responsive layout (1920x1080 optimized) - Expanded information display - Standard scrollbars -- **For remote access via network** +- **For remote desktop access with high-resolution displays** +- **Recommended for remote monitoring via PC browser** + +**Note:** Running `./start.sh` without arguments starts both Kiosk (8888) and Remote HD (9999) servers simultaneously. ## Navigation @@ -384,17 +392,19 @@ The `start.sh` script provides an interactive menu for common development comman | `1` or `dev` | Start dev server (port 5173) | | `2` or `dev:8888` | Start dev server on port 8888 (kiosk mode) | | `3` or `dev:9090` | Start dev server on port 9090 (remote mode) | -| `4` or `test` | Run tests | -| `5` or `test:watch` | Run tests in watch mode | -| `6` or `build` | Build for production | -| `7` or `preview` | Preview production (port 4173) | -| `8` or `lint` | Run linter | -| `9` or `clean` | Clean build artifacts | -| `10` or `install` | Install dependencies | +| `4` or `dev:9999` | Start dev server on port 9999 (remote HD mode) | +| `5` or `test` | Run tests | +| `6` or `test:watch` | Run tests in watch mode | +| `7` or `build` | Build for production | +| `8` or `preview` | Preview production (port 4173) | +| `9` or `lint` | Run linter | +| `10` or `clean` | Clean build artifacts | +| `11` or `install` | Install dependencies | | `p` or `port` | Change default ports | | `0` or `exit` | Exit | +| (no args) | Start both 8888 and 9999 (dual-mode) | -**Note**: Port 8888 is recommended for kiosk mode (7" touchscreen), port 9090 for remote access. +**Note**: Port 8888 is for kiosk mode (7" touchscreen), port 9090 for legacy remote, port 9999 for remote HD desktop access. Running without arguments starts dual-mode. ## Installation Script diff --git a/install_everything.sh b/install_everything.sh index 07a00ef4d..603b96f1f 100755 --- a/install_everything.sh +++ b/install_everything.sh @@ -150,10 +150,16 @@ start_app() { echo -e "${GREEN}Installation complete!${NC}" echo -e "${GREEN}━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━${NC}" echo "" - echo -e "Starting TCK RTU menu..." + echo -e "${GREEN}━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━${NC}" + echo -e "${GREEN} Dual-mode servers will be available:${NC}" + echo -e "${GREEN} - Kiosk (port 8888): 7\" touchscreen display${NC}" + echo -e "${GREEN} - Remote HD (port 9999): Full HD desktop access${NC}" + echo -e "${GREEN}━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━${NC}" + echo "" + echo -e "Starting TCK RTU in dual-mode..." echo "" - # Run start.sh + # Run start.sh (starts dual-mode by default) ./start.sh }