Skip to content

Commit

Permalink
Switch HTML link to MD link for SDD images
Browse files Browse the repository at this point in the history
  • Loading branch information
thomas-bc committed Jan 15, 2025
1 parent 301e028 commit 0fff52d
Show file tree
Hide file tree
Showing 4 changed files with 14 additions and 42 deletions.
28 changes: 7 additions & 21 deletions Svc/Deframer/docs/sdd.md
Original file line number Diff line number Diff line change
Expand Up @@ -94,9 +94,7 @@ SVC-DEFRAMER-011 | `Svc::Deframer` shall operate nominally when its port for sen

The diagram below shows the `Deframer` component.

<div>
<img src="img/Deframer.png" width=700/>
</div>
![Deframer](img/Deframer.png)

### 4.2. Ports

Expand Down Expand Up @@ -348,24 +346,18 @@ optional.

**Topology 1a: Buffers containing framed data (active byte stream driver):**

<div>
<img src="img/top/framed-active.png" width=1000/>
</div>
![active](img/top/framed-active.png)

**Topology 1b: Buffers containing framed data (passive byte stream driver):**

<div>
<img src="img/top/framed-passive.png" width=1000/>
</div>
![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:**

<div>
<img src="img/top/cmd.png" width=800/>
</div>
![cmd](img/top/cmd.png)

Revise the port numbers of `cmdDisp.seqCmdBuff` and
`cmdDisp.compCmdStat` as appropriate for your application.
Expand All @@ -374,9 +366,7 @@ assign these numbers.

**Topology 3: Buffers containing packet data:**

<div>
<img src="img/top/deframer-file.png" width=1000/>
</div>
![file](img/top/deframer-file.png)

### 6.2. Sequence Diagrams

Expand Down Expand Up @@ -506,17 +496,13 @@ instance `hub` of type `Svc::GenericHub`.

**Topology 2: Command packets**

<div>
<img src="img/top/hub-cmd.png" width=800/>
</div>
![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**

<div>
<img src="img/top/hub-file.png" width=1000/>
</div>
![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
Expand Down
4 changes: 1 addition & 3 deletions Svc/DpManager/docs/sdd.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,9 +41,7 @@ SVC-DPMANAGER-004 | `Svc::DpManager` shall provide telemetry that reports the nu

The diagram below shows the `DpManager` component.

<div>
<img src="img/DpManager.png" width=700/>
</div>
![DpManager](img/DpManager.png)

### 3.2. Ports

Expand Down
8 changes: 2 additions & 6 deletions Svc/DpWriter/docs/sdd.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,9 +42,7 @@ SVC-DPWRITER-006 | `Svc::DpManager` shall provide telemetry that reports the num

The diagram below shows the `DpWriter` component.

<div>
<img src="img/DpWriter.png" width=700/>
</div>
![DpWriter](img/DpWriter.png)

### 3.2. Ports

Expand Down Expand Up @@ -205,9 +203,7 @@ The diagrams use the following instances:

* `producer`: A component that produces data products.

<div>
<img src="./img/top/product-write.png" width=800/>
</div>
![product-write](./img/top/product-write.png)

### 6.2. Sequence Diagrams

Expand Down
16 changes: 4 additions & 12 deletions Svc/Framer/docs/sdd.md
Original file line number Diff line number Diff line change
Expand Up @@ -192,25 +192,19 @@ The diagrams use the following instances:

**Topology 1: Telemetry packets:**

<div>
<img src="img/top/tlm.png" width=1000/>
</div>
![tlm](img/top/tlm.png)

The `chanTlm` instance sends telemetry packets to the `framer` instance.

**Topology 2: Event packets:**

<div>
<img src="img/top/event.png" width=1000/>
</div>
![event](img/top/event.png)

The `eventLogger` instance sends event packets to the `framer` instance.

**Topology 3: File packets:**

<div>
<img src="img/top/framer-file.png" width=1000/>
</div>
![file](img/top/framer-file.png)

The `fileDownlink` instance sends a sequence of file packets,
representing a complete file, to the `framer` instance.
Expand All @@ -231,9 +225,7 @@ can handle the packets.

**Topology 4: Framed data:**

<div>
<img src="img/top/framed.png" width=1000/>
</div>
![framed](img/top/framed.png)

`framer` allocates frame buffers from `buffMgr`.
It sends buffers containing frames to `comm`.
Expand Down

0 comments on commit 0fff52d

Please sign in to comment.