Docs Portal
Documentation
API ReferenceConsole

Crestron XiO

Crestron Logo

The Crestron XiO connector links your Crestron equipment to Mapped, enabling room occupancy insights based on data from your Crestron system.

Use Cases

  • Monitor room occupancy status from Crestron touch panels in near real time.
  • Use occupancy data in automations, dashboards, and analytics workflows.
  • Relate panel occupancy telemetry to building, floor, and space context in the graph.

Configuration

Auth Requirements

Provide credentials for your Crestron XiO Cloud account.

FieldRequiredDescriptionWhere to find it
API KeyYesXiO subscription key used to authenticate API requestsCrestron XiO Cloud developer/admin portal
Account IDYesXiO account identifier for device and status queriesCrestron XiO Cloud account settings

Place Mappings

Use the mapping table to select and map touch panels into your place hierarchy.

Mapping FieldRequiredNotes
building.siteIdYesBuilding site identifier
building.nameYesBuilding display name
building.addressYesBuilding address
floor.levelYesNumeric floor level
floor.nameNoOptional floor name
space.nameYesSpace display name
space.codeNoOptional space code
thing.nameYesDevice name
thing.refIdYesUnique source device identifier

Only devices categorized as touch panels are presented for mapping.

Advanced Options

This may be enabled via the JSON mode editor.

OptionDefaultDescription
addOccupancyZonesDisabled (FALSE)When enabled, creates occupancy zone entities for mapped locations and links devices as serving those zones.

Mapped Concepts

API to Mapped Entities

Source ModelMapped EntityExact Type NotesRelationships
XiO device (TouchPanel)ThingUses connector defaults for a device entity (no custom exactType override)hasLocation to mapped Place (Space, Floor, or Building)
Mapped location context (optional mode)Place (Zone)Uses connector defaults for occupancy zone entity (no custom exactType override)Place hasPart Zone, Thing serves Zone
XiO device identityIdentityExternal identity in org scopeThing identities

API to Mapped Points

Source PropertyMapped PointDatatypeUnitDescription
device.occupancy-statusOccupancy status point per mapped deviceINTNUMEncodes occupancy state as 0 (Vacant), 1 (Occupied), 2 (Null/unknown)

Enumerations

The occupancy point uses these status mappings:

  • 0 = VACANT
  • 1 = OCCUPIED
  • 2 = NULL (used when status is null or unexpected)

Sample Code

Query latest occupancy time series

Request Response
Copy
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
{
  points(filter: {connectedDataSourceId: {eq: "your-connector-Id"}}) {
    id
    name
    exactType
    datatype
    mappingKey
    unit {
      id
    }
    valueMap
    series(latest: true) {
      timestamp
      value {
        int64Value
      }
    }
  }
}

Graph Shape

Crestron graph shape. Building hasPart Floor, which hasPart Space. Thing hasLocation Space and serves Zone, which isPartOf Space.