AMWA NMOS Device Control Mock Application
About NC-DEVICE-MOCK
This is a mock NMOS device written in Typescript and running on the NodeJS stack. It has support for the NMOS Modeling suite (MS-05-02 and IS-12 in particular).
It also has support for IS-04 and IS-05 with some limitations:
- It does not support DND-SD discovery and the NMOS registry endpoint has to be configured in the config.json file
- It does not support the IS-05 bulk API as it only has 1 receiver currently.
Installation
Note
: npm commands need to be executed from the /code
subfolder.
First install dependencies with
npm install
Modify the config.json properties for your configuration.
At the very least point registry_address
and registry_port
to the NMOS registry on your network.
Usage
Build and run with:
npm run build-and-start
If you plan to make changes and want the app to recompile and run whenever you save run with:
npm run serve
Configuration
These are the configuration keys which can be specified in the configuration file (config.json):
- notify_without_subscriptions - boolean flag which is set to false by default, but it can be set to true if you would like to get all notifications on all sessions without subscribing (for debugging purposes only).
- work_without_registry - boolean flag which is set to false by default, but it can be set to true if you would like the mock device not to attempt to register with an NMOS registry.
Specifications supported
- AMWA IS-04 NMOS Discovery and Registration
- AMWA IS-05 NMOS Device Connection Management
- AMWA IS-12 NMOS Control Protocol
- MS-05-01 NMOS Control Architecture
- MS-05-02 NMOS Control Framework
- BCP-002-02 NMOS Asset Distinguishing Information
NC-DEVICE-MOCK has been developed by the Advanced Media Workflow Association as part of the Networked Media Open Specifications initiative. See here for an overview of NMOS specifications.
The NMOS Testing Tool creates a simple web service for testing implementations of all NMOS APIs.
The links to documentation, API and examples below, and for SPEC links in the page menu bar are for this release or branch: branches/main. Links to other published releases and other live branches appear later in the page, or in the VERSIONS menu.
Documentation
Published Releases
Live Branches
These pages are rendered from the source of the specification, which is in this GitHub repository.
Repository | Default Branch | Lint (default) | Render (all) |
---|---|---|---|
nmos-device-control-mock | main |