Creating Schema App with ST CLI

iquix · October 5, 2022, 4:17am

I’ve created webhook Schema app with SmartThings CLI with following command

$ smartthings schema:create -y -i input.yaml

Content of input.yaml is in format below.

partnerName: Schema Create Test ptnName
oAuthClientId: 'https://c2c-ap.smartthings.com/'
oAuthClientSecret: dummy2
oAuthAuthorizationUrl: 'https://myserver.net/auth/authorize'
oAuthTokenUrl: 'https://myserver.net/auth/token'
hostingType: webhook
webhookUrl: 'https://myserver.net/api/hast_bridge'
appName: Schema Create Test appName
schemaType: st-schema
oAuthScope: null
icon: 'https://catalog3rd.samsungiotcloud.com/devws/2021/08/12/HYJnYXOGdZEnIe3i'
icon2x: 'https://catalog3rd.samsungiotcloud.com/devws/2021/08/12/HYJnYXOGdZEnIe3i'
icon3x: 'https://catalog3rd.samsungiotcloud.com/devws/2021/08/12/HYJnYXOGdZEnIe3i'
userEmail: 'my@email.com'

I successfully got the endpointAppId, stClientId and stClientSecret as the result of the command above. Also, I can see the content of the Schema with the CLI with the command

$ smartthings schema

But, the schema is not visible in the SmartThings app.
I’ve already activated developer mode in the ST app, with no luck.

When I generate the schema app from the DevWS, then it shows up in the list in the ST app, and fully functional.

but, I need to use SmartThings API (which is identical to ST CLI) to create a ST Schema for my purpose.

FYI, I’m using ST app android version 1.7.89.25.

nayelyz · October 5, 2022, 4:57pm

I believe it is because when we create it from the API, it is not deployed to test, using the DevWS it appears after you deploy it, right?
I already asked the team why is this happening, I’ll let you know their feedback.

Can you provide more details about your use case, please?

iquix · October 5, 2022, 10:48pm

I’ve made a Home Assistant custom component, which brings devices from Home Assistant to SmartThings using SmartThings Schema Connector.

There’s a HomeAssistant’s built-in component which works opposite direction. (brings SmartThings devices to HomeAssistant) It creates SmartThings webhook smartapp just by using SmartThings API, and it does not require devWS to deploy. It is made by @andrewsayre.

github.com

home-assistant/core/blob/5674295b3cd50536a18f08c6baa72d651b5dbd46/homeassistant/components/smartthings/smartapp.py#L140


      
                  "app_name": APP_NAME_PREFIX + str(uuid4()),
                  "display_name": "Home Assistant",
                  "description": description,
                  "webhook_target_url": get_webhook_url(hass),
                  "app_type": APP_TYPE_WEBHOOK,
                  "single_instance": True,
                  "classifications": [CLASSIFICATION_AUTOMATION],
              }
          
          

          
async def create_app(hass: HomeAssistant, api):
              """Create a SmartApp for this instance of hass."""
              # Create app from template attributes
              template = _get_app_template(hass)
              app = App()
              for key, value in template.items():
                  setattr(app, key, value)
              app, client = await api.create_app(app)
              _LOGGER.debug("Created SmartApp '%s' (%s)", app.app_name, app.app_id)
          
          
    # Set unique hass id in settings

I hope webhook Schema Connector could be created with SmartThings API, just like webhook Smartpp can be created with SmartThings API only.

nayelyz · October 5, 2022, 10:54pm

Mmm…but this SmartApp appears in the mobile app? AFAIK it isn’t possible to deploy to test a SmartApp either, I’m curious about the setup of this integration, is it done on the HA side or ST?
The team mentioned the deployment to test can be done only in the Developer Workspace for ST Schema as well.

iquix · October 5, 2022, 11:32pm

Oh, the smartapp is not visible in SmartThings app, but it is fully functional.

When adding SmartThings Integration in the HomeAssistant, There’s a step where you provide SmartThings PAT, and then it automatically registers the webhook smartapp to SmartThings using SmartThings API.

The homeassistant source code, linked above, is the part that registers smartapp to SmartThings using pysmartthings, which is a wrapper for SmartThings API for python.

edit:
It seems that pysmarttings uses undocumented method to activate smartapp, by accessing strongman-regional.api~~ server.
I’m sorry for asking you about undocumented(=unsupported) method.

github.com

andrewsayre/pysmartthings/blob/dev/pysmartthings/installedapp.py

"""Define the installedapp module."""

from enum import Enum
from typing import Sequence

from .api import Api
from .entity import Entity
from .subscription import SubscriptionEntity


def format_install_url(app_id: str, location_id: str) -> str:
    """Return a web-based URL to auth and install a SmartApp."""
    return f"https://account.smartthings.com/login?redirect=https%3A%2F%2Fstrongman-regional.api.smartthings.com%2F%3FappId%3D{app_id}%26locationId%3D{location_id}%26appType%3DENDPOINTAPP%26language%3Den%26clientOS%3Dweb"


class InstalledAppType(Enum):
    """Define the type of installed app."""

    UNKNOWN = "UNKNOWN"
    LAMBDA_SMART_APP = "LAMBDA_SMART_APP"

This file has been truncated. show original

Topic		Replies	Views
Schema Connector webhook device issues Developer Programs	3	684	March 31, 2021
C2C Schema connector. Lambda, . No authentication in discovery event Support	4	689	November 29, 2019
'st-schema' examples and 'Aqara smart plug' or 'SmartThings-smartthings-hub' intergration Support developers	1	331	May 31, 2023
Schema Callabak API Docs Developer Programs	3	476	March 11, 2021
SmartThings Schema for other programming languages Developer Programs	7	1423	November 10, 2022

Creating Schema App with ST CLI

Related topics