From 182920809df06a8ee9b7556e259afdc81cd0374b Mon Sep 17 00:00:00 2001 From: serversdwn Date: Fri, 16 Jan 2026 19:06:38 +0000 Subject: [PATCH] chore: docs and scripts organized. clutter cleared. --- README.md | 9 +++ archive/README.md | 67 +++++++++++++++++++ .../legacy_migrations/migrate_add_counter.py | 0 .../legacy_migrations/migrate_add_ftp_port.py | 0 .../migrate_add_measurement_start_time.py | 0 .../legacy_migrations/migrate_field_names.py | 0 .../migrate_revert_field_names.py | 0 nl43_dod_poll.py => archive/nl43_dod_poll.py | 0 .../features/FEATURE_SUMMARY.md | 0 docs/features/README.md | 26 +++++++ .../features/SETTINGS_ENDPOINT.md | 0 .../features/SLEEP_MODE_AUTO_DISABLE.md | 0 .../features/TIMEZONE_CONFIGURATION.md | 0 UI_UPDATE.md => docs/features/UI_UPDATE.md | 0 14 files changed, 102 insertions(+) create mode 100644 archive/README.md rename migrate_add_counter.py => archive/legacy_migrations/migrate_add_counter.py (100%) rename migrate_add_ftp_port.py => archive/legacy_migrations/migrate_add_ftp_port.py (100%) rename migrate_add_measurement_start_time.py => archive/legacy_migrations/migrate_add_measurement_start_time.py (100%) rename migrate_field_names.py => archive/legacy_migrations/migrate_field_names.py (100%) rename migrate_revert_field_names.py => archive/legacy_migrations/migrate_revert_field_names.py (100%) rename nl43_dod_poll.py => archive/nl43_dod_poll.py (100%) rename FEATURE_SUMMARY.md => docs/features/FEATURE_SUMMARY.md (100%) create mode 100644 docs/features/README.md rename SETTINGS_ENDPOINT.md => docs/features/SETTINGS_ENDPOINT.md (100%) rename SLEEP_MODE_AUTO_DISABLE.md => docs/features/SLEEP_MODE_AUTO_DISABLE.md (100%) rename TIMEZONE_CONFIGURATION.md => docs/features/TIMEZONE_CONFIGURATION.md (100%) rename UI_UPDATE.md => docs/features/UI_UPDATE.md (100%) diff --git a/README.md b/README.md index ad2f3bd..e6521cc 100644 --- a/README.md +++ b/README.md @@ -432,8 +432,17 @@ python set_ftp_credentials.py ```bash # Run comprehensive polling tests ./test_polling.sh [unit_id] + +# Test settings endpoint +python3 test_settings_endpoint.py + +# Test sleep mode auto-disable +python3 test_sleep_mode_auto_disable.py ``` +### Legacy Scripts +Old migration scripts and manual polling tools have been moved to `archive/` for reference. See [archive/README.md](archive/README.md) for details. + ## Contributing This is a standalone module kept separate from the SFM/Terra-View codebase. When contributing: diff --git a/archive/README.md b/archive/README.md new file mode 100644 index 0000000..c05fa43 --- /dev/null +++ b/archive/README.md @@ -0,0 +1,67 @@ +# SLMM Archive + +This directory contains legacy scripts that are no longer needed for normal operation but are preserved for reference. + +## Legacy Migrations (`legacy_migrations/`) + +These migration scripts were used during SLMM development (v0.1.x) to incrementally add database fields. They are **no longer needed** because: + +1. **Fresh databases** get the complete schema automatically from `app/models.py` +2. **Existing databases** should already have these fields from previous runs +3. **Current migration** is `migrate_add_polling_fields.py` (v0.2.0) in the parent directory + +### Archived Migration Files + +- `migrate_add_counter.py` - Added `counter` field to NL43Status +- `migrate_add_measurement_start_time.py` - Added `measurement_start_time` field +- `migrate_add_ftp_port.py` - Added `ftp_port` field to NL43Config +- `migrate_field_names.py` - Renamed fields for consistency (one-time fix) +- `migrate_revert_field_names.py` - Rollback for the rename migration + +**Do not delete** - These provide historical context for database schema evolution. + +--- + +## Legacy Tools + +### `nl43_dod_poll.py` + +Manual polling script that queries a single NL-43 device for DOD (Device On-Demand) data. + +**Status**: Replaced by background polling system in v0.2.0 + +**Why archived**: +- Background poller (`app/background_poller.py`) now handles continuous polling automatically +- No need for manual polling scripts +- Kept for reference in case manual querying is needed for debugging + +**How to use** (if needed): +```bash +cd /home/serversdown/tmi/slmm/archive +python3 nl43_dod_poll.py +``` + +--- + +## Active Scripts (Still in Parent Directory) + +These scripts are **actively used** and documented in the main README: + +### Migrations +- `migrate_add_polling_fields.py` - **v0.2.0 migration** - Adds background polling fields +- `migrate_add_ftp_credentials.py` - **Legacy FTP migration** - Adds FTP auth fields + +### Testing +- `test_polling.sh` - Comprehensive test suite for background polling features +- `test_settings_endpoint.py` - Tests device settings API +- `test_sleep_mode_auto_disable.py` - Tests automatic sleep mode handling + +### Utilities +- `set_ftp_credentials.py` - Command-line tool to set FTP credentials for a device + +--- + +## Version History + +- **v0.2.0** (2026-01-15) - Background polling system added, manual polling scripts archived +- **v0.1.0** (2025-12-XX) - Initial release with incremental migrations diff --git a/migrate_add_counter.py b/archive/legacy_migrations/migrate_add_counter.py similarity index 100% rename from migrate_add_counter.py rename to archive/legacy_migrations/migrate_add_counter.py diff --git a/migrate_add_ftp_port.py b/archive/legacy_migrations/migrate_add_ftp_port.py similarity index 100% rename from migrate_add_ftp_port.py rename to archive/legacy_migrations/migrate_add_ftp_port.py diff --git a/migrate_add_measurement_start_time.py b/archive/legacy_migrations/migrate_add_measurement_start_time.py similarity index 100% rename from migrate_add_measurement_start_time.py rename to archive/legacy_migrations/migrate_add_measurement_start_time.py diff --git a/migrate_field_names.py b/archive/legacy_migrations/migrate_field_names.py similarity index 100% rename from migrate_field_names.py rename to archive/legacy_migrations/migrate_field_names.py diff --git a/migrate_revert_field_names.py b/archive/legacy_migrations/migrate_revert_field_names.py similarity index 100% rename from migrate_revert_field_names.py rename to archive/legacy_migrations/migrate_revert_field_names.py diff --git a/nl43_dod_poll.py b/archive/nl43_dod_poll.py similarity index 100% rename from nl43_dod_poll.py rename to archive/nl43_dod_poll.py diff --git a/FEATURE_SUMMARY.md b/docs/features/FEATURE_SUMMARY.md similarity index 100% rename from FEATURE_SUMMARY.md rename to docs/features/FEATURE_SUMMARY.md diff --git a/docs/features/README.md b/docs/features/README.md new file mode 100644 index 0000000..a2c32a3 --- /dev/null +++ b/docs/features/README.md @@ -0,0 +1,26 @@ +# SLMM Feature Documentation + +This directory contains detailed documentation for specific SLMM features and enhancements. + +## Feature Documents + +### FEATURE_SUMMARY.md +Overview of all major features in SLMM. + +### SETTINGS_ENDPOINT.md +Documentation of the device settings endpoint and verification system. + +### TIMEZONE_CONFIGURATION.md +Timezone handling and configuration for SLMM timestamps. + +### SLEEP_MODE_AUTO_DISABLE.md +Automatic sleep mode wake-up system for background polling. + +### UI_UPDATE.md +UI/UX improvements and interface updates. + +## Related Documentation + +- [../README.md](../../README.md) - Main SLMM documentation +- [../CHANGELOG.md](../../CHANGELOG.md) - Version history +- [../API.md](../../API.md) - Complete API reference diff --git a/SETTINGS_ENDPOINT.md b/docs/features/SETTINGS_ENDPOINT.md similarity index 100% rename from SETTINGS_ENDPOINT.md rename to docs/features/SETTINGS_ENDPOINT.md diff --git a/SLEEP_MODE_AUTO_DISABLE.md b/docs/features/SLEEP_MODE_AUTO_DISABLE.md similarity index 100% rename from SLEEP_MODE_AUTO_DISABLE.md rename to docs/features/SLEEP_MODE_AUTO_DISABLE.md diff --git a/TIMEZONE_CONFIGURATION.md b/docs/features/TIMEZONE_CONFIGURATION.md similarity index 100% rename from TIMEZONE_CONFIGURATION.md rename to docs/features/TIMEZONE_CONFIGURATION.md diff --git a/UI_UPDATE.md b/docs/features/UI_UPDATE.md similarity index 100% rename from UI_UPDATE.md rename to docs/features/UI_UPDATE.md