From 599a9c66cb29c7e25833a7033d8225eb6985ea9a Mon Sep 17 00:00:00 2001 From: howels Date: Tue, 27 Dec 2022 02:11:21 +0000 Subject: [PATCH] Add MSP displayport HD OSD flow diagrams (#12092) --- docs/API/DisplayPort.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/docs/API/DisplayPort.md b/docs/API/DisplayPort.md index e0d7c66f07..e93239b688 100644 --- a/docs/API/DisplayPort.md +++ b/docs/API/DisplayPort.md @@ -17,6 +17,15 @@ The MSP\_SET\_OSD\_CANVAS command is sent by the VTX, or display device, to the | canvas_cols | uint8 | The number of columns | | canvas_rows | uint8 | The number of rows | +```mermaid +sequenceDiagram + participant FC + participant VTX + FC->>VTX: MSP_DP_HEARTBEAT sent and detected + VTX->>FC: MSP_SET_OSD_CANVAS set rows/columns + FC->>VTX: MSP request success +``` + ### MSP\_OSD\_CANVAS The MSP\_OSD\_CANVAS command is sent by the configurator to the FC to determine the size of the canvas available to the DisplayPort rendering when in HD mode. This is then used on the OSD tab to show the correct number of rows/columns when editing the OSD element positions. @@ -32,6 +41,16 @@ Response is two bytes. | canvas_cols | uint8 | The number of columns | | canvas_rows | uint8 | The number of rows | +```mermaid +sequenceDiagram + participant FC + participant Configurator + participant Preview + Configurator->>FC: Configurator connects to FC + Configurator->>FC: MSP_OSD_CANVAS get rows/columns + Configurator->>Preview: OSD Preview pane resized +``` + ### MSP\_DISPLAYPORT The MSP\_DISPLAYPORT command is sent by the FC to the display device/VTX to perform a DisplayPort operation.