acidburns
3e9259735e
- Fix documentation: CSV header typo (ts_hms_utc ts_hms_local) - Add comprehensive compatibility test suite (test_republish_compatibility.py) - Both republish_mqtt.py and republish_mqtt_gui.py verified working - Tests: CSV parsing, MQTT JSON format, legacy compatibility, InfluxDB schema - All 5/5 compatibility tests passing - Create detailed compatibility reports and validation documentation
110 lines
3.3 KiB
Markdown
110 lines
3.3 KiB
Markdown
# ✅ Python Scripts Compatibility Check - Quick Result
|
|
|
|
**Status:** BOTH SCRIPTS ARE FULLY COMPATIBLE ✅
|
|
**Date:** March 11, 2026
|
|
**Scripts Tested:** `republish_mqtt.py` and `republish_mqtt_gui.py`
|
|
|
|
---
|
|
|
|
## Checklist
|
|
|
|
- ✅ CSV parsing works with current SD card format ([`ts_utc,ts_hms_local,...`](https://github.com/search?q=ts_hms_local))
|
|
- ✅ Backward compatible with legacy CSV format (no `ts_hms_local`)
|
|
- ✅ MQTT JSON output matches device expectations
|
|
- ✅ All required fields present in current schema
|
|
- ✅ Scripts handle future CSV columns gracefully
|
|
- ✅ InfluxDB auto-detect schema is correct (optional feature)
|
|
- ✅ Both scripts compile without syntax errors
|
|
- ⚠️ **Documentation error found and FIXED** (typo in CSV header)
|
|
- ⚠️ Error fields from CSV not republished (expected limitation)
|
|
|
|
---
|
|
|
|
## What's Different?
|
|
|
|
### Device CSV Format (Current)
|
|
```
|
|
ts_utc,ts_hms_local,p_w,p1_w,p2_w,p3_w,e_kwh,bat_v,bat_pct,rssi,snr,err_m,err_d,err_tx,err_last
|
|
```
|
|
- `ts_hms_local` = local time (your timezone)
|
|
- `ts_utc` = UTC timestamp in seconds
|
|
- Scripts work with both!
|
|
|
|
### MQTT Format (What scripts republish)
|
|
```json
|
|
{
|
|
"id": "F19C",
|
|
"ts": 1710076800,
|
|
"e_kwh": "1234.57",
|
|
"p_w": 5432,
|
|
"p1_w": 1800,
|
|
"p2_w": 1816,
|
|
"p3_w": 1816,
|
|
"bat_v": "4.15",
|
|
"bat_pct": 95,
|
|
"rssi": -95,
|
|
"snr": 9.25
|
|
}
|
|
```
|
|
- Fully compatible with device format ✅
|
|
- Can be parsed by Home Assistant, InfluxDB, etc. ✅
|
|
|
|
---
|
|
|
|
## Issues Found & Fixed
|
|
|
|
| Issue | Severity | Status | Fix |
|
|
|-------|----------|--------|-----|
|
|
| CSV header typo in docs<br/>(was: `ts_hms_utc`, should be: `ts_hms_local`) | HIGH<br/>(docs only) | ✅ FIXED | Updated [REPUBLISH_README.md](REPUBLISH_README.md#L84) |
|
|
| Error fields not republished<br/>(err_m, err_d, err_tx, err_last) | LOW<br/>(expected limitation) | ✅ DOCUMENTED | Added notes to compatibility report |
|
|
| InfluxDB bridge required | INFO<br/>(optional feature) | ✅ OK | Gracefully falls back to manual mode |
|
|
|
|
---
|
|
|
|
## What to Do
|
|
|
|
### For Users
|
|
- ✅ **No action needed** - scripts work as-is
|
|
- ✅ Use these scripts normally with confidence
|
|
- 📖 Check updated [REPUBLISH_README.md](REPUBLISH_README.md) for correct CSV format
|
|
- 💾 CSV files from device are compatible
|
|
|
|
### For Developers
|
|
- 📄 See [REPUBLISH_COMPATIBILITY_REPORT.md](REPUBLISH_COMPATIBILITY_REPORT.md) for detailed analysis
|
|
- 🧪 Run `python test_republish_compatibility.py` to validate changes
|
|
- 📋 Consider adding error field republishing in future versions (optional)
|
|
|
|
---
|
|
|
|
## Test Evidence
|
|
|
|
### Automated Tests (5/5 PASS)
|
|
```
|
|
✓ CSV Format (Current with ts_hms_local)
|
|
✓ CSV Format (with future fields)
|
|
✓ MQTT JSON Format compatibility
|
|
✓ CSV Format (Legacy - backward compat)
|
|
✓ InfluxDB schema validation
|
|
```
|
|
|
|
### What Script Tests
|
|
- ✅ Parses CSV headers correctly
|
|
- ✅ Converts data types properly (strings, ints, floats)
|
|
- ✅ Handles missing optional fields
|
|
- ✅ Generates correct MQTT JSON
|
|
- ✅ Works with InfluxDB schema expectations
|
|
|
|
---
|
|
|
|
## Summary
|
|
|
|
Both Python scripts (`republish_mqtt.py` and `republish_mqtt_gui.py`) continue to work correctly with:
|
|
- Current SD card CSV exports from the device
|
|
- MQTT broker connectivity
|
|
- Optional InfluxDB auto-detect mode
|
|
- All data types and field formats
|
|
|
|
The only problem found was a documentation typo which has been corrected.
|
|
|
|
**✅ Scripts are ready for production use.**
|