Skip to content

Latest commit

 

History

History
39 lines (30 loc) · 2.89 KB

File metadata and controls

39 lines (30 loc) · 2.89 KB

Implementation map (this repository)

This file maps concerns to source files in MonitorControlSDK only. There is no out-of-tree dependency for building, testing, or documenting the shipped SDK.

Protocol and buffers

Concern Primary types
SDCP v3/v4 framing, errors SdcpMessageBuffer, SdcpErrorCodes
SDAP advertisement parse SdapAdvertisementPacket
VMS payload tree LegacyVmsContainer, VmsCommandEngine
VMC ASCII payloads LegacyVmcContainer
VMA binary payloads LegacyVmaContainer

Transport and clients

Concern Primary types
TCP SDCP SdcpConnection, StreamSdcpTransport, ISdcpTransport
UDP SDCP VMC broadcast SdcpUdpBroadcastTransport, VmcUdpBroadcastClient
UDP SDAP listen SdapDiscovery
Operator clients VmcClient, VmsClient, VmaClient

Operator surfaces

Surface Path
HTTP / JSON / Swagger / browser UI / SSE / WebSocket src/MonitorControl.Web/ (MonitorApiExtensions, MonitorPushEndpoints)
CLI src/MonitorControl.Cli/
Samples samples/
Python gateway (optional) examples/python-service/
MCU → HTTP bridge (optional) examples/arduino-knobs-brightness-contrast/
Control-flow diagrams docs/diagrams/monitor-control-flows.md
References ↔ shipped SDK (parity) docs/reference/references-parity.md
Appendix regeneration scripts/regen-appendices.sh

Documentation entry

Start at docs/index.md; for auditors, docs/handbook.md is the single narrative across protocol, implementation, and examples.