Update to latest spec datatypes and classes

Author: jonathan-r-thorpe

Development/nmos-cpp-node/main.cpp

@@ -138,7 +138,7 @@ int main(int argc, char* argv[])
                 .on_request_authorization_code(nmos::experimental::make_request_authorization_code_handler(gate)); // may be omitted, only required for OAuth client which is using the Authorization Code Flow to obtain the access token
         }
 
-        nmos::experimental::control_protocol_state control_protocol_state(node_implementation.get_lost_packet_counters, node_implementation.get_late_packet_counters, node_implementation.reset_packet_counters, node_implementation.control_protocol_property_changed);
+        nmos::experimental::control_protocol_state control_protocol_state(node_implementation.get_lost_packet_counters, node_implementation.get_late_packet_counters, node_implementation.reset_packet_counters, node_implementation.reset_synchronization_source_changes, node_implementation.control_protocol_property_changed);
         if (0 <= nmos::fields::control_protocol_ws_port(node_model.settings))
         {
             node_implementation

Development/nmos-cpp-node/node_implementation.cpp

@@ -1746,8 +1746,15 @@ nmos::reset_packet_counters_handler make_node_implementation_reset_packet_counte
     };
 }
 
-
-
+// Example Receiver Status Monitor callback for reset_synchronization_source_changes method
+nmos::reset_synchronization_source_changes_handler make_reset_synchronization_source_changes_handler()
+{
+    return [&]()
+        {
+            // Implement reset of lost and late packet counters
+            return nmos::details::make_nc_method_result({ nmos::nc_method_status::ok });
+        };
+}
 
 namespace impl
 {
@@ -1906,5 +1913,6 @@ nmos::experimental::node_implementation make_node_implementation(nmos::node_mode
         .on_control_protocol_property_changed(make_node_implementation_control_protocol_property_changed_handler(gate)) // may be omitted if IS-12 not required
         .on_get_lost_packet_counters(make_node_implementation_get_lost_packet_counters_handler())
         .on_get_late_packet_counters(make_node_implementation_get_late_packet_counters_handler())
-        .on_reset_packet_counters(make_node_implementation_reset_packet_counters_handler());
+        .on_reset_packet_counters(make_node_implementation_reset_packet_counters_handler())
+        .on_reset_synchronization_source_changes(make_reset_synchronization_source_changes_handler());
 }

Development/nmos/control_protocol_handlers.h

@@ -41,6 +41,7 @@ namespace nmos
     typedef std::function<web::json::value(void)> get_lost_packet_counters_handler;
     typedef std::function<web::json::value(void)> get_late_packet_counters_handler;
     typedef std::function<web::json::value(void)> reset_packet_counters_handler;
+    typedef std::function<web::json::value(void)> reset_synchronization_source_changes_handler;
 
     namespace experimental
     {

Development/nmos/control_protocol_resource.cpp

@@ -263,7 +263,7 @@ 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
     // TODO: link
     web::json::value make_nc_status_monitor_properties();
@@ -426,6 +426,8 @@ namespace nmos
     // See https://specs.amwa.tv/nmos-control-feature-sets/branches/main/monitoring/#ncconnectionstatus
     web::json::value make_nc_connection_status_datatype();
     // TODO: link
+    web::json::value make_nc_essence_status_datatype();
+    // TODO: link
     web::json::value make_nc_overall_status_datatype();
     // TODO: link
     web::json::value make_nc_link_status_datatype();
@@ -434,9 +436,11 @@ namespace nmos
     // TODO: link
     web::json::value make_nc_stream_status_datatype();
     // TODO: link
-    web::json::value make_nc_packet_counter_datatype();
+    web::json::value make_nc_counter_datatype();
     // TODO: link
     web::json::value make_nc_method_result_counters_datatype();
+    // TODO: link
+    web::json::value make_nc_transmission_status_datatype();
 }
 
 #endif

Development/nmos/control_protocol_resource.h

@@ -185,7 +185,7 @@ namespace nmos
                 {
                     // Delegate to user defined handler
                     auto result = nmos::details::make_nc_method_result_error({ nmos::nc_method_status::method_not_implemented }, U("not implemented"));
-                    
+
                     if (get_lost_packet_counters)
                     {
                         result = get_lost_packet_counters();
@@ -239,9 +239,29 @@ namespace nmos
                     return result;
                 };
             }
+            nmos::experimental::control_protocol_method_handler make_nc_reset_synchronization_source_changes_handler(reset_synchronization_source_changes_handler reset_synchonization_source_changes)
+            {
+                return [reset_synchonization_source_changes](nmos::resources& resources, const nmos::resource& resource, const web::json::value& arguments, bool is_deprecated, slog::base_gate& gate)
+                    {
+                        // Delegate to user defined handler
+                        auto result = nmos::details::make_nc_method_result_error({ nmos::nc_method_status::method_not_implemented }, U("not implemented"));
+
+                        if (reset_synchonization_source_changes)
+                        {
+                            result = reset_synchonization_source_changes();
+
+                            const auto& status = nmos::fields::nc::status(result);
+                            if (!web::http::is_error_status_code((web::http::status_code)status) && is_deprecated)
+                            {
+                                return nmos::details::make_nc_method_result({ nmos::nc_method_status::method_deprecated }, nmos::fields::nc::value(result));
+                            }
+                        }
+                        return result;
+                    };
+            }
         }
 
-        control_protocol_state::control_protocol_state(get_lost_packet_counters_handler get_lost_packet_counters, get_late_packet_counters_handler get_late_packet_counters, reset_packet_counters_handler reset_packet_counters, control_protocol_property_changed_handler property_changed)
+        control_protocol_state::control_protocol_state(get_lost_packet_counters_handler get_lost_packet_counters, get_late_packet_counters_handler get_late_packet_counters, reset_packet_counters_handler reset_packet_counters, reset_synchronization_source_changes_handler reset_synchonization_source_changes, control_protocol_property_changed_handler property_changed)
         {
             using web::json::value;
 
@@ -374,11 +394,12 @@ namespace nmos
                     to_vector(make_nc_receiver_monitor_properties()),
                     // NcReceiverMonitor methods
                     to_methods_vector(make_nc_receiver_monitor_methods(),
-                    { 
+                    {
                         // link NcReceiverMonitor method_ids with method functions
                         { nc_receiver_monitor_get_lost_packet_counters_method_id, details::make_nc_get_lost_packet_counters_handler(get_lost_packet_counters)},
                         { nc_receiver_monitor_get_late_packet_counters_method_id, details::make_nc_get_late_packet_counters_handler(get_late_packet_counters)},
-                        { nc_receiver_monitor_reset_packet_counters_method_id, details::make_nc_reset_packet_counters_handler(reset_packet_counters)}
+                        { nc_receiver_monitor_reset_packet_counters_method_id, details::make_nc_reset_packet_counters_handler(reset_packet_counters)},
+                        { nc_receiver_monitor_reset_synchonization_source_changes_method_id, details::make_nc_reset_synchronization_source_changes_handler(reset_packet_counters) }
                     }),
                     // NcReceiverMonitor events
                     to_vector(make_nc_receiver_monitor_events())) }
@@ -460,12 +481,14 @@ namespace nmos
                 // Monitoring feature set
                 // See https://specs.amwa.tv/nmos-control-feature-sets/branches/main/monitoring/#datatypes
                 { U("NcConnectionStatus"), {make_nc_connection_status_datatype()} },
-                { U("NcOverallStatus"), {make_nc_overall_status_datatype() } },
-                { U("NcLinkStatus"), {make_nc_link_status_datatype() } },
-                { U("NcSynchronizationStatus"), {make_nc_synchronization_status_datatype() } },
-                { U("NcStreamStatus"), {make_nc_stream_status_datatype() } },
-                { U("NcPacketCounter"), {make_nc_packet_counter_datatype() } },
-                { U("NcMethodResultCounters"), {make_nc_method_result_counters_datatype() } }
+                { U("NcCounter"), {make_nc_counter_datatype()} },
+                { U("NcEssenceStatus"), {make_nc_essence_status_datatype()} },
+                { U("NcLinkStatus"), {make_nc_link_status_datatype()} },
+                { U("NcMethodResultCounters"), {make_nc_method_result_counters_datatype()} },
+                { U("NcOverallStatus"), {make_nc_overall_status_datatype()} },
+                { U("NcSynchronizationStatus"), {make_nc_synchronization_status_datatype()} },
+                { U("NcStreamStatus"), {make_nc_stream_status_datatype()} },
+                { U("NcTransmissionStatus"), {make_nc_transmission_status_datatype()} }
             };
         }
 

Development/nmos/control_protocol_state.cpp

@@ -58,7 +58,7 @@ namespace nmos
             nmos::read_lock read_lock() const { return nmos::read_lock{ mutex }; }
             nmos::write_lock write_lock() const { return nmos::write_lock{ mutex }; }
 
-            control_protocol_state(get_lost_packet_counters_handler get_lost_packet_counters = nullptr, get_late_packet_counters_handler get_late_packet_counters = nullptr, reset_packet_counters_handler reset_packet_counters = nullptr, control_protocol_property_changed_handler property_changed = nullptr);
+            control_protocol_state(get_lost_packet_counters_handler get_lost_packet_counters = nullptr, get_late_packet_counters_handler get_late_packet_counters = nullptr, reset_packet_counters_handler reset_packet_counters = nullptr, reset_synchronization_source_changes_handler reset_synchonization_source_changes = nullptr, control_protocol_property_changed_handler property_changed = nullptr);
 
             // insert control class descriptor, false if class descriptor already inserted
             bool insert(const experimental::control_class_descriptor& control_class_descriptor);

Development/nmos/control_protocol_state.h

@@ -98,6 +98,8 @@ namespace nmos
         };
     }
 
+    // BCP-008-01/02 enum types
+
     // NcConnectionStatus
     // See https://specs.amwa.tv/nmos-control-feature-sets/branches/main/monitoring/#ncconnectionstatus
     namespace nc_connection_status
@@ -111,15 +113,16 @@ namespace nmos
         };
     }
 
-    // NcOverallStatus
+    // NcEssenceStatus
     // TODO: link
-    namespace nc_overall_status
+    namespace nc_essence_status
     {
         enum status
         {
-            healthy = 1, //         // The overall status is healthy
-            partially_unhealthy = 2,// The overall status is partially healthy
-            unhealthy = 3           // The overall status is unhealthy
+            inactive = 0,           // Inactive
+            healthy = 1,            // Active and healthy
+            partially_healthy = 2,  // Active and partially healthy
+            unhealthy = 3           // Active and unhealthy
         };
     }
 
@@ -129,9 +132,22 @@ namespace nmos
     {
         enum status
         {
-            all_down = 1,   // All the associated network interfaces are down
-            some_down = 2,  // Some of the associated network interfaces are down
-            all_up = 3      // All the associated network interfaces are up
+            all_up = 1,    // All the associated network interfaces are up
+            some_down = 2, // Some of the associated network interfaces are down
+            all_down = 3   // All the associated network interfaces are down
+        };
+    }
+
+    // NcOverallStatus
+    // TODO: link
+    namespace nc_overall_status
+    {
+        enum status
+        {
+            inactive = 0,           // Inactive
+            healthy = 1,            // The overall status is healthy
+            partially_healthy = 2,// The overall status is partially healthy
+            unhealthy = 3           // The overall status is unhealthy
         };
     }
 
@@ -141,12 +157,10 @@ namespace nmos
     {
         enum status
         {
-            not_used = 0,                   // Feature not in use
-            baseband_locked = 1,            // Locked from baseband
-            baseband_partially_locked = 2,  // Partially locked from baseband
-            network_locked = 3,             // Partially locked from network
-            network_partially_locked = 4,   // Partially locked from network
-            not_locked = 5                  // Not locked
+            not_used = 0,           // Feature not in use
+            healthy = 1,            // Locked to a synchronization source
+            partially_healthy = 2,  // Partially locked to a synchronization source
+            unhealthy = 3           // Not locked to a synchronization source
         };
     }
 
@@ -163,6 +177,19 @@ namespace nmos
         };
     }
 
+    //NcTransmissionStatus
+    // TODO: add link
+    namespace nc_transmission_status
+    {
+        enum status
+        {
+            inactive = 0,           // Inactive
+            healthy = 1,            // Active and healthy
+            partially_healthy = 2,  // Active and partially healthy
+            unhealthy = 3           // Active and unhealthy
+        };
+    }
+
     // NcElementId
     // See https://specs.amwa.tv/ms-05-02/branches/v1.0.x/docs/Framework.html#ncelementid
     struct nc_element_id
@@ -215,6 +242,7 @@ namespace nmos
     const nc_method_id nc_receiver_monitor_get_lost_packet_counters_method_id(4, 1);
     const nc_method_id nc_receiver_monitor_get_late_packet_counters_method_id(4, 2);
     const nc_method_id nc_receiver_monitor_reset_packet_counters_method_id(4, 3);
+    const nc_method_id nc_receiver_monitor_reset_synchonization_source_changes_method_id(4, 4);
 
     // NcPropertyId
     // See https://specs.amwa.tv/ms-05-02/branches/v1.0.x/docs/Framework.html#ncpropertyid
@@ -255,18 +283,21 @@ namespace nmos
     // NcPropertyIds for NcStatusMonitor
     const nc_property_id nc_status_monitor_overall_status_property_id(3, 1);
     const nc_property_id nc_status_monitor_overall_status_message_property_id(3, 2);
+    const nc_property_id nc_status_monitor_status_reporting_delay(3, 3);
     // NcPropertyids for NcReceiverMonitor
     // See https://specs.amwa.tv/nmos-control-feature-sets/branches/main/monitoring/#ncreceivermonitor
     const nc_property_id nc_receiver_monitor_link_status_property_id(4, 1);
     const nc_property_id nc_receiver_monitor_link_status_message_property_id(4, 2);
     const nc_property_id nc_receiver_monitor_connection_status_property_id(4, 3);
     const nc_property_id nc_receiver_monitor_connection_status_message_property_id(4, 4);
-    const nc_property_id nc_receiver_monitor_synchronization_status_property_id(4, 5);
-    const nc_property_id nc_receiver_monitor_synchronization_status_message_property_id(4, 6);
-    const nc_property_id nc_receiver_monitor_synchronization_synchronization_source_id_property_id(4, 7);
-    const nc_property_id nc_receiver_monitor_stream_status_property_id(4, 8);
-    const nc_property_id nc_receiver_monitor_stream_status_message_property_id(4, 9);
-    const nc_property_id nc_receiver_monitor_protected_signal_protection_status_property_id(4, 1);
+    const nc_property_id nc_receiver_monitor_external_synchronization_status_property_id(4, 5);
+    const nc_property_id nc_receiver_monitor_external_synchronization_status_message_property_id(4, 6);
+    const nc_property_id nc_receiver_monitor_synchronization_source_id_property_id(4, 7);
+    const nc_property_id nc_receiver_monitor_synchronization_source_changes_property_id(4, 8);
+    const nc_property_id nc_receiver_monitor_stream_status_property_id(4, 9);
+    const nc_property_id nc_receiver_monitor_stream_status_message_property_id(4, 10);
+    const nc_property_id nc_receiver_monitor_auto_reset_packet_counters_property_id(4, 11);
+    const nc_property_id nc_receiver_monitor_auto_reset_synchronization_source_changes_property_id(4, 12);
     // NcPropertyids for NcIdentBeacon
     // See https://specs.amwa.tv/nmos-control-feature-sets/branches/main/identification/#ncidentbeacon
     const nc_property_id nc_ident_beacon_active_property_id(3, 1);

Development/nmos/control_protocol_typedefs.h

@@ -334,15 +334,18 @@ namespace nmos
             const web::json::field_as_string connection_status_message{ U("connectionStatusMessage") };
             const web::json::field_as_integer link_status{ U("linkStatus") }; // NcLinkStatus
             const web::json::field_as_string link_status_message{ U("linkStatusMessage") };
-            const web::json::field_as_integer synchronization_status{ U("synchronizationStatus") }; // NcSynchronizationStatus
-            const web::json::field_as_string synchronization_status_message{ U("synchronizationStatusMessage") };
+            const web::json::field_as_integer synchronization_status{ U("externalSynchronizationStatus") }; // NcSynchronizationStatus
+            const web::json::field_as_string synchronization_status_message{ U("externalSynchronizationStatusMessage") };
             const web::json::field_as_string synchronization_source_id{ U("synchronizationSourceId") };
-            const web::json::field_as_bool signal_protection_status{ U("signalProtectionStatus") };
+            const web::json::field_as_integer synchronization_source_changes{ U("synchronizationSourceChanges") };
             const web::json::field_as_integer stream_status{ U("streamStatus") }; // NcStreamStatus
             const web::json::field_as_string stream_status_message{ U("streamStatusMessage") };
+            const web::json::field_as_bool auto_reset_packet_counters{ U("autoResetPacketCounters") };
+            const web::json::field_as_bool auto_reset_synchronization_source_changes{ U("autoResetSynchronizationSourceChanges") };
             const web::json::field_as_bool active{ U("active") };
             const web::json::field_as_integer overall_status{ U("overallStatus") };
             const web::json::field_as_string overall_status_message{ U("overallStatusMessage") };
+            const web::json::field_as_integer status_reporting_delay{ U("statusReportingDelay") };
         }
 
         // NMOS Parameter Registers

Development/nmos/json_fields.h

@@ -85,6 +85,7 @@ namespace nmos
             node_implementation& on_get_lost_packet_counters(nmos::get_lost_packet_counters_handler get_lost_packet_counters) { this->get_lost_packet_counters = std::move(get_lost_packet_counters); return *this; }
             node_implementation& on_get_late_packet_counters(nmos::get_late_packet_counters_handler get_late_packet_counters) { this->get_late_packet_counters = std::move(get_late_packet_counters); return *this; }
             node_implementation& on_reset_packet_counters(nmos::reset_packet_counters_handler reset_packet_counters) { this->reset_packet_counters = std::move(reset_packet_counters); return *this; }
+            node_implementation& on_reset_synchronization_source_changes(nmos::reset_synchronization_source_changes_handler reset_synchronization_source_changes) { this->reset_synchronization_source_changes = std::move(reset_synchronization_source_changes); return *this; }
 
             // deprecated, use on_validate_connection_resource_patch
             node_implementation& on_validate_merged(nmos::details::connection_resource_patch_validator validate_merged) { return on_validate_connection_resource_patch(std::move(validate_merged)); }
@@ -130,6 +131,7 @@ namespace nmos
             nmos::get_lost_packet_counters_handler get_lost_packet_counters;
             nmos::get_late_packet_counters_handler get_late_packet_counters;
             nmos::reset_packet_counters_handler reset_packet_counters;
+            nmos::reset_synchronization_source_changes_handler reset_synchronization_source_changes;
         };
 
         // Construct a server instance for an NMOS Node, implementing the IS-04 Node API, IS-05 Connection API, IS-07 Events API