https://github.com/smartthingscommunity/smartapp-example-open-close-nodets

The Typescript version of the Open/Close example SmartApp.
https://github.com/smartthingscommunity/smartapp-example-open-close-nodets

smartthings-smartapp-example webhook

Last synced: 9 days ago
JSON representation

The Typescript version of the Open/Close example SmartApp.

• Host: GitHub
• URL: https://github.com/smartthingscommunity/smartapp-example-open-close-nodets
• Owner: SmartThingsCommunity
• License: apache-2.0
• Created: 2020-12-03T22:33:35.000Z (over 5 years ago)
• Default Branch: main
• Last Pushed: 2022-10-17T17:30:01.000Z (over 3 years ago)
• Last Synced: 2024-11-07T11:14:38.878Z (over 1 year ago)
• Topics: smartthings-smartapp-example, webhook
• Language: TypeScript
• Homepage:
• Size: 164 KB
• Stars: 4
• Watchers: 9
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Open/Close Lighting Control (TypeScript)

The following example SmartApp is the equivalent of a simple Rule (if contact sensor opens/closes, turn lights on/off) which is easily achieved via our [Rules API](https://smartthings.developer.samsung.com/docs/rules/overview.html). This simple automation is used here as a brief functional showcase of a SmartApp using the Node SDK, and is not meant to be a good candidate for a SmartApp. Be sure to check if your automation is possible with the Rules API, as it will benefit from speed, stability, and security through future local execution support.

## Start

To get going quickly with this example, we've provided a few options for hosting below. Follow any one of them to get the app up and accepting requests before moving on to registration instructions.

### Heroku

[![Deploy](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy)

[View logs](https://devcenter.heroku.com/articles/logging#log-retrieval-via-the-web-dashboard) in the Heroku dashboard.

Click the **Open app** button in the Heroku dashboard app page to copy the public URL for use in steps below.

### Glitch (no account required)

[![Remix on Glitch](https://cdn.glitch.com/2703baf2-b643-4da7-ab91-7ee2a2d00b5b%2Fremix-button.svg)](https://glitch.com/edit/#!/import/github/SmartThingsCommunity/smartapp-example-open-close-nodets)

[View logs](https://support.glitch.com/t/console-log-where-to-find-it/14456) in the Glitch editor.

Copy the [Live Site URL](https://glitch.happyfox.com/kb/article/50-how-do-i-find-the-url-for-my-app/) from Glitch for use in steps below.

### Local

To make this work locally, we recommend using [ngrok](https://ngrok.com/) to create a globally available URL for fast testing.

`npm install`  

`npm run build`  

`npm start`  

`ngrok http 3001`

## Register

Follow the instructions for [registering a SmartApp](https://smartthings.developer.samsung.com/docs/smartapps/app-registration.html) with the SmartThings platform.

- The following OAuth2 scopes are required.

    - `r:devices:*` 

    - `x:devices:*` 

A `CONFIRMATION request` log should show in the log output of the server once registered. Navigate to this link to [verify your domain ownership](https://smartthings.developer.samsung.com/docs/smartapps/webhook-apps.html#Verify-your-domain-ownership) and enable the app to receive events. **This is required for successful installation.**

## Test

Follow the instructions for [testing a SmartApp](https://smartthings.developer.samsung.com/docs/testing/how-to-test.html).