Add device to a home

Description

Add a device to a user's home. The complete process depends on how the project was set up and is carried out in one of two possible ways.

Devices are Pre-provisioned

If the project was configured to pre-provision all its devices, adding a device to a home means claiming ownership of an existing device and registering it to the specified home. In this scenario, the device in question must first enable registration before the user calls this API method.

Also, if a user also has permission to create devices in the project, the user can create a new device instance to be registered to a specified home later. In this scenario, the user must make a request with the projectId and deviceClass properties without claimCode.

Devices are Provisioned on Demand

If the project was configured to allow On-Demand Device Provisioning, a user must first initiate the device provisioning process and obtain a provisioning token. The token should be passed to the device hardware which will then call this API method to complete the process. The Device object returned will contain an API key. The device hardware should store the device ID and API key, so that it can begin communicating with the MODE API directly.

Request body

Content type: application/x-www-form-urlencoded

homeId=1885&claimCode=b4d632e16981e66a

Responses

{
  "claimExpirationTime": "2019-12-17T22:54:39Z",
  "claimTime": "2019-12-17T22:54:39Z",
  "deviceClass": "smart_sensor",
  "homeId": 1885,
  "id": 34328,
  "isConnected": false,
  "lastConnectTime": "2019-12-17T22:54:03.321Z",
  "name": "happy",
  "projectId": 1260,
  "tag": "0002"
}