Merge pull request #462 from lo-simon/line-up-control-protocol-dataset

Update control protocol dataset

Author: jonathan-r-thorpe

Development/nmos/api_utils.cpp

@@ -168,8 +168,7 @@ namespace nmos
             { U("nc_manager"), nmos::types::nc_manager },
             { U("nc_device_manager"), nmos::types::nc_device_manager },
             { U("nc_class_manager"), nmos::types::nc_class_manager },
-            { U("nc_receiver_monitor"), nmos::types::nc_receiver_monitor },
-            { U("nc_receiver_monitor_protected"), nmos::types::nc_receiver_monitor_protected },
+            { U("nc_status_monitor"), nmos::types::nc_status_monitor }, // this is commonly used for nc_receiver_monitor and nc_sender_monitor
             { U("nc_ident_beacon"), nmos::types::nc_ident_beacon }
         };
         return types_from_resourceType.at(resourceType);
@@ -195,8 +194,7 @@ namespace nmos
             { nmos::types::nc_manager, U("nc_manager") },
             { nmos::types::nc_device_manager, U("nc_device_manager") },
             { nmos::types::nc_class_manager, U("nc_class_manager") },
-            { nmos::types::nc_receiver_monitor, U("nc_receiver_monitor") },
-            { nmos::types::nc_receiver_monitor_protected, U("nc_receiver_monitor_protected") },
+            { nmos::types::nc_status_monitor, U("nc_status_monitor") }, // this is commonly used for nc_receiver_monitor and nc_sender_monitor
             { nmos::types::nc_ident_beacon, U("nc_ident_beacon") }
         };
         return resourceTypes_from_type.at(type);

Development/nmos/control_protocol_handlers.cpp

@@ -74,27 +74,24 @@ namespace nmos
     {
         return [&resources](const resource& connection_resource)
         {
-            auto found = find_control_protocol_resource(resources, nmos::types::nc_receiver_monitor, connection_resource.id);
+            auto found = find_control_protocol_resource(resources, nmos::types::nc_status_monitor, connection_resource.id);
             if (resources.end() != found && nc_receiver_monitor_class_id == details::parse_nc_class_id(nmos::fields::nc::class_id(found->data)))
             {
                 // update receiver-monitor's connectionStatus and payloadStatus properties
 
                 const auto active = nmos::fields::master_enable(nmos::fields::endpoint_active(connection_resource.data));
-                const web::json::value connection_status = active ? nc_connection_status::connected : nc_connection_status::disconnected;
-                const web::json::value payload_status = active ? nc_payload_status::payload_ok : nc_payload_status::undefined;
+                const web::json::value connection_status = active ? nc_connection_status::healthy : nc_connection_status::inactive;
 
-                // hmm, maybe updating connectionStatusMessage and payloadStatusMessage too
+                // hmm, maybe updating connectionStatusMessage
 
                 const auto property_changed_event = make_property_changed_event(nmos::fields::nc::oid(found->data),
                 {
                     { nc_receiver_monitor_connection_status_property_id, nc_property_change_type::type::value_changed, connection_status },
-                    { nc_receiver_monitor_payload_status_property_id, nc_property_change_type::type::value_changed, payload_status }
                 });
 
                 modify_control_protocol_resource(resources, found->id, [&](nmos::resource& resource)
                 {
                     resource.data[nmos::fields::nc::connection_status] = connection_status;
-                    resource.data[nmos::fields::nc::payload_status] = payload_status;
 
                 }, property_changed_event);
             }

Development/nmos/control_protocol_resource.cpp

@@ -177,9 +177,14 @@ namespace nmos
         // See https://specs.amwa.tv/ms-05-02/branches/v1.0.x/docs/Framework.html#ncworker
         web::json::value make_nc_worker(const nc_class_id& class_id, nc_oid oid, bool constant_oid, nc_oid owner, const utility::string_t& role, const web::json::value& user_label, const utility::string_t& description, const web::json::value& touchpoints, const web::json::value& runtime_property_constraints, bool enabled);
 
+        // See https://specs.amwa.tv/nmos-control-feature-sets/branches/main/monitoring/#ncstatusmonitor
+        web::json::value make_nc_status_monitor(const nc_class_id& class_id, nc_oid oid, bool constant_oid, nc_oid owner, const utility::string_t& role, const utility::string_t& user_label, const utility::string_t& description, const web::json::value& touchpoints, const web::json::value& runtime_property_constraints, bool enabled, nc_overall_status::status overall_status, const utility::string_t& overall_status_message, uint64_t status_reporting_delay);
+
         // See https://specs.amwa.tv/nmos-control-feature-sets/branches/main/monitoring/#ncreceivermonitor
-        web::json::value make_receiver_monitor(const nc_class_id& class_id, nc_oid oid, bool constant_oid, nc_oid owner, const utility::string_t& role, const utility::string_t& user_label, const utility::string_t& description, const web::json::value& touchpoints, const web::json::value& runtime_property_constraints, bool enabled,
-            nc_connection_status::status connection_status, const utility::string_t& connection_status_message, nc_payload_status::status payload_status, const utility::string_t& payload_status_message);
+        web::json::value make_receiver_monitor(const nc_class_id& class_id, nc_oid oid, bool constant_oid, nc_oid owner, const utility::string_t& role, const utility::string_t& user_label, const utility::string_t& description, const web::json::value& touchpoints, const web::json::value& runtime_property_constraints, bool enabled, nc_overall_status::status overall_status, const utility::string_t& overall_status_message, nc_link_status::status link_status, const utility::string_t& link_status_message, nc_connection_status::status connection_status, const utility::string_t& connection_status_message, nc_synchronization_status::status external_synchronization_status, const utility::string_t& external_synchronization_status_message, const web::json::value& synchronization_source_id, nc_stream_status::status stream_status, const utility::string_t& stream_status_message, uint32_t status_reporting_delay, bool auto_reset_monitor);
+
+        // See https://specs.amwa.tv/nmos-control-feature-sets/branches/main/monitoring/#ncsendermonitor
+        web::json::value make_sender_monitor(const nc_class_id& class_id, nc_oid oid, bool constant_oid, nc_oid owner, const utility::string_t& role, const utility::string_t& user_label, const utility::string_t& description, const web::json::value& touchpoints, const web::json::value& runtime_property_constraints, bool enabled, nc_overall_status::status overall_status, const utility::string_t& overall_status_message, nc_link_status::status link_status, const utility::string_t& link_status_message, nc_transmission_status::status transmission_status, const utility::string_t& transmission_status_message, nc_synchronization_status::status external_synchronization_status, const utility::string_t& external_synchronization_status_message, const web::json::value& synchronization_source_id, nc_essence_status::status essence_status, const utility::string_t& essence_status_message, uint32_t status_reporting_delay, bool auto_reset_monitor);
 
         // See https://specs.amwa.tv/ms-05-02/branches/v1.0.x/docs/Framework.html#ncmanager
         web::json::value make_nc_manager(const nc_class_id& class_id, nc_oid oid, bool constant_oid, const web::json::value& owner, const utility::string_t& role, const web::json::value& user_label, const utility::string_t& description, const web::json::value& touchpoints, const web::json::value& runtime_property_constraints);
@@ -236,10 +241,10 @@ namespace nmos
     web::json::value make_nc_ident_beacon_class();
     // See https://specs.amwa.tv/nmos-control-feature-sets/branches/main/monitoring/#ncreceivermonitor
     web::json::value make_nc_receiver_monitor_class();
-    // See https://specs.amwa.tv/nmos-control-feature-sets/branches/main/monitoring/#ncreceivermonitorprotected
-    web::json::value make_nc_receiver_monitor_protected_class();
+    // See https://specs.amwa.tv/nmos-control-feature-sets/branches/main/monitoring/#ncsendermonitor
+    web::json::value make_nc_sender_monitor_class();
 
-    // control classes proprties/methods/events
+    // control classes properties/methods/events
     // See https://specs.amwa.tv/ms-05-02/branches/v1.0.x/docs/Framework.html#ncobject
     web::json::value make_nc_object_properties();
     web::json::value make_nc_object_methods();
@@ -264,16 +269,19 @@ namespace nmos
     web::json::value make_nc_class_manager_properties();
     web::json::value make_nc_class_manager_methods();
     web::json::value make_nc_class_manager_events();
+    // Monitoring feature set control classes
+    // https://specs.amwa.tv/nmos-control-feature-sets/branches/main/monitoring/#ncstatusmonitor
+    web::json::value make_nc_status_monitor_properties();
+    web::json::value make_nc_status_monitor_methods();
+    web::json::value make_nc_status_monitor_events();
     // See https://specs.amwa.tv/nmos-control-feature-sets/branches/main/monitoring/#ncreceivermonitor
     web::json::value make_nc_receiver_monitor_properties();
     web::json::value make_nc_receiver_monitor_methods();
     web::json::value make_nc_receiver_monitor_events();
-
-    // Monitoring feature set control classes
-    // See https://specs.amwa.tv/nmos-control-feature-sets/branches/main/monitoring/#ncreceivermonitorprotected
-    web::json::value make_nc_receiver_monitor_protected_properties();
-    web::json::value make_nc_receiver_monitor_protected_methods();
-    web::json::value make_nc_receiver_monitor_protected_events();
+    // See https://specs.amwa.tv/nmos-control-feature-sets/branches/main/monitoring/#ncsendermonitor
+    web::json::value make_nc_sender_monitor_properties();
+    web::json::value make_nc_sender_monitor_methods();
+    web::json::value make_nc_sender_monitor_events();
 
     // Identification feature set control classes
     // See https://specs.amwa.tv/nmos-control-feature-sets/branches/main/identification/#ncidentbeacon
@@ -426,8 +434,22 @@ namespace nmos
     //
     // See https://specs.amwa.tv/nmos-control-feature-sets/branches/main/monitoring/#ncconnectionstatus
     web::json::value make_nc_connection_status_datatype();
-    // See https://specs.amwa.tv/nmos-control-feature-sets/branches/main/monitoring/#ncpayloadstatus
-    web::json::value make_nc_payload_status_datatype();
+    // See https://specs.amwa.tv/nmos-control-feature-sets/branches/main/monitoring/#ncessencestatus
+    web::json::value make_nc_essence_status_datatype();
+    // See https://specs.amwa.tv/nmos-control-feature-sets/branches/main/monitoring/#ncoverallstatus
+    web::json::value make_nc_overall_status_datatype();
+    // See https://specs.amwa.tv/nmos-control-feature-sets/branches/main/monitoring/#nclinkstatus
+    web::json::value make_nc_link_status_datatype();
+    // See https://specs.amwa.tv/nmos-control-feature-sets/branches/main/monitoring/#ncsynchronizationstatus
+    web::json::value make_nc_synchronization_status_datatype();
+    // See https://specs.amwa.tv/nmos-control-feature-sets/branches/main/monitoring/#ncstreamstatus
+    web::json::value make_nc_stream_status_datatype();
+    // See https://specs.amwa.tv/nmos-control-feature-sets/branches/main/monitoring/#nccounter
+    web::json::value make_nc_counter_datatype();
+    // See https://specs.amwa.tv/nmos-control-feature-sets/branches/main/monitoring/#nctransmissionstatus
+    web::json::value make_nc_transmission_status_datatype();
+    // See https://specs.amwa.tv/nmos-control-feature-sets/branches/main/monitoring/#ncmethodresultcounters
+    web::json::value make_nc_method_result_counters_datatype();
 }
 
 #endif

Development/nmos/control_protocol_resource.h

@@ -67,22 +67,20 @@ namespace nmos
     //
     // See https://specs.amwa.tv/nmos-control-feature-sets/branches/main/monitoring/#ncreceivermonitor
     control_protocol_resource make_receiver_monitor(nc_oid oid, bool constant_oid, nc_oid owner, const utility::string_t& role, const utility::string_t& user_label, const utility::string_t& description, const web::json::value& touchpoints, const web::json::value& runtime_property_constraints, bool enabled,
-        nc_connection_status::status connection_status, const utility::string_t& connection_status_message, nc_payload_status::status payload_status, const utility::string_t& payload_status_message)
+        nc_overall_status::status overall_status, const utility::string_t& overall_status_message, nc_link_status::status link_status, const utility::string_t& link_status_message, nc_connection_status::status connection_status, const utility::string_t& connection_status_message, nc_synchronization_status::status synchronization_status, const utility::string_t& synchronization_status_message, const web::json::value& synchronization_source_id, nc_stream_status::status stream_status, const utility::string_t& stream_status_message, uint32_t status_reporting_delay, bool auto_reset_monitor)
     {
-        auto data = details::make_receiver_monitor(nc_receiver_monitor_class_id, oid, constant_oid, owner, role, user_label, description, touchpoints, runtime_property_constraints, enabled, connection_status, connection_status_message, payload_status, payload_status_message);
+        auto data = details::make_receiver_monitor(nc_receiver_monitor_class_id, oid, constant_oid, owner, role, user_label, description, touchpoints, runtime_property_constraints, enabled, overall_status, overall_status_message, link_status, link_status_message, connection_status, connection_status_message, synchronization_status, synchronization_status_message, synchronization_source_id, stream_status, stream_status_message, status_reporting_delay, auto_reset_monitor);
 
-        return{ is12_versions::v1_0, types::nc_receiver_monitor, std::move(data), true };
+        return{ is12_versions::v1_0, types::nc_status_monitor, std::move(data), true };
     }
-    // See https://specs.amwa.tv/nmos-control-feature-sets/branches/main/monitoring/#ncreceivermonitorprotected
-    control_protocol_resource make_receiver_monitor_protected(nc_oid oid, bool constant_oid, nc_oid owner, const utility::string_t& role, const utility::string_t& user_label, const utility::string_t& description, const web::json::value& touchpoints, const web::json::value& runtime_property_constraints, bool enabled,
-        nc_connection_status::status connection_status, const utility::string_t& connection_status_message, nc_payload_status::status payload_status, const utility::string_t& payload_status_message, bool signal_protection_status)
-    {
-        using web::json::value;
 
-        auto data = details::make_receiver_monitor(nc_receiver_monitor_protected_class_id, oid, constant_oid, owner, role, user_label, description, touchpoints, runtime_property_constraints, enabled, connection_status, connection_status_message, payload_status, payload_status_message);
-        data[nmos::fields::nc::signal_protection_status] = value::boolean(signal_protection_status);
+    // See https://specs.amwa.tv/nmos-control-feature-sets/branches/main/monitoring/#ncsendermonitor
+    control_protocol_resource make_sender_monitor(nc_oid oid, bool constant_oid, nc_oid owner, const utility::string_t& role, const utility::string_t& user_label, const utility::string_t& description, const web::json::value& touchpoints, const web::json::value& runtime_property_constraints, bool enabled,
+        nc_overall_status::status overall_status, const utility::string_t& overall_status_message, nc_link_status::status link_status, const utility::string_t& link_status_message, nc_transmission_status::status transmission_status, const utility::string_t& transmission_status_message, nc_synchronization_status::status synchronization_status, const utility::string_t& synchronization_status_message, const web::json::value& synchronization_source_id, nc_essence_status::status essence_status, const utility::string_t& essence_status_message, uint32_t status_reporting_delay, bool auto_reset_counters)
+    {
+        auto data = details::make_sender_monitor(nc_sender_monitor_class_id, oid, constant_oid, owner, role, user_label, description, touchpoints, runtime_property_constraints, enabled, overall_status, overall_status_message, link_status, link_status_message, transmission_status, transmission_status_message, synchronization_status, synchronization_status_message, synchronization_source_id, essence_status, essence_status_message, status_reporting_delay, auto_reset_counters);
 
-        return{ is12_versions::v1_0, types::nc_receiver_monitor_protected, std::move(data), true };
+        return{ is12_versions::v1_0, types::nc_status_monitor, std::move(data), true };
     }
 
     // Identification feature set control classes