Summary

Device Referencing in KODE OS is a key feature that enables the creation of a digital twin for a building's systems by linking devices according to their physical and functional relationships. This interconnected digital model mirrors real-world interactions, such as how one device supplies air, water, or power to another, or how meters monitor specific equipment. 

The primary goal of Device Referencing is to transform raw device data into a structured, relational framework that enhances building management.

The importance of Device Referencing manifests in several key areas:

• Diagnostics and Troubleshooting: By mapping device connections, operators can swiftly trace issues. For instance, if a Variable Air Volume (VAV) unit malfunctions, its relationship to an Air Handling Unit (AHU) via a "feeds" reference can pinpoint the source of the problem.

• Fault Detection and Diagnosis (FDD): The system leverages these references to generate contextual alarms, considering not just individual devices but their interconnected dependencies, offering a holistic view of system health.

• Energy Analysis: Linking meters to the devices they measure enables detailed energy consumption insights, empowering operators to optimize efficiency and reduce costs.

In short, Device Referencing bridges the gap between physical infrastructure and digital intelligence,
enabling smarter monitoring, control, and optimization of building systems.

Reference Types

Reference types in KODE OS define the specific nature of relationships between devices. Each reference type has a corresponding reverse reference, automatically establishing a two-way connection. For example, if you connect an AHU to a VAV using the "feeds" reference, the VAV will automatically show an "isFedBy" reference back to the AHU.

Below are the reference types, their purposes, and their reverse connections:

HVAC

isFedBy

Indicates that a device receives an input (e.g., air, water, power) from another device or system.

• Reverse Reference: feeds

• Examples: 

• A VAV isFedBy an AHU means the AHU supplies air to the VAV.

• An AHU isFedBy a Chilled Water System means the chilled water system supplies water to the AHU for cooling purposes

feeds

Indicates that a device supplies an output (e.g., air, water, power) to another device or system.

• Reverse Reference: isFedBy

• Example: An AHU feeds a VAV means the AHU provides air to the VAV.

hasPart

Denotes that a device or system includes another device as a component or subsystem.

• Reverse Reference: isPartOf

• Example: A chilledWaterSystem hasPart a chiller means the chiller is a component of the system.

isPartOf

Indicates that a device is a component or subsystem within a larger device or system.

• Reverse Reference: hasPart

• Example: A chiller isPartOf a chilledWaterSystem means it belongs to that system.

Metering

isSubmeterOf

Specifies that a meter is a submeter of another meter, often in hierarchical metering setups.

• Reverse Reference: hasSubmeter

• Example: A submeter isSubmeterOf a main electricMeter means it reports to the main meter.

hasSubmeter

Indicates that a meter has another meter as its submeter.

• Reverse Reference: isSubmeterOf

• Example: A main electricMeter hasSubmeter a submeter means it oversees the submeter.

isMeasuredBy

Specifies that a device's performance or consumption is monitored by a meter.

• Reverse Reference: measures

• Example: An AHU isMeasuredBy an electricMeter means the meter tracks the AHU's electrical usage.

measures

Indicates that a meter monitors the performance or consumption of a device or system.

• Reverse Reference: isMeasuredBy

• Example: An electricMeter measures an AHU means it tracks the AHU's electrical consumption.

API References

isMirrorOf

Indicates that a device is a mirrored or API-referenced version of another device, typically for integration with external systems.

• Reverse Reference: mirrors

• Example: A device isMirrorOf another device in an external system means it replicates its data.

mirrors

Indicates that a device mirrors another device via an API connection.

• Reverse Reference: isMirrorOf

• Example: A device mirrors an external device means it reflects its data in KODE OS.

Supported References by Canonical Type

Please refer to the sheet below for a comprehensive list of each canonical type in KODE OS, the references they support, and the canonical types that appear on the other side of those references:

Device Referencing in KODE OS