Spots & Sensor Placement
Spots
A spot is a single, named location on a floor that a sensor measures, for example one desk. Rooms and floors describe areas; a spot describes a point, so you can report on each desk and not only on the room it is in.
Site
└── Building
└── Floor
├── Room
│ └── Spot ← e.g. "Desk 3A"
└── Spot ← a spot outside any roomFloor: every spot belongs to one floor.
Room: a spot's room is set automatically from where the spot sits on the floor plan. A spot outside every room has no room.
Spot type: each spot has a type, such as
desk.IDs: spot IDs start with
spot_. They appear as the keys of spot-level results, and you can use them as items.
To list the spots on a floor or in a room, query the spots field of a floor or room through the GraphQL API. The field is not yet shown on the Floors and Rooms pages, but it is available:
query {
floor(id: "space_XXXX") {
spots { id name spotType roomID customID }
}
}How sensors map to your spaces
Each third-party sensor is placed on a floor. Its room is determined by where it sits on the floor plan. A sensor can also be attached to a spot.
That placement determines where its data appears:
Spot-level measurements (
spot_*) include only sensors attached to a spot.Room-level measurements (
room_*) include only sensors that fall inside a room.Floor-level measurements (
floor_*) include every sensor on the floor.
Butlr installers manage placement. If a sensor's data is missing at a level, check its placement with your Butlr contact.
IDs
Site
site_
site_XXXX
Building
building_
building_XXXX
Floor
space_
space_XXXX
Room
room_
room_XXXX
Spot
spot_
spot_XXXX
Site, building, floor, and room IDs are the same IDs used everywhere else in the Butlr API.
Per-sensor measurements (temperature and heartbeat) are keyed by the sensor's device ID, for example abc123def456ghi789jk.
Sensor IDs starting with sensor3p_ appear in some responses (for example touch events) but cannot be used as items.
Last updated