How to find out the selected room ID?

Heikki_Pirttinen · October 11, 2022, 7:37am

We use cloud to cloud and Webhooks. The SmartApp first asks for the location and room when the device installation session is started. How can I find out which room the user has chosen? Now I only get the locationId. The roomId is missing?

This message is returned from the SmartApp to the Webhook.

{
  "lifecycle": "UPDATE",
  "executionId": "e5ce614a-d51b-b0fd-257c-xxxxxxxxxxxxx",
  "appId": "d4050528-bb0d-4ef1-a02b-xxxxxxxxxxxxx",
  "locale": "fi",
  "version": "0.1.0",
  "client": {
    "os": "ios",
    "version": "1.6.90",
    "language": "fi-FI",
    "displayMode": "LIGHT",
    "timeZoneOffset": "",
    "supportedTemplates": [],
    "samsungAccountId": "",
    "mobileDeviceId": ""
  },
  "updateData": {
    "authToken": "a477c7b1-63e9-43d3-a9ca-xxxxxxxxxxxxx",
    "refreshToken": "5a7fdd7e-611b-413e-8f5e-xxxxxxxxxxxxx",
    "installedApp": {
      "installedAppId": "f84509fa-ad63-4bb9-be96-xxxxxxxxxxxxx",
      "locationId": "d5920722-0959-4fae-8083-xxxxxxxxxxxxx",
      "config": {
        "colorControl": [
          {
            "valueType": "DEVICE",
            "deviceConfig": {
              "deviceId": "5ac46bb4-7ed0-4bd2-801f-xxxxxxxxxxxxx",
              "componentId": "main"
            }
          }
        ],
        "contactSensor": [
          {
            "valueType": "DEVICE",
            "deviceConfig": {
              "deviceId": "5ac46bb4-7ed0-4bd2-801f-xxxxxxxxxxxxx",
              "componentId": "main"
            }
          }
        ],
        "ParagraphSetting": [
          {
            "valueType": "STRING",
            "stringConfig": {
              "value": "All done."
            }
          }
        ],
        "DeviceSetting": [
          {
            "valueType": "STRING",
            "stringConfig": {
              "value": "xxxxxxxxxxxxx"
            }
          }
        ]
      },
      "permissions": [
        "r:locations:*",
        "r:devices:5ac46bb4-7ed0-4bd2-801f-xxxxxxxxxxxxx",
        "x:devices:*",
        "r:devices:*",
        "w:devices:*",
        "i:deviceprofiles:*"
      ]
    }
  "settings": {}
}

nayelyz · October 11, 2022, 3:31pm

Hi, @Heikki_Pirttinen!
So, did you define settings to select the location and room? I don’t see those settings included in the payload, have you checked if you receive only the values updated?

Heikki_Pirttinen · October 12, 2022, 7:21am

At the beginning, I choose a place and a room. The first message I get is “lifecycle”: “CONFIGURATION” and “phase”: “INITIALIZE”. This message has no location information at all. And not in the following “phase”:“PAGE” or “lifecycle”: “OAUTH_CALLBACK” messages either.

INSTALL or UPDATE messages have a locationId, but not a roomId.

I get this message after I have selected a room. The SmartApp seems to remember previous cofigs.

{
  "lifecycle": "CONFIGURATION",
  "executionId": "83bbd21f-6add-f6a7-5325-xxxxxxxxxxx",
  "appId": "d4050528-bb0d-4ef1-a02b-xxxxxxxxxxx",
  "locale": "fi",
  "version": "0.1.0",
  "client": {
    "os": "ios",
    "version": "1.6.90",
    "language": "fi-FI",
    "displayMode": "LIGHT",
    "timeZoneOffset": "",
    "supportedTemplates": [],
    "samsungAccountId": "",
    "mobileDeviceId": ""
  },
  "configurationData": {
    "installedAppId": "f84509fa-ad63-4bb9-be96-xxxxxxxxxxx",
    "phase": "INITIALIZE",
    "pageId": "",
    "previousPageId": "",
    "config": {
      "colorControl": [
        {
          "valueType": "DEVICE",
          "deviceConfig": {
            "deviceId": "5ac46bb4-7ed0-4bd2-801f-xxxxxxxxxxx",
            "componentId": "main"
          }
        }
      ],
      "contactSensor": [
        {
          "valueType": "DEVICE",
          "deviceConfig": {
            "deviceId": "5ac46bb4-7ed0-4bd2-801f-xxxxxxxxxxx",
            "componentId": "main"
          }
        }
      ],
      "ParagraphSetting": [
        {
          "valueType": "STRING",
          "stringConfig": {
            "value": "All done."
          }
        }
      ],
      "DeviceSetting": [
        {
          "valueType": "STRING",
          "stringConfig": {
            "value": "xxxxxxxxxxx"
          }
        }
      ],
      "DeviceSetting": [
        {
          "valueType": "STRING",
          "stringConfig": {
            "value": "xxxxxxxxxxx"
          }
        }
      ]
    }
  },
  "settings": {}
}

nayelyz · October 12, 2022, 5:06pm

A SmartApp is installed on a Location level, so, I wouldn’t expect it to be bound to any room.
That’s why I asked if you had a setting where you could select the room because I’m not sure where are you currently selecting it.
But, do you want to know in which room is the device located?

Heikki_Pirttinen · October 13, 2022, 6:22am

I am installing the device in the SmartApp, the device is in our own cloud.

The installation process first asks for the location of the device (location and room). How can I access this information? When user select the next button, we get a request to initialize our cloud. This works OK, but the room information is missing.

nayelyz · October 13, 2022, 10:55pm

aaaaah, got it.
I’ll ask the team about this but, currently, I would say that info only belongs to the device itself. When we query it, it has the roomId property:

await ctx.api.devices.get(deviceID)

orangebucket · October 13, 2022, 11:10pm

I’ve not played with this yet. Is the issue that it is down to you to install the device in the required room and you can’t do that if they haven’t told you what it is? Or does it end up in that room anyway?

Heikki_Pirttinen · October 14, 2022, 7:06am

The problem is that when I don’t get a roomId, the roomId is not set during the installation of the device, so the device does not go to any room. The device can be found in the SmartApp for devices without a room section. Since the roomId is not set, the roomId is also missing when reading the information from the device.

I have now worked around the problem by reading all the rooms of the user and selecting the first one. I will add this roomId to the device installation information. The problem is that the user’s choice does not matter here, but the user finds the device more easily when device even goes somewhere visible.

nayelyz · October 14, 2022, 11:09pm

Ah, this doesn’t happen when we use the SmartApp SDK. You mentioned your integration wasn’t using this tool, right?
I’m not sure why but I’ll check with the team if it can be retrieved somehow.

Heikki_Pirttinen · October 19, 2022, 7:05am

We have done the implementation by following the instructions:
Cloud Connected devices → Webhook Endpoint

We use Google’s serverless service. So the assumption is that Webhook Endpoint is the right way to do the implementation.

nayelyz · October 19, 2022, 3:07pm

Ok, just to clarify, there are two different approaches for Cloud Connected Services → Webhook endpoint.
One is a SmartApp Connector and the other is an ST Schema, both have their own SDK to help you with the development SmartApp NodeJS SDK and ST Schema NodeJS SDK.
What I asked before is if you were using the SmartApp SDK of the link above.

Here’s an example of a SmartApp Connector definition using the SDK:

gist.github.com

https://gist.github.com/nayelyzarazua-bluetrail/15a56ee01eeceb4a9dd573982c4ebd06

server.js

'use strict';

const express = require('express');
const bodyParser = require('body-parser');
const SmartApp = require('@smartthings/smartapp');
require('dotenv').config();

const server = module.exports = express();
server.use(bodyParser.json());
const deviceStates = {switch: 'off'}//1-10

This file has been truncated. show original

Heikki_Pirttinen · October 20, 2022, 6:13am

Because we have a serverless service with a maximum instance usage time of 9 minutes. We can’t stay and listen to WebSockets. Because of this, we cannot use the SmartApp SDK.

nayelyz · October 20, 2022, 8:57pm

ok, I just wanted to confirm. I haven’t received more info from the team. I’ll keep you updated.

nayelyz · October 25, 2022, 5:01pm

Hi, @Heikki_Pirttinen.
Following up on your question, the team mentioned that the page where we select the location and room where the device will be installed belongs to the ST app itself, not the SmartApp, therefore, this value isn’t known by it.
I previously mentioned using the SDK the issue of the device being created in another room didn’t happen but the SDK is not the one putting the device in the correct room but the ST app.

When this happened, it was because you included the roomId in the device’s properties empty or the property was empty?

Basically, the ST app should place the device where selected. For example, I don’t assign any roomId and it worked
The team also mentioned that this process can fail, so, if you already found a workaround, you should continue using it.
Another thing you can do is create your own setting in the SmartApp definition to get the rooms list and allow the user to select one where he wants to install the device. The only inconvenience would be that the user needs to install the SmartApp before making the API request (this is to get the SmartApp Access Token).

Heikki_Pirttinen · October 26, 2022, 8:43am

When the user installs the device. First he/she chooses the location and the room. After this, Webhook get the first message (CONFIGURATION). Rooms cannot be requested until the user has given permission. Granting permission is the final step of the Wizard. I think this message should also include the roomId (INSTALL/UPDATE).

If I send the API command “Install a Device” without a roomId, the device does not go to any room.

My current workaround is not acceptable. Because the user’s choice is not taken into account. Are you saying there is no solution for this? Am I the first one to use the SmartApp like this? Where can I find ST app support?

nayelyz · October 26, 2022, 4:18pm

As the page of the selection of the location and room isn’t part of the SmartApp, it is normal this is not included in those lifecycles (context variable)

I’ll open a report to get more info about why the app isn’t creating the device where it belongs. Just a heads up, this can take some time to be reviewed by the team.

Can you share the following information, please?

App ID of the SmartApp Connector (it’s in the Dev WS)
Replicate the error and share the mobile app’s logs:

For Android:

Go to the “calls” app on your Android phone

Dial *#9900#. It will open the Dump sys

Chose RUN DUMPSTATE/LOGCAT and wait for it to finish

Then, select COPY TO SDCARD(INCLUDE CP RAMDUMP), it takes some time as well

Connect your phone to a computer (USB cable)

Open the device (phone) in the files explorer to see its content

Find the log folder and look for the text file whose name is similar to
“DUMP_STATE_G93FXXU1DQJ3.DM_202210261516”
The last value is the current date and hour which helps you identify the correct folder.

Copy that file to the computer and share it with us
Note: You can also send the file directly from your phone, but it can be hard finding the file due to its long name.

For iOS:
2. Go to Dashboard settings (hamburger icon).
3. Select “Help” (at the bottom of the menu).
4. Tap on “Report a problem” and agree to the prompt.
5. Save these logs in the storage service of your preference.
6. Download and share them with me.

For Cloud-to-Cloud integrations it’s more common for companies to use ST Schema because of its level of security (OAuth 2.0) and it doesn’t require direct requests to the API to create a device, it has a discovery process where they are created.
In this integration, the roomId isn’t included either, the app should take care of it just like in a SmartApp.

Heikki_Pirttinen · October 27, 2022, 9:38am

If I install several devices, the first device does not go into any room, the second device goes in the right room. The third device also goes also to the right room, but takes the previous device with it, so two devices now go to the same room even though they should go to different rooms. The fourth device also goes to the right room, but the other device follows behind, so now three devices in the same room even though they should be in different rooms. The first device stays in the “No room” section all the time. Other devices change rooms depending on which room was last selected.

nayelyz · October 27, 2022, 9:18pm

So, if I understand correctly, you’re not installing all of those devices at once and you create them one by one?

Heikki_Pirttinen · October 31, 2022, 1:32pm

We have applied for the WWST certificate. When I now add the device, selecting through our company name, the device is installed correctly. It seems that the problem is only on that test side.

nayelyz · October 31, 2022, 3:26pm

Thank you for sharing this info.

Topic		Replies	Views
Get rooms in SmartApp? Writing SmartApps smartapp	3	1955	June 24, 2016
Group names API call Writing SmartApps	6	1252	July 16, 2017
Any way to get locationId in CONFIGURATION Lifecycle phase? Writing SmartApps	5	525	June 1, 2018
How can I know what is the location for my issued access token? Writing SmartApps	11	1318	March 21, 2018
Group/Room name? General Discussion developers	4	1361	October 12, 2015

How to find out the selected room ID?

Related topics