serversdown/terra-view
1
0
Fork 0
Code Issues 8 Pull Requests Actions Packages Projects Releases Wiki Activity

0.4.2 - Early implementation of SLMs. WIP.

Browse Source
This commit is contained in:
serversdwn
2026-01-06 07:50:58 +00:00
parent 96cb27ef83
commit 4d74eda65f
36 changed files with 4211 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

276
docs/DEVICE_TYPE_DASHBOARDS.md Normal file
View File

@@ -0,0 +1,276 @@
# Device Type Dashboards
This document describes the separate dashboard system for different device types in SFM.
## Overview
SFM now has dedicated dashboards for each device type:
- **Main Dashboard** (`/`) - Combined overview of all devices
- **Seismographs Dashboard** (`/seismographs`) - Seismograph-specific view
- **Sound Level Meters Dashboard** (`/sound-level-meters`) - SLM-specific view
- **Fleet Roster** (`/roster`) - All devices with filtering and management
## Architecture
### 1. Main Dashboard
**Route**: `/`
**Template**: [templates/dashboard.html](../templates/dashboard.html)
**Purpose**: Combined overview showing all device types
**Features**:
- Fleet summary card now includes device type breakdown
- Shows count of seismographs and SLMs separately
- Links to dedicated dashboards for each device type
- Shared components: map, alerts, recent photos, fleet status
**Device Type Counts**:
The dashboard calculates device type counts in JavaScript from the snapshot data:
```javascript
// Device type counts
let seismoCount = 0;
let slmCount = 0;
Object.values(data.units || {}).forEach(unit => {
if (unit.retired) return; // Don't count retired units
const deviceType = unit.device_type || 'seismograph';
if (deviceType === 'seismograph') {
seismoCount++;
} else if (deviceType === 'sound_level_meter') {
slmCount++;
}
});
```
### 2. Seismographs Dashboard
**Route**: `/seismographs`
**Template**: [templates/seismographs.html](../templates/seismographs.html)
**Router**: [backend/routers/seismo_dashboard.py](../backend/routers/seismo_dashboard.py)
**API Endpoints**:
- `GET /api/seismo-dashboard/stats` - Statistics summary (HTML partial)
- `GET /api/seismo-dashboard/units?search=<query>` - Unit list with search (HTML partial)
**Features**:
- Statistics cards (total, deployed, benched, with/without modem)
- Searchable unit list with real-time filtering
- Shows modem assignments
- Links to individual unit detail pages
**Stats Calculation** ([backend/routers/seismo_dashboard.py:18](../backend/routers/seismo_dashboard.py#L18)):
```python
seismos = db.query(RosterUnit).filter_by(
device_type="seismograph",
retired=False
).all()
total = len(seismos)
deployed = sum(1 for s in seismos if s.deployed)
benched = sum(1 for s in seismos if not s.deployed)
with_modem = sum(1 for s in seismos if s.deployed and s.deployed_with_modem_id)
```
### 3. Sound Level Meters Dashboard
**Route**: `/sound-level-meters`
**Template**: [templates/sound_level_meters.html](../templates/sound_level_meters.html)
**Router**: [backend/routers/slm_dashboard.py](../backend/routers/slm_dashboard.py)
**API Endpoints**:
- `GET /api/slm-dashboard/stats` - Statistics summary (HTML partial)
- `GET /api/slm-dashboard/units?search=<query>` - Unit list with search (HTML partial)
- `GET /api/slm-dashboard/live-view/{unit_id}` - Live view panel (HTML partial)
**Features**:
- Statistics cards (total, deployed, benched, measuring)
- Searchable unit list
- Live view panel with real-time measurement data
- WebSocket integration for DRD streaming
- Shows modem assignments and IP resolution
See [SOUND_LEVEL_METERS_DASHBOARD.md](SOUND_LEVEL_METERS_DASHBOARD.md) for detailed SLM dashboard documentation.
## Navigation
The sidebar navigation ([templates/base.html:116-128](../templates/base.html#L116-L128)) includes links to both dashboards:
```html
<a href="/seismographs">
<svg>...</svg>
Seismographs
</a>
<a href="/sound-level-meters">
<svg>...</svg>
Sound Level Meters
</a>
```
Active page highlighting is automatic based on `request.url.path`.
## Database Queries
All dashboards filter by device type using SQLAlchemy:
### Seismographs Query
```python
seismos = db.query(RosterUnit).filter_by(
device_type="seismograph",
retired=False
).all()
```
### Sound Level Meters Query
```python
slms = db.query(RosterUnit).filter_by(
device_type="sound_level_meter",
retired=False
).all()
```
### With Search Filter
```python
query = db.query(RosterUnit).filter_by(
device_type="seismograph",
retired=False
)
if search:
query = query.filter(
(RosterUnit.id.ilike(f"%{search}%")) |
(RosterUnit.note.ilike(f"%{search}%")) |
(RosterUnit.address.ilike(f"%{search}%"))
)
```
## UI Components
### Stats Cards (Partials)
**Seismograph Stats**: [templates/partials/seismo_stats.html](../templates/partials/seismo_stats.html)
- Total Seismographs
- Deployed
- Benched
- With Modem (showing X / Y deployed)
**SLM Stats**: [templates/partials/slm_stats.html](../templates/partials/slm_stats.html)
- Total SLMs
- Deployed
- Benched
- Currently Measuring (from live status)
### Unit Lists (Partials)
**Seismograph List**: [templates/partials/seismo_unit_list.html](../templates/partials/seismo_unit_list.html)
Table columns:
- Unit ID (link to detail page)
- Status (Deployed/Benched badge)
- Modem (link to modem unit)
- Location (address or coordinates)
- Notes
- Actions (View Details link)
**SLM List**: [templates/partials/slm_unit_list.html](../templates/partials/slm_unit_list.html)
Table columns:
- Unit ID (link to detail page)
- Model (NL-43, NL-53)
- Status (Deployed/Benched badge)
- Modem (link to modem unit)
- Location
- Actions (View Details, Live View)
## HTMX Integration
Both dashboards use HTMX for dynamic updates:
### Auto-refresh Stats
```html
<div hx-get="/api/seismo-dashboard/stats"
hx-trigger="load, every 30s"
hx-swap="innerHTML">
```
### Search with Debouncing
```html
<input type="text"
hx-get="/api/seismo-dashboard/units"
hx-trigger="keyup changed delay:300ms"
hx-target="#seismo-units-list"
name="search" />
```
## Adding New Device Types
To add support for a new device type (e.g., "modem"):
1. **Create Router** (`backend/routers/modem_dashboard.py`):
```python
@router.get("/stats", response_class=HTMLResponse)
async def get_modem_stats(request: Request, db: Session = Depends(get_db)):
modems = db.query(RosterUnit).filter_by(
device_type="modem",
retired=False
).all()
# Calculate stats and return partial
```
2. **Create Templates**:
- `templates/modems.html` - Main dashboard page
- `templates/partials/modem_stats.html` - Stats cards
- `templates/partials/modem_unit_list.html` - Unit list table
3. **Register in main.py**:
```python
from backend.routers import modem_dashboard
app.include_router(modem_dashboard.router)
@app.get("/modems", response_class=HTMLResponse)
async def modems_page(request: Request):
return templates.TemplateResponse("modems.html", {"request": request})
```
4. **Add to Navigation** (`templates/base.html`):
```html
<a href="/modems">
<svg>...</svg>
Modems
</a>
```
5. **Update Main Dashboard** (`templates/dashboard.html`):
Add modem count to the device type breakdown:
```html
<div class="flex justify-between items-center">
<a href="/modems">Modems</a>
<span id="modem-count">--</span>
</div>
```
Update JavaScript to count modems:
```javascript
let modemCount = 0;
Object.values(data.units || {}).forEach(unit => {
if (unit.device_type === 'modem' && !unit.retired) {
modemCount++;
}
});
document.getElementById('modem-count').textContent = modemCount;
```
## Benefits
1. **Separation of Concerns**: Each device type has its own dedicated interface
2. **Scalability**: Easy to add new device types following the established pattern
3. **Performance**: Queries are filtered by device type, reducing data transfer
4. **User Experience**: Users can focus on specific device types without clutter
5. **Maintainability**: Each dashboard is self-contained and easy to modify
## Related Documentation
- [SOUND_LEVEL_METERS_DASHBOARD.md](SOUND_LEVEL_METERS_DASHBOARD.md) - SLM dashboard details
- [DEVICE_TYPE_SLM_SUPPORT.md](DEVICE_TYPE_SLM_SUPPORT.md) - Adding SLM device type support
- [MODEM_INTEGRATION.md](MODEM_INTEGRATION.md) - Modem assignment architecture

159
docs/DEVICE_TYPE_SLM_SUPPORT.md Normal file
View File

@@ -0,0 +1,159 @@
# Sound Level Meter Device Type Support
## Overview
Added full support for "Sound Level Meter" as a device type in the roster management system. Users can now create, edit, and manage SLM units through the Fleet Roster interface.
## Changes Made
### 1. Frontend - Unit Detail Page
**File**: `templates/unit_detail.html`
#### Added Device Type Option
- Added "Sound Level Meter" option to device type dropdown (line 243)
- Value: `sound_level_meter`
#### Added SLM-Specific Fields Section (lines 320-370)
New form fields for Sound Level Meter configuration:
- **Host (IP Address)**: Device network address
- Field name: `slm_host`
- Example: `192.168.1.100`
- **TCP Port**: Control port (default 2255)
- Field name: `slm_tcp_port`
- Type: number
- **Model**: Device model designation
- Field name: `slm_model`
- Example: `NL-43`, `NL-53`
- **Serial Number**: Manufacturer serial number
- Field name: `slm_serial_number`
- **Frequency Weighting**: Sound measurement weighting curve
- Field name: `slm_frequency_weighting`
- Options: A-weighting, C-weighting, Z-weighting (Flat)
- **Time Weighting**: Temporal averaging method
- Field name: `slm_time_weighting`
- Options: Fast (125ms), Slow (1s), Impulse (35ms)
- **Measurement Range**: Device measurement capability
- Field name: `slm_measurement_range`
- Example: `30-130 dB`
#### Updated JavaScript Functions
**toggleDetailFields()** (lines 552-571)
- Now handles three device types: seismograph, modem, sound_level_meter
- Hides all device-specific sections, then shows only the relevant one
- Shows `slmFields` section when device type is `sound_level_meter`
**populateEditForm()** (lines 527-558)
- Populates all 7 SLM-specific fields from unit data
- Sets empty string as default if field is null
### 2. Backend - API Endpoints
**File**: `backend/routers/roster_edit.py`
#### Updated Add Unit Endpoint
`POST /api/roster/add`
**New Parameters** (lines 61-67):
- `slm_host`: str (optional)
- `slm_tcp_port`: int (optional)
- `slm_model`: str (optional)
- `slm_serial_number`: str (optional)
- `slm_frequency_weighting`: str (optional)
- `slm_time_weighting`: str (optional)
- `slm_measurement_range`: str (optional)
**Unit Creation** (lines 108-115):
All SLM fields are set when creating new unit.
#### Updated Get Unit Endpoint
`GET /api/roster/{unit_id}`
**New Response Fields** (lines 146-152):
Returns all 7 SLM fields in the response, with empty string as default if null.
#### Updated Edit Unit Endpoint
`POST /api/roster/edit/{unit_id}`
**New Parameters** (lines 177-183):
Same 7 SLM-specific parameters as add endpoint.
**Unit Update** (lines 232-239):
All SLM fields are updated when editing existing unit.
### 3. Database Schema
**File**: `backend/models.py`
The database schema already included SLM fields (no changes needed):
- All fields are nullable to support multiple device types
- Fields are only relevant when `device_type = "sound_level_meter"`
## Usage
### Creating a New SLM Unit
1. Go to Fleet Roster page
2. Click "Add Unit" or edit an existing unit
3. Select "Sound Level Meter" from Device Type dropdown
4. Fill in SLM-specific fields (Host, Port, Model, etc.)
5. Save
### Converting Existing Unit to SLM
1. Open unit detail page
2. Click "Edit Unit"
3. Change Device Type to "Sound Level Meter"
4. SLM fields section will appear
5. Fill in required SLM configuration
6. Save changes
### Field Visibility
The form automatically shows/hides relevant fields based on device type:
- **Seismograph**: Shows calibration dates, modem deployment info
- **Modem**: Shows IP, phone number, hardware model
- **Sound Level Meter**: Shows host, port, model, serial, weightings, range
## Integration with SLMM Dashboard
Units with `device_type = "sound_level_meter"` will:
- Appear in the Sound Level Meters dashboard (`/sound-level-meters`)
- Be available for live monitoring and control
- Use the configured `slm_host` and `slm_tcp_port` for device communication
## Testing
Test SLM units have been added via `add_test_slms.py`:
- `nl43-001` - Deployed at construction site A
- `nl43-002` - Deployed at construction site B
- `nl53-001` - Deployed at residential area
- `nl43-003` - Benched for calibration
You can edit any of these units to verify the form works correctly.
## Files Modified
1. `templates/unit_detail.html` - Added dropdown option, SLM fields section, updated JavaScript
2. `backend/routers/roster_edit.py` - Added SLM parameters to add/edit/get endpoints
3. `backend/models.py` - No changes (schema already supported SLM)
## Backward Compatibility
- Existing seismograph and modem units are unaffected
- All SLM fields are optional/nullable
- Forms gracefully handle units with missing device_type (defaults to seismograph)
---
**Version**: 1.0.0
**Date**: January 5, 2026
**Related**: SOUND_LEVEL_METERS_DASHBOARD.md

132
docs/DEV_DATABASE_SETUP.md Normal file
View File

@@ -0,0 +1,132 @@
# DEV Database Setup Instructions
## Current Situation
The test SLM and modem data was accidentally added to the **PRODUCTION** database (`data/seismo_fleet.db`).
**Good news**: I've already removed it! The production database is clean.
**Issue**: The DEV database (`data-dev/seismo_fleet.db`) is:
1. Owned by root (read-only for your user)
2. Missing the SLM-specific columns in its schema
## What You Need to Do
### Step 1: Fix DEV Database Permissions
Run this command to make the DEV database writable:
```bash
cd /home/serversdown/sfm/seismo-fleet-manager
sudo chown serversdown:serversdown data-dev/seismo_fleet.db
sudo chmod 664 data-dev/seismo_fleet.db
```
### Step 2: Migrate DEV Database Schema
Add the SLM columns to the DEV database:
```bash
python3 scripts/migrate_dev_db.py
```
This will add these columns to the `roster` table:
- `slm_host`
- `slm_tcp_port`
- `slm_model`
- `slm_serial_number`
- `slm_frequency_weighting`
- `slm_time_weighting`
- `slm_measurement_range`
- `slm_last_check`
### Step 3: Add Test Data to DEV
Now you can safely add test data to the DEV database:
```bash
# Add test SLMs
python3 scripts/add_test_slms.py
# Add test modems and assign to SLMs
python3 scripts/add_test_modems.py
```
This will create:
- 4 test SLM units (nl43-001, nl43-002, nl53-001, nl43-003)
- 4 test modem units (modem-001, modem-002, modem-003, modem-004)
- Assign modems to the SLMs
## Production Database Status
✅ **Production database is CLEAN** - all test data has been removed.
The production database (`data/seismo_fleet.db`) is ready for real production use.
## Test Scripts
All test scripts have been updated to use the DEV database:
### Scripts Updated:
1. `scripts/add_test_slms.py` - Now uses `data-dev/seismo_fleet.db`
2. `scripts/add_test_modems.py` - Now uses `data-dev/seismo_fleet.db`
### Scripts Created:
1. `scripts/remove_test_data_from_prod.py` - Removes test data from production (already run)
2. `scripts/update_dev_db_schema.py` - Updates schema (doesn't work for SQLite ALTER)
3. `scripts/migrate_dev_db.py` - Adds SLM columns to DEV database
All helper scripts are located in the `scripts/` directory. See [scripts/README.md](../scripts/README.md) for detailed usage instructions.
## Verification
After running the steps above, verify everything worked:
```bash
# Check DEV database has test data
sqlite3 data-dev/seismo_fleet.db "SELECT id, device_type FROM roster WHERE device_type IN ('sound_level_meter', 'modem');"
```
You should see:
```
nl43-001|sound_level_meter
nl43-002|sound_level_meter
nl53-001|sound_level_meter
nl43-003|sound_level_meter
modem-001|modem
modem-002|modem
modem-003|modem
modem-004|modem
```
## Development vs Production
### When to Use DEV Database
To use the DEV database, set the environment variable:
```bash
# Not implemented yet, but you could add this to database.py:
export DATABASE_ENV=dev
```
Or modify `backend/database.py` to check for an environment variable.
### Current Setup
Right now, the application always uses `data/seismo_fleet.db` (production).
For development/testing, you could:
1. Point SFM to use the DEV database temporarily
2. Or keep test data in production (not recommended)
3. Or implement environment-based database selection
## Summary
- ✅ Production DB cleaned (no test data)
- ⚠️ DEV DB needs permission fix (run sudo commands above)
- ⚠️ DEV DB needs schema migration (run scripts/migrate_dev_db.py)
- ✅ Test scripts updated to use DEV DB
- ✅ All test data ready to be added to DEV DB
Run the commands above and you'll be all set!

62
docs/FIX_DEV_PERMISSIONS.md Normal file
View File

@@ -0,0 +1,62 @@
# Fix DEV Database Permissions
## The Problem
SQLite needs write access to both the database file AND the directory it's in (to create temporary files like journals and WAL files).
Currently:
- ✅ Database file: `data-dev/seismo_fleet.db` - permissions fixed
- ❌ Directory: `data-dev/` - still owned by root
## The Fix
Run this command to fix the directory ownership:
```bash
sudo chown -R serversdown:serversdown /home/serversdown/sfm/seismo-fleet-manager/data-dev/
```
Then run the migration again:
```bash
python3 scripts/migrate_dev_db.py
```
## Full Setup Commands
Here's the complete sequence:
```bash
cd /home/serversdown/sfm/seismo-fleet-manager
# Fix directory ownership (includes all files inside)
sudo chown -R serversdown:serversdown data-dev/
# Migrate schema
python3 scripts/migrate_dev_db.py
# Add test data
python3 scripts/add_test_slms.py
python3 scripts/add_test_modems.py
```
## Verify It Worked
After running the migration, you should see:
```
Migrating DEV database to add SLM columns...
============================================================
✓ Added column: slm_host
✓ Added column: slm_tcp_port
✓ Added column: slm_model
✓ Added column: slm_serial_number
✓ Added column: slm_frequency_weighting
✓ Added column: slm_time_weighting
✓ Added column: slm_measurement_range
✓ Added column: slm_last_check
============================================================
DEV database migration completed!
```
Then the test data scripts should work without errors!

375
docs/MODEM_INTEGRATION.md Normal file
View File

@@ -0,0 +1,375 @@
# Modem Integration System
## Overview
The modem integration system allows Sound Level Meters (SLMs) and Seismographs to be deployed with network connectivity modems. Instead of storing IP addresses directly on each device, units are assigned to modems which provide the network connection. This enables:
- Centralized modem management and tracking
- IP address updates in one place
- Future modem API integration for diagnostics
- Proper asset tracking for network equipment
## Architecture
### Database Design
**Modem Units**: Stored as `RosterUnit` with `device_type = "modem"`
**Modem-Specific Fields**:
- `ip_address`: Network IP address or hostname
- `phone_number`: Cellular phone number (if applicable)
- `hardware_model`: Modem hardware (e.g., "Raven XTV", "Sierra Wireless AirLink")
**Device Assignment**:
- Both SLMs and Seismographs use `deployed_with_modem_id` to reference their modem
- This is a foreign key to another `RosterUnit.id` where `device_type = "modem"`
### How It Works
1. **Create Modem Units**
- Add modems as regular roster units with `device_type = "modem"`
- Set IP address, phone number, and hardware model
- Deploy or bench modems like any other asset
2. **Assign Devices to Modems**
- When editing an SLM or Seismograph, select modem from dropdown
- The `deployed_with_modem_id` field stores the modem ID
- IP address is fetched from the assigned modem at runtime
3. **Runtime Resolution**
- When SLM dashboard needs to connect to a device:
1. Load SLM unit data
2. Check `deployed_with_modem_id`
3. Fetch modem unit
4. Use modem's `ip_address` for connection
5. Fallback to legacy `slm_host` if no modem assigned
## Implementation Details
### Frontend Changes
#### Unit Detail Page (`templates/unit_detail.html`)
**SLM Fields** (lines 320-375):
- Removed direct "Host (IP Address)" field
- Added "Deployed With Modem" dropdown selector
- Dropdown populated with all active modems via JavaScript
- Shows modem ID, IP address, and hardware model in dropdown
**JavaScript** (lines 456-485):
```javascript
async function loadModemsList() {
// Fetches all modems from /api/roster/modems
// Populates both seismograph and SLM modem dropdowns
// Shows format: "modem-001 (192.168.1.100) - Raven XTV"
}
```
#### SLM Dashboard (`backend/routers/slm_dashboard.py`)
**Live View Endpoint** (lines 84-148):
```python
# Get modem information if assigned
modem = None
modem_ip = None
if unit.deployed_with_modem_id:
modem = db.query(RosterUnit).filter_by(
id=unit.deployed_with_modem_id,
device_type="modem"
).first()
if modem:
modem_ip = modem.ip_address
# Fallback to direct slm_host (backward compatibility)
if not modem_ip and unit.slm_host:
modem_ip = unit.slm_host
```
**Live View Template** (`templates/partials/slm_live_view.html`):
- Displays modem information in header
- Shows "via Modem: modem-001 (192.168.1.100)"
- Warning if no modem assigned
### Backend Changes
#### New API Endpoint (`backend/routers/roster_edit.py`)
```python
GET /api/roster/modems
```
Returns list of all non-retired modem units:
```json
[
{
"id": "modem-001",
"ip_address": "192.168.1.100",
"phone_number": "+1-555-0100",
"hardware_model": "Raven XTV",
"deployed": true
}
]
```
Used by frontend to populate modem selection dropdowns.
#### Database Schema (`backend/models.py`)
**Modem Assignment Field** (line 44):
```python
# Shared by seismographs and SLMs
deployed_with_modem_id = Column(String, nullable=True)
```
**Modem Fields** (lines 46-48):
```python
ip_address = Column(String, nullable=True)
phone_number = Column(String, nullable=True)
hardware_model = Column(String, nullable=True)
```
**Legacy SLM Fields** (kept for backward compatibility):
```python
slm_host = Column(String, nullable=True) # Deprecated - use modem instead
slm_tcp_port = Column(Integer, nullable=True) # Still used
```
## Usage
### Creating Modem Units
1. Go to Fleet Roster
2. Click "Add Unit"
3. Set Device Type to "Modem"
4. Fill in:
- Unit ID (e.g., "modem-001")
- IP Address (e.g., "192.168.1.100")
- Phone Number (if cellular)
- Hardware Model (e.g., "Raven XTV")
- Address/Coordinates (physical location)
5. Set Deployed status
6. Save
### Assigning Modem to SLM
1. Open SLM unit detail page
2. Click "Edit Unit"
3. Ensure Device Type is "Sound Level Meter"
4. In "Deployed With Modem" dropdown, select modem
5. Verify TCP Port (default 2255)
6. Save
### Assigning Modem to Seismograph
Same process - both device types use the same modem selection field.
## Test Data
Use the included script to create test modems:
```bash
python3 add_test_modems.py
```
This creates:
- **modem-001**: 192.168.1.100, Raven XTV → assigned to nl43-001
- **modem-002**: 192.168.1.101, Raven XTV → assigned to nl43-002
- **modem-003**: 192.168.1.102, Sierra Wireless → assigned to nl53-001
- **modem-004**: Spare modem (not deployed)
## Benefits
### For Operations
1. **Centralized IP Management**
- Update modem IP once, affects all assigned devices
- Easy to track which modem serves which devices
- Inventory management for network equipment
2. **Asset Tracking**
- Modems are first-class assets in the roster
- Track deployment status, location, notes
- Can bench/retire modems independently
3. **Future Capabilities**
- Modem API integration (signal strength, data usage)
- Automatic IP updates from DHCP/cellular network
- Modem health monitoring
- Remote modem diagnostics
### For Maintenance
1. **Easier Troubleshooting**
- See which modem serves a device
- Check modem status separately
- Swap modems without reconfiguring devices
2. **Configuration Changes**
- Change IP addresses system-wide
- Move devices between modems
- Test with backup modems
## Migration from Legacy System
### For Existing SLMs with Direct IP
Legacy SLMs with `slm_host` set still work:
- System checks `deployed_with_modem_id` first
- Falls back to `slm_host` if no modem assigned
- Logs fallback usage for visibility
### Migration Steps
1. Create modem units for each IP address
2. Assign SLMs to their modems
3. System will use modem IP automatically
4. Legacy `slm_host` can be cleared (optional)
Script `add_test_modems.py` demonstrates this:
```python
# Clear legacy field after modem assignment
slm.slm_host = None
slm.deployed_with_modem_id = "modem-001"
```
## Future Enhancements
### Near-term
1. **Modem Status Dashboard**
- List all modems with connection status
- Show which devices use each modem
- Signal strength, data usage indicators
2. **Automatic IP Discovery**
- Query cellular provider API for modem IPs
- Auto-update IP addresses in database
- Alert on IP changes
3. **Modem Health Monitoring**
- Ping modems periodically
- Check cellular signal quality
- Data usage tracking
### Long-term
1. **Modem API Integration**
- Direct modem management (Raven, Sierra APIs)
- Remote reboot capability
- Configuration backup/restore
- Firmware updates
2. **Network Topology View**
- Graphical view of modem-device relationships
- Network health visualization
- Troubleshooting tools
3. **Multi-Modem Support**
- Failover between modems
- Load balancing
- Automatic fallback on modem failure
## API Reference
### Get Modems List
**Endpoint**: `GET /api/roster/modems`
**Response**:
```json
[
{
"id": "modem-001",
"ip_address": "192.168.1.100",
"phone_number": "+1-555-0100",
"hardware_model": "Raven XTV",
"deployed": true
}
]
```
**Used By**:
- Unit detail page (modem dropdown)
- Future modem management dashboard
### Get Unit with Modem Info
**Endpoint**: `GET /api/roster/{unit_id}`
**Response** (for SLM):
```json
{
"id": "nl43-001",
"device_type": "sound_level_meter",
"deployed_with_modem_id": "modem-001",
"slm_tcp_port": 2255,
"slm_model": "NL-43",
...
}
```
Then fetch modem separately or use dashboard endpoint which resolves it automatically.
### SLM Live View (with modem resolution)
**Endpoint**: `GET /api/slm-dashboard/live-view/{unit_id}`
**Process**:
1. Loads SLM unit
2. Resolves `deployed_with_modem_id` to modem unit
3. Extracts `modem.ip_address`
4. Uses IP to connect to SLMM backend
5. Returns live view HTML with modem info
## Files Modified/Created
### Modified
1. `backend/models.py` - Clarified modem assignment field
2. `templates/unit_detail.html` - Added modem selector for SLMs
3. `backend/routers/roster_edit.py` - Added modems list endpoint
4. `backend/routers/slm_dashboard.py` - Modem resolution logic
5. `templates/partials/slm_live_view.html` - Display modem info
### Created
1. `add_test_modems.py` - Script to create test modems and assignments
2. `docs/MODEM_INTEGRATION.md` - This documentation
## Troubleshooting
### SLM shows "No modem assigned"
**Cause**: Unit has no `deployed_with_modem_id` set
**Solution**:
1. Edit the SLM unit
2. Select a modem from dropdown
3. Save
### Modem dropdown is empty
**Cause**: No modem units in database
**Solution**:
1. Create modem units first
2. Set `device_type = "modem"`
3. Ensure they're not retired
### Can't connect to SLM
**Possible Causes**:
1. Modem IP is incorrect
2. Modem is offline
3. SLM TCP port is wrong
4. Network routing issue
**Debug Steps**:
1. Check modem unit's IP address
2. Ping the modem IP
3. Check SLM's `slm_tcp_port` (default 2255)
4. Review logs for connection errors
---
**Version**: 1.0.0
**Date**: January 5, 2026
**Related**: SOUND_LEVEL_METERS_DASHBOARD.md, DEVICE_TYPE_SLM_SUPPORT.md

275
docs/SLM_CONFIGURATION.md Normal file
View File

@@ -0,0 +1,275 @@
# SLM Configuration Interface
This document describes the SLM configuration interface added to the Sound Level Meters dashboard.
## Overview
Sound Level Meters can now be configured directly from the dashboard without needing to navigate to the unit detail page. A configuration button appears on each SLM unit card on hover, opening a modal with all configurable parameters.
## Features
### 1. Quick Access Configuration Button
- **Location**: Appears on each SLM unit card in the unit list
- **Behavior**: Shows on hover (desktop) or always visible (mobile)
- **Icon**: Gear/settings icon in top-right corner of unit card
### 2. Configuration Modal
The configuration modal provides a comprehensive interface for all SLM parameters:
#### Device Information
- **Model**: Dropdown selection (NL-43, NL-53)
- **Serial Number**: Text input for device serial number
#### Measurement Parameters
- **Frequency Weighting**: A, C, or Z (Linear)
- **Time Weighting**: Fast (125ms), Slow (1s), or Impulse
- **Measurement Range**: 30-130 dB, 40-140 dB, or 50-140 dB
#### Network Configuration
- **Assigned Modem**: Dropdown list of available modems
- Shows modem ID and IP address
- Option for "No modem (direct connection)"
- **Direct IP Address**: Only shown when no modem assigned
- **TCP Port**: Only shown when no modem assigned (default: 502)
### 3. Actions
The modal provides three action buttons:
- **Test Connection**: Tests network connectivity to the SLM
- Uses current form values (not saved values)
- Shows toast notification with results
- Green: Connection successful
- Yellow: Connection failed or device offline
- Red: Test error
- **Cancel**: Closes modal without saving changes
- **Save Configuration**: Saves all changes to database
- Shows success/error toast
- Refreshes unit list on success
- Auto-closes modal after 2 seconds
## Implementation
### Frontend Components
#### Unit List Partial
**File**: [templates/partials/slm_unit_list.html](../templates/partials/slm_unit_list.html)
```html
<!-- Configure button (appears on hover) -->
<button onclick="event.stopPropagation(); openConfigModal('{{ unit.id }}');"
class="absolute top-2 right-2 opacity-0 group-hover:opacity-100...">
<svg>...</svg>
</button>
```
#### Configuration Modal
**File**: [templates/sound_level_meters.html](../templates/sound_level_meters.html#L73)
```html
<!-- Configuration Modal -->
<div id="config-modal" class="hidden fixed inset-0 bg-black bg-opacity-50...">
<div id="config-modal-content">
<!-- Content loaded via HTMX -->
</div>
</div>
```
#### Configuration Form
**File**: [templates/partials/slm_config_form.html](../templates/partials/slm_config_form.html)
Form fields mapped to database columns:
- `slm_model` → `unit.slm_model`
- `slm_serial_number` → `unit.slm_serial_number`
- `slm_frequency_weighting` → `unit.slm_frequency_weighting`
- `slm_time_weighting` → `unit.slm_time_weighting`
- `slm_measurement_range` → `unit.slm_measurement_range`
- `deployed_with_modem_id` → `unit.deployed_with_modem_id`
- `slm_host` → `unit.slm_host` (legacy, only if no modem)
- `slm_tcp_port` → `unit.slm_tcp_port` (legacy, only if no modem)
### Backend Endpoints
#### GET /api/slm-dashboard/config/{unit_id}
**File**: [backend/routers/slm_dashboard.py:184](../backend/routers/slm_dashboard.py#L184)
Returns configuration form HTML partial with current unit values pre-populated.
**Response**: HTML partial (slm_config_form.html)
#### POST /api/slm-dashboard/config/{unit_id}
**File**: [backend/routers/slm_dashboard.py:203](../backend/routers/slm_dashboard.py#L203)
Saves configuration changes to database.
**Request**: Form data with configuration parameters
**Response**: JSON
```json
{
"status": "success",
"unit_id": "nl43-001"
}
```
**Behavior**:
- Updates all SLM-specific fields from form data
- If modem is assigned: clears legacy `slm_host` and `slm_tcp_port`
- If no modem: uses direct IP fields from form
### JavaScript Functions
#### openConfigModal(unitId)
**File**: [templates/sound_level_meters.html:127](../templates/sound_level_meters.html#L127)
Opens configuration modal and loads form via HTMX.
```javascript
function openConfigModal(unitId) {
const modal = document.getElementById('config-modal');
modal.classList.remove('hidden');
htmx.ajax('GET', `/api/slm-dashboard/config/${unitId}`, {
target: '#config-modal-content',
swap: 'innerHTML'
});
}
```
#### closeConfigModal()
**File**: [templates/sound_level_meters.html:136](../templates/sound_level_meters.html#L136)
Closes configuration modal.
#### handleConfigSave(event)
**File**: [templates/partials/slm_config_form.html:109](../templates/partials/slm_config_form.html#L109)
Handles HTMX response after form submission:
- Shows success/error toast
- Refreshes unit list
- Auto-closes modal after 2 seconds
#### testConnection(unitId)
**File**: [templates/partials/slm_config_form.html:129](../templates/partials/slm_config_form.html#L129)
Tests connection to SLM unit:
```javascript
async function testConnection(unitId) {
const response = await fetch(`/api/slmm/${unitId}/status`);
const data = await response.json();
if (response.ok && data.status === 'online') {
// Show success toast
} else {
// Show warning toast
}
}
```
#### loadModemsForConfig()
**File**: [templates/partials/slm_config_form.html:87](../templates/partials/slm_config_form.html#L87)
Loads available modems from `/api/roster/modems` and populates dropdown.
## User Workflow
### Configuring an SLM
1. Navigate to Sound Level Meters dashboard ([/sound-level-meters](../sound-level-meters))
2. Hover over desired SLM unit card in the list
3. Click the gear icon that appears in top-right corner
4. Configuration modal opens with current values pre-filled
5. Modify desired parameters:
- Update model/serial if needed
- Set measurement parameters (frequency/time weighting, range)
- Choose network configuration:
- **Option A**: Select a modem from dropdown (recommended)
- **Option B**: Enter direct IP address and port
6. (Optional) Click "Test Connection" to verify network settings
7. Click "Save Configuration"
8. Modal shows success message and auto-closes
9. Unit list refreshes to show updated information
### Network Configuration Options
**Modem Assignment (Recommended)**:
- Select modem from dropdown
- IP address automatically resolved from modem's `ip_address` field
- Direct IP/port fields hidden
- Enables modem tracking and management
**Direct Connection (Legacy)**:
- Select "No modem (direct connection)"
- Enter IP address and TCP port manually
- Direct IP/port fields become visible
- Useful for temporary setups or non-modem connections
## Database Schema
The configuration interface updates these `roster` table columns:
```sql
-- SLM-specific fields
slm_model VARCHAR -- Device model (NL-43, NL-53)
slm_serial_number VARCHAR -- Serial number
slm_frequency_weighting VARCHAR -- A, C, or Z weighting
slm_time_weighting VARCHAR -- Fast, Slow, or Impulse
slm_measurement_range VARCHAR -- Measurement range (30-130, 40-140, 50-140)
-- Network configuration
deployed_with_modem_id VARCHAR -- FK to modem unit (preferred method)
slm_host VARCHAR -- Legacy direct IP (only if no modem)
slm_tcp_port INTEGER -- Legacy TCP port (only if no modem)
```
## UI/UX Design
### Modal Behavior
- **Opens**: Via configure button on unit card
- **Closes**:
- Cancel button
- X button in header
- Escape key
- Clicking outside modal (on backdrop)
- **Auto-close**: After successful save (2 second delay)
### Responsive Design
- **Desktop**: Configuration button appears on hover
- **Mobile**: Configuration button always visible
- **Modal**: Responsive width, scrollable on small screens
- **Form**: Two-column layout on desktop, single column on mobile
### Visual Feedback
- **Loading**: Skeleton loader while form loads
- **Saving**: HTMX handles form submission
- **Success**: Green toast notification
- **Error**: Red toast notification
- **Testing**: Blue toast while testing, then green/yellow/red based on result
### Accessibility
- **Keyboard**: Modal can be closed with Escape key
- **Focus**: Modal traps focus when open
- **Labels**: All form fields have proper labels
- **Colors**: Sufficient contrast in dark/light modes
## Future Enhancements
Potential improvements for future versions:
1. **Bulk Configuration**: Configure multiple SLMs at once
2. **Configuration Templates**: Save and apply configuration presets
3. **Configuration History**: Track configuration changes over time
4. **Remote Configuration**: Push configuration directly to device via SLMM
5. **Validation**: Real-time validation of IP addresses and ports
6. **Advanced Settings**: Additional NL-43/NL-53 specific parameters
7. **Configuration Import/Export**: JSON/CSV configuration files
## Related Documentation
- [SOUND_LEVEL_METERS_DASHBOARD.md](SOUND_LEVEL_METERS_DASHBOARD.md) - Main SLM dashboard
- [MODEM_INTEGRATION.md](MODEM_INTEGRATION.md) - Modem assignment architecture
- [DEVICE_TYPE_SLM_SUPPORT.md](DEVICE_TYPE_SLM_SUPPORT.md) - SLM device type implementation

333
docs/SOUND_LEVEL_METERS_DASHBOARD.md Normal file
View File

@@ -0,0 +1,333 @@
# Sound Level Meters Dashboard
## Overview
The Sound Level Meters dashboard is a new feature in SFM (soon to be rebranded as Terra-view) that provides real-time monitoring and control of Rion NL-43/NL-53 sound level meters through the SLMM backend integration.
## Features
### 1. Dashboard Summary Statistics
- **Total Units**: Count of all SLM devices in the system
- **Deployed Units**: Active devices currently in the field
- **Active Now**: Units that have checked in within the last hour
- **Benched Units**: Devices not currently deployed
### 2. Unit List (Sidebar)
- Searchable list of all deployed SLM units
- Real-time status indicators:
- 🟢 Green: Active (recently checked in)
- ⚪ Gray: No check-in data
- Quick unit information:
- Device model (NL-43, NL-53, etc.)
- Location/address
- Network address (IP:port)
- Click any unit to view its live data
### 3. Live View Panel
When a unit is selected, the live view panel displays:
#### Control Buttons
- **Start**: Begin measurement
- **Pause**: Pause current measurement
- **Stop**: Stop measurement
- **Reset**: Reset measurement data
- **Start Live Stream**: Open WebSocket connection for real-time DRD data
#### Real-time Metrics
- **Lp (Current)**: Instantaneous sound level in dB
- **Leq (Average)**: Equivalent continuous sound level
- **Lmax (Peak)**: Maximum sound level recorded
- **Lmin**: Minimum sound level recorded
#### Live Chart
- Real-time line chart showing Lp and Leq over time
- 60-second rolling window (adjustable)
- Chart.js-powered visualization with dark mode support
- No animation for smooth real-time updates
#### Device Information
- Battery level and power source
- Frequency weighting (A, C, Z)
- Time weighting (F, S, I)
- SD card remaining space
## Architecture
### Frontend Components
#### Main Template
**File**: `templates/sound_level_meters.html`
The main dashboard page that includes:
- Page header and navigation integration
- Stats summary section (auto-refreshes every 10s)
- Two-column layout: unit list (left) + live view (right)
- JavaScript functions for unit selection and WebSocket streaming
#### Partial Templates
1. **slm_stats.html** - Summary statistics cards
- Auto-loads on page load
- Refreshes every 10 seconds via HTMX
2. **slm_unit_list.html** - Searchable unit list
- Auto-loads on page load
- Refreshes every 10 seconds via HTMX
- Supports search filtering
3. **slm_live_view.html** - Live data panel for selected unit
- Loaded on-demand when unit is selected
- Includes Chart.js for visualization
- WebSocket connection for streaming data
4. **slm_live_view_error.html** - Error state display
### Backend Components
#### Router: `backend/routers/slm_dashboard.py`
**Endpoints:**
```python
GET /api/slm-dashboard/stats
```
Returns HTML partial with summary statistics.
```python
GET /api/slm-dashboard/units?search={term}
```
Returns HTML partial with filtered unit list.
```python
GET /api/slm-dashboard/live-view/{unit_id}
```
Returns HTML partial with live view panel for specific unit.
- Fetches unit details from database
- Queries SLMM API for current measurement state
- Queries SLMM API for live status (DOD data)
```python
POST /api/slm-dashboard/control/{unit_id}/{action}
```
Sends control commands to SLMM backend.
- Valid actions: start, stop, pause, resume, reset
- Proxies to `http://localhost:8100/api/nl43/{unit_id}/{action}`
### Integration with SLMM
The dashboard communicates with the SLMM backend service running on port 8100:
**REST API Calls:**
- `GET /api/nl43/{unit_id}/measurement-state` - Check if measuring
- `GET /api/nl43/{unit_id}/live` - Get current DOD data
- `POST /api/nl43/{unit_id}/start|stop|pause|resume|reset` - Control commands
**WebSocket Streaming:**
- `WS /api/nl43/{unit_id}/live` - Real-time DRD data stream
- Proxied through SFM at `/api/slmm/{unit_id}/live`
- Streams continuous measurement data for live charting
### Database Schema
**Table**: `roster`
SLM-specific fields in the RosterUnit model:
```python
device_type = "sound_level_meter" # Distinguishes SLMs from seismographs
slm_host = String # Device IP or hostname
slm_tcp_port = Integer # TCP control port (default 2255)
slm_model = String # NL-43, NL-53, etc.
slm_serial_number = String # Device serial number
slm_frequency_weighting = String # A, C, or Z weighting
slm_time_weighting = String # F (Fast), S (Slow), I (Impulse)
slm_measurement_range = String # e.g., "30-130 dB"
slm_last_check = DateTime # Last communication timestamp
```
## Navigation
The Sound Level Meters page is accessible from:
- **URL**: `/sound-level-meters`
- **Sidebar**: "Sound Level Meters" menu item (between Fleet Roster and Projects)
- **Icon**: Speaker/sound wave SVG icon
## Real-time Updates
The dashboard uses three mechanisms for real-time updates:
1. **HTMX Polling** (10-second intervals)
- Summary statistics
- Unit list
- Ensures data freshness even without user interaction
2. **On-Demand Loading** (HTMX)
- Live view panel loads when unit is selected
- Control button responses
3. **WebSocket Streaming** (continuous)
- Real-time DRD data for live charting
- User-initiated via "Start Live Stream" button
- Automatically closed on page unload or unit change
## Measurement Duration Tracking
**Important**: The NL-43/NL-53 devices do not expose measurement duration via their API. Elapsed time and interval counts are only visible on the device's on-screen display (OSD).
**Solution**: Track measurement start time in your application when calling the `/start` endpoint:
```javascript
// When starting measurement
const startTime = new Date();
localStorage.setItem(`slm_${unitId}_start`, startTime.toISOString());
// Calculate elapsed time
const startTime = new Date(localStorage.getItem(`slm_${unitId}_start`));
const elapsed = (new Date() - startTime) / 1000; // seconds
```
**Future Enhancement**: SLMM backend could store measurement start times in a database table to track duration across sessions.
## Testing
### Add Test Data
Use the included script to add test SLM units:
```bash
python3 add_test_slms.py
```
This creates:
- 3 deployed test units (nl43-001, nl43-002, nl53-001)
- 1 benched unit (nl43-003)
### Running the Dashboard
1. Start SLMM backend (port 8100):
```bash
cd /home/serversdown/slmm
uvicorn main:app --host 0.0.0.0 --port 8100
```
2. Start SFM (port 8000):
```bash
cd /home/serversdown/sfm/seismo-fleet-manager
uvicorn backend.main:app --host 0.0.0.0 --port 8000 --reload
```
3. Access dashboard:
```
http://localhost:8000/sound-level-meters
```
### Testing Without Physical Devices
The dashboard will work without physical NL-43 devices connected:
- Unit list will display based on database records
- Live view will show connection errors (gracefully handled)
- Mock data can be added to SLMM for testing
## Future Enhancements
### Near-term
1. **Measurement Duration Tracking**
- Add database table to track measurement sessions
- Display elapsed time in live view
- Store start/stop timestamps
2. **Historical Data View**
- Chart historical Leq intervals
- Export measurement data
- Comparison between units
3. **Alerts & Thresholds**
- Configurable sound level alerts
- Email/SMS notifications when thresholds exceeded
- Visual indicators on dashboard
### Long-term
1. **Map View**
- Display all SLMs on a map (like seismographs)
- Click map markers to view live data
- Color-coded by current sound level
2. **Batch Operations**
- Start/stop multiple units simultaneously
- Synchronized measurements
- Group configurations
3. **Advanced Analytics**
- Noise compliance reports
- Statistical summaries
- Trend analysis
## Integration with Terra-view
When SFM is rebranded to Terra-view:
1. **Multi-Module Dashboard**
- Sound Level Meters module (this dashboard)
- Seismograph Fleet Manager module (existing)
- Future monitoring modules
2. **Project Management**
- Link SLMs to projects
- Combined project view with seismographs + SLMs
- Project-level reporting
3. **Unified Navigation**
- Top-level module switcher
- Consistent UI/UX across modules
- Shared authentication and settings
## Technical Notes
### HTMX Integration
The dashboard extensively uses HTMX for dynamic updates without full page reloads:
- `hx-get`: Fetch and swap content
- `hx-trigger`: Auto-refresh intervals
- `hx-swap`: Content replacement strategy
- `hx-target`: Specify update target
### Dark Mode Support
All components support dark mode:
- Chart.js colors adapt to theme
- Tailwind dark: classes throughout
- Automatic theme detection
### Performance Considerations
- WebSocket connections are per-unit (only one active at a time)
- Chart data limited to 60 points (1 minute) to prevent memory bloat
- Polling intervals balanced for responsiveness vs server load
- Lazy loading of live view panel (only when unit selected)
## Files Modified/Created
### New Files
- `templates/sound_level_meters.html`
- `templates/partials/slm_stats.html`
- `templates/partials/slm_unit_list.html`
- `templates/partials/slm_live_view.html`
- `templates/partials/slm_live_view_error.html`
- `backend/routers/slm_dashboard.py`
- `add_test_slms.py`
- `docs/SOUND_LEVEL_METERS_DASHBOARD.md`
### Modified Files
- `backend/main.py` - Added route and router import
- `templates/base.html` - Added navigation menu item
## Support
For issues or questions:
- Check SLMM API documentation: `/home/serversdown/slmm/docs/API.md`
- Review SFM changelog: `CHANGELOG.md`
- Submit issues to project repository
---
**Version**: 1.0.0
**Created**: January 2026
**Last Updated**: January 5, 2026