Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Authentication Result [application/vnd.hobson.authResult]

Field NameTypeDescription
tokenSTRINGThe bearer token to use for subsequent API calls.
userapplication/vnd.hobson.personThe user that was authenticated.

Device [application/vnd.hobson.device]

Field NameTypeDescription
availableBOOLEANIndicates whether the device is currently reachable.
cclassapplication/vnd.hobson.v1.user

...

.propertyContainerClassThe device's configuration class. This describes the supported configuration properties for the device.
configurationapplication/vnd.hobson.

...

 

presenceEntities
NameType
devicespropertyContainerThe device's configuration property values.
lastCheckInNUMBERThe last time the device was heard from.
nameSTRINGThe device name.
preferredVariableapplication/vnd.hobson.variableThe device's preferred variable. For example, this is the variable that will be rendered to a dashboard tile.
telemetry

application/vnd.hobson.

itemList

deviceTelemetry

The device's telemetry data.
typeSTRINGThe device type.
variablesapplication/vnd.hobson.itemListThe variables the device has published.

Hub [application/vnd.hobson.

...

hub]

Field NameTypeDescription
actionClassesapplication/vnd.hobson.itemListThe list of action classes that have been published to the hub.
cclassapplication/vnd.hobson.propertyContainerClassThe hub's configuration class. This describes the supported configuration properties for the hub.
conditionClassesapplication/vnd.hobson.itemListThe list of condition classes that have been published to the hub.
configurationapplication/vnd.hobson.v1.propertySet
nameSTRING
pluginpropertyContainerThe hubs' configuration property values.
devicesapplication/vnd.hobson.itemListThe list of devices that have been published to the hub.
globalVariablesapplication/vnd.hobson.v1.plugin
telemetry
NameDescription
capableBOOLEAN
enabledBOOLEAN
typeSTRING
variableSetitemListThe list of global variables that have been published to the hub.
linksJSON ObjectA map of link relations to corresponding URI.
localPluginsapplication/vnd.hobson.itemListThe list of plugins that have been installed on the hub.
logapplication/vnd.hobson.itemListThe list of hub log entries.
nameSTRINGThe hub's configured name.
presenceEntitiesapplication/vnd.hobson.v1.variableSetitemListThe list presence entities associated with the hub.
presenceLocationsapplication/vnd.hobson.itemListThe list of presence locations associated with the hub.
NameType
nameSTRING
logLevelSTRINGremotePluginsapplication/vnd.hobson.itemListThe list of plugins that are available from hub's configured remote repositories.
tasksapplication/vnd.hobson.itemListThe list of tasks that have been created on the hub.
versionSTRINGThe current hub version.

application/vnd.hobson.itemList

...

NameType
configurationapplication/vnd.hobson.v1.propertySet
descriptionSTRING
nameSTRING
status
NameType
codeSTRING
messageSTRING
typeSTRING
versionapplication/vnd.hobson.v1.version

 

application/vnd.hobson.presenceEntity

...

application/vnd.hobson.presenceLocation

 

NameType
nameSTRING
latitudeNUMBER
longitudeNUMBER
radiusNUMBER
beaconMajorNUMBER
beaconMinorNUMBER

...