Skip to content
Michelle Staley edited this page Jan 18, 2023 · 4 revisions

A Room is a grouping of devices in a Location.

Note: A Location is the user-defined geolocation and primary organization of devices in a user account. See Locations.

For example, if a user has many connected devices at home, Rooms can further organize them into a "Kitchen", "Office", and "Living Room".

Managing Rooms

  • Each Location can have up to 20 Rooms.
  • A Room can have up to 200 devices. This counts toward the device limit for the Location.
  • A Room is owned by its Location. The Location owner and all members invited to a Location can create/read/update/delete Rooms in the Location.

More information can be found here.

Functions

Note: The list of functions can also be found here.

  • list - List the rooms in a location.

  • get - Get a specific room in a location. Requires the UUID of the room and the UUID for the location. If the client is configured with a location ID this parameter can be omitted.

  • create - Creat a room in a location. Requires the UUID of the room and the UUID for the location. If the client is configured with a location ID this parameter can be omitted.

  • update - Update a room. Requires the UUID of the room and the UUID for the location. If the client is configured with a location ID this parameter can be omitted. Requires the data request containing the name of the room.

  • delete - Delete a room from a location. Requires the UUID of the room and the UUID for the location. If the client is configured with a location ID this parameter can be omitted.

  • listDevices - Returns a list of all the devices in a room. Requires the UUID of the room and the UUID for the location. If the client is configured with a location ID this parameter can be omitted.

Clone this wiki locally