Appendix
10. Appendix
This section contains supporting information, definitions, and forward-looking notes to supplement the main API specification.
Glossary
- OSS8: Optical Sensor System, version 8 — the hardware device sending sensor data and images.
- W3S: WebSocket Secure Server — the backend middleware responsible for routing, validating, and authorizing all messages.
- Client: Any user interface, app, or system that connects to W3S to interact with one or more OSS8 devices.
- MessageTypeId: A string identifier used to classify and validate message contents and enforce access control.
- DeviceId: The globally unique identifier of a physical OSS8 device.
- Payload: The data block contained within a message. May include structured fields or metadata about binary content.
Reserved MessageTypeId Ranges
MessageTypeIds may be structured or grouped into ranges based on function or origin. Reserved or internal types include:
INTERNAL_*: Used only within W3S and not forwarded to clients or devices.DEBUG_*: Used for development, testing, or diagnostic purposes only.OSS_IMAGE_FRAME: Reserved for binary image transfer messages.
Notes on Binary Encoding Conventions
- Binary messages must use JPEG XL in near-lossless mode.
- All binary messages must include a structured JSON header.
- The header must be valid UTF-8 and include a length prefix.
Future Extensions & Roadmap
Potential additions under consideration:
- Support for delta encoding between image frames
- Hash verification fields in binary headers
- Client-side role introspection endpoints
- Expanded schema constraint language for roles
This section is subject to updates as the system evolves.