Entities
Entities represent structured data associated with objects in Grid Studio.
While parameters typically represent individual values, entities provide a way to expose structured datasets composed of multiple related values.
Entities are commonly used to represent device data, system information, or internal object state, allowing objects to expose complex information in a structured format.
Purpose of Entities
Entities allow objects to expose groups of related information that describe the state or data produced by a system component.
This is particularly useful when working with external devices, integrations, or internal system state.
Typical examples include:
device status and health information
system or protocol data received from external devices
internal state values of an object
structured datasets generated by integrations
Entities provide a structured way to represent this information and make it accessible to other systems within the project.
Entity Structure
The structure of an entity can be described as a value tree, similar to a JSON structure.
Each entity contains multiple values organized in a hierarchical structure, allowing complex information to be represented in a structured way.
For example, an entity representing device status might contain values such as:
connection state
battery level
device temperature
operational status
This structure allows objects to expose multiple related values as a single structured dataset.
Entities as System State
Entities can also be used to represent the current state of a system.
For example, a workflow may update a value inside an entity when a device is turned on or off. User interface elements such as widgets can then read or modify the same entity value.
Because workflows, widgets, and other systems can all access the same entity structure, entities provide a centralized way to maintain system state.
This makes it possible to keep different parts of the system synchronized. For example:
a workflow updates a state value
a widget reflects the current state in the interface
other workflows react to entity change events
Using entities in this way allows multiple systems to interact with the same state information without duplicating logic.
Entities in the System
Entities can be accessed and used by different systems within Grid Studio.
They are commonly used in:
Workflows, where entity values can be evaluated or modified
Widgets, where entity values can be displayed or controlled
Extensions or integrations, where entities expose device or protocol data
Because entities represent dynamic data structures, their values can change over time as the associated object updates its internal state.
Entities vs Parameters vs Data Sources
Grid Studio provides several ways to represent data within a project.
Parameter
Represents a single value
Entity
Represents structured data associated with an object
Data Source
Generates or exposes datasets used by other systems
Parameters are typically used for simple configuration values, while entities provide structured data, and data sources generate datasets that can be used by workflows or interfaces.
Learn More
Detailed information about working with entity structures and accessing entity values can be found in the Entities section.
Last updated