Developer Portal
Connector Guides
API ReferenceConsole

Butlr

ButlrLogo

Butlr provides occupancy sensing devices that can be used to track space utilization. The Butlr connector allows you to connect your Butlr devices to your Mapped graph, giving you access to occupancy data.

Use Cases

Potential use cases include:

  • Determining floor occupancy
  • Determining zone occupancy
  • Determining presence data

Configuration

Currently Butlr support will need to be contacted in order to retrieve the ID and Secret; their email: [email protected]

CredentialDescription
Client IDThe Client ID provided to you by Butlr
Client SecretThe Client Secret provided by Butlr

Mapped Concepts

Connector ConceptMapped Type
PlaceFloor, Space, Occupancy_Zone
ThingOccupancy_Sensing_Device
PointOccupancy Count Sensor

The occupancy count sensor exists as a point on the Floor, Space, Occupancy Zone, or Device depending on if it is a Floor-level, Space-level, Zone-level, or Presence-level data point.

Sample Code

Here's an example showing how to retrieve occupancy data from a particular occupancy sensor:

Request Response
Copy
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
{
  buildings(filter: {id: {eq: "BLDG46sS8TpQrHsToLCRseaBcD"}}) {
    name
    id
    things(filter: {type: {eq: "OccupancySensingDevice"}}) {
      name
      type
      points(filter: {type: {eq: "OccupancyCountSensor"}}) {
        name
        type
        series(startTime: "2022-07-28T06:35:00", endTime: "2022-07-28T06:36:00") {
          timestamp
          value {
            float64Value
          }
        }
      }
    }
  }
}

In this scenario, the returned value of 1.0 indicates the presence of someone in the space, at the time listed.