IS-14 support

Development/cmake/NmosCppLibraries.cmake

@@ -834,6 +834,90 @@ target_include_directories(nmos_is12_schemas PUBLIC
 list(APPEND NMOS_CPP_TARGETS nmos_is12_schemas)
 add_library(nmos-cpp::nmos_is12_schemas ALIAS nmos_is12_schemas)
 
+# nmos_is14_schemas library
+
+set(NMOS_IS14_SCHEMAS_HEADERS
+    nmos/is14_schemas/is14_schemas.h
+    )
+
+set(NMOS_IS14_V1_0_TAG v1.0.x)
+
+set(NMOS_IS14_V1_0_SCHEMAS_JSON
+    third_party/is-14/${NMOS_IS14_V1_0_TAG}/APIs/schemas/base.json
+    third_party/is-14/${NMOS_IS14_V1_0_TAG}/APIs/schemas/bulkProperties-get-response.json
+    third_party/is-14/${NMOS_IS14_V1_0_TAG}/APIs/schemas/bulkProperties-set-request.json
+    third_party/is-14/${NMOS_IS14_V1_0_TAG}/APIs/schemas/bulkProperties-set-response.json
+    third_party/is-14/${NMOS_IS14_V1_0_TAG}/APIs/schemas/bulkProperties-validate-request.json
+    third_party/is-14/${NMOS_IS14_V1_0_TAG}/APIs/schemas/bulkProperties-validate-response.json
+    third_party/is-14/${NMOS_IS14_V1_0_TAG}/APIs/schemas/descriptor-get.json
+    third_party/is-14/${NMOS_IS14_V1_0_TAG}/APIs/schemas/method-patch-request.json
+    third_party/is-14/${NMOS_IS14_V1_0_TAG}/APIs/schemas/method-patch-response.json
+    third_party/is-14/${NMOS_IS14_V1_0_TAG}/APIs/schemas/methods-base.json
+    third_party/is-14/${NMOS_IS14_V1_0_TAG}/APIs/schemas/ms05-error.json
+    third_party/is-14/${NMOS_IS14_V1_0_TAG}/APIs/schemas/properties-base.json
+    third_party/is-14/${NMOS_IS14_V1_0_TAG}/APIs/schemas/property.json
+    third_party/is-14/${NMOS_IS14_V1_0_TAG}/APIs/schemas/property-descriptor.json
+    third_party/is-14/${NMOS_IS14_V1_0_TAG}/APIs/schemas/property-value-get.json
+    third_party/is-14/${NMOS_IS14_V1_0_TAG}/APIs/schemas/property-value-put-request.json
+    third_party/is-14/${NMOS_IS14_V1_0_TAG}/APIs/schemas/property-value-put-response.json
+    third_party/is-14/${NMOS_IS14_V1_0_TAG}/APIs/schemas/rolePath.json
+    third_party/is-14/${NMOS_IS14_V1_0_TAG}/APIs/schemas/rolePaths-base.json
+    )
+
+set(NMOS_IS14_SCHEMAS_JSON_MATCH "third_party/is-14/([^/]+)/APIs/schemas/([^;]+)\\.json")
+set(NMOS_IS14_SCHEMAS_SOURCE_REPLACE "${CMAKE_CURRENT_BINARY_DIR_REPLACE}/nmos/is14_schemas/\\1/\\2.cpp")
+string(REGEX REPLACE "${NMOS_IS14_SCHEMAS_JSON_MATCH}(;|$)" "${NMOS_IS14_SCHEMAS_SOURCE_REPLACE}\\3" NMOS_IS14_V1_0_SCHEMAS_SOURCES "${NMOS_IS14_V1_0_SCHEMAS_JSON}")
+
+foreach(JSON ${NMOS_IS14_V1_0_SCHEMAS_JSON})
+    string(REGEX REPLACE "${NMOS_IS14_SCHEMAS_JSON_MATCH}" "${NMOS_IS14_SCHEMAS_SOURCE_REPLACE}" SOURCE "${JSON}")
+    string(REGEX REPLACE "${NMOS_IS14_SCHEMAS_JSON_MATCH}" "\\1" NS "${JSON}")
+    string(REGEX REPLACE "${NMOS_IS14_SCHEMAS_JSON_MATCH}" "\\2" VAR "${JSON}")
+    string(MAKE_C_IDENTIFIER "${NS}" NS)
+    string(MAKE_C_IDENTIFIER "${VAR}" VAR)
+
+    file(WRITE "${SOURCE}.in" "\
+// Auto-generated from: ${JSON}\n\
+\n\
+namespace nmos\n\
+{\n\
+    namespace is14_schemas\n\
+    {\n\
+        namespace ${NS}\n\
+        {\n\
+            const char* ${VAR} = R\"-auto-generated-(")
+
+    file(READ "${JSON}" RAW)
+    file(APPEND "${SOURCE}.in" "${RAW}")
+
+    file(APPEND "${SOURCE}.in" ")-auto-generated-\";\n\
+        }\n\
+    }\n\
+}\n")
+
+    configure_file("${SOURCE}.in" "${SOURCE}" COPYONLY)
+endforeach()
+
+add_library(
+    nmos_is14_schemas STATIC
+    ${NMOS_IS14_SCHEMAS_HEADERS}
+    ${NMOS_IS14_V1_0_SCHEMAS_SOURCES}
+    )
+
+source_group("nmos\\is14_schemas\\Header Files" FILES ${NMOS_IS14_SCHEMAS_HEADERS})
+source_group("nmos\\is14_schemas\\${NMOS_IS14_V1_0_TAG}\\Source Files" FILES ${NMOS_IS14_V1_0_SCHEMAS_SOURCES})
+
+target_link_libraries(
+    nmos_is14_schemas PRIVATE
+    nmos-cpp::compile-settings
+    )
+target_include_directories(nmos_is14_schemas PUBLIC
+    $<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}>
+    $<INSTALL_INTERFACE:${NMOS_CPP_INSTALL_INCLUDEDIR}>
+    )
+
+list(APPEND NMOS_CPP_TARGETS nmos_is14_schemas)
+add_library(nmos-cpp::nmos_is14_schemas ALIAS nmos_is14_schemas)
+
 # nmos-cpp library
 
 set(NMOS_CPP_BST_SOURCES
@@ -921,6 +1005,7 @@ set(NMOS_CPP_NMOS_SOURCES
     nmos/channels.cpp
     nmos/client_utils.cpp
     nmos/components.cpp
+    nmos/configuration_api.cpp
     nmos/connection_activation.cpp
     nmos/connection_api.cpp
     nmos/connection_events_activation.cpp
@@ -1014,6 +1099,7 @@ set(NMOS_CPP_NMOS_HEADERS
     nmos/colorspace.h
     nmos/components.h
     nmos/copyable_atomic.h
+    nmos/configuration_api.h
     nmos/connection_activation.h
     nmos/connection_api.h
     nmos/connection_events_activation.h
@@ -1048,6 +1134,7 @@ set(NMOS_CPP_NMOS_HEADERS
     nmos/is09_versions.h
     nmos/is10_versions.h
     nmos/is12_versions.h
+    nmos/is14_versions.h
     nmos/issuers.h
     nmos/json_fields.h
     nmos/json_schema.h
@@ -1198,6 +1285,7 @@ target_link_libraries(
     nmos-cpp::nmos_is09_schemas
     nmos-cpp::nmos_is10_schemas
     nmos-cpp::nmos_is12_schemas
+    nmos-cpp::nmos_is14_schemas
     nmos-cpp::mdns
     nmos-cpp::slog
     nmos-cpp::OpenSSL

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.control_protocol_property_changed);
+        nmos::experimental::control_protocol_state control_protocol_state(node_implementation.control_protocol_property_changed, node_implementation.get_properties_by_path, node_implementation.validate_set_properties_by_path, node_implementation.set_properties_by_path);
         if (0 <= nmos::fields::control_protocol_ws_port(node_model.settings))
         {
             node_implementation

Development/nmos-cpp-node/node_implementation.cpp

@@ -1206,6 +1206,9 @@ void node_implementation_init(nmos::node_model& model, nmos::experimental::contr
         // example class manager
         auto class_manager = nmos::make_class_manager(++oid, control_protocol_state);
 
+        // example bulk properties manager
+        auto bulk_properties_manager = nmos::make_bulk_properties_manager(++oid);
+
         // example stereo gain
         const auto stereo_gain_oid = ++oid;
         auto stereo_gain = nmos::make_block(stereo_gain_oid, nmos::root_block_oid, U("stereo-gain"), U("Stereo gain"), U("Stereo gain block"));
@@ -1263,7 +1266,7 @@ void node_implementation_init(nmos::node_model& model, nmos::experimental::contr
                     utility::stringstream_t role;
                     role << U("monitor-") << ++count;
                     const auto& receiver = nmos::find_resource(model.node_resources, receiver_id);
-                    const auto receiver_monitor = nmos::make_receiver_monitor(++oid, true, nmos::root_block_oid, role.str(), nmos::fields::label(receiver->data), nmos::fields::description(receiver->data), value_of({ { nmos::details::make_nc_touchpoint_nmos({nmos::ncp_nmos_resource_types::receiver, receiver_id}) } }));
+                    const auto receiver_monitor = nmos::make_receiver_monitor(++oid, true, nmos::root_block_oid, role.str(), nmos::fields::label(receiver->data), nmos::fields::description(receiver->data), value_of({ { nmos::details::make_nc_touchpoint_nmos({nmos::ncp_touchpoint_resource_types::receiver, receiver_id}) } }));
 
                     // add receiver-monitor to root-block
                     nmos::push_back(root_block, receiver_monitor);
@@ -1284,6 +1287,8 @@ void node_implementation_init(nmos::node_model& model, nmos::experimental::contr
         nmos::push_back(root_block, class_manager);
         // add device-manager to root-block
         nmos::push_back(root_block, device_manager);
+        // add bulk-properties-manager to root-block
+        nmos::push_back(root_block, bulk_properties_manager);
 
         // insert control protocol resources to model
         insert_root_after(delay_millis, root_block, gate);
@@ -1714,6 +1719,42 @@ nmos::control_protocol_property_changed_handler make_node_implementation_control
     };
 }
 
+// Example Device Configuration callback for creating a back-up dataset
+nmos::get_properties_by_path_handler make_node_implementation_get_properties_by_path_handler(const nmos::resources& resources, slog::base_gate& gate)
+{
+    return [&resources, &gate](nmos::get_control_protocol_class_descriptor_handler get_control_protocol_class_descriptor, nmos::get_control_protocol_datatype_descriptor_handler get_control_protocol_datatype_descriptor, const nmos::resource& resource, bool recurse)
+    {
+        slog::log<slog::severities::info>(gate, SLOG_FLF) << nmos::stash_category(impl::categories::node_implementation) << "Do get_properties_by_path";
+
+        // Implement backup of device model here
+        return nmos::details::make_nc_method_result({ nmos::nc_method_status::ok });
+    };
+}
+
+// Example Device Configuration callback for validating a back-up dataset
+nmos::validate_set_properties_by_path_handler make_node_implementation_validate_set_properties_by_path_handler(const nmos::resources& resources, slog::base_gate& gate)
+{
+    return [&resources, &gate](nmos::get_control_protocol_class_descriptor_handler get_control_protocol_class_descriptor, nmos::get_control_protocol_datatype_descriptor_handler get_control_protocol_datatype_descriptor, const nmos::resource& resource, const web::json::value& backup_data_set, bool recurse, const web::json::array& included_property_traits)
+    {
+        slog::log<slog::severities::info>(gate, SLOG_FLF) << nmos::stash_category(impl::categories::node_implementation) << "Do validate_set_properties_by_path";
+
+        // Can this backup be restored?
+        return nmos::details::make_nc_method_result({ nmos::nc_method_status::ok });
+    };
+}
+
+// Example Device Configuration callback for restoring a back-up dataset
+nmos::set_properties_by_path_handler make_node_implementation_set_properties_by_path_handler(nmos::resources& resources, slog::base_gate& gate)
+{
+    return [&resources, &gate](nmos::get_control_protocol_class_descriptor_handler get_control_protocol_class_descriptor, nmos::get_control_protocol_datatype_descriptor_handler get_control_protocol_datatype_descriptor, const nmos::resource& resource, const web::json::value& data_set, bool recurse, const web::json::array& included_property_traits)
+    {
+        slog::log<slog::severities::info>(gate, SLOG_FLF) << nmos::stash_category(impl::categories::node_implementation) << "Do set_properties_by_path";
+
+        // Implement restore of device model here
+        return nmos::details::make_nc_method_result({ nmos::nc_method_status::ok });
+    };
+}
+
 namespace impl
 {
     nmos::interlace_mode get_interlace_mode(const nmos::settings& settings)
@@ -1868,5 +1909,8 @@ nmos::experimental::node_implementation make_node_implementation(nmos::node_mode
         .on_connection_activated(make_node_implementation_connection_activation_handler(model, gate))
         .on_validate_channelmapping_output_map(make_node_implementation_map_validator()) // may be omitted if not required
         .on_channelmapping_activated(make_node_implementation_channelmapping_activation_handler(gate))
-        .on_control_protocol_property_changed(make_node_implementation_control_protocol_property_changed_handler(gate)); // may be omitted if IS-12 not required
+        .on_control_protocol_property_changed(make_node_implementation_control_protocol_property_changed_handler(gate)) // may be omitted if IS-12 not required
+        .on_get_properties_by_path(make_node_implementation_get_properties_by_path_handler(model.control_protocol_resources, gate)) // may be omitted if IS-14 not required
+        .on_validate_set_properties_by_path(make_node_implementation_validate_set_properties_by_path_handler(model.control_protocol_resources, gate)) // may be omitted if IS-14 not required
+        .on_set_properties_by_path(make_node_implementation_set_properties_by_path_handler(model.control_protocol_resources, gate)); // may be omitted if IS-14 not required
 }

Development/nmos/api_utils.h

@@ -57,6 +57,8 @@ namespace nmos
         const route_pattern channelmapping_api = make_route_pattern(U("api"), U("channelmapping"));
         // IS-09 System API (originally specified in JT-NM TR-1001-1:2018 Annex A)
         const route_pattern system_api = make_route_pattern(U("api"), U("system"));
+        // IS-14 Configuration API
+        const route_pattern configuration_api = make_route_pattern(U("api"), U("configuration"));
 
         // API version pattern
         const route_pattern version = make_route_pattern(U("version"), U("v[0-9]+\\.[0-9]+"));
@@ -87,6 +89,11 @@ namespace nmos
         const route_pattern outputSubroute = make_route_pattern(U("outputSubroute"), U("properties|sourceid|channels|caps"));
         const route_pattern activationId = make_route_pattern(U("activationId"), U("[a-zA-Z0-9\\-_]+"));
 
+        // Configuration API
+        const route_pattern rolePath = make_route_pattern(U("rolePath"), U("root|root\\.[a-zA-Z0-9\\-_\\.]+"));
+        const route_pattern propertyId = make_route_pattern(U("propertyId"), U("[0-9]+p[0-9]+"));
+        const route_pattern methodId = make_route_pattern(U("methodId"), U("[0-9]+m[0-9]+"));
+
         // Common patterns
         const route_pattern resourceId = make_route_pattern(U("resourceId"), U("[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}"));
     }