https://github.com/smartthingscommunity/webrtc-tutorial
A SmartThings Schema tutorial that enables you to add a webcam to your SmartThings account.
https://github.com/smartthingscommunity/webrtc-tutorial
Last synced: 5 months ago
JSON representation
A SmartThings Schema tutorial that enables you to add a webcam to your SmartThings account.
- Host: GitHub
- URL: https://github.com/smartthingscommunity/webrtc-tutorial
- Owner: SmartThingsCommunity
- License: apache-2.0
- Created: 2024-02-16T02:20:40.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-10-16T20:49:46.000Z (over 1 year ago)
- Last Synced: 2025-08-07T09:51:21.380Z (8 months ago)
- Language: JavaScript
- Homepage: https://developer.smartthings.com
- Size: 180 KB
- Stars: 4
- Watchers: 5
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Overview
This tutorial demonstrates how to create a SmartThings Schema integration that
enables you to add a webcam to your SmartThings account. The integration
creates a single camera device that can be used to view the webcam's video stream from within the SmartThings app.
This tutorial is divided into five unique steps. Instructions for each step can be found in each `step_` subdirectory.
> **⚠️ IMPORTANT**: Code provided in steps 2 and later in each `sample_files` directory is for *reference only* and is not intended to be a pre-configured standalone solution. Each step builds on the previous step's sample files - when you finish following instructions for a given step, the code in your working directory should resemble the code examples and files provided in each step's `sample_files` directory.
# Prerequisites
1. Basic familiarity with NodeJS and JavaScript
1. A [Samsung account](https://developer.smartthings.com/).
1. The [SmartThings CLI](https://github.com/SmartThingsCommunity/smartthings-cli/tree/main/packages/cli) installed and configured for your Samsung account. If you have not yet configured the CLI for use with your Samsung account, you will be prompted to do so when running the CLI for the first time.
1. A computer running MacOS, Windows, or Linux.
1. A webcam connected to your computer.
1. NodeJS version 20.
# Tutorial
* [Step 1: Get started with a pre-existing OAuth app](step_1/STEP_1.md)
* [Step 2: Create a device profile](step_2/STEP_2.md)
* [Step 3: Register your Schema integration](step_3/STEP_3.md)
* [Step 4: Implement a ring button](step_4/STEP_4.md)
* [Step 5: Add your camera](step_5/STEP_5.md)
# References
* [Get Started with Cloud Connected Devices](https://developer.smartthings.com/docs/devices/cloud-connected/get-started)
* [Get Started with SmartThings Schema](https://developer.smartthings.com/docs/devices/cloud-connected/st-schema)
* [Device Profiles](https://developer.smartthings.com/docs/devices/device-profiles/)
* [st-schema NodeJS library](https://github.com/SmartThingsCommunity/st-schema-nodejs)