diff --git a/_toc.yml b/_toc.yml index bdc6c3a..238b134 100644 --- a/_toc.yml +++ b/_toc.yml @@ -32,6 +32,7 @@ parts: - file: modeling/collections - file: modeling/connections - file: modeling/meters + - file: modeling/point-groups - file: modeling/terminal-units - caption: Extensions and Alignments chapters: diff --git a/modeling/point-groups.md b/modeling/point-groups.md new file mode 100644 index 0000000..2dc1df2 --- /dev/null +++ b/modeling/point-groups.md @@ -0,0 +1,86 @@ +Point Groups +============ + +Point Groups are Brick collections that organize sets of related points (and optionally other point groups) so they can be managed as a coherent bundle. They are intentionally lightweight: the membership of a Point Group does **not** imply any functional or causal relationship between its members. Instead, Point Groups serve UI, configuration, and lifecycle tasks such as presenting related telemetry to operators and exchanging configuration packages between software systems. + +## Core Concepts + +- **`brick:Point_Group`** is a subclass of `brick:Collection`. Point Groups can be created whenever you need a named bundle of points. Use `rdfs:label` to provide a human-friendly title such as `"VAV1 Frost Detection Points"`. +- **Membership** is described with `brick:hasPart`. A Point Group may include: + - individual `brick:Point` instances + - other `brick:Point_Group` instances (nesting lets you build hierarchies such as *Zone Groups → Unit Groups → Individual Points*) +- **Controllers host points directly.** Controllers relate to points with `brick:hostsPoint` (inverse: `brick:isHostedBy`). Point Groups are optional logical groupings and are *not* what controllers host. +- **Controllers and equipment.** Controllers interact with the equipment they supervise via `brick:controls` / `brick:isControlledBy` + +```{important} +Avoid inferring semantics from group membership alone. For example, adding a setpoint and its min/max limits to the same Point Group does *not* mean those limits constrain that setpoint. Model explicit relationships if you need to express functional ties. +``` + +This is *not* a replacement for `brick:hasPoint`! You should still use `brick:hasPoint`/`brick:isPointOf` to relate points to their equipment. This modeling construct focuses on the networking/instrumentation of the system. + +## Modeling Guidelines + +- **Scope and intent:** Use Point Groups for display, configuration exchange, and packaging telemetry. They are not a substitute for equipment, loop, or system modeling. +- **Granularity:** Prefer smaller, task-specific groups (e.g., startup points, alarm points) rather than one monolithic bundle. Nest groups when you need coarse and fine-grained organization. +- **Custom subclasses:** If your organization needs formal semantics, define project-specific subclasses of `brick:Point_Group` (e.g. `my:Startup_Point_Group`) and document their intended meaning. Brick itself does not ship a standardized taxonomy of Point Group types. +- **Labeling and metadata:** Provide `rdfs:label` and, when useful, add entity properties (for example a revision number or deployment status) to describe the package. + +## Example: Controller Hosting Points (with an optional Point Group) + +```turtle +@prefix bldg: . +@prefix brick: . +@prefix rec: . +@prefix unit: . +@prefix rdfs: . + +bldg:Controller_1 a brick:Controller ; + rdfs:label "Main Building Controller" ; + brick:hostsPoint bldg:VAV1_Temperature_Sensor, bldg:VAV1_Occupancy_Sensor ; + brick:controls bldg:VAV1 ; + brick:concerns bldg:Zone1 . + +bldg:VAV1PointGroup a brick:Point_Group ; + rdfs:label "VAV1 Point Group" ; + brick:hasPart bldg:VAV1_Temperature_Sensor, bldg:VAV1_Occupancy_Sensor . + +bldg:VAV1_Temperature_Sensor a brick:Supply_Air_Temperature_Sensor ; + brick:hasUnit unit:DEG_C . + +bldg:VAV1_Occupancy_Sensor a brick:Occupancy_Sensor . + +bldg:VAV1 a brick:Variable_Air_Volume_Box ; + brick:feeds bldg:Zone1 . + +bldg:Zone1 a rec:HVACZone . +``` + +This pattern scales to larger controllers by nesting Point Groups—for example, `bldg:StartupPoints` and `bldg:DiagnosticsPoints` contained inside `bldg:AHU1PointGroup`. The controller still uses `brick:hostsPoint` for the individual points; the groups remain for logical organization. + +## Query Patterns + +Retrieve all points hosted by a controller: + +```sparql +SELECT ?point WHERE { + ?controller a/rdfs:subClassOf* brick:Controller ; + brick:hostsPoint ?point . + ?point a/rdfs:subClassOf* brick:Point . +} +``` + +Identify the Point Groups associated with a zone of interest (for UI organization): + +```sparql +SELECT DISTINCT ?group WHERE { + ?controller brick:concerns :Zone1 ; + brick:hostsPoint ?point . + ?group brick:hasPart+ ?point ; + a brick:Point_Group . +} +``` + +## Migration Notes + +- When exporting configuration to external tools, deliver the Point Group identifiers and their member points. Consuming systems that do not yet understand Point Groups can treat them as named collections of points without additional semantics. +- Future Brick releases may add convenience shapes or inference rules (for example, deriving `brick:hosts` relationships to points). Until then, use property paths (`brick:hasPart+`) in queries and tooling that need to traverse Point Group hierarchies.