From 1c20b85ba97b74800fb0b683bf3a320ba5081bce Mon Sep 17 00:00:00 2001 From: cbupp Date: Thu, 9 Nov 2023 16:10:51 +0000 Subject: [PATCH] Merged and regenerated docs/APIs for revision 4.0.0.21 --- API/REST/RealEstateCore.Ontology.DTDLv2.yaml | 554 +++++++++--------- Doc/Asset/Equipment/ICT-/Controller.md | 49 ++ .../Equipment/ICT-/Controller/Controller.md | 55 -- Doc/Asset/Equipment/ICT-/ICTEquipment.md | 2 +- .../GatewayConnectionParameter.md | 14 +- .../IoTHubConnectionParameter.md | 14 +- Doc/Point/Parameter/Parameter.md | 1 + Doc/index.full.md | 6 +- .../RealEstateCore.Ontology.DTDLv2.nuspec | 2 +- RealEstateCore.DTDLv2.jsonld | 72 ++- 10 files changed, 388 insertions(+), 381 deletions(-) create mode 100644 Doc/Asset/Equipment/ICT-/Controller.md delete mode 100644 Doc/Asset/Equipment/ICT-/Controller/Controller.md diff --git a/API/REST/RealEstateCore.Ontology.DTDLv2.yaml b/API/REST/RealEstateCore.Ontology.DTDLv2.yaml index 6f52de30d..0f1714165 100644 --- a/API/REST/RealEstateCore.Ontology.DTDLv2.yaml +++ b/API/REST/RealEstateCore.Ontology.DTDLv2.yaml @@ -1,6 +1,6 @@ openapi: 3.0.3 info: - version: "4.0.0.20" + version: "4.0.0.21" title: RealEstateCore.Ontology.DTDLv2 license: name: BSD-3-Clause @@ -130,29 +130,17 @@ components: type: string desc: type: string - Asset: + Collection: type: object properties: '@id': type: string '@type': type: string - default: dtmi:org:w3id:rec:Asset;1 + default: dtmi:org:w3id:rec:Collection;1 '@context': type: string - default: https://dev.realestatecore.io/contexts/Asset.jsonld - commissionedBy: - type: array - items: - type: object - required: - - '@id' - properties: - '@id': - type: string - '@type': - type: string - default: dtmi:org:w3id:rec:Agent;1 + default: https://dev.realestatecore.io/contexts/Collection.jsonld documentation: type: array items: @@ -165,143 +153,14 @@ components: '@type': type: string default: dtmi:org:w3id:rec:Document;1 - geometry: - type: object - required: - - '@id' - properties: - '@id': - type: string - '@type': - type: string - default: dtmi:org:w3id:rec:Geometry;1 - hasPart: - type: array - items: - type: object - required: - - '@id' - properties: - '@id': - type: string - '@type': - type: string - default: dtmi:org:w3id:rec:Asset;1 - hasPoint: - type: array - items: - type: object - required: - - '@id' - properties: - '@id': - type: string - '@type': - type: string - default: dtmi:org:brickschema:schema:Brick:Point;1 - installedBy: - type: array - items: - type: object - required: - - '@id' - properties: - '@id': - type: string - '@type': - type: string - default: dtmi:org:w3id:rec:Agent;1 - isPartOf: - type: array - items: - type: object - required: - - '@id' - properties: - '@id': - type: string - '@type': - type: string - default: dtmi:org:w3id:rec:Asset;1 - locatedIn: - type: array - items: - type: object - required: - - '@id' - properties: - '@id': - type: string - '@type': - type: string - default: dtmi:org:w3id:rec:Space;1 - manufacturedBy: - type: array - items: - type: object - required: - - '@id' - properties: - '@id': - type: string - '@type': - type: string - default: dtmi:org:w3id:rec:Agent;1 - mountedOn: - type: object - required: - - '@id' - properties: - '@id': - type: string - '@type': - type: string - default: dtmi:org:w3id:rec:BuildingElement;1 - servicedBy: - type: array - items: - type: object - required: - - '@id' - properties: - '@id': - type: string - '@type': - type: string - default: dtmi:org:w3id:rec:Agent;1 - IPAddress: - type: string - MACAddress: - type: string - assetTag: - type: string - commissioningDate: - type: string - format: date customProperties: type: string customTags: type: string identifiers: type: string - initialCost: - type: string - installationDate: - type: string - format: date - maintenanceInterval: - type: string - modelNumber: - type: string name: type: string - serialNumber: - type: string - turnoverDate: - type: string - format: date - weight: - type: string Space: type: object properties: @@ -374,34 +233,69 @@ components: type: string name: type: string - Event: + BuildingElement: type: object properties: '@id': type: string '@type': type: string - default: dtmi:org:w3id:rec:Event;1 + default: dtmi:org:w3id:rec:BuildingElement;1 '@context': type: string - default: https://dev.realestatecore.io/contexts/Event.jsonld + default: https://dev.realestatecore.io/contexts/BuildingElement.jsonld + documentation: + type: array + items: + type: object + required: + - '@id' + properties: + '@id': + type: string + '@type': + type: string + default: dtmi:org:w3id:rec:Document;1 + hasPart: + type: array + items: + type: object + required: + - '@id' + properties: + '@id': + type: string + '@type': + type: string + default: dtmi:org:w3id:rec:BuildingElement;1 + isPartOf: + type: object + required: + - '@id' + properties: + '@id': + type: string + '@type': + type: string + default: dtmi:org:w3id:rec:BuildingElement;1 + locatedIn: + type: object + required: + - '@id' + properties: + '@id': + type: string + '@type': + type: string + default: dtmi:org:w3id:rec:Architecture;1 customProperties: type: string customTags: type: string - end: - type: string - format: date-time identifiers: type: string name: type: string - start: - type: string - format: date-time - timestamp: - type: string - format: date-time Agent: type: object properties: @@ -444,29 +338,17 @@ components: type: string name: type: string - Collection: + Information: type: object properties: '@id': type: string '@type': type: string - default: dtmi:org:w3id:rec:Collection;1 + default: dtmi:org:w3id:rec:Information;1 '@context': type: string - default: https://dev.realestatecore.io/contexts/Collection.jsonld - documentation: - type: array - items: - type: object - required: - - '@id' - properties: - '@id': - type: string - '@type': - type: string - default: dtmi:org:w3id:rec:Document;1 + default: https://dev.realestatecore.io/contexts/Information.jsonld customProperties: type: string customTags: @@ -475,36 +357,57 @@ components: type: string name: type: string - Information: + Event: type: object properties: '@id': type: string '@type': type: string - default: dtmi:org:w3id:rec:Information;1 + default: dtmi:org:w3id:rec:Event;1 '@context': type: string - default: https://dev.realestatecore.io/contexts/Information.jsonld + default: https://dev.realestatecore.io/contexts/Event.jsonld customProperties: type: string customTags: type: string + end: + type: string + format: date-time identifiers: type: string name: type: string - BuildingElement: + start: + type: string + format: date-time + timestamp: + type: string + format: date-time + Asset: type: object properties: '@id': type: string '@type': type: string - default: dtmi:org:w3id:rec:BuildingElement;1 + default: dtmi:org:w3id:rec:Asset;1 '@context': type: string - default: https://dev.realestatecore.io/contexts/BuildingElement.jsonld + default: https://dev.realestatecore.io/contexts/Asset.jsonld + commissionedBy: + type: array + items: + type: object + required: + - '@id' + properties: + '@id': + type: string + '@type': + type: string + default: dtmi:org:w3id:rec:Agent;1 documentation: type: array items: @@ -516,8 +419,54 @@ components: type: string '@type': type: string - default: dtmi:org:w3id:rec:Document;1 - hasPart: + default: dtmi:org:w3id:rec:Document;1 + geometry: + type: object + required: + - '@id' + properties: + '@id': + type: string + '@type': + type: string + default: dtmi:org:w3id:rec:Geometry;1 + hasPart: + type: array + items: + type: object + required: + - '@id' + properties: + '@id': + type: string + '@type': + type: string + default: dtmi:org:w3id:rec:Asset;1 + hasPoint: + type: array + items: + type: object + required: + - '@id' + properties: + '@id': + type: string + '@type': + type: string + default: dtmi:org:brickschema:schema:Brick:Point;1 + installedBy: + type: array + items: + type: object + required: + - '@id' + properties: + '@id': + type: string + '@type': + type: string + default: dtmi:org:w3id:rec:Agent;1 + isPartOf: type: array items: type: object @@ -528,18 +477,32 @@ components: type: string '@type': type: string - default: dtmi:org:w3id:rec:BuildingElement;1 - isPartOf: - type: object - required: - - '@id' - properties: - '@id': - type: string - '@type': - type: string - default: dtmi:org:w3id:rec:BuildingElement;1 + default: dtmi:org:w3id:rec:Asset;1 locatedIn: + type: array + items: + type: object + required: + - '@id' + properties: + '@id': + type: string + '@type': + type: string + default: dtmi:org:w3id:rec:Space;1 + manufacturedBy: + type: array + items: + type: object + required: + - '@id' + properties: + '@id': + type: string + '@type': + type: string + default: dtmi:org:w3id:rec:Agent;1 + mountedOn: type: object required: - '@id' @@ -548,15 +511,52 @@ components: type: string '@type': type: string - default: dtmi:org:w3id:rec:Architecture;1 + default: dtmi:org:w3id:rec:BuildingElement;1 + servicedBy: + type: array + items: + type: object + required: + - '@id' + properties: + '@id': + type: string + '@type': + type: string + default: dtmi:org:w3id:rec:Agent;1 + IPAddress: + type: string + MACAddress: + type: string + assetTag: + type: string + commissioningDate: + type: string + format: date customProperties: type: string customTags: type: string identifiers: type: string + initialCost: + type: string + installationDate: + type: string + format: date + maintenanceInterval: + type: string + modelNumber: + type: string name: type: string + serialNumber: + type: string + turnoverDate: + type: string + format: date + weight: + type: string Point: type: object properties: @@ -593,17 +593,17 @@ components: type: string name: type: string - Site: + SubBuilding: type: object properties: '@id': type: string '@type': type: string - default: dtmi:org:w3id:rec:Site;1 + default: dtmi:org:w3id:rec:SubBuilding;1 '@context': type: string - default: https://dev.realestatecore.io/contexts/Site.jsonld + default: https://dev.realestatecore.io/contexts/SubBuilding.jsonld address: type: array items: @@ -800,17 +800,17 @@ components: type: string name: type: string - SubBuilding: + Site: type: object properties: '@id': type: string '@type': type: string - default: dtmi:org:w3id:rec:SubBuilding;1 + default: dtmi:org:w3id:rec:Site;1 '@context': type: string - default: https://dev.realestatecore.io/contexts/SubBuilding.jsonld + default: https://dev.realestatecore.io/contexts/Site.jsonld address: type: array items: @@ -1007,6 +1007,47 @@ components: type: string name: type: string + Document: + type: object + properties: + '@id': + type: string + '@type': + type: string + default: dtmi:org:w3id:rec:Document;1 + '@context': + type: string + default: https://dev.realestatecore.io/contexts/Document.jsonld + documentTopic: + type: array + items: + type: object + required: + - '@id' + properties: + '@id': + type: string + '@type': + type: string + url: + type: array + items: + type: object + required: + - '@id' + properties: + '@id': + type: string + '@type': + type: string + customProperties: + type: string + customTags: + type: string + identifiers: + type: string + name: + type: string ActuationEvent: type: object properties: @@ -1089,58 +1130,17 @@ components: timestamp: type: string format: date-time - Document: - type: object - properties: - '@id': - type: string - '@type': - type: string - default: dtmi:org:w3id:rec:Document;1 - '@context': - type: string - default: https://dev.realestatecore.io/contexts/Document.jsonld - documentTopic: - type: array - items: - type: object - required: - - '@id' - properties: - '@id': - type: string - '@type': - type: string - url: - type: array - items: - type: object - required: - - '@id' - properties: - '@id': - type: string - '@type': - type: string - customProperties: - type: string - customTags: - type: string - identifiers: - type: string - name: - type: string - Parameter: + Alarm: type: object properties: '@id': type: string '@type': type: string - default: dtmi:org:brickschema:schema:Brick:Parameter;1 + default: dtmi:org:brickschema:schema:Brick:Alarm;1 '@context': type: string - default: https://dev.realestatecore.io/contexts/Parameter.jsonld + default: https://dev.realestatecore.io/contexts/Alarm.jsonld isPointOf: type: array items: @@ -1153,7 +1153,7 @@ components: '@type': type: string lastKnownValue: - type: string + $ref: '#/components/schemas/ExceptionEvent' aggregate: type: string customProperties: @@ -1168,17 +1168,17 @@ components: type: string name: type: string - Command: + Setpoint: type: object properties: '@id': type: string '@type': type: string - default: dtmi:org:brickschema:schema:Brick:Command;1 + default: dtmi:org:brickschema:schema:Brick:Setpoint;1 '@context': type: string - default: https://dev.realestatecore.io/contexts/Command.jsonld + default: https://dev.realestatecore.io/contexts/Setpoint.jsonld isPointOf: type: array items: @@ -1191,7 +1191,7 @@ components: '@type': type: string lastKnownValue: - $ref: '#/components/schemas/ActuationEvent' + type: string aggregate: type: string customProperties: @@ -1206,17 +1206,17 @@ components: type: string name: type: string - Setpoint: + Command: type: object properties: '@id': type: string '@type': type: string - default: dtmi:org:brickschema:schema:Brick:Setpoint;1 + default: dtmi:org:brickschema:schema:Brick:Command;1 '@context': type: string - default: https://dev.realestatecore.io/contexts/Setpoint.jsonld + default: https://dev.realestatecore.io/contexts/Command.jsonld isPointOf: type: array items: @@ -1229,7 +1229,7 @@ components: '@type': type: string lastKnownValue: - type: string + $ref: '#/components/schemas/ActuationEvent' aggregate: type: string customProperties: @@ -1244,17 +1244,17 @@ components: type: string name: type: string - Alarm: + Sensor: type: object properties: '@id': type: string '@type': type: string - default: dtmi:org:brickschema:schema:Brick:Alarm;1 + default: dtmi:org:brickschema:schema:Brick:Sensor;1 '@context': type: string - default: https://dev.realestatecore.io/contexts/Alarm.jsonld + default: https://dev.realestatecore.io/contexts/Sensor.jsonld isPointOf: type: array items: @@ -1266,8 +1266,6 @@ components: type: string '@type': type: string - lastKnownValue: - $ref: '#/components/schemas/ExceptionEvent' aggregate: type: string customProperties: @@ -1282,17 +1280,17 @@ components: type: string name: type: string - Sensor: + Status: type: object properties: '@id': type: string '@type': type: string - default: dtmi:org:brickschema:schema:Brick:Sensor;1 + default: dtmi:org:brickschema:schema:Brick:Status;1 '@context': type: string - default: https://dev.realestatecore.io/contexts/Sensor.jsonld + default: https://dev.realestatecore.io/contexts/Status.jsonld isPointOf: type: array items: @@ -1304,6 +1302,8 @@ components: type: string '@type': type: string + lastKnownValue: + type: string aggregate: type: string customProperties: @@ -1318,17 +1318,17 @@ components: type: string name: type: string - Status: + Parameter: type: object properties: '@id': type: string '@type': type: string - default: dtmi:org:brickschema:schema:Brick:Status;1 + default: dtmi:org:brickschema:schema:Brick:Parameter;1 '@context': type: string - default: https://dev.realestatecore.io/contexts/Status.jsonld + default: https://dev.realestatecore.io/contexts/Parameter.jsonld isPointOf: type: array items: @@ -1356,17 +1356,17 @@ components: type: string name: type: string - Zone: + Building: type: object properties: '@id': type: string '@type': type: string - default: dtmi:org:w3id:rec:Zone;1 + default: dtmi:org:w3id:rec:Building;1 '@context': type: string - default: https://dev.realestatecore.io/contexts/Zone.jsonld + default: https://dev.realestatecore.io/contexts/Building.jsonld address: type: array items: @@ -1563,17 +1563,17 @@ components: type: string name: type: string - Level: + Room: type: object properties: '@id': type: string '@type': type: string - default: dtmi:org:w3id:rec:Level;1 + default: dtmi:org:w3id:rec:Room;1 '@context': type: string - default: https://dev.realestatecore.io/contexts/Level.jsonld + default: https://dev.realestatecore.io/contexts/Room.jsonld address: type: array items: @@ -1762,9 +1762,6 @@ components: $ref: '#/components/schemas/ArchitectureArea' capacity: $ref: '#/components/schemas/ArchitectureCapacity' - levelNumber: - type: integer - format: int32 customProperties: type: string customTags: @@ -1773,17 +1770,17 @@ components: type: string name: type: string - Building: + Zone: type: object properties: '@id': type: string '@type': type: string - default: dtmi:org:w3id:rec:Building;1 + default: dtmi:org:w3id:rec:Zone;1 '@context': type: string - default: https://dev.realestatecore.io/contexts/Building.jsonld + default: https://dev.realestatecore.io/contexts/Zone.jsonld address: type: array items: @@ -1980,17 +1977,17 @@ components: type: string name: type: string - Room: + Level: type: object properties: '@id': type: string '@type': type: string - default: dtmi:org:w3id:rec:Room;1 + default: dtmi:org:w3id:rec:Level;1 '@context': type: string - default: https://dev.realestatecore.io/contexts/Room.jsonld + default: https://dev.realestatecore.io/contexts/Level.jsonld address: type: array items: @@ -2179,6 +2176,9 @@ components: $ref: '#/components/schemas/ArchitectureArea' capacity: $ref: '#/components/schemas/ArchitectureCapacity' + levelNumber: + type: integer + format: int32 customProperties: type: string customTags: diff --git a/Doc/Asset/Equipment/ICT-/Controller.md b/Doc/Asset/Equipment/ICT-/Controller.md new file mode 100644 index 000000000..d28cc60c0 --- /dev/null +++ b/Doc/Asset/Equipment/ICT-/Controller.md @@ -0,0 +1,49 @@ +[Index](../../../index.md) > [Asset](../../Asset.md) > [Equipment](../Equipment.md) > [ICTEquipment](ICTEquipment.md) > [Controller](#) +# Controller + +Controller. + + +**Display name:** Controller
+**DTMI:** dtmi:org:w3id:rec:Controller;1 + +--- + +## Relationships + +### Inherited Relationships +* **[Equipment](../Equipment.md):** feeds, isFedBy +* **[Asset](../../Asset.md):** commissionedBy, documentation, geometry, hasPart, hasPoint, installedBy, isPartOf, locatedIn, manufacturedBy, mountedOn, servicedBy + +--- + +## Properties + +### Inherited Properties +* **[Equipment](../Equipment.md):** operationalStageCount +* **[Asset](../../Asset.md):** assetTag, commissioningDate, customProperties, customTags, identifiers, initialCost, installationDate, IPAddress, MACAddress, maintenanceInterval, modelNumber, name, serialNumber, turnoverDate, weight +* **[ICTEquipment](ICTEquipment.md):** heightRUs, numberOfPorts, standard + +--- + +## Target Of +### General +* [Point](../../../Point/Point.md).isPointOf +* [Agent](../../../Agent/Agent.md).owns +* [Space](../../../Space/Space.md).isLocationOf +* [Equipment](../Equipment.md).feeds +* [Equipment](../Equipment.md).isFedBy +* [Architecture](../../../Space/Architecture/Architecture.md).isFedBy +* [Document](../../../Information/Document/Document.md).documentTopic +* [Document](../../../Information/Document/Document.md).url +* [Lease](../../../Event/Lease.md).leaseOf +* [PointOfInterest](../../../Information/PointOfInterest.md).objectOfInterest +* [Portfolio](../../../Collection/Portfolio.md).includes +* [ServiceObject](../../../Information/ServiceObject/ServiceObject.md).relatedTo +* [Meter](../Meter/Meter.md).meters +### Inherited +* [Loop](../../../Collection/Loop/Loop.md).includes +* [System](../../../Collection/System/System.md).includes +* [Asset](../../Asset.md).hasPart +* [Asset](../../Asset.md).isPartOf +* [EquipmentCollection](../../../Collection/Equipment-.md).includes diff --git a/Doc/Asset/Equipment/ICT-/Controller/Controller.md b/Doc/Asset/Equipment/ICT-/Controller/Controller.md deleted file mode 100644 index 28454baf2..000000000 --- a/Doc/Asset/Equipment/ICT-/Controller/Controller.md +++ /dev/null @@ -1,55 +0,0 @@ -[Index](../../../../index.md) > [Asset](../../../Asset.md) > [Equipment](../../Equipment.md) > [ICTEquipment](../ICTEquipment.md) > [Controller](#) -# Controller - -Controller. - - -**Display name:** Controller
-**DTMI:** dtmi:org:w3id:rec:Controller;1 - ---- - -## Child interfaces -* [BACnetController](BACnet-.md) -* [ModbusController](Modbus-.md) - ---- - -## Relationships - -### Inherited Relationships -* **[Equipment](../../Equipment.md):** feeds, isFedBy -* **[Asset](../../../Asset.md):** commissionedBy, documentation, geometry, hasPart, hasPoint, installedBy, isPartOf, locatedIn, manufacturedBy, mountedOn, servicedBy - ---- - -## Properties - -### Inherited Properties -* **[Equipment](../../Equipment.md):** operationalStageCount -* **[Asset](../../../Asset.md):** assetTag, commissioningDate, customProperties, customTags, identifiers, initialCost, installationDate, IPAddress, MACAddress, maintenanceInterval, modelNumber, name, serialNumber, turnoverDate, weight -* **[ICTEquipment](../ICTEquipment.md):** heightRUs, numberOfPorts, standard - ---- - -## Target Of -### General -* [Point](../../../../Point/Point.md).isPointOf -* [Agent](../../../../Agent/Agent.md).owns -* [Space](../../../../Space/Space.md).isLocationOf -* [Equipment](../../Equipment.md).feeds -* [Equipment](../../Equipment.md).isFedBy -* [Architecture](../../../../Space/Architecture/Architecture.md).isFedBy -* [Document](../../../../Information/Document/Document.md).documentTopic -* [Document](../../../../Information/Document/Document.md).url -* [Lease](../../../../Event/Lease.md).leaseOf -* [PointOfInterest](../../../../Information/PointOfInterest.md).objectOfInterest -* [Portfolio](../../../../Collection/Portfolio.md).includes -* [ServiceObject](../../../../Information/ServiceObject/ServiceObject.md).relatedTo -* [Meter](../../Meter/Meter.md).meters -### Inherited -* [Loop](../../../../Collection/Loop/Loop.md).includes -* [System](../../../../Collection/System/System.md).includes -* [Asset](../../../Asset.md).hasPart -* [Asset](../../../Asset.md).isPartOf -* [EquipmentCollection](../../../../Collection/Equipment-.md).includes diff --git a/Doc/Asset/Equipment/ICT-/ICTEquipment.md b/Doc/Asset/Equipment/ICT-/ICTEquipment.md index e68641156..8740640be 100644 --- a/Doc/Asset/Equipment/ICT-/ICTEquipment.md +++ b/Doc/Asset/Equipment/ICT-/ICTEquipment.md @@ -11,7 +11,7 @@ Equipment and devices that are part of a building's ICT infrastructure. ## Child interfaces * [AudioVisualEquipment](AudioVisualEquipment.md) -* [Controller](Controller/Controller.md) +* [Controller](Controller.md) * [DataNetworkEquipment](DataNetworkEquipment/DataNetworkEquipment.md) * [Gateway](Gateway.md) * [ICTHardware](ICTHardware/ICTHardware.md) diff --git a/Doc/Point/Parameter/GatewayConnection-/GatewayConnectionParameter.md b/Doc/Point/Parameter/GatewayConnection-/GatewayConnectionParameter.md index f994ab273..c07274dad 100644 --- a/Doc/Point/Parameter/GatewayConnection-/GatewayConnectionParameter.md +++ b/Doc/Point/Parameter/GatewayConnection-/GatewayConnectionParameter.md @@ -28,18 +28,18 @@ ## Target Of ### General -* [Portfolio](../../../Collection/Portfolio.md).includes -* [PointOfInterest](../../../Information/PointOfInterest.md).objectOfInterest +* [Point](../../Point.md).isPointOf * [Agent](../../../Agent/Agent.md).owns * [Space](../../../Space/Space.md).isLocationOf -* [Lease](../../../Event/Lease.md).leaseOf -* [Point](../../Point.md).isPointOf +* [Equipment](../../../Asset/Equipment/Equipment.md).feeds +* [Equipment](../../../Asset/Equipment/Equipment.md).isFedBy +* [Architecture](../../../Space/Architecture/Architecture.md).isFedBy * [Document](../../../Information/Document/Document.md).documentTopic * [Document](../../../Information/Document/Document.md).url +* [Lease](../../../Event/Lease.md).leaseOf +* [PointOfInterest](../../../Information/PointOfInterest.md).objectOfInterest +* [Portfolio](../../../Collection/Portfolio.md).includes * [ServiceObject](../../../Information/ServiceObject/ServiceObject.md).relatedTo -* [Architecture](../../../Space/Architecture/Architecture.md).isFedBy -* [Equipment](../../../Asset/Equipment/Equipment.md).feeds -* [Equipment](../../../Asset/Equipment/Equipment.md).isFedBy * [Meter](../../../Asset/Equipment/Meter/Meter.md).meters ### Inherited * [ActuationEvent](../../../Event/Point-/ActuationEvent.md).targetPoint diff --git a/Doc/Point/Parameter/GatewayConnection-/IoTHubConnectionParameter.md b/Doc/Point/Parameter/GatewayConnection-/IoTHubConnectionParameter.md index ef2c5eede..df1b0678b 100644 --- a/Doc/Point/Parameter/GatewayConnection-/IoTHubConnectionParameter.md +++ b/Doc/Point/Parameter/GatewayConnection-/IoTHubConnectionParameter.md @@ -27,18 +27,18 @@ ## Target Of ### General -* [Portfolio](../../../Collection/Portfolio.md).includes -* [PointOfInterest](../../../Information/PointOfInterest.md).objectOfInterest +* [Point](../../Point.md).isPointOf * [Agent](../../../Agent/Agent.md).owns * [Space](../../../Space/Space.md).isLocationOf -* [Lease](../../../Event/Lease.md).leaseOf -* [Point](../../Point.md).isPointOf +* [Equipment](../../../Asset/Equipment/Equipment.md).feeds +* [Equipment](../../../Asset/Equipment/Equipment.md).isFedBy +* [Architecture](../../../Space/Architecture/Architecture.md).isFedBy * [Document](../../../Information/Document/Document.md).documentTopic * [Document](../../../Information/Document/Document.md).url +* [Lease](../../../Event/Lease.md).leaseOf +* [PointOfInterest](../../../Information/PointOfInterest.md).objectOfInterest +* [Portfolio](../../../Collection/Portfolio.md).includes * [ServiceObject](../../../Information/ServiceObject/ServiceObject.md).relatedTo -* [Architecture](../../../Space/Architecture/Architecture.md).isFedBy -* [Equipment](../../../Asset/Equipment/Equipment.md).feeds -* [Equipment](../../../Asset/Equipment/Equipment.md).isFedBy * [Meter](../../../Asset/Equipment/Meter/Meter.md).meters ### Inherited * [ActuationEvent](../../../Event/Point-/ActuationEvent.md).targetPoint diff --git a/Doc/Point/Parameter/Parameter.md b/Doc/Point/Parameter/Parameter.md index c27f92b0a..f4b2f186d 100644 --- a/Doc/Point/Parameter/Parameter.md +++ b/Doc/Point/Parameter/Parameter.md @@ -18,6 +18,7 @@ Parameter points are configuration settings used to guide the operation of equip * [PID_Parameter](PID-/PID_Parameter.md) * [Temperature_Parameter](Temperature-/Temperature_Parameter.md) * [Tolerance_Parameter](Tolerance-/Tolerance_Parameter.md) +* [GatewayConnectionParameter](GatewayConnection-/GatewayConnectionParameter.md) --- diff --git a/Doc/index.full.md b/Doc/index.full.md index 97126bb7c..ea8f11206 100644 --- a/Doc/index.full.md +++ b/Doc/index.full.md @@ -175,11 +175,7 @@ * [Thermostat](Asset/Equipment/HVAC-/Thermostat.md) * [ICTEquipment](Asset/Equipment/ICT-/ICTEquipment.md) * [AudioVisualEquipment](Asset/Equipment/ICT-/AudioVisualEquipment.md) - * [Controller](Asset/Equipment/ICT-/Controller/Controller.md) - * [BACnetController](Asset/Equipment/ICT-/Controller/BACnet-/BACnetController.md) - * [BACnetAndModbusController](Asset/Equipment/ICT-/Controller/BACnet-/BACnetAndModbusController.md) - * [ModbusController](Asset/Equipment/ICT-/Controller/Modbus-/ModbusController.md) - * [BACnetAndModbusController](Asset/Equipment/ICT-/Controller/BACnet-/BACnetAndModbusController.md) + * [Controller](Asset/Equipment/ICT-/Controller.md) * [DataNetworkEquipment](Asset/Equipment/ICT-/DataNetworkEquipment/DataNetworkEquipment.md) * [EthernetPort](Asset/Equipment/ICT-/DataNetworkEquipment/EthernetPort.md) * [EthernetSwitch](Asset/Equipment/ICT-/DataNetworkEquipment/EthernetSwitch.md) diff --git a/Metadata/RealEstateCore.Ontology.DTDLv2.nuspec b/Metadata/RealEstateCore.Ontology.DTDLv2.nuspec index a9c613290..d64cbdcba 100644 --- a/Metadata/RealEstateCore.Ontology.DTDLv2.nuspec +++ b/Metadata/RealEstateCore.Ontology.DTDLv2.nuspec @@ -2,7 +2,7 @@ RealEstateCore.Ontology.DTDLv2 - 4.0.0.20 + 4.0.0.21 RealEstateCore realestatecore https://github.com/RealEstateCore/rec diff --git a/RealEstateCore.DTDLv2.jsonld b/RealEstateCore.DTDLv2.jsonld index 93681dd02..9a8a81830 100644 --- a/RealEstateCore.DTDLv2.jsonld +++ b/RealEstateCore.DTDLv2.jsonld @@ -8509,6 +8509,15 @@ "dtmi:dtdl:context;2" ] }, + { + "@id": "dtmi:org:w3id:rec:GatewayConnectionParameter;1", + "@type": "Interface", + "displayName": "Gateway Connection Parameter", + "extends": "dtmi:org:brickschema:schema:Brick:Parameter;1", + "@context": [ + "dtmi:dtdl:context;2" + ] + }, { "@id": "dtmi:org:w3id:rec:Geotransform;1", "@type": "Interface", @@ -18829,6 +18838,41 @@ "dtmi:dtdl:context;2" ] }, + { + "@id": "dtmi:org:w3id:rec:IoTHubConnectionParameter;1", + "@type": "Interface", + "displayName": "IoT Hub Connection Parameter", + "extends": "dtmi:org:w3id:rec:GatewayConnectionParameter;1", + "contents": [ + { + "@type": "Property", + "schema": "string", + "description": { + "en": "The Device ID of the device connected to Azure IoT Hub" + }, + "displayName": { + "en": "Device ID" + }, + "name": "deviceId", + "writable": true + }, + { + "@type": "Property", + "schema": "string", + "description": { + "en": "The Hostname of the Azure IoT Hub the gateway is connected to" + }, + "displayName": { + "en": "Hostname" + }, + "name": "hostname", + "writable": true + } + ], + "@context": [ + "dtmi:dtdl:context;2" + ] + }, { "@id": "dtmi:org:w3id:rec:ITRack;1", "@type": "Interface", @@ -29231,20 +29275,6 @@ "dtmi:dtdl:context;2" ] }, - { - "@id": "dtmi:org:w3id:rec:BACnetController;1", - "@type": "Interface", - "description": { - "en": "BACnet controller." - }, - "displayName": { - "en": "BACnet Controller" - }, - "@context": [ - "dtmi:dtdl:context;2" - ], - "extends": "dtmi:org:w3id:rec:Controller;1" - }, { "@id": "dtmi:org:w3id:rec:BarRoom;1", "@type": "Interface", @@ -29587,20 +29617,6 @@ "dtmi:dtdl:context;2" ] }, - { - "@id": "dtmi:org:w3id:rec:ModbusController;1", - "@type": "Interface", - "description": { - "en": "Modbus controller." - }, - "displayName": { - "en": "Modbus Controller" - }, - "@context": [ - "dtmi:dtdl:context;2" - ], - "extends": "dtmi:org:w3id:rec:Controller;1" - }, { "@id": "dtmi:org:w3id:rec:Morgue;1", "@type": "Interface",