• Documentation >
• Apps >
• Internet of Things >
• SmartThings

SmartThings

With SmartThings modules in Ibexa Connect, you can:

• execute and list rules

• execute and list scenes

• create, update, retrieve, list, and delete locations

• create, update, retrieve, list, and delete rooms

To get started with SmartThings, create an account at smartthings.com.

Connect SmartThings to Ibexa Connect

To connect to SmartThings app, you need to obtain the Personal Access Token.

1. Log in to your SmartThings account.

2. Click Generate New Token.

   

3. Select the Authorized Scopes and click Generate Token.

   

4. Copy the personal access token to a safe place.

   

5. Log in to your Ibexa Connect account, insert a SmartThings module in your scenario and click the Add button next to the Connection field.

   

6. In the Connection name field, enter a name for the connection.

7. In the Personal Access Token field, enter the token copied in step 4 and click Save.

You have successfully connected the SmartThings app and can now build scenarios.

Rules

You can execute and list rules using the following modules.

Execute a Rule

Executes a rule.

Location ID	Select or map the Location ID whose rule you want to execute.
Rule ID	Select or map the Rule ID you want to execute.

List Rules

Lists rules.

Location ID	Select or map the Location ID whose rules you want to list.
Limit	Set the maximum number of rules Ibexa Connect will return during one execution cycle.

Scenes

You can execute and list scenes using the following modules.

Execute a Scene

Executes a scene.

For field descriptions, see the SmartThings API reference.

List Scenes

Lists scenes.

Location ID	Select or map the Location ID whose scenes you want to list.
Limit	Set the maximum number of scenes Ibexa Connect will return during one execution cycle.

Locations

You can create, update, retrieve, list, and delete locations using the following modules.

Create a Location

Creates a location for a user.

For field descriptions, see the SmartThings API reference.

Update a Location

Updates a location.

Location ID	Select or map the Location ID whose details you want to update.

For field descriptions, see the SmartThings API reference.

Get a Location

Retrieves a location.

Location ID	Select or map the Location ID whose details you want to retrieve.
Allowed	Select whether the items in the response may contain the allowed list property.

List Locations

Lists all locations currently available in a user account.

Limit	Set the maximum number of locations Ibexa Connect will return during one execution cycle.

Delete a Location

Deletes a location.

Location ID	Select or map the Location ID you want to delete.

Rooms

You can create, update, retrieve, list, and delete rooms using the following modules.

Create a Room

Creates a room.

Name	Enter the name of the room. For example, Living Room.
Location ID	Select or map the Location ID to which you want to attach this room.

Update a Room

Updates a room.

Name	Enter the name of the room. For example, Living Room.
Location ID	Select or map the Location ID whose room you want to update.
Room ID	Select or map the Room ID whose details you want to update.

Get a Room

Retrieve a room.

Location ID	Select or map the Location ID whose room details you want to retrieve.
Room ID	Select or map the Room ID whose details you want to retrieve.

List Rooms

LIsts rooms.

Location ID	Select or map the Location ID whose rooms you want to list.
Limit	Set the maximum number of rooms Ibexa Connect will return during one execution cycle.

Delete a Room

Deletes a room.

Location ID	Select or map the Location ID whose room you want to delete.
Room ID	Select or map the Room ID you want to delete.

Other

You can call APIs using the following module.

Make an API Call

Performs an arbitrary authorized call.

For the list of available endpoints, refer to the SmartThings API Documentation.

URL	Enter a path relative to https://api.smartthings.com. For example, /v1/locations.
Method	Select the HTTP method you want to use: GET to retrieve information for an entry. POST to create a new entry. PUT to update/replace an existing entry. PATCH to make a partial entry update.DELETE - to delete an entry.
Headers	Enter the desired request headers. You don't have to add authorization headers; we already did that for you.
Query String	Enter the request query string.
Body	Enter the body content for your API call.

Example of Use - Get Rooms

The following API call returns all the rooms from your SmartThings account.

URL: /v1/locations/<location_id>/rooms

Method: GET

Matches of the search can be found in the module's Output under Bundles > Body > items.

In our example, 3 rooms were returned: