An authentication result is a response returned by an attempt to authenticate with the Hobson hub.
| Field Name | Type | Description |
|---|
| token | STRING | The bearer token to use for subsequent API calls. |
| user | application/vnd.hobson.person | The user that was authenticated. |
A device represents any smart device that Hobson knows how to monitor and control.
| Field Name | Type | Description |
|---|
| available | BOOLEAN | Indicates whether the device is currently reachable. |
| cclass | application/vnd.hobson.propertyContainerClass | The device's configuration class. This describes the supported configuration properties for the device. |
| configuration | application/vnd.hobson.propertyContainer | The device's configuration property values. |
| lastCheckIn | NUMBER | The last time the device was heard from. |
| name | STRING | The device name. |
| preferredVariable | application/vnd.hobson.variable | The device's preferred variable. For example, this is the variable that will be rendered to a dashboard tile. |
| telemetry | application/vnd.hobson.deviceTelemetry | The device's telemetry data. |
| type | STRING | The device type. |
| variables | application/vnd.hobson.itemList | The variables the device has published. |
A hub represents the specific device that is running the Hobson Hub software.
| Field Name | Type | Description |
|---|
| actionClasses | application/vnd.hobson.itemList | The list of action classes that have been published to the hub. |
| cclass | application/vnd.hobson.propertyContainerClass | The hub's configuration class. This describes the supported configuration properties for the hub. |
| conditionClasses | application/vnd.hobson.itemList | The list of condition classes that have been published to the hub. |
| configuration | application/vnd.hobson.propertyContainer | The hubs' configuration property values. |
| devices | application/vnd.hobson.itemList | The list of devices that have been published to the hub. |
| globalVariables | application/vnd.hobson.itemList | The list of global variables that have been published to the hub. |
| links | JSON Object | A map of link relations to corresponding URI. |
| localPlugins | application/vnd.hobson.itemList | The list of plugins that have been installed on the hub. |
| log | application/vnd.hobson.itemList | The list of hub log entries. |
| name | STRING | The hub's configured name. |
| presenceEntities | application/vnd.hobson.itemList | The list presence entities associated with the hub. |
| presenceLocations | application/vnd.hobson.itemList | The list of presence locations associated with the hub. |
| remotePlugins | application/vnd.hobson.itemList | The list of plugins that are available from hub's configured remote repositories. |
| tasks | application/vnd.hobson.itemList | The list of tasks that have been created on the hub. |
| version | STRING | The current hub version. |
Conforms to http://www.schema.org/ItemList
| Name | Type |
|---|
| numberOfItems | NUMBER |
| itemListElement | Array of application/vnd.hobson.listItem |
Conforms to http://www.schema.org/ListItem
| Name | Type |
|---|
| item | OBJECT |
| position | NUMBER |
| Name | Type |
|---|
| configuration | application/vnd.hobson.v1.propertySet |
| description | STRING |
| name | STRING |
| status | | Name | Type |
|---|
| code | STRING | | message | STRING |
|
| type | STRING |
| version | application/vnd.hobson.v1.version |
application/vnd.hobson.presenceEntity
| Name | Type |
|---|
| name | STRING |
| lastUpdate | NUMBER |
| location | application/vnd.hobson.presenceLocation |
application/vnd.hobson.presenceLocation
| Name | Type |
|---|
| name | STRING |
| latitude | NUMBER |
| longitude | NUMBER |
| radius | NUMBER |
| beaconMajor | NUMBER |
| beaconMinor | NUMBER |
| Name | Type |
|---|
| name | STRING |
| description | STRING |
| type | STRING (COLOR, DATE, DEVICE, DEVICES, RECURRENCE, NUMBER, STRING, TIME) |
| Name | Type |
|---|
| cclass | application/vnd.hobson.v1.propertyContainerClass |
| values | OBJECT |
| | |
|---|
| supportedProperties | Array of application/vnd.hobson.property |
| Name | Type |
|---|
| plugin | application/vnd.hobson.v1.plugin |
| name | STRING |
| conditionSet | application/vnd.hobson.v1.conditionSet |
| actionSet | application/vnd/hobson.v1.actionSet |
| properties | OBJECT |
Conforms to: https://schema.org/Person
| Name | Type |
|---|
| name | STRING |
| givenName | STRING |
| familyName | STRING |
| Name | Type |
|---|
| lastUpdate | NUMBER |
| mask | STRING (READ_ONLY, WRITE_ONLY, READ_WRITE) |
| name | STRING |
| value | OBJECT |
| Name | Type |
|---|
| variables | Array of application/vnd.hobson.v1.variable |