Skip to content

Commit

Permalink
Update Overview.md
Browse files Browse the repository at this point in the history
with initial structure
  • Loading branch information
cristian-recoseanu committed May 8, 2024
1 parent 0066dbd commit 913e1b0
Showing 1 changed file with 33 additions and 30 deletions.
63 changes: 33 additions & 30 deletions docs/Overview.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# AMWA NMOS Best Common Practice Template: Overview
# AMWA BCP-00X-0X: Receiver status monitoring
{:.no_toc}

* A markdown unordered list which will be replaced with the ToC, excluding the "Contents header" from above
Expand All @@ -8,34 +8,24 @@ _(c) AMWA 2021, CC Attribution-NoDerivatives 4.0 International (CC BY-ND 4.0)_

![NMOS logo](images/NMOS-logo.png)

> ## Instructions
>
> **Delete this section after creating a new repo from this template.**
>
>Use this template repo to create a new AMWA NMOS Best Common Practice repo.
>
> Add your content as (GitHub Flavoured) Markdown documents.
>
> - For consistency with other specifications, keep this `Overview.md` but remove these Instructions.
>
> Put diagrams (ideally PNG with encapsulated draw.io source) in the `images/` sub-directory.
>
> Follow the [Style Guide](Style%20Guide.md).
>
> Make a bulleted list of documents in `README.md` in this directory.
>
> Set the repo name used to get the Lint and Render status in the top-level `README.md` (four changes needed).
>
> Set the value of `amwa_id` in `.render/_config.yml` to the AMWA-assigned ID.
## Introduction

> Provide an overview of the Specification.
The aim of this BCP document is to describe the expectations, behaviour and conformance requirements for Devices with stream Receivers in terms of status monitoring.

This document relies on previous familiarity with the following existing documents:

Familiarity with the [JT-NM Reference Architecture](https://jt-nm.org/reference-architecture/) is assumed.
* [NMOS Control Framework](https://specs.amwa.tv/ms-05-02/)
* [NMOS Control Protocol](https://specs.amwa.tv/is-12/)
* [NMOS Discovery and Registration](https://specs.amwa.tv/is-04/)
* [NMOS Device Connection Management](https://specs.amwa.tv/is-05/)

See also the [NMOS Technical Overview](https://specs.amwa.tv/nmos/main/docs/Technical_Overview.html).
The technical models referenced in this document are fully published in the [Monitoring NMOS Control Feature Set](https://specs.amwa.tv/nmos-control-feature-sets/branches/publish-status-reporting/monitoring/).

The following domains are covered in terms of status monitoring with specific sections for each:

* [Receiver connectivity](#receiver-connectivity)
* [Receiver synchronization](#receiver-synchronization)
* [Receiver stream validation](#receiver-stream-validation)

## Use of Normative Language

Expand All @@ -44,14 +34,27 @@ and "OPTIONAL" in this document are to be interpreted as described in [RFC 2119]

## Definitions

The NMOS terms 'Node', ... are used as defined in the [NMOS Glossary](https://specs.amwa.tv/nmos/main/docs/Glossary.html).
The NMOS terms 'Controller', 'Node', 'Source', 'Flow', 'Sender', 'Receiver' are used as defined in the [NMOS Glossary](https://specs.amwa.tv/nmos/main/docs/Glossary.html).

## Prerequisites

Devices in conformance to this BCP MUST use [NMOS Control Framework](https://specs.amwa.tv/ms-05-02/) for generating device models.
Devices in conformance to this BCP MUST use [NMOS Control Protocol](https://specs.amwa.tv/is-12/) to expose device models via a standard API with full support for notifications.
Devices in conformance to this BCP MUST use [NMOS Discovery and Registration](https://specs.amwa.tv/is-04/) to create and register Nodes, Devices and Receiver resources.
Devices in conformance to this BCP MUST use [NMOS Device Connection Management](https://specs.amwa.tv/is-05/) to perform connection management actions against Receiver resources.

## Receiver overall status

Document overall status model and intention.

## Receiver connectivity

> List as appropriate
Document models specific to connectivity and behaviour.

This specification also defines the following terms.
## Receiver synchronization

### Example Term
Document models specific to synchronization and behaviour.

Example definition
## Receiver stream validation

[RFC-2119]: https://tools.ietf.org/html/rfc2119 "Key words for use in RFCs"
Document models specific to stream validation and behaviour.

0 comments on commit 913e1b0

Please sign in to comment.