Skip to content

Commit

Permalink
Add diagrams
Browse files Browse the repository at this point in the history
  • Loading branch information
cristian-recoseanu committed Dec 9, 2024
1 parent 486d99c commit b0426d2
Show file tree
Hide file tree
Showing 4 changed files with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions docs/Overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,10 @@ The `statusReportingDelay` property allows clients to customize the reporting de

* Once any Sender activation `statusReportingDelay` has elapsed and the Sender isn't being [deactivated](#deactivating-a-sender), all domain specific statuses MUST delay the transition to a more healthy state by the configured `statusReportingDelay` value and MUST only make the transition if the healthier state is maintained for the duration. All domain specific statuses MUST make a transition to a less healthy state without delay.

| ![Status reporting delay](images/status-reporting-delay.png) |
|:--:|
| _**Status reporting delay**_ |

### Sender overall status

The purpose of the overallStatus is to abstract and combine the specific domain statuses of a monitor into a single status which can be more easily observed and displayed by a simple client.
Expand All @@ -81,6 +85,10 @@ Devices MUST follow the rules listed below when mapping specific domain statuses
* When the Sender is Active the overallStatus takes the worst state across the different domains (if one status is PartiallyHealthy (or equivalent) and another is Unhealthy (or equivalent) then the overallStatus would be Unhealthy)
* The overallStatus is Healthy only when all domain statuses are either Healthy or a neutral state (e.g. Not used)

| ![Overall status mapping examples](images/overall-status.png) |
|:--:|
| _**Overall status mapping examples**_ |

### Sender connectivity

[NcSenderMonitor](https://specs.amwa.tv/nmos-control-feature-sets/branches/publish-status-reporting/monitoring/#ncsendermonitor) includes the following specific items covering the connectivity domain:
Expand Down Expand Up @@ -256,6 +264,10 @@ When a sender is being deactivated it MUST cleanly interrupt its transmission by
* transmissionStatus
* essenceStatus

| ![Deactivation transition example](images/deactivation.png) |
|:--:|
| _**Deactivation transition example**_ |

### Touchpoints and IS-04 senders

Sender monitors make use of the [Touchpoints](https://specs.amwa.tv/ms-05-02/latest/docs/NcObject.html#touchpoints) mechanism inherited from [NcObject](https://specs.amwa.tv/ms-05-02/latest/docs/NcObject.html) to attach to the correct sender identity.
Expand Down
Binary file added docs/images/deactivation.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/overall-status.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/status-reporting-delay.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit b0426d2

Please sign in to comment.