diff --git a/docs-gen/.hugo_build.lock b/docs-gen/.hugo_build.lock deleted file mode 100644 index e69de29..0000000 diff --git a/docs-gen/content/configuration_rule_set/basics.md b/docs-gen/content/configuration_rule_set/basics.md index f1cd20b..f1e46f6 100644 --- a/docs-gen/content/configuration_rule_set/basics.md +++ b/docs-gen/content/configuration_rule_set/basics.md @@ -12,13 +12,13 @@ To support the server in managing this forest of trees, a HIM configuration tree The server may also share this configuration file on request from clients, in order for them to discover the information available by the forest. The HIM model is not restricted to client/server models. -A file containing this configuration shall have a name starting with "HIM_configuration", +A file containing this configuration shall have a name starting with "HIM_configuration", with an optional suffix that might describe the domain, information type, or version. The file may have the extension ".him", which typically would indicate that it is YAML formatted. -Any file extension can be used that indicates it has been transformed from its YAML source format to a different format like ".json". +Any file extension can be used that indicates it has been transformed from its YAML source format to a different format like ".json". The configuration tree root node shall have a name starting with "HIM_config", which may be followed by additional information -such as a descriptive domain name, version, etc. +such as a descriptive domain name, version, etc. A server may share the information of this file with a client that wants to discover what information the server manages. @@ -35,7 +35,7 @@ The creation of a HIM configuration file is the responsibility of the HIM server The following node types can be used in a configuration tree: 1. [Branch](/hierarchical_information_model/common_rule_set/node_types/branch/) -2. [Taxonomy](/hierarchical_information_model/configuration_rule_set/node_types/taxonomy/) +2. [Direct](/hierarchical_information_model/configuration_rule_set/node_types/diect/) 3. [Proxy](/hierarchical_information_model/configuration_rule_set/node_types/proxy/) ## Configuration Tree Example @@ -44,7 +44,6 @@ This example shows a forest consisting of three local trees, and a remote tree: 2. A local tree containing passenger car related services, having the root node name VehicleServices. 3. A local tree containing type passenger car related ype definitions, having the root node name Types. 4. A remote tree containing charge station related signals, having the root node name ChargingStationData. -- ```YAML HIM: @@ -53,27 +52,27 @@ HIM: VehicleData: - type: taxonomy + type: direct domain: Vehicle.Car.ResourceData version: X.Y.Z local: file:// - public: https://himrepo.oem.com?taxonomy=Vehicle.Car.ResourceData.X.Y.Z + public: https://himrepo.oem.com?instance=Vehicle.Car.ResourceData.X.Y.Z description: …. VehicleServices: - type: taxonomy + type: direct domain: Vehicle.Car.ServiceData version: X.Y.Z local: file:// - public: https://himrepo.oem.com?taxonomy=Vehicle.Car.ServiceData.X.Y.Z + public: https://himrepo.oem.com?instance=Vehicle.Car.ServiceData.X.Y.Z description: …. Types: - type: taxonomy + type: direct domain: Vehicle.Car.TypeDefinition version: X.Y.Z local: file:// - public: https://himrepo.oem.com?taxonomy=Vehicle.Car.DataType.X.Y.Z + public: https://himrepo.oem.com?instance=Vehicle.Car.DataType.X.Y.Z description: …. @@ -81,6 +80,6 @@ ChargingStationData: type: proxy domain:ChargingStation.Vehicle.ResourceData version: X.Y.Z - public: https://himrepo.energyco.com?taxonomy=ChargingStation.Vehicle.ResourceData.X.Y.Z + public: https://himrepo.energyco.com?instance=ChargingStation.Vehicle.ResourceData.X.Y.Z description: …. ``` diff --git a/docs-gen/content/configuration_rule_set/node_types/taxonomy.md b/docs-gen/content/configuration_rule_set/node_types/direct.md similarity index 85% rename from docs-gen/content/configuration_rule_set/node_types/taxonomy.md rename to docs-gen/content/configuration_rule_set/node_types/direct.md index 6166efe..72c88cc 100644 --- a/docs-gen/content/configuration_rule_set/node_types/taxonomy.md +++ b/docs-gen/content/configuration_rule_set/node_types/direct.md @@ -1,12 +1,12 @@ --- -title: "Taxonomy node" +title: "Direct node" weight: 30 --- -A `taxonomy` node in a HIM configuration file defines a tree that the server managing this forest have a local and complete copy of. +A `direct` node in a HIM configuration file defines a tree that the server managing this forest have a local and complete copy of. This means that the server can efficiently parse the tree to e. g. verify that a client request for information points to an existing node in the tree. -Nodes of the type `taxonomy` must have the following mandatory metadata: +Nodes of the type `direct` must have the following mandatory metadata: - Name - Type - Domain @@ -58,17 +58,17 @@ The `local` metadta shall not be supplied to a client requesting the configurati ## Public The public metadata shall, if available, be a URL to a public copy of the tree. -It may be used to provision a server with a copy of the tree, +It may be used to provision a server with a copy of the tree, but also by a client to obtin a copy instead of e. g. requesting the server to provision a copy. -An example of the specification of a `taxonomy` node is given below. +An example of the specification of a `direct` node is given below. ```YAML VehicleData: - type: taxonomy + type: direct domain: Vehicle.Car.ResourceData version: X.Y.Z local: file:// - public: https://himrepo.oem.com?taxonomy=Vehicle.Car.ResourceData.X.Y.Z + public: https://himrepo.oem.com?intance=Vehicle.Car.ResourceData.X.Y.Z description: …. ``` diff --git a/docs-gen/content/configuration_rule_set/node_types/proxy.md b/docs-gen/content/configuration_rule_set/node_types/proxy.md index d659bbb..9931eb6 100644 --- a/docs-gen/content/configuration_rule_set/node_types/proxy.md +++ b/docs-gen/content/configuration_rule_set/node_types/proxy.md @@ -55,16 +55,16 @@ Versioning shall be based on the [Semantic versioning](https://semver.org/spec/v ## Public The public metadata shall, if available, be a URL to a public copy of the tree. -It may be used to provision a server with a copy of the tree, +It may be used to provision a server with a copy of the tree, but also by a client to obtain a copy instead of e. g. requesting the proxy server to provision a copy from the server managing it. -An example of the specification of a `taxonomy` node is given below. +An example of the specification of a `proxy` node is given below. ```YAML VehicleData: type: proxy domain: HomeAutomation.Zigbee.ResourceData version: X.Y.Z - public: https://himrepo.oem.com?taxonomy=HomeAutomation.Zigbee.ResourceData.X.Y.Z + public: https://himrepo.oem.com?instance=HomeAutomation.Zigbee.ResourceData.X.Y.Z description: …. ``` diff --git a/examples/HIM_Service.v1.0.0.him b/examples/HIM_Service.v1.0.0.him index 9906806..1879f31 100644 --- a/examples/HIM_Service.v1.0.0.him +++ b/examples/HIM_Service.v1.0.0.him @@ -7,7 +7,7 @@ VehicleService.ExteriorLighting: description: The Exterior lighting service. VehicleService.ExteriorLighting.HeadLampsOnOff: - type: microservice + type: procedure description: Microservice name: HeadLampsOnOff, Input: Switch, Output: None. VehicleService.ExteriorLighting.HeadLampsOnOff.Input: diff --git a/examples/HIM_config_example.v1.0.0.him b/examples/HIM_config_example.v1.0.0.him index 64dfe2d..68dede0 100644 --- a/examples/HIM_config_example.v1.0.0.him +++ b/examples/HIM_config_example.v1.0.0.him @@ -4,27 +4,27 @@ HIM: VehicleData: - type: taxonomy + type: direct domain: Vehicle.Car.ResourceData version: X.Y.Z local: file:// - public: https://himrepo.oem.com?taxonomy=Vehicle.Car.ResourceData.X.Y.Z + public: https://himrepo.oem.com?instance=Vehicle.Car.ResourceData.X.Y.Z description: …. VehicleServices: - type: taxonomy + type: direct domain: Vehicle.Car.ServiceData version: X.Y.Z local: file:// - public: https://himrepo.oem.com?taxonomy=Vehicle.Car.ServiceData.X.Y.Z + public: https://himrepo.oem.com?instance=Vehicle.Car.ServiceData.X.Y.Z description: …. Types: - type: taxonomy + type: direct domain: Vehicle.Car.TypeDefinition version: X.Y.Z local: file:// - public: https://himrepo.oem.com?taxonomy=Vehicle.Car.DataType.X.Y.Z + public: https://himrepo.oem.com?instance=Vehicle.Car.DataType.X.Y.Z description: …. @@ -32,7 +32,7 @@ ChargingStationData: type: proxy domain:ChargingStation.Vehicle.ResourceData version: X.Y.Z - public: https://himrepo.energyco.com?taxonomy=ChargingStation.Vehicle.ResourceData.X.Y.Z + public: https://himrepo.energyco.com?instance=ChargingStation.Vehicle.ResourceData.X.Y.Z description: …. HIM.Version: