Skip to content

CLI for SidePulse

Python

Revert "Write LED programs in place"

Peter Kuhar16526e1b192b
diff --git a/LEDS_FORMAT.md b/LEDS_FORMAT.md
index 2ad447b..995067b 100644
--- a/LEDS_FORMAT.md
+++ b/LEDS_FORMAT.md
@@ -28,11 +28,6 @@ or
To recap, write to LEDS.LED what you want displayed.
That's all you have to know.
-SidePulse's host software keeps `LEDS.LED` as one fixed 512-byte record and
-space-pads the unused tail. It overwrites that record in place so repeated status
-updates reuse the same filesystem cluster instead of truncating and reallocating
-the file. The firmware ignores the trailing whitespace.
-
## Initial state.
The content in INIT.LED is played on power up. It can be anything supported by LEDS.LED.
diff --git a/src/sidepulse/device_writer.py b/src/sidepulse/device_writer.py
index b3afa79..260d0ec 100644
--- a/src/sidepulse/device_writer.py
+++ b/src/sidepulse/device_writer.py
@@ -9,7 +9,6 @@ LED_FILE_NAMES = (DEFAULT_FILE_NAME,)
KNOWN_LED_FILE_NAMES = frozenset(name.upper() for name in LED_FILE_NAMES)
MAX_LED_BYTES = 512
MAX_LED_LINES = 20
-LED_RECORD_PADDING_BYTE = b" "
MOUNT_ROOT = Path("/Volumes")
DEVICE_NAME_HINTS = (
"sidepulsepro",
@@ -44,45 +43,10 @@ def write_led_program(
return target
target.parent.mkdir(parents=True, exist_ok=True)
- _write_led_record_in_place(target, program.encode("utf-8"))
+ target.write_text(program, encoding="utf-8")
return target
-def _write_led_record_in_place(target: Path, program: bytes) -> None:
- """Overwrite the fixed-size LED record without truncating the file first."""
- if len(program) > MAX_LED_BYTES:
- raise DeviceWriteError(
- f"LED program is {len(program)} bytes; max is {MAX_LED_BYTES}."
- )
- record = program.ljust(MAX_LED_BYTES, LED_RECORD_PADDING_BYTE)
-
- try:
- handle = target.open("r+b", buffering=0)
- except FileNotFoundError:
- # Creation is only a recovery path. Firmware normally provides LEDS.LED.
- handle = target.open("x+b", buffering=0)
-
- with handle:
- handle.seek(0)
- written = handle.write(record)
- if written != len(record):
- raise DeviceWriteError(
- f"Only wrote {written} of {len(record)} bytes to {target}."
- )
-
- # Repair an unexpectedly oversized file once. Normal writes stay at the
- # fixed size and therefore never release/reallocate the data cluster.
- handle.seek(0, 2)
- if handle.tell() > MAX_LED_BYTES:
- handle.truncate(MAX_LED_BYTES)
-
-
-def read_led_program(path: Path) -> str:
- """Read a fixed-size LED record as its logical, unpadded program text."""
- data = path.read_bytes().rstrip(b" \x00\xff")
- return data.decode("utf-8")
-
-
def normalize_led_text(text: str) -> str:
return decode_simple_escapes(text)
diff --git a/src/sidepulse/led_status.py b/src/sidepulse/led_status.py
index b4a604b..e2f3968 100644
--- a/src/sidepulse/led_status.py
+++ b/src/sidepulse/led_status.py
@@ -11,7 +11,6 @@ from .device_writer import (
DEFAULT_FILE_NAME,
DeviceWriteError,
normalize_led_text,
- read_led_program,
resolve_target_path,
write_led_program,
)
@@ -357,7 +356,7 @@ class AgentLedController:
if self.last_target is None or self.last_program is None:
return False
try:
- return read_led_program(self.last_target) == self.last_program
+ return self.last_target.read_text(encoding="utf-8") == self.last_program
except (OSError, UnicodeError):
return False
diff --git a/tests/test_sidepulse.py b/tests/test_sidepulse.py
index 4240486..5e2ef24 100644
--- a/tests/test_sidepulse.py
+++ b/tests/test_sidepulse.py
@@ -45,7 +45,6 @@ from sidepulse.device_writer import (
DeviceWriteError,
discover_devices,
normalize_led_text,
- read_led_program,
validate_led_text,
write_led_program,
)
@@ -2012,7 +2011,7 @@ class AgentMonitorTests(unittest.TestCase):
17,
)
- program = read_led_program(root / "LEDS.LED")
+ program = (root / "LEDS.LED").read_text()
self.assertIn("7:#00E5FF 320ms pulse 595ms", program)
self.assertEqual(
restore_calls,
@@ -3699,26 +3698,7 @@ class AgentMonitorTests(unittest.TestCase):
)
self.assertEqual(target, device / "LEDS.LED")
- self.assertEqual(read_led_program(target), "off\n#FF00FF pulse")
- self.assertEqual(target.stat().st_size, 512)
-
- def test_sidepulse_write_reuses_fixed_record_and_clears_old_tail(self) -> None:
- with tempfile.TemporaryDirectory() as tmp:
- device = Path(tmp) / "SidePulsePro"
- device.mkdir()
- target = device / "LEDS.LED"
- target.write_bytes(b"old")
-
- write_led_program("off\n#FF00FF pulse", device_path=device)
- first_inode = target.stat().st_ino
- write_led_program("off", device_path=device)
-
- data = target.read_bytes()
- self.assertEqual(target.stat().st_ino, first_inode)
- self.assertEqual(len(data), 512)
- self.assertEqual(data[:3], b"off")
- self.assertEqual(data[3:], b" " * 509)
- self.assertEqual(read_led_program(target), "off")
+ self.assertEqual(target.read_text(), "off\n#FF00FF pulse")
def test_sidepulse_write_uses_leds_led_even_when_old_file_exists(self) -> None:
with tempfile.TemporaryDirectory() as tmp:
@@ -3732,7 +3712,7 @@ class AgentMonitorTests(unittest.TestCase):
)
self.assertEqual(target, device / "LEDS.LED")
- self.assertEqual(read_led_program(target), "off\n#FF00FF pulse")
+ self.assertEqual(target.read_text(), "off\n#FF00FF pulse")
self.assertEqual((device / "LEDS.TXT").read_text(), "off")
def test_sidepulse_write_discovers_sidepulse_dot_volume(self) -> None:
@@ -3808,7 +3788,7 @@ class AgentMonitorTests(unittest.TestCase):
)
self.assertEqual(result, 0)
- self.assertEqual(read_led_program(device / "LEDS.LED"), "off\n#FF00FF pulse")
+ self.assertEqual((device / "LEDS.LED").read_text(), "off\n#FF00FF pulse")
def test_led_status_maps_agent_modes_to_programs(self) -> None:
self.assertEqual(
@@ -4160,7 +4140,7 @@ class AgentMonitorTests(unittest.TestCase):
self.assertEqual(result.state, LedDisplayState.WORKING)
self.assertEqual(result.target, device / "LEDS.LED")
self.assertEqual(
- read_led_program(device / "LEDS.LED"),
+ (device / "LEDS.LED").read_text(),
"off 320ms cosine\n"
"0:#00E5FF 760ms pulse 0ms; 1:#00E5FF 760ms pulse 260ms\n"
"repeat",
@@ -4169,14 +4149,14 @@ class AgentMonitorTests(unittest.TestCase):
write_mode_to_leds(AgentMode.IDLE_READY, device_path=device)
self.assertEqual(
- read_led_program(device / "LEDS.LED"),
+ (device / "LEDS.LED").read_text(),
"off 2s\n0:#006060 1:#006060 2s ease\nrepeat",
)
write_mode_to_leds(AgentMode.COMPLETED, device_path=device, brightness=64)
self.assertEqual(
- read_led_program(device / "LEDS.LED"),
+ (device / "LEDS.LED").read_text(),
"brightness 64\n#00FF66 320ms cosine",
)
@@ -4192,7 +4172,7 @@ class AgentMonitorTests(unittest.TestCase):
write_mode_to_leds(AgentMode.WORKING, device_path=device)
- lines = read_led_program(device / "LEDS.LED").splitlines()
+ lines = (device / "LEDS.LED").read_text().splitlines()
self.assertEqual(len(lines), 3)
self.assertEqual(lines[0], "off 320ms cosine")
self.assertIn("0:#00E5FF 760ms pulse 0ms", lines[1])
@@ -4213,7 +4193,7 @@ class AgentMonitorTests(unittest.TestCase):
self.assertTrue(first.changed)
self.assertFalse(second.changed)
self.assertTrue(third.changed)
- self.assertIn("#FF3A00 1.6s pulse", read_led_program(device / "LEDS.LED"))
+ self.assertIn("#FF3A00 1.6s pulse", (device / "LEDS.LED").read_text())
def test_agent_led_controller_repairs_externally_changed_program(self) -> None:
with tempfile.TemporaryDirectory() as tmp:
@@ -4234,7 +4214,7 @@ class AgentMonitorTests(unittest.TestCase):
)
self.assertTrue(repaired.changed)
- self.assertEqual(read_led_program(target), first.program)
+ self.assertEqual(target.read_text(), first.program)
def test_agent_led_controller_tracks_mode_and_animation_choice(self) -> None:
with tempfile.TemporaryDirectory() as tmp:
@@ -4264,7 +4244,7 @@ class AgentMonitorTests(unittest.TestCase):
self.assertTrue(kitt.changed)
self.assertTrue(custom_tool.changed)
self.assertFalse(unchanged.changed)
- self.assertEqual(read_led_program(device / "LEDS.LED"), "#123456")
+ self.assertEqual((device / "LEDS.LED").read_text(), "#123456")
def test_battery_parser_uses_adapter_watts_and_raw_capacity(self) -> None:
payload = plistlib.dumps(