Developer_release_1.4.0

Class `lua-repl.lib.rest.nmos.node.api`

Node REST API wrapper.

Overview

The Node API is exposed by each NMOS Node in a system, regardless of whether it is possible for that Node to provide NMOS resources such as Flows, Sources etc. Data exposed by the Node API is used to populate the (distributed) registry via the Registration API. In smaller deployments the Node API is fetched from directly as required by Nodes which implement the peer-to-peer specification.

Further Documentation

Further normative documentation covering the behaviour of this API is contained in the [docs](../docs) folder of this repository.

Methods

api.devices[deviceId]:get ()	Get a single Device.
api.devices:get ()	List Devices.
api.flows[flowId]:get ()	Get a single Flow.
api.flows:get ()	List Flows.
api.receivers[receiverId].target:options ()	A pre-flight check generally used for Cross-Origin Resource Sharing (CORS) purposes.
api.receivers[receiverId].target:put (payload)	Request a change to a Receiver's subscription (deprecated).
api.receivers[receiverId]:get ()	Get a single Receiver.
api.receivers[receiverId]:options_target ()	A pre-flight check generally used for Cross-Origin Resource Sharing (CORS) purposes.
api.receivers[receiverId]:put_target (payload)	Request a change to a Receiver's subscription (deprecated).
api.receivers:get ()	List Receivers.
api.self:get ()	Get information about this Node.
api.senders[senderId]:get ()	Get a single Sender.
api.senders:get ()	List Senders.
api.sources[sourceId]:get ()	Get a single Source.
api.sources:get ()	List Sources.
lua-repl.lib.rest.nmos.node.api:get ()	List of paths available from this API.
lua-repl.lib.rest.nmos.node.api:get_devices ()	List Devices.
lua-repl.lib.rest.nmos.node.api:get_flows ()	List Flows.
lua-repl.lib.rest.nmos.node.api:get_receivers ()	List Receivers.
lua-repl.lib.rest.nmos.node.api:get_self ()	Get information about this Node.
lua-repl.lib.rest.nmos.node.api:get_senders ()	List Senders.
lua-repl.lib.rest.nmos.node.api:get_sources ()	List Sources.

Methods

api.devices[deviceId]:get ()

Get a single Device.

deviceId: (string) Must match the pattern: /^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$/.

Returns:

table/Device

Describes a Device. +

(string) Detailed description of the resource.

(string) Globally unique identifier for the resource. Must match the pattern: /^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$/.

(string) Freeform string label for the resource.

(table/resource_core) Key value set of freeform string tags to aid in filtering resources. Values should be represented as an array of strings. Can be empty.

(string) String formatted TAI timestamp (<seconds>:<nanoseconds>) indicating precisely when an attribute of the resource last changed. Must match the pattern: /^[0-9]+:[0-9]+$/.

controls: (array of items) Control endpoints exposed for the Device. +

item: (table/device) +

item.authorization: (boolean) This endpoint requires authorization.

item.href: (string/uri) URL to reach a control endpoint, whether http or otherwise.

item.type: (string/uri) URN identifying the control format.

(string) Globally unique identifier for the Node which initially created the Device. This attribute is used to ensure referential integrity by registry implementations. Must match the pattern: /^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$/.

receivers: (array of items) UUIDs of Receivers attached to the Device (deprecated). +

item: (string) Must match the pattern: /^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$/.

senders: (array of items) UUIDs of Senders attached to the Device (deprecated). +

item: (string) Must match the pattern: /^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$/.

type: Device type URN. Possible content:

(string) Must match the pattern: /^urn:x-nmos:device:/.

(any)

{
   controls =
   {
     {
       href = "ws://182.54.54.75:223";
       type = "urn:x-manufacturer:control:generic";
     };
     {
       href = "http://134.24.64.22/x-manufacturer/control/";
       type = "urn:x-manufacturer:control:generic";
     };
     {
       href = "telnet://120.43.64.3:8080";
       type = "urn:x-manufacturer:control:legacy";
     };
   };
   description = "pipeline 1 default device";
   id = "67c25159-ce25-4000-a66c-f31fff890265";
   label = "pipeline 1 default device";
   node_id = "3b8be755-08ff-452b-b217-c9151eb21193";
   receivers = { };
   senders = { };
   tags = { };
   type = "urn:x-nmos:device:pipeline";
   version = "1441703338:962976113";
 }

Or

table/Error

result.code: (number/integer) HTTP error code. Minimum: 400. Maximum: 599.

result.debug: (nil | string) Debug information which may assist a programmer working with the API.

result.error: (string) Human readable message which is suitable for user interface display, and helpful to the user.

Or

table/Error

result.code: (number/integer) HTTP error code. Minimum: 400. Maximum: 599.

result.debug: (nil | string) Debug information which may assist a programmer working with the API.

result.error: (string) Human readable message which is suitable for user interface display, and helpful to the user.

api.devices:get ()

List Devices.

Returns:

table/Devices

result.nil: (array of items) Collection of Devices. A list of Device resources. +
- item: Describes a Device. +

{
   {
     controls =
     {
       {
         authorization = false;
         href = "wss://154.67.63.2:4535";
         type = "urn:x-manufacturer:control:generic";
       };
     };
     description = "pipeline 3 default device";
     id = "9126cc2f-4c26-4c9b-a6cd-93c4381c9be5";
     label = "pipeline 3 default device";
     node_id = "3b8be755-08ff-452b-b217-c9151eb21193";
     receivers = { };
     senders = { "d7aa5a30-681d-4e72-92fb-f0ba0f6f4c3e" };
     tags = { };
     type = "urn:x-nmos:device:pipeline";
     version = "1441704616:592733242";
   };
   {
     controls =
     {
       {
         href = "ws://182.54.54.75:223";
         type = "urn:x-manufacturer:control:generic";
       };
       {
         href = "http://134.24.64.22/x-manufacturer/control/";
         type = "urn:x-manufacturer:control:generic";
       };
       {
         href = "telnet://120.43.64.3:8080";
         type = "urn:x-manufacturer:control:legacy";
       };
     };
     description = "pipeline 1 default device";
     id = "67c25159-ce25-4000-a66c-f31fff890265";
     label = "pipeline 1 default device";
     node_id = "3b8be755-08ff-452b-b217-c9151eb21193";
     receivers = { };
     senders = { };
     tags = { };
     type = "urn:x-nmos:device:pipeline";
     version = "1441703338:962976113";
   };
   {
     controls = { };
     description = "pipeline 2 default device";
     id = "05017e08-b329-45f9-a566-a3f99cc11e4d";
     label = "pipeline 2 default device";
     node_id = "3b8be755-08ff-452b-b217-c9151eb21193";
     receivers = { "1eb53d65-ac83-441c-86f6-9b27df30ef0c" };
     senders = { };
     tags = { };
     type = "urn:x-nmos:device:pipeline";
     version = "1441704514:993221361";
   };
 }

api.flows[flowId]:get ()

Get a single Flow.

flowId: (string) Must match the pattern: /^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$/.

Returns:

table/Flow

{
   colorspace = "BT709";
   components =
   {
     { bit_depth = 10, height = 1080, name = "Y", width = 1920 };
     { bit_depth = 10, height = 1080, name = "Cb", width = 960 };
     { bit_depth = 10, height = 1080, name = "Cr", width = 960 };
   };
   description = "Test Card";
   device_id = "9126cc2f-4c26-4c9b-a6cd-93c4381c9be5";
   format = "urn:x-nmos:format:video";
   frame_height = 1080;
   frame_width = 1920;
   id = "5fbec3b1-1b0f-417d-9059-8b94a47197ed";
   interlace_mode = "interlaced_tff";
   label = "Test Card";
   media_type = "video/raw";
   parents = { };
   source_id = "02c46999-d532-4c52-905f-2e368a2af6cb";
   tags = { };
   version = "1441704616:587121295";
 }

Or

table/Error

result.code: (number/integer) HTTP error code. Minimum: 400. Maximum: 599.

result.debug: (nil | string) Debug information which may assist a programmer working with the API.

result.error: (string) Human readable message which is suitable for user interface display, and helpful to the user.

Or

table/Error

result.code: (number/integer) HTTP error code. Minimum: 400. Maximum: 599.

result.debug: (nil | string) Debug information which may assist a programmer working with the API.

result.error: (string) Human readable message which is suitable for user interface display, and helpful to the user.

api.flows:get ()

List Flows.

Returns:

table/Flows

result.nil: (array of items) Collection of Flows. A list of Flow resources. +
- item: Describes a Flow. Possible content: +
  - item: Describes a raw Video Flow. +
  - item: Describes a coded Video Flow. +
  - item: Describes a raw audio Flow. +
  - item: Describes a coded audio Flow. +
  - item: Describes a generic data Flow. +
  - item: Describes an SDI ancillary Flow. +
  - item: Describes a JSON based Flow. +
  - item: Describes a mux Flow. +

{
   {
     colorspace = "BT709";
     components =
     {
       { bit_depth = 10, height = 1080, name = "Y", width = 1920 };
       { bit_depth = 10, height = 1080, name = "Cb", width = 960 };
       { bit_depth = 10, height = 1080, name = "Cr", width = 960 };
     };
     description = "Test Card";
     device_id = "9126cc2f-4c26-4c9b-a6cd-93c4381c9be5";
     format = "urn:x-nmos:format:video";
     frame_height = 1080;
     frame_width = 1920;
     id = "5fbec3b1-1b0f-417d-9059-8b94a47197ed";
     interlace_mode = "interlaced_tff";
     label = "Test Card";
     media_type = "video/raw";
     parents = { };
     source_id = "02c46999-d532-4c52-905f-2e368a2af6cb";
     tags = { };
     version = "1441704616:587121295";
   };
   {
     description = "VANC Data";
     device_id = "9126cc2f-4c26-4c9b-a6cd-93c4381c9be5";
     format = "urn:x-nmos:format:data";
     id = "db3bd465-2772-484f-8fac-830b0471258b";
     label = "VANC Data";
     media_type = "video/smpte291";
     parents = { };
     source_id = "0e635152-e501-4d4e-bb87-9f3fe05eb79a";
     tags = { };
     version = "1453880607:123995943";
   };
   {
     description = "TR-04 Video";
     device_id = "9126cc2f-4c26-4c9b-a6cd-93c4381c9be5";
     format = "urn:x-nmos:format:mux";
     id = "4857f747-96cf-4ed7-8f4b-9497199f1f25";
     label = "TR-04 Video";
     media_type = "video/SMPTE2022-6";
     parents = { };
     source_id = "782fac41-17f6-4a21-8186-57ba63a1a8d3";
     tags = { };
     version = "1453880607:123995943";
   };
   {
     description = "IS-07 Temperature Readings (C)";
     device_id = "9126cc2f-4c26-4c9b-a6cd-93c4381c9be5";
     event_type = "number/temperature/C";
     format = "urn:x-nmos:format:data";
     id = "6327c381-1239-41d1-b314-efc719600e26";
     label = "IS-07 Temperature Readings (C)";
     media_type = "application/json";
     parents = { };
     source_id = "33e28c6f-d5ab-4ae5-b00d-f1cccab29af4";
     tags = { };
     version = "1453880605:374934072";
   };
   {
     description = "IS-07 Temperature Readings (F)";
     device_id = "9126cc2f-4c26-4c9b-a6cd-93c4381c9be5";
     event_type = "number/temperature/F";
     format = "urn:x-nmos:format:data";
     id = "6327c381-1239-41d1-b314-efc719600e26";
     label = "IS-07 Temperature Readings (F)";
     media_type = "application/json";
     parents = { };
     source_id = "33e28c6f-d5ab-4ae5-b00d-f1cccab29af4";
     tags = { };
     version = "1453880605:374934072";
   };
   {
     description = "IS-07 Button";
     device_id = "9126cc2f-4c26-4c9b-a6cd-93c4381c9be5";
     event_type = "boolean";
     format = "urn:x-nmos:format:data";
     id = "fa6258b9-2826-4a0d-81d0-7da9edbc405f";
     label = "IS-07 Button";
     media_type = "application/json";
     parents = { };
     source_id = "c8d27a1d-d124-4d06-bc43-312fd36f7db1";
     tags = { };
     version = "1453880605:374934072";
   };
 }

api.receivers[receiverId].target:options ()

A pre-flight check generally used for Cross-Origin Resource Sharing (CORS) purposes.

Returns:

table

result

result.body: (string) Empty string.

result.status: (number) 200.

Or

table

result

result.body: (string) Empty string.

result.status: (number) 403.

api.receivers[receiverId].target:put (payload)

Request a change to a Receiver's subscription (deprecated).

Parameters:

payload (table) nil
args.payload: Describes the possible requests to a Node's Receiver target resource. Possible content:
- sender: Describes a sender. +
- (table/nodeapi_receiver_target) Describes an empty object. +

Returns:

table/ReceiverTarget

Describes the possible requests to a Node's Receiver target resource. Possible content:
- alt1: Describes a sender. +
- (table/nodeapi_receiver_target) Describes an empty object. +

{
   caps = { };
   description = "Test Card";
   device_id = "9126cc2f-4c26-4c9b-a6cd-93c4381c9be5";
   flow_id = "5fbec3b1-1b0f-417d-9059-8b94a47197ed";
   id = "d7aa5a30-681d-4e72-92fb-f0ba0f6f4c3e";
   interface_bindings = { "eth0", "eth1" };
   label = "Test Card";
   manifest_href = "http://172.29.80.65/x-manufacturer/senders/d7aa5a30-681d-4e72-92fb-f0ba0f6f4c3e/stream.sdp";
   subscription = { active = true };
   tags = { };
   transport = "urn:x-nmos:transport:rtp.mcast";
   version = "1441704616:890020555";
 }

Or

table/Error

result.code: (number/integer) HTTP error code. Minimum: 400. Maximum: 599.

result.debug: (nil | string) Debug information which may assist a programmer working with the API.

result.error: (string) Human readable message which is suitable for user interface display, and helpful to the user.

Or

table/Error

result.code: (number/integer) HTTP error code. Minimum: 400. Maximum: 599.

result.debug: (nil | string) Debug information which may assist a programmer working with the API.

result.error: (string) Human readable message which is suitable for user interface display, and helpful to the user.

Or

table/Error

result.code: (number/integer) HTTP error code. Minimum: 400. Maximum: 599.

result.debug: (nil | string) Debug information which may assist a programmer working with the API.

result.error: (string) Human readable message which is suitable for user interface display, and helpful to the user.

Or

table/Error

result.code: (number/integer) HTTP error code. Minimum: 400. Maximum: 599.

result.debug: (nil | string) Debug information which may assist a programmer working with the API.

result.error: (string) Human readable message which is suitable for user interface display, and helpful to the user.

Usage:

node = require "lua-repl.lib.rest.nmos.node"
api = node:create_api("http://node.nmos.acme.example.com")
payload =
{
  caps = { };
  description = "Test Card";
  device_id = "9126cc2f-4c26-4c9b-a6cd-93c4381c9be5";
  flow_id = "5fbec3b1-1b0f-417d-9059-8b94a47197ed";
  id = "d7aa5a30-681d-4e72-92fb-f0ba0f6f4c3e";
  interface_bindings = { "eth0", "eth1" };
  label = "Test Card";
  manifest_href = "http://172.29.80.65/x-manufacturer/senders/d7aa5a30-681d-4e72-92fb-f0ba0f6f4c3e/stream.sdp";
  subscription = { active = true };
  tags = { };
  transport = "urn:x-nmos:transport:rtp.mcast";
  version = "1441704616:890020555";
}
result = api.receivers[receiverId].target:put(payload)

api.receivers[receiverId]:get ()

Get a single Receiver.

receiverId: (string) Must match the pattern: /^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$/.

Returns:

table/Receiver

Describes a Receiver. Possible content:
- receiver_video: Describes a video Receiver. +
- receiver_audio: Describes an audio Receiver. +
- receiver_data: Describes a data Receiver. +
- receiver_mux: Describes a mux Receiver. +

{
   caps =
   {
     media_types = { "video/raw" };
   };
   description = "";
   device_id = "05017e08-b329-45f9-a566-a3f99cc11e4d";
   format = "urn:x-nmos:format:video";
   id = "1eb53d65-ac83-441c-86f6-9b27df30ef0c";
   interface_bindings = { "eth0", "eth1" };
   label = "RTPRx";
   subscription = { active = true, sender_id = "2683ad14-642f-459d-a169-ef91c76cec6b" };
   tags = { };
   transport = "urn:x-nmos:transport:rtp";
   version = "1441704532:450093308";
 }

Or

table/Error

result.code: (number/integer) HTTP error code. Minimum: 400. Maximum: 599.

result.debug: (nil | string) Debug information which may assist a programmer working with the API.

result.error: (string) Human readable message which is suitable for user interface display, and helpful to the user.

Or

table/Error

result.code: (number/integer) HTTP error code. Minimum: 400. Maximum: 599.

result.debug: (nil | string) Debug information which may assist a programmer working with the API.

result.error: (string) Human readable message which is suitable for user interface display, and helpful to the user.

api.receivers[receiverId]:options_target ()

A pre-flight check generally used for Cross-Origin Resource Sharing (CORS) purposes. This function is alias for api.receivers[receiverId].target:options().

Returns:

table

result

result.body: (string) Empty string.

result.status: (number) 200.

Or

table

result

result.body: (string) Empty string.

result.status: (number) 403.

api.receivers[receiverId]:put_target (payload)

Request a change to a Receiver's subscription (deprecated). This function is alias for api.receivers[receiverId].target:put(payload).

Parameters:

payload (table) nil
args.payload: Describes the possible requests to a Node's Receiver target resource. Possible content:
- alt1: Describes a sender. +
- (table/nodeapi_receiver_target) Describes an empty object. +

Returns:

table/ReceiverTarget

Describes the possible requests to a Node's Receiver target resource. Possible content:
- alt1: Describes a sender. +
- (table/nodeapi_receiver_target) Describes an empty object. +

{
   caps = { };
   description = "Test Card";
   device_id = "9126cc2f-4c26-4c9b-a6cd-93c4381c9be5";
   flow_id = "5fbec3b1-1b0f-417d-9059-8b94a47197ed";
   id = "d7aa5a30-681d-4e72-92fb-f0ba0f6f4c3e";
   interface_bindings = { "eth0", "eth1" };
   label = "Test Card";
   manifest_href = "http://172.29.80.65/x-manufacturer/senders/d7aa5a30-681d-4e72-92fb-f0ba0f6f4c3e/stream.sdp";
   subscription = { active = true };
   tags = { };
   transport = "urn:x-nmos:transport:rtp.mcast";
   version = "1441704616:890020555";
 }

Or

table/Error

result.code: (number/integer) HTTP error code. Minimum: 400. Maximum: 599.

result.debug: (nil | string) Debug information which may assist a programmer working with the API.

result.error: (string) Human readable message which is suitable for user interface display, and helpful to the user.

Or

table/Error

result.code: (number/integer) HTTP error code. Minimum: 400. Maximum: 599.

result.debug: (nil | string) Debug information which may assist a programmer working with the API.

result.error: (string) Human readable message which is suitable for user interface display, and helpful to the user.

Or

table/Error

result.code: (number/integer) HTTP error code. Minimum: 400. Maximum: 599.

result.debug: (nil | string) Debug information which may assist a programmer working with the API.

result.error: (string) Human readable message which is suitable for user interface display, and helpful to the user.

Or

table/Error

result.code: (number/integer) HTTP error code. Minimum: 400. Maximum: 599.

result.debug: (nil | string) Debug information which may assist a programmer working with the API.

result.error: (string) Human readable message which is suitable for user interface display, and helpful to the user.

Usage:

node = require "lua-repl.lib.rest.nmos.node"
api = node:create_api("http://node.nmos.acme.example.com")
payload =
{
  caps = { };
  description = "Test Card";
  device_id = "9126cc2f-4c26-4c9b-a6cd-93c4381c9be5";
  flow_id = "5fbec3b1-1b0f-417d-9059-8b94a47197ed";
  id = "d7aa5a30-681d-4e72-92fb-f0ba0f6f4c3e";
  interface_bindings = { "eth0", "eth1" };
  label = "Test Card";
  manifest_href = "http://172.29.80.65/x-manufacturer/senders/d7aa5a30-681d-4e72-92fb-f0ba0f6f4c3e/stream.sdp";
  subscription = { active = true };
  tags = { };
  transport = "urn:x-nmos:transport:rtp.mcast";
  version = "1441704616:890020555";
}
result = api.receivers[receiverId]:put_target(payload)

api.receivers:get ()

List Receivers.

Returns:

table/Receivers

result.nil: (array of items) Collection of Receivers. A list of Receiver resources. +
- item: Describes a Receiver. Possible content:
  - receiver_video: Describes a video Receiver. +
  - receiver_audio: Describes an audio Receiver. +
  - receiver_data: Describes a data Receiver. +
  - receiver_mux: Describes a mux Receiver. +

{
   {
     caps =
     {
       media_types = { "video/raw" };
     };
     description = "";
     device_id = "05017e08-b329-45f9-a566-a3f99cc11e4d";
     format = "urn:x-nmos:format:video";
     id = "1eb53d65-ac83-441c-86f6-9b27df30ef0c";
     interface_bindings = { "eth0", "eth1" };
     label = "RTPRx";
     subscription = { active = true, sender_id = "2683ad14-642f-459d-a169-ef91c76cec6b" };
     tags = { };
     transport = "urn:x-nmos:transport:rtp";
     version = "1441704532:450093308";
   };
   {
     caps =
     {
       event_types = { "number/temperature/*", "boolean" };
       media_types = { "application/json" };
     };
     description = "";
     device_id = "05017e08-b329-45f9-a566-a3f99cc11e4d";
     format = "urn:x-nmos:format:data";
     id = "9503a7ab-cc49-4b6a-a5a3-d0d0ca5c9671";
     interface_bindings = { "eth0" };
     label = "IS-07 Mixed RTPRx";
     subscription = { active = false };
     tags = { };
     transport = "urn:x-nmos:transport:mqtt";
     version = "1441704532:450093308";
   };
 }

api.self:get ()

Get information about this Node.

Returns:

table/Node

Describes the Node and the services which run on it. +

(string) Detailed description of the resource.

(string) Globally unique identifier for the resource. Must match the pattern: /^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$/.

(string) Freeform string label for the resource.

(table/resource_core) Key value set of freeform string tags to aid in filtering resources. Values should be represented as an array of strings. Can be empty.

(string) String formatted TAI timestamp (<seconds>:<nanoseconds>) indicating precisely when an attribute of the resource last changed. Must match the pattern: /^[0-9]+:[0-9]+$/.

(table/node) URL fragments required to connect to the Node API. +

api.endpoints: (array of items) Host, port and protocol details required to connect to the API. +

item: (table/node) +

item.authorization: (boolean) This endpoint requires authorization.

item.host: IP address or hostname which the Node API is running on. Possible content: +

(string/hostname)

(string/ipv4)

(string/ipv6)

item.port: (number/integer) Port number which the Node API is running on. Minimum: 1. Maximum: 65535.

item.protocol: (string) Protocol supported by this instance of the Node API. Possible values: {"http","https"}.

api.versions: (array of items) Supported API versions running on this Node. +

item: (string) Must match the pattern: /^v[0-9]+\.[0-9]+$/.

(table/node) Capabilities (not yet defined).

clocks: (array of items) Clocks made available to Devices owned by this Node. +

item: Possible content: +
- (table/clock_internal) Describes a clock with no external reference. +
- (table/clock_ptp) Describes a clock referenced to PTP. +

(string/hostname) Node hostname (optional, deprecated).

(string/uri) HTTP access href for the Node's API (deprecated).

interfaces: (array of items) Network interfaces made available to devices owned by this Node. Port IDs and Chassis IDs are used to inform topology discovery via IS-06, and require that interfaces implement ARP at a minimum, and ideally LLDP.. +

item: (table/node) +

item.attached_network_device: (table/node) +

item.attached_network_device.chassis_id: Chassis ID of the attached network device, as signalled in LLDP received by this Node. Possible content: +

(string) When the Chassis ID is a MAC address, use this format. Must match the pattern: /^([0-9a-f]{2}-){5}([0-9a-f]{2})$/.

(string) When the Chassis ID is anything other than a MAC address, a freeform string may be used. Must match the pattern: /^.+$/.

item.attached_network_device.port_id: Port ID of the attached network device, as signalled in LLDP received by this Node. Possible content: +

(string) When the Port ID is a MAC address, use this format. Must match the pattern: /^([0-9a-f]{2}-){5}([0-9a-f]{2})$/.

(string) When the Port ID is anything other than a MAC address, a freeform string may be used. Must match the pattern: /^.+$/.

item.chassis_id: Chassis ID of the interface, as signalled in LLDP from this node. Set to null where LLDP is unsuitable for use (ie. virtualised environments). Possible content: +

(string) When the Chassis ID is a MAC address, use this format. Must match the pattern: /^([0-9a-f]{2}-){5}([0-9a-f]{2})$/.

(string) When the Chassis ID is anything other than a MAC address, a freeform string may be used. Must match the pattern: /^.+$/.

(nil) When the Chassis ID is unavailable it should be set to null.

item.name: (string) Name of the interface (unique in scope of this node). This attribute is used by sub-resources of this node such as senders and receivers to refer to interfaces to which they are bound.

item.port_id: (string) Port ID of the interface, as signalled in LLDP or via ARP responses from this node. Must be a MAC address. Must match the pattern: /^([0-9a-f]{2}-){5}([0-9a-f]{2})$/.

services: (array of items) Array of objects containing a URN format type and href. +

item: (table/node) +

item.authorization: (boolean) This endpoint requires authorization.

item.href: (string/uri) URL to reach a service running on the Node.

item.type: (string/uri) URN identifying the type of service.

{
   api =
   {
     endpoints =
     {
       { host = "172.29.80.65", port = 12345, protocol = "http" };
       {
         authorization = false;
         host = "172.29.80.65";
         port = 443;
         protocol = "https";
       };
     };
     versions = { "v1.0", "v1.1", "v1.2", "v1.3" };
   };
   caps = { };
   clocks =
   {
     { name = "clk0", ref_type = "internal" };
     {
       gmid = "08-00-11-ff-fe-21-e1-b0";
       locked = true;
       name = "clk1";
       ref_type = "ptp";
       traceable = true;
       version = "IEEE1588-2008";
     };
   };
   description = "host1";
   hostname = "host1";
   href = "http://172.29.80.65:12345/";
   id = "3b8be755-08ff-452b-b217-c9151eb21193";
   interfaces =
   {
     {
       attached_network_device = { chassis_id = "2f-8c-af-79-c7-00", port_id = "Ethernet 1/3" };
       chassis_id = "74-26-96-db-87-31";
       name = "eth0";
       port_id = "74-26-96-db-87-31";
     };
     {
       attached_network_device = { chassis_id = "2d-51-2b-85-89-7b", port_id = "Ethernet 1/2" };
       chassis_id = "74-26-96-db-87-31";
       name = "eth1";
       port_id = "74-26-96-db-87-32";
     };
   };
   label = "host1";
   services =
   {
     {
       authorization = false;
       href = "https://172.29.80.65:443/x-manufacturer/pipelinemanager/";
       type = "urn:x-manufacturer:service:pipelinemanager";
     };
     {
       authorization = false;
       href = "https://172.29.80.65:443/x-manufacturer/status/";
       type = "urn:x-manufacturer:service:status";
     };
     {
       authorization = false;
       href = "https://172.29.80.65:443/x-manufacturer/tally/";
       type = "urn:x-manufacturer:service:tally";
     };
     {
       authorization = false;
       href = "https://172.29.80.65:443/x-manufacturer/mdnsbridge/";
       type = "urn:x-manufacturer:service:mdnsbridge";
     };
     {
       authorization = false;
       href = "https://172.29.80.65:443/x-manufacturer/storequery/";
       type = "urn:x-manufacturer:service:storequery";
     };
   };
   tags = { };
   version = "1441700172:318426300";
 }

api.senders[senderId]:get ()

Get a single Sender.

senderId: (string) Must match the pattern: /^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$/.

Returns:

table/Sender

Describes a sender. +

(string) Detailed description of the resource.

(string) Globally unique identifier for the resource. Must match the pattern: /^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$/.

(string) Freeform string label for the resource.

(table/resource_core) Key value set of freeform string tags to aid in filtering resources. Values should be represented as an array of strings. Can be empty.

(string) String formatted TAI timestamp (<seconds>:<nanoseconds>) indicating precisely when an attribute of the resource last changed. Must match the pattern: /^[0-9]+:[0-9]+$/.

(table/sender) Capabilities of this sender. +

(string) Device ID which this Sender forms part of. This attribute is used to ensure referential integrity by registry implementations. Must match the pattern: /^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$/.

(string | nil) ID of the Flow currently passing via this Sender. Must match the pattern: /^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$/.

interface_bindings: (array of items) Binding of Sender egress ports to interfaces on the parent Node.. +

item: (string)

(string | nil/uri) HTTP(S) accessible URL to a file describing how to connect to the Sender.

(table/sender) Object indicating how this Sender is currently configured to send data. +

(boolean) Sender is enabled and configured to send data.

(string | nil) UUID of the Receiver to which this Sender is currently configured to send data. Only set if it is active, uses a unicast push-based transport and is sending to an NMOS Receiver; otherwise null. Must match the pattern: /^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$/.

transport: Transport type used by the Sender in URN format. Possible content:

(string) Must match the pattern: /^urn:x-nmos:transport:/.

(any)

{
   caps = { };
   description = "Test Card";
   device_id = "9126cc2f-4c26-4c9b-a6cd-93c4381c9be5";
   flow_id = "5fbec3b1-1b0f-417d-9059-8b94a47197ed";
   id = "d7aa5a30-681d-4e72-92fb-f0ba0f6f4c3e";
   interface_bindings = { "eth0", "eth1" };
   label = "Test Card";
   manifest_href = "http://172.29.80.65/x-manufacturer/senders/d7aa5a30-681d-4e72-92fb-f0ba0f6f4c3e/stream.sdp";
   subscription = { active = true };
   tags = { };
   transport = "urn:x-nmos:transport:rtp.mcast";
   version = "1441704616:890020555";
 }

Or

table/Error

result.code: (number/integer) HTTP error code. Minimum: 400. Maximum: 599.

result.debug: (nil | string) Debug information which may assist a programmer working with the API.

result.error: (string) Human readable message which is suitable for user interface display, and helpful to the user.

Or

table/Error

result.code: (number/integer) HTTP error code. Minimum: 400. Maximum: 599.

result.debug: (nil | string) Debug information which may assist a programmer working with the API.

result.error: (string) Human readable message which is suitable for user interface display, and helpful to the user.

api.senders:get ()

List Senders.

Returns:

table/Senders

result.nil: (array of items) Collection of Senders. A list of Sender resources. +
- item: Describes a sender. +

{
   {
     caps = { };
     description = "Test Card";
     device_id = "9126cc2f-4c26-4c9b-a6cd-93c4381c9be5";
     flow_id = "5fbec3b1-1b0f-417d-9059-8b94a47197ed";
     id = "d7aa5a30-681d-4e72-92fb-f0ba0f6f4c3e";
     interface_bindings = { "eth0", "eth1" };
     label = "Test Card";
     manifest_href = "http://172.29.80.65/x-manufacturer/senders/d7aa5a30-681d-4e72-92fb-f0ba0f6f4c3e/stream.sdp";
     subscription = { active = true };
     tags = { };
     transport = "urn:x-nmos:transport:rtp.mcast";
     version = "1441704616:890020555";
   };
 }

api.sources[sourceId]:get ()

Get a single Source.

sourceId: (string) Must match the pattern: /^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$/.

Returns:

table/Source

Describes a Source. Possible content:
- source_generic: Describes a generic Source. +
- source_audio: Describes an audio Source. +
- source_data: Describes a data Source. +

{
   caps = { };
   clock_name = "clk1";
   description = "Capture Card Source Video";
   device_id = "9126cc2f-4c26-4c9b-a6cd-93c4381c9be5";
   format = "urn:x-nmos:format:video";
   id = "4569cea2-ab63-4f97-8dd1-bad4669ea5e4";
   label = "CaptureCardSourceVideo";
   parents = { };
   tags =
   {
     host = { "host1" };
   };
   version = "1441703336:902850419";
 }

Or

table/Error

result.code: (number/integer) HTTP error code. Minimum: 400. Maximum: 599.

result.debug: (nil | string) Debug information which may assist a programmer working with the API.

result.error: (string) Human readable message which is suitable for user interface display, and helpful to the user.

Or

table/Error

result.code: (number/integer) HTTP error code. Minimum: 400. Maximum: 599.

result.debug: (nil | string) Debug information which may assist a programmer working with the API.

result.error: (string) Human readable message which is suitable for user interface display, and helpful to the user.

api.sources:get ()

List Sources.

Returns:

table/Sources

result.nil: (array of items) Collection of Sources. A list of Source resources. +
- item: Describes a Source. Possible content:
  - source_generic: Describes a generic Source. +
  - source_audio: Describes an audio Source. +
  - source_data: Describes a data Source. +

{
   {
     caps = { };
     clock_name = "clk0";
     description = "Capture Card Source Video";
     device_id = "9126cc2f-4c26-4c9b-a6cd-93c4381c9be5";
     format = "urn:x-nmos:format:video";
     id = "4569cea2-ab63-4f97-8dd1-bad4669ea5e4";
     label = "CaptureCardSourceVideo";
     parents = { };
     tags =
     {
       host = { "host1" };
     };
     version = "1441703336:902850419";
   };
   {
     caps = { };
     channels =
     {
       { label = "Left Channel", symbol = "L" };
       { label = "Right Channel", symbol = "R" };
     };
     clock_name = "clk0";
     description = "Capture Card Source Audio";
     device_id = "9126cc2f-4c26-4c9b-a6cd-93c4381c9be5";
     format = "urn:x-nmos:format:audio";
     id = "fc97ab0f-b51b-4129-9385-dcaf30f9482b";
     label = "CaptureCardSourceAudio";
     parents = { };
     tags =
     {
       host = { "host1" };
     };
     version = "1441703336:912670314";
   };
   {
     caps = { };
     channels =
     {
       { label = "Left Channel", symbol = "L" };
       { label = "Right Channel", symbol = "R" };
     };
     clock_name = "clk0";
     description = "Capture Card Source Audio";
     device_id = "9126cc2f-4c26-4c9b-a6cd-93c4381c9be5";
     format = "urn:x-nmos:format:audio";
     id = "9738780e-141f-4e19-8601-a157dc855aa2";
     label = "CaptureCardSourceAudio";
     parents = { };
     tags =
     {
       host = { "host1" };
     };
     version = "1441704614:174935325";
   };
   {
     caps = { };
     clock_name = "clk0";
     description = "Capture Card Source Video";
     device_id = "9126cc2f-4c26-4c9b-a6cd-93c4381c9be5";
     format = "urn:x-nmos:format:video";
     id = "02c46999-d532-4c52-905f-2e368a2af6cb";
     label = "CaptureCardSourceVideo";
     parents = { };
     tags =
     {
       host = { "host1" };
     };
     version = "1441704614:163285887";
   };
   {
     caps = { };
     clock_name = "clk0";
     description = "Capture Card Source VANC";
     device_id = "9126cc2f-4c26-4c9b-a6cd-93c4381c9be5";
     format = "urn:x-nmos:format:data";
     id = "0e635152-e501-4d4e-bb87-9f3fe05eb79a";
     label = "Capture Card Source VANC";
     parents = { };
     tags =
     {
       host = { "host1" };
     };
     version = "1453880605:374934072";
   };
   {
     caps = { };
     clock_name = "clk0";
     description = "Capture Card Source TR-04/2022-6";
     device_id = "9126cc2f-4c26-4c9b-a6cd-93c4381c9be5";
     format = "urn:x-nmos:format:mux";
     id = "782fac41-17f6-4a21-8186-57ba63a1a8d3";
     label = "Capture Card Source TR-04/2022-6";
     parents = { };
     tags =
     {
       host = { "host1" };
     };
     version = "1453880605:374934072";
   };
   {
     caps = { };
     description = "Capture Card Source 2022-6 (No Refclock)";
     device_id = "9126cc2f-4c26-4c9b-a6cd-93c4381c9be5";
     format = "urn:x-nmos:format:mux";
     id = "3ca37fce-c0cf-42a6-86ad-43635a53b5bb";
     label = "Capture Card Source 2022-6 (No Refclock)";
     parents = { };
     tags =
     {
       host = { "host1" };
     };
     version = "1453880605:374934072";
   };
   {
     caps = { };
     clock_name = "clk0";
     description = "IS-07 Temperature Readings";
     device_id = "9126cc2f-4c26-4c9b-a6cd-93c4381c9be5";
     event_type = "number/temperature/*";
     format = "urn:x-nmos:format:data";
     id = "33e28c6f-d5ab-4ae5-b00d-f1cccab29af4";
     label = "IS-07 Temperature Readings";
     parents = { };
     tags =
     {
       host = { "host1" };
     };
     version = "1453880605:374934072";
   };
   {
     caps = { };
     clock_name = "clk0";
     description = "IS-07 Button";
     device_id = "9126cc2f-4c26-4c9b-a6cd-93c4381c9be5";
     event_type = "boolean";
     format = "urn:x-nmos:format:data";
     id = "c8d27a1d-d124-4d06-bc43-312fd36f7db1";
     label = "IS-07 Button";
     parents = { };
     tags =
     {
       host = { "host1" };
     };
     version = "1453880605:374934072";
   };
 }

lua-repl.lib.rest.nmos.node.api:get ()

List of paths available from this API.

Returns:

table/nodeapi_base[]

result.nil: (array of items) Node API base resource. Describes the Node API base resource. +
- item: (string) Possible values: {"self/","sources/","flows/","devices/","senders/","receivers/"}.

{ "self/", "sources/", "flows/", "devices/", "senders/", "receivers/" }

lua-repl.lib.rest.nmos.node.api:get_devices ()

List Devices. This function is alias for api.devices:get().

Returns:

table/Devices

result.nil: (array of items) Collection of Devices. A list of Device resources. +
- item: Describes a Device. +

{
   {
     controls =
     {
       {
         authorization = false;
         href = "wss://154.67.63.2:4535";
         type = "urn:x-manufacturer:control:generic";
       };
     };
     description = "pipeline 3 default device";
     id = "9126cc2f-4c26-4c9b-a6cd-93c4381c9be5";
     label = "pipeline 3 default device";
     node_id = "3b8be755-08ff-452b-b217-c9151eb21193";
     receivers = { };
     senders = { "d7aa5a30-681d-4e72-92fb-f0ba0f6f4c3e" };
     tags = { };
     type = "urn:x-nmos:device:pipeline";
     version = "1441704616:592733242";
   };
   {
     controls =
     {
       {
         href = "ws://182.54.54.75:223";
         type = "urn:x-manufacturer:control:generic";
       };
       {
         href = "http://134.24.64.22/x-manufacturer/control/";
         type = "urn:x-manufacturer:control:generic";
       };
       {
         href = "telnet://120.43.64.3:8080";
         type = "urn:x-manufacturer:control:legacy";
       };
     };
     description = "pipeline 1 default device";
     id = "67c25159-ce25-4000-a66c-f31fff890265";
     label = "pipeline 1 default device";
     node_id = "3b8be755-08ff-452b-b217-c9151eb21193";
     receivers = { };
     senders = { };
     tags = { };
     type = "urn:x-nmos:device:pipeline";
     version = "1441703338:962976113";
   };
   {
     controls = { };
     description = "pipeline 2 default device";
     id = "05017e08-b329-45f9-a566-a3f99cc11e4d";
     label = "pipeline 2 default device";
     node_id = "3b8be755-08ff-452b-b217-c9151eb21193";
     receivers = { "1eb53d65-ac83-441c-86f6-9b27df30ef0c" };
     senders = { };
     tags = { };
     type = "urn:x-nmos:device:pipeline";
     version = "1441704514:993221361";
   };
 }

lua-repl.lib.rest.nmos.node.api:get_flows ()

List Flows. This function is alias for api.flows:get().

Returns:

table/Flows

result.nil: (array of items) Collection of Flows. A list of Flow resources. +
- item: Describes a Flow. Possible content: +
  - item: Describes a raw Video Flow. +
  - item: Describes a coded Video Flow. +
  - item: Describes a raw audio Flow. +
  - item: Describes a coded audio Flow. +
  - item: Describes a generic data Flow. +
  - item: Describes an SDI ancillary Flow. +
  - item: Describes a JSON based Flow. +
  - item: Describes a mux Flow. +

{
   {
     colorspace = "BT709";
     components =
     {
       { bit_depth = 10, height = 1080, name = "Y", width = 1920 };
       { bit_depth = 10, height = 1080, name = "Cb", width = 960 };
       { bit_depth = 10, height = 1080, name = "Cr", width = 960 };
     };
     description = "Test Card";
     device_id = "9126cc2f-4c26-4c9b-a6cd-93c4381c9be5";
     format = "urn:x-nmos:format:video";
     frame_height = 1080;
     frame_width = 1920;
     id = "5fbec3b1-1b0f-417d-9059-8b94a47197ed";
     interlace_mode = "interlaced_tff";
     label = "Test Card";
     media_type = "video/raw";
     parents = { };
     source_id = "02c46999-d532-4c52-905f-2e368a2af6cb";
     tags = { };
     version = "1441704616:587121295";
   };
   {
     description = "VANC Data";
     device_id = "9126cc2f-4c26-4c9b-a6cd-93c4381c9be5";
     format = "urn:x-nmos:format:data";
     id = "db3bd465-2772-484f-8fac-830b0471258b";
     label = "VANC Data";
     media_type = "video/smpte291";
     parents = { };
     source_id = "0e635152-e501-4d4e-bb87-9f3fe05eb79a";
     tags = { };
     version = "1453880607:123995943";
   };
   {
     description = "TR-04 Video";
     device_id = "9126cc2f-4c26-4c9b-a6cd-93c4381c9be5";
     format = "urn:x-nmos:format:mux";
     id = "4857f747-96cf-4ed7-8f4b-9497199f1f25";
     label = "TR-04 Video";
     media_type = "video/SMPTE2022-6";
     parents = { };
     source_id = "782fac41-17f6-4a21-8186-57ba63a1a8d3";
     tags = { };
     version = "1453880607:123995943";
   };
   {
     description = "IS-07 Temperature Readings (C)";
     device_id = "9126cc2f-4c26-4c9b-a6cd-93c4381c9be5";
     event_type = "number/temperature/C";
     format = "urn:x-nmos:format:data";
     id = "6327c381-1239-41d1-b314-efc719600e26";
     label = "IS-07 Temperature Readings (C)";
     media_type = "application/json";
     parents = { };
     source_id = "33e28c6f-d5ab-4ae5-b00d-f1cccab29af4";
     tags = { };
     version = "1453880605:374934072";
   };
   {
     description = "IS-07 Temperature Readings (F)";
     device_id = "9126cc2f-4c26-4c9b-a6cd-93c4381c9be5";
     event_type = "number/temperature/F";
     format = "urn:x-nmos:format:data";
     id = "6327c381-1239-41d1-b314-efc719600e26";
     label = "IS-07 Temperature Readings (F)";
     media_type = "application/json";
     parents = { };
     source_id = "33e28c6f-d5ab-4ae5-b00d-f1cccab29af4";
     tags = { };
     version = "1453880605:374934072";
   };
   {
     description = "IS-07 Button";
     device_id = "9126cc2f-4c26-4c9b-a6cd-93c4381c9be5";
     event_type = "boolean";
     format = "urn:x-nmos:format:data";
     id = "fa6258b9-2826-4a0d-81d0-7da9edbc405f";
     label = "IS-07 Button";
     media_type = "application/json";
     parents = { };
     source_id = "c8d27a1d-d124-4d06-bc43-312fd36f7db1";
     tags = { };
     version = "1453880605:374934072";
   };
 }

lua-repl.lib.rest.nmos.node.api:get_receivers ()

List Receivers. This function is alias for api.receivers:get().

Returns:

table/Receivers

result.nil: (array of items) Collection of Receivers. A list of Receiver resources. +
- item: Describes a Receiver. Possible content:
  - alt1: Describes a video Receiver. +
  - alt2: Describes an audio Receiver. +
  - alt3: Describes a data Receiver. +
  - alt4: Describes a mux Receiver. +

{
   {
     caps =
     {
       media_types = { "video/raw" };
     };
     description = "";
     device_id = "05017e08-b329-45f9-a566-a3f99cc11e4d";
     format = "urn:x-nmos:format:video";
     id = "1eb53d65-ac83-441c-86f6-9b27df30ef0c";
     interface_bindings = { "eth0", "eth1" };
     label = "RTPRx";
     subscription = { active = true, sender_id = "2683ad14-642f-459d-a169-ef91c76cec6b" };
     tags = { };
     transport = "urn:x-nmos:transport:rtp";
     version = "1441704532:450093308";
   };
   {
     caps =
     {
       event_types = { "number/temperature/*", "boolean" };
       media_types = { "application/json" };
     };
     description = "";
     device_id = "05017e08-b329-45f9-a566-a3f99cc11e4d";
     format = "urn:x-nmos:format:data";
     id = "9503a7ab-cc49-4b6a-a5a3-d0d0ca5c9671";
     interface_bindings = { "eth0" };
     label = "IS-07 Mixed RTPRx";
     subscription = { active = false };
     tags = { };
     transport = "urn:x-nmos:transport:mqtt";
     version = "1441704532:450093308";
   };
 }

lua-repl.lib.rest.nmos.node.api:get_self ()

Get information about this Node. This function is alias for api.self:get().

Returns:

table/Node

Describes the Node and the services which run on it. +

(string) Detailed description of the resource.

(string) Globally unique identifier for the resource. Must match the pattern: /^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$/.

(string) Freeform string label for the resource.

(table/resource_core) Key value set of freeform string tags to aid in filtering resources. Values should be represented as an array of strings. Can be empty.

(string) String formatted TAI timestamp (<seconds>:<nanoseconds>) indicating precisely when an attribute of the resource last changed. Must match the pattern: /^[0-9]+:[0-9]+$/.

(table/node) URL fragments required to connect to the Node API. +

api.endpoints: (array of items) Host, port and protocol details required to connect to the API. +

item: (table/node) +

item.authorization: (boolean) This endpoint requires authorization.

item.host: IP address or hostname which the Node API is running on. Possible content: +

(string/hostname)

(string/ipv4)

(string/ipv6)

item.port: (number/integer) Port number which the Node API is running on. Minimum: 1. Maximum: 65535.

item.protocol: (string) Protocol supported by this instance of the Node API. Possible values: {"http","https"}.

api.versions: (array of items) Supported API versions running on this Node. +

item: (string) Must match the pattern: /^v[0-9]+\.[0-9]+$/.

(table/node) Capabilities (not yet defined).

clocks: (array of items) Clocks made available to Devices owned by this Node. +

item: Possible content: +
- (table/clock_internal) Describes a clock with no external reference. +
- (table/clock_ptp) Describes a clock referenced to PTP. +

(string/hostname) Node hostname (optional, deprecated).

(string/uri) HTTP access href for the Node's API (deprecated).

item: (table/node) +

item.attached_network_device: (table/node) +

item.attached_network_device.chassis_id: Chassis ID of the attached network device, as signalled in LLDP received by this Node. Possible content: +

(string) When the Chassis ID is a MAC address, use this format. Must match the pattern: /^([0-9a-f]{2}-){5}([0-9a-f]{2})$/.

(string) When the Chassis ID is anything other than a MAC address, a freeform string may be used. Must match the pattern: /^.+$/.

item.attached_network_device.port_id: Port ID of the attached network device, as signalled in LLDP received by this Node. Possible content: +

(string) When the Port ID is a MAC address, use this format. Must match the pattern: /^([0-9a-f]{2}-){5}([0-9a-f]{2})$/.

(string) When the Port ID is anything other than a MAC address, a freeform string may be used. Must match the pattern: /^.+$/.

item.chassis_id: Chassis ID of the interface, as signalled in LLDP from this node. Set to null where LLDP is unsuitable for use (ie. virtualised environments). Possible content: +

(string) When the Chassis ID is a MAC address, use this format. Must match the pattern: /^([0-9a-f]{2}-){5}([0-9a-f]{2})$/.

(string) When the Chassis ID is anything other than a MAC address, a freeform string may be used. Must match the pattern: /^.+$/.

(nil) When the Chassis ID is unavailable it should be set to null.

item.port_id: (string) Port ID of the interface, as signalled in LLDP or via ARP responses from this node. Must be a MAC address. Must match the pattern: /^([0-9a-f]{2}-){5}([0-9a-f]{2})$/.

services: (array of items) Array of objects containing a URN format type and href. +

item: (table/node) +

item.authorization: (boolean) This endpoint requires authorization.

item.href: (string/uri) URL to reach a service running on the Node.

item.type: (string/uri) URN identifying the type of service.

{
   api =
   {
     endpoints =
     {
       { host = "172.29.80.65", port = 12345, protocol = "http" };
       {
         authorization = false;
         host = "172.29.80.65";
         port = 443;
         protocol = "https";
       };
     };
     versions = { "v1.0", "v1.1", "v1.2", "v1.3" };
   };
   caps = { };
   clocks =
   {
     { name = "clk0", ref_type = "internal" };
     {
       gmid = "08-00-11-ff-fe-21-e1-b0";
       locked = true;
       name = "clk1";
       ref_type = "ptp";
       traceable = true;
       version = "IEEE1588-2008";
     };
   };
   description = "host1";
   hostname = "host1";
   href = "http://172.29.80.65:12345/";
   id = "3b8be755-08ff-452b-b217-c9151eb21193";
   interfaces =
   {
     {
       attached_network_device = { chassis_id = "2f-8c-af-79-c7-00", port_id = "Ethernet 1/3" };
       chassis_id = "74-26-96-db-87-31";
       name = "eth0";
       port_id = "74-26-96-db-87-31";
     };
     {
       attached_network_device = { chassis_id = "2d-51-2b-85-89-7b", port_id = "Ethernet 1/2" };
       chassis_id = "74-26-96-db-87-31";
       name = "eth1";
       port_id = "74-26-96-db-87-32";
     };
   };
   label = "host1";
   services =
   {
     {
       authorization = false;
       href = "https://172.29.80.65:443/x-manufacturer/pipelinemanager/";
       type = "urn:x-manufacturer:service:pipelinemanager";
     };
     {
       authorization = false;
       href = "https://172.29.80.65:443/x-manufacturer/status/";
       type = "urn:x-manufacturer:service:status";
     };
     {
       authorization = false;
       href = "https://172.29.80.65:443/x-manufacturer/tally/";
       type = "urn:x-manufacturer:service:tally";
     };
     {
       authorization = false;
       href = "https://172.29.80.65:443/x-manufacturer/mdnsbridge/";
       type = "urn:x-manufacturer:service:mdnsbridge";
     };
     {
       authorization = false;
       href = "https://172.29.80.65:443/x-manufacturer/storequery/";
       type = "urn:x-manufacturer:service:storequery";
     };
   };
   tags = { };
   version = "1441700172:318426300";
 }

lua-repl.lib.rest.nmos.node.api:get_senders ()

List Senders. This function is alias for api.senders:get().

Returns:

table/Senders

result.nil: (array of items) Collection of Senders. A list of Sender resources. +
- item: Describes a sender. +

{
   {
     caps = { };
     description = "Test Card";
     device_id = "9126cc2f-4c26-4c9b-a6cd-93c4381c9be5";
     flow_id = "5fbec3b1-1b0f-417d-9059-8b94a47197ed";
     id = "d7aa5a30-681d-4e72-92fb-f0ba0f6f4c3e";
     interface_bindings = { "eth0", "eth1" };
     label = "Test Card";
     manifest_href = "http://172.29.80.65/x-manufacturer/senders/d7aa5a30-681d-4e72-92fb-f0ba0f6f4c3e/stream.sdp";
     subscription = { active = true };
     tags = { };
     transport = "urn:x-nmos:transport:rtp.mcast";
     version = "1441704616:890020555";
   };
 }

lua-repl.lib.rest.nmos.node.api:get_sources ()

List Sources. This function is alias for api.sources:get().

Returns:

table/Sources

result.nil: (array of items) Collection of Sources. A list of Source resources. +
- item: Describes a Source. Possible content:
  - alt1: Describes a generic Source. +
  - alt2: Describes an audio Source. +
  - alt3: Describes a data Source. +

{
   {
     caps = { };
     clock_name = "clk0";
     description = "Capture Card Source Video";
     device_id = "9126cc2f-4c26-4c9b-a6cd-93c4381c9be5";
     format = "urn:x-nmos:format:video";
     id = "4569cea2-ab63-4f97-8dd1-bad4669ea5e4";
     label = "CaptureCardSourceVideo";
     parents = { };
     tags =
     {
       host = { "host1" };
     };
     version = "1441703336:902850419";
   };
   {
     caps = { };
     channels =
     {
       { label = "Left Channel", symbol = "L" };
       { label = "Right Channel", symbol = "R" };
     };
     clock_name = "clk0";
     description = "Capture Card Source Audio";
     device_id = "9126cc2f-4c26-4c9b-a6cd-93c4381c9be5";
     format = "urn:x-nmos:format:audio";
     id = "fc97ab0f-b51b-4129-9385-dcaf30f9482b";
     label = "CaptureCardSourceAudio";
     parents = { };
     tags =
     {
       host = { "host1" };
     };
     version = "1441703336:912670314";
   };
   {
     caps = { };
     channels =
     {
       { label = "Left Channel", symbol = "L" };
       { label = "Right Channel", symbol = "R" };
     };
     clock_name = "clk0";
     description = "Capture Card Source Audio";
     device_id = "9126cc2f-4c26-4c9b-a6cd-93c4381c9be5";
     format = "urn:x-nmos:format:audio";
     id = "9738780e-141f-4e19-8601-a157dc855aa2";
     label = "CaptureCardSourceAudio";
     parents = { };
     tags =
     {
       host = { "host1" };
     };
     version = "1441704614:174935325";
   };
   {
     caps = { };
     clock_name = "clk0";
     description = "Capture Card Source Video";
     device_id = "9126cc2f-4c26-4c9b-a6cd-93c4381c9be5";
     format = "urn:x-nmos:format:video";
     id = "02c46999-d532-4c52-905f-2e368a2af6cb";
     label = "CaptureCardSourceVideo";
     parents = { };
     tags =
     {
       host = { "host1" };
     };
     version = "1441704614:163285887";
   };
   {
     caps = { };
     clock_name = "clk0";
     description = "Capture Card Source VANC";
     device_id = "9126cc2f-4c26-4c9b-a6cd-93c4381c9be5";
     format = "urn:x-nmos:format:data";
     id = "0e635152-e501-4d4e-bb87-9f3fe05eb79a";
     label = "Capture Card Source VANC";
     parents = { };
     tags =
     {
       host = { "host1" };
     };
     version = "1453880605:374934072";
   };
   {
     caps = { };
     clock_name = "clk0";
     description = "Capture Card Source TR-04/2022-6";
     device_id = "9126cc2f-4c26-4c9b-a6cd-93c4381c9be5";
     format = "urn:x-nmos:format:mux";
     id = "782fac41-17f6-4a21-8186-57ba63a1a8d3";
     label = "Capture Card Source TR-04/2022-6";
     parents = { };
     tags =
     {
       host = { "host1" };
     };
     version = "1453880605:374934072";
   };
   {
     caps = { };
     description = "Capture Card Source 2022-6 (No Refclock)";
     device_id = "9126cc2f-4c26-4c9b-a6cd-93c4381c9be5";
     format = "urn:x-nmos:format:mux";
     id = "3ca37fce-c0cf-42a6-86ad-43635a53b5bb";
     label = "Capture Card Source 2022-6 (No Refclock)";
     parents = { };
     tags =
     {
       host = { "host1" };
     };
     version = "1453880605:374934072";
   };
   {
     caps = { };
     clock_name = "clk0";
     description = "IS-07 Temperature Readings";
     device_id = "9126cc2f-4c26-4c9b-a6cd-93c4381c9be5";
     event_type = "number/temperature/*";
     format = "urn:x-nmos:format:data";
     id = "33e28c6f-d5ab-4ae5-b00d-f1cccab29af4";
     label = "IS-07 Temperature Readings";
     parents = { };
     tags =
     {
       host = { "host1" };
     };
     version = "1453880605:374934072";
   };
   {
     caps = { };
     clock_name = "clk0";
     description = "IS-07 Button";
     device_id = "9126cc2f-4c26-4c9b-a6cd-93c4381c9be5";
     event_type = "boolean";
     format = "urn:x-nmos:format:data";
     id = "c8d27a1d-d124-4d06-bc43-312fd36f7db1";
     label = "IS-07 Button";
     parents = { };
     tags =
     {
       host = { "host1" };
     };
     version = "1453880605:374934072";
   };
 }

MintLua

Contents

Classes

Structs

Enums

Modules

Developer_release_1.4.0

Class lua-repl.lib.rest.nmos.node.api

Overview

Further Documentation

Methods

Methods

Returns:

Or

Or

Returns:

Returns:

Or

Or

Returns:

Returns:

Or

Parameters:

Returns:

Or

Or

Or

Or

Usage:

Returns:

Or

Or

Returns:

Or

Parameters:

Returns:

Or

Or

Or

Or

Usage:

Returns:

Returns:

Returns:

Or

Or

Returns:

Returns:

Or

Or

Returns:

Returns:

Returns:

Returns:

Returns:

Returns:

Returns:

Returns:

Class `lua-repl.lib.rest.nmos.node.api`