Files
mapper/openspec/changes/mpvj-headless-control-center/specs/osc-bridge-api/spec.md
2026-03-10 20:48:09 +00:00

1.2 KiB

ADDED Requirements

Requirement: OSC Command Translation

The system SHALL provide a backend API that receives HTTP/WebSocket commands from the frontend and translates them into OSC (Open Sound Control) messages for ofxPiMapper.

Scenario: Vertex movement command

  • WHEN the API receives a /vertex/move request with (x, y) coordinates
  • THEN it SHALL send an OSC message to localhost:9999 using the /ofxPiMapper/vertex/move address

Requirement: Service Management

The system SHALL provide endpoints to start, stop, and restart the ofxPiMapper application process.

Scenario: Starting the mapper

  • WHEN the user triggers the "Start Mapper" action in the UI
  • THEN the API SHALL execute the system-level command ofxPiMapper -f (fullscreen) and return the process status

Requirement: Real-time Status Monitoring

The system SHALL monitor the Raspberry Pi 3B's system health (CPU, RAM, and temperature) and provide this data to the frontend for real-time visualization.

Scenario: Polling system health

  • WHEN the API is requested for health status
  • THEN it SHALL query /proc/loadavg, /proc/meminfo, and /sys/class/thermal/thermal_zone0/temp and return a JSON status object