Skip to content

Commit 6a6102b

Browse files
Update and refactor (#22)
* Update diagrams * Add BCP-008 references * Add section fo Status monitors and correct commands and responses based on latest mock-device * Add checklist section * Add Status monitors section * Refactor heading * Show Receiver monitor example instead of a generic one * Remove blank line * Split checklist in 2 sections * Add quick checklist * Refactor and add new Status monitors section * Use links with "latest" tag wherever possible * Fix linting issues * Rewording * Remove "Device specific" line as already covered by sentence above * Add references to the testing tool and nmos-cpp * Use specs.awma.tv link for nmos-testing * Simplify Co-authored-by: jonathan-r-thorpe <[email protected]> * Fix "relevant" repetition Co-authored-by: jonathan-r-thorpe <[email protected]> * Better readability Co-authored-by: jonathan-r-thorpe <[email protected]> * Use correct terminology Co-authored-by: jonathan-r-thorpe <[email protected]> --------- Co-authored-by: jonathan-r-thorpe <[email protected]>
1 parent d8873b7 commit 6a6102b

9 files changed

+435
-330
lines changed

docs/Controller implementation tutorial.md

Lines changed: 105 additions & 52 deletions
Large diffs are not rendered by default.

docs/Device implementation tutorial.md

Lines changed: 78 additions & 26 deletions
Large diffs are not rendered by default.

docs/How To practical examples.md

Lines changed: 240 additions & 248 deletions
Large diffs are not rendered by default.

docs/Tutorials.md

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,24 +5,32 @@
55
- This will be replaced with a table of contents
66
{:toc}
77

8-
This Implementation Guide aims to present implementers with a launchpad to propel their MS-05 / IS-12 implementations quickly off the ground.
8+
This Implementation Guide aims to present implementers with a launchpad to propel their MS-05 / IS-12 / BCP-008 implementations quickly off the ground.
99

10-
Target specifications:
10+
The guide targets the following specifications:
1111

1212
- [MS-05-01 NMOS Control Architecture](https://specs.amwa.tv/ms-05-01)
1313
- [MS-05-02 NMOS Control Framework](https://specs.amwa.tv/ms-05-02)
1414
- [AMWA IS-12 NMOS Control Protocol](https://specs.amwa.tv/is-12)
15+
- [AMWA BCP-008-01 NMOS Receiver Status](https://specs.amwa.tv/bcp-008-01)
16+
- [AMWA BCP-008-02 NMOS Sender Status](https://specs.amwa.tv/bcp-008-02)
1517

16-
`Note:` This guide assumes some previous familiarity with two existing NMOS specifications:
18+
Guidance sections will include links to relevant sections of these specifications.
19+
20+
This guide also assumes some previous familiarity with two existing NMOS specifications:
1721

1822
- [AMWA IS-04 NMOS Discovery and Registration](https://specs.amwa.tv/is-04)
1923
- [AMWA IS-05 NMOS Device Connection Management](https://specs.amwa.tv/is-05)
2024

21-
Resources:
25+
The following resources will be used in later sections of this guide:
2226

2327
- [NMOS Device control mock](https://github.com/AMWA-TV/nmos-device-control-mock)
2428
- [Browser WebSocket extensions](https://chrome.google.com/webstore/search/websocket)
2529

30+
A comprehensive testing tool is available in the form of the [NMOS API Testing Tool](https://specs.amwa.tv/nmos-testing).
31+
32+
An open source media node framework is available in the form of [nmos-cpp](https://github.com/sony/nmos-cpp).
33+
2634
>The Guide is a living document and suggestions, corrections or other input is welcome at all times.
2735
>
2836
> To provide feedback, please create an issue at <https://github.com/AMWA-TV/info-006/issues>. We look forward to your feedback.

docs/images/command-example.png

3.2 KB
Loading
2.33 KB
Loading

docs/images/identities.png

29.4 KB
Loading
2.62 KB
Loading
63.7 KB
Loading

0 commit comments

Comments
 (0)