From 0fff52d67b0e8a6f3c8566c4ef5ae8fc19af3133 Mon Sep 17 00:00:00 2001 From: thomas-bc Date: Wed, 15 Jan 2025 13:25:07 -0800 Subject: [PATCH] Switch HTML link to MD link for SDD images --- Svc/Deframer/docs/sdd.md | 28 +++++++--------------------- Svc/DpManager/docs/sdd.md | 4 +--- Svc/DpWriter/docs/sdd.md | 8 ++------ Svc/Framer/docs/sdd.md | 16 ++++------------ 4 files changed, 14 insertions(+), 42 deletions(-) diff --git a/Svc/Deframer/docs/sdd.md b/Svc/Deframer/docs/sdd.md index 265b18585c6..5c4acf2719f 100644 --- a/Svc/Deframer/docs/sdd.md +++ b/Svc/Deframer/docs/sdd.md @@ -94,9 +94,7 @@ SVC-DEFRAMER-011 | `Svc::Deframer` shall operate nominally when its port for sen The diagram below shows the `Deframer` component. -
- -
+![Deframer](img/Deframer.png) ### 4.2. Ports @@ -348,24 +346,18 @@ optional. **Topology 1a: Buffers containing framed data (active byte stream driver):** -
- -
+![active](img/top/framed-active.png) **Topology 1b: Buffers containing framed data (passive byte stream driver):** -
- -
+![passive](img/top/framed-passive.png) Revise the port number of `rateGroup.RateGroupMemberOut` as appropriate for your application. **Topology 2: Command packets and command responses:** -
- -
+![cmd](img/top/cmd.png) Revise the port numbers of `cmdDisp.seqCmdBuff` and `cmdDisp.compCmdStat` as appropriate for your application. @@ -374,9 +366,7 @@ assign these numbers. **Topology 3: Buffers containing packet data:** -
- -
+![file](img/top/deframer-file.png) ### 6.2. Sequence Diagrams @@ -506,17 +496,13 @@ instance `hub` of type `Svc::GenericHub`. **Topology 2: Command packets** -
- -
+![hub-cmd](img/top/hub-cmd.png) Revise the port number of `hub.portIn` as appropriate for your application. **Topology 3: Buffers containing packet data** -
- -
+![file](img/top/hub-file.png) Revise the port number of `hub.buffersIn` as appropriate for your application. When `hub` receives a buffer on `buffersIn`, it copies the data across diff --git a/Svc/DpManager/docs/sdd.md b/Svc/DpManager/docs/sdd.md index 2ce37db6852..a9259b67640 100644 --- a/Svc/DpManager/docs/sdd.md +++ b/Svc/DpManager/docs/sdd.md @@ -41,9 +41,7 @@ SVC-DPMANAGER-004 | `Svc::DpManager` shall provide telemetry that reports the nu The diagram below shows the `DpManager` component. -
- -
+![DpManager](img/DpManager.png) ### 3.2. Ports diff --git a/Svc/DpWriter/docs/sdd.md b/Svc/DpWriter/docs/sdd.md index 59c5b0d9026..ebe8c3799ad 100644 --- a/Svc/DpWriter/docs/sdd.md +++ b/Svc/DpWriter/docs/sdd.md @@ -42,9 +42,7 @@ SVC-DPWRITER-006 | `Svc::DpManager` shall provide telemetry that reports the num The diagram below shows the `DpWriter` component. -
- -
+![DpWriter](img/DpWriter.png) ### 3.2. Ports @@ -205,9 +203,7 @@ The diagrams use the following instances: * `producer`: A component that produces data products. -
- -
+![product-write](./img/top/product-write.png) ### 6.2. Sequence Diagrams diff --git a/Svc/Framer/docs/sdd.md b/Svc/Framer/docs/sdd.md index 0b058906b8e..29021ac8b47 100644 --- a/Svc/Framer/docs/sdd.md +++ b/Svc/Framer/docs/sdd.md @@ -192,25 +192,19 @@ The diagrams use the following instances: **Topology 1: Telemetry packets:** -
- -
+![tlm](img/top/tlm.png) The `chanTlm` instance sends telemetry packets to the `framer` instance. **Topology 2: Event packets:** -
- -
+![event](img/top/event.png) The `eventLogger` instance sends event packets to the `framer` instance. **Topology 3: File packets:** -
- -
+![file](img/top/framer-file.png) The `fileDownlink` instance sends a sequence of file packets, representing a complete file, to the `framer` instance. @@ -231,9 +225,7 @@ can handle the packets. **Topology 4: Framed data:** -
- -
+![framed](img/top/framed.png) `framer` allocates frame buffers from `buffMgr`. It sends buffers containing frames to `comm`.