A Data asset is related to any live data points, schedules or references to another system.
- "Active Power" of a meter
- "AHU 01 return air temperature"
- "Occupancy schedule 04"
Each Data asset will inherit properties from "Structure" and "Point" data models. It means they will:
- Implement the Structure model: where is this data coming from?
- Implement the Point model: what type of data is it?
Each Data asset may inherit from "Equipment" and/or "Product" data models. It means they may:
- Implement the Equipment model: which equipment is it coming from?
- Implement the Product model: what product is it?
Data assets will contain relations with other Data assets to describe subordinate relations as well as with Device to describe the data feeds.
Common Tagging list
Device assets are exposed to a third party through the Linksper API or through a connector (database, mqtt...).
- A Data asset will contain several standardized properties, also called "tags" to provide additional information.
- Each Data asset will inherit properties from Structure, Equipment, Product and Point data models as seen above
Below the properties/tags list you may/will find on a Data asset whether it's mandatory or not.
There are predefined combinations of Tags related to the Point data model that you are most likely to find on any Linksper instance. See Point Data Model combinations
| Mandatory | Tag key | Description | Tag value examples | |
|---|---|---|---|---|
| x | displayName | A human readable label used to display an asset. Often contains the related space. | A specific Temperature data point: "displayName":"L2 Warehouse - L2_FCU_16 - Zone temperature". |
| x | id | Unique identifier of the asset (specific to Linksper). This id will likely changed between sites. | Specific id of a Temperature data point: "id":"e0SQFVCRAVXswkzTa0OG0" |
| x | assetType | The value will always be "Data" | assetType:"Data" |
| x | dataType | Defines the type of Data asset. See Linksper DataType | dataType='Point' |
| controlType | Defines the control type of the Data asset. See Linksper DataType. Will only appear if dataType="Point" or dataType="Schedule" | "controlType":"Boolean" | |
| x | description | Additional information to describe the asset. | "description":"Zone temperature" |
| x | facets | Additional information on the value. See dedicated part on the facets below. | "facets":"min=f:-inf|max=f:+inf|precision=i:1|units=u:celsius;°C;(K);+273.15;" |
| x | bosEquipment | Main information regarding the asset. This property is the asset code name which follows a naming convention. This is the name/code often used to create a common mapping with a BIM model. This value will be found on the Data assets related to the equipment | "bosEquipment":"L2_FCU_16" |
| x | bosEquipmentId | Associated identifier of the BOS asset (Similar to the id) | "bosEquipmentId":"U0SQFVCOVxbhTEiFpqWb1" |
| x | bosDevice | Main information regarding the asset. This property is the asset code name which follows a naming convention. This is the name/code often used to create a common mapping with a BIM model. This value will be found on the Data assets related to the equipment | "bosDevice":"L2_LMAP04E_01" |
| x | bosDeviceId | Associated identifier of the BOS asset (Similar to the id) | "bosDeviceId":"g0SQFVIz1fHnKS1lQEHnm" |
| x | pointType | Associated point type from the Point data model. It's the only mandatory tag from the Point data model. | "pointType":"Measure" |
| x | pointTypeId | Associated point type identifier from the Point data model. | "pointTypeId":"x0SDQfQrnvxNNax6x3H0H" |
| dimension | Associated dimension from the Point data model. | "dimension":"Temperature" | |
| dimensionId | Associated dimension idetifier from the Point data model. | "dimensionId":"d0SD7O1X9PseXo6TnnY37" | |
| position | Associated position from the Point data model. | "position":"Zone" | |
| positionId | Associated position identifier from the Point data model. | "positionId":"Zone" | |
| resource | Associated resource from the Point data model. | "resource":"Air" | |
| resourceId | Associated resource identifier from the Point data model. | "resourceId":"q0SD7OETp1HexZxKsBtIf" | |
| component | Associated component from the Point data model. | "component":"Fan" | |
| componentId | Associated component identifier from the Point data model. | "componentId":"v0SDQgkP3FEiXOF1mQ9xR" | |
| productTypeId | Associated subsystem identifier from the Product data model | "productTypeId":"B0SBQv86LD9IFNR2bpQ3c" | |
| product | Associated category from the Product data model | "product":"LDALI-3E" | |
| productId | Associated category identifier from the Product data model | "productId":"Z0T3r7hOrMTkc9aKLYnmL" | |
| site | Associated site from the Structure data model | "site":"Le Rabelais" | |
| siteId | Associated site identifier from the Structure data model | "siteId":"2HmOvgFOH38eBeF9x89sBM" | |
| building | Associated building from the Structure data model | "building":"Le Rabelais" | |
| buildingId | Associated building identifier from the Structure data model | "buildingId":"07bs4hrET8r9DNdhaNmO9m" | |
| floor | Associated floor from the Structure data model. | "floor":"Level 2" | |
| floorId | Associated floor identifier from the Structure data model. | "floorId":"2MhuM4MG90Vw6o5JdtYxTm" | |
| space | Associated space from the Structure data model. | "space":"L2 Warehouse" | |
| spaceId | Associated spaceId identifier from the Structure data model. | "spaceId":"0CL2iOHI56zB4pgilRVW1T" | |
| equipment | Associated equipment from the Structure data model. This is most of the time related to a BIM model that would define the device (quite rare so far). The value will often be the same than bimCode. | "equipment":"L2_FCU_16" | |
| equipmentId | Associated equipment identifier from the Structure data model | "equipmentId":"0GdkqlHyjBHxOjchHdiKL5" | |
| subsystem | Associated subsystem from the Equipment data model | "subsystem":"HVAC" | |
| subsystemId | Associated subsystem identifier from the Equipment data model | "subsystemId":"c0SD7RGNylEEe5nMS668E" | |
| category | Associated category from the Equipment data model | "category":"Terminal Unit" | |
| categoryId | Associated category identifier from the Equipment data model | "categoryId":"D0SD7RKlaTkh5mx3kcM3G" | |
| equipmentType | Associated equipmentType from the Equipment data model | "equipmentType":"Fan Coil Unit" | |
| equipmentTypeId | Associated equipmenentType identifier from the Equipment data model | "equipmentTypeId":"q0SD7RfxSNuJEgEGwavXz" |
To get the relations with the associated Data asset(s). These relations always go from a Data asset to a Device asset (or several successive Device assets) and finally to a LinksperInstance asset.
| Mandatory | Tag key | Description | Tag value examples | |
|---|---|---|---|---|
| dataFeedsIds | List all related Device or LinksperInstance assets identifier fed by the current Data asset. It is related to only one device. | "dataFeedsIds":"g0SQFVIz1fHnKS1lQEHnm" |
Data assets can have subordinate relations
| Mandatory | Tag key | Description | Tag value examples | |
|---|---|---|---|---|
| isSubmeterOf | List ascendant meter Data asset. Works for electrical meters, water meters etc. It is related to only one Data asset | "isSubmeterOf":"Z0SVLkcdcyRtVlMOnIxa8" |
Facets
Facets are used to give contextual information about the value. This only applies to DataAssetType = "Point". Facets may contain:
- Numeric Value
- min
- max
- precision: the number of digits to keep
- units
- Boolean Value
- trueText: display text associated when the value is true. Example: "On"
- falseText: display text associated when the value is false. Example: "Off"
Examples
Below is an example taken from VayanData's headquarters exposed on a MongoDb database. The result is centered on a Data asset called "L2_LDALI3E_01" which is a DALI controller located in "L2 IT Room". It will be similar with a MQTT connector or through the API.
Below is the same asset retrieved from the API. We ask the API to give us all Data related to the Fan Coil Equipment of the room.
Availability
Data assets are always exposed to third parties.