Builder APIConcepts
Resources and points
Buildings, levels, rooms, equipment and points, their type keys, and how to find a kind of point on a kind of resource.
Everything in a building is a resource with a type key, and points are the resources that carry readings.
Type keys
| Kind of resource | Example type keys |
|---|---|
| Buildings | rec_Building |
| Levels | rec_Level |
| Rooms, other spaces | rec_Room, rec_Space |
| Equipment | brick_Air_Handling_Unit, … |
| Points | brick_Temperature_Sensor, brick_Supply_Air_Temperature_Sensor, … |
- Type keys differ per tenant. Look them up with
resourceTypes.list; never guess them. - A type key matches its subtypes.
brick_Temperature_Sensorincludes supply, return, zone and outside air temperature sensors. Each point names its exacttypeKey, so you can tell them apart.
A kind of point on a kind of resource
To get, say, room temperatures or the supply air temperature of air handling units:
- List the resources first, with
resources.relatedorresources.listand their type keys. - Call
points.listwith their ids asresourceIdsand the pointtypeKeys.
A point type with only a buildingId matches the points of every resource in the building. Each
point names its resourceIds, so you can map readings back to rooms. latest is its most recent
reading (null when it has none yet).
The guide Rooms and their temperatures shows both calls.