https://github.com/smartthingscommunity/weather-color-light-smartapp-nodejs
This SmartApp sets the color of a light based on the weather forecast.
https://github.com/smartthingscommunity/weather-color-light-smartapp-nodejs
aws-lambda smartthings-smartapp-example
Last synced: 12 months ago
JSON representation
This SmartApp sets the color of a light based on the weather forecast.
- Host: GitHub
- URL: https://github.com/smartthingscommunity/weather-color-light-smartapp-nodejs
- Owner: SmartThingsCommunity
- License: apache-2.0
- Created: 2017-12-07T05:47:04.000Z (over 8 years ago)
- Default Branch: main
- Last Pushed: 2024-01-09T17:34:53.000Z (about 2 years ago)
- Last Synced: 2025-03-26T02:42:37.070Z (12 months ago)
- Topics: aws-lambda, smartthings-smartapp-example
- Language: JavaScript
- Homepage:
- Size: 1.44 MB
- Stars: 58
- Watchers: 98
- Forks: 52
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Set the color of a light based on the weather.
This example Lambda SmartApp demonstrates the use of SmartThings APIs via the [SmartApp NodeJS SDK](https://github.com/SmartThingsCommunity/smartapp-sdk-nodejs) to achieve an Automation.
It showcases:
- App installation and configuration flow.
- Integrating with a third-party API (OpenWeather).
- Actuating devices using the SmartThings API.
- Creating schedules and handling scheduled executions.
## Setup instructions
### Prerequisites
- An [AWS](https://www.serverless.com/framework/docs/providers/aws/guide/credentials/) account (free tier is fine).
- An [OpenWeather](https://api.openweathermap.org) account (free tier is fine).
- A [Samsung account](https://account.samsung.com/membership/index.do) and the SmartThings mobile application.
- A [Developer Workspace](https://smartthings.developer.samsung.com/workspace/) account.
- A SmartThings compatible color bulb, such as SYLVANIA Smart RGBW, LIFX, or Phillips Hue.
#### If testing locally (using provided webserver)
- [Node.js](https://nodejs.org) and [npm](https://npmjs.com) installed (verified with npm version 6.14.8 and Node 12.19.0).
- [ngrok](https://ngrok.com/) installed to create a secure tunnel and create a globally available URL for fast testing.
### Start
We've provided two options: the intended deployment platform for this automation (AWS Lambda) and a simple web server that can be used to run and test locally. In either case, first create an API key at [OpenWeather](https://api.openweathermap.org). We will use this in both options below.
Clone or download this repository and follow the desired option.
#### Lambda
1. Install the dependencies for this app: `npm install`.
1. Follow the instructions to [setup AWS credentials](https://www.serverless.com/framework/docs/providers/aws/guide/credentials/) for serverless.
1. Deploy the Lambda function: `serverless deploy`.
1. Navigate to the AWS Lambda dashboard to [add an env var](https://docs.aws.amazon.com/lambda/latest/dg/configuration-envvars.html) with the key `WEATHER_API_KEY` and the value as the API key you created at OpenWeather.
1. Follow the steps to grant SmartThings [permission to execute your Lambda function](https://smartthings.developer.samsung.com/docs/smartapps/aws-lambda.html). **This is required for successful registration.**
#### Local
1. Create a `.env` and store your OpenWeather API key as shown in `.env.example` file.
1. Install the dependencies for this app: `npm install`.
1. Start the server: `npm start`.
1. Start ngrok (in another terminal window/tab): `ngrok http 3005`. Copy the `https:` URL to your clipboard.
### 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:*`
#### Local Only
A `CONFIRMATION request` log should show in the log output of the local 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).
Once installed, the configured bulb will turn on and its color will either be purple (if precipitation is in the forecast), orange (if the forecast calls for temperatures above 80 degrees Fahrenheit), blue (if the forecast calls for temperatures below 50 degrees Fahrenheit), or white (if no precipitation and temperature between 50 and 80 degrees Fahrenheit). It will check the current weather forecast at the interval set during installation.
## Troubleshooting
### Local
- When installing the SmartApp in the SmartThings mobile app, if you get an error **Something went wrong. Please try to install the SmartApp again**, then it is possible that you did not navigate to the confirmation link as specified above. If this is the case, then in the npm server terminal you will also see an error. Make sure you navigate to the URL sent with the `CONFIRMATION request` to the npm server. This can be resent by navigating to Developer Workspace `Overview` and clicking `Verify App Registration`.
## Documentation
- Documentation for developing SmartApps can be found on the [SmartThings developer portal](https://smartthings.developer.samsung.com/develop/guides/smartapps/basics.html).
- [SmartThings API reference documentation](https://smartthings.developer.samsung.com/develop/api-ref/st-api.html)
- [SmartApp API reference documentation](https://smartthings.developer.samsung.com/docs/api-ref/smartapps-v1.html)
## Credits
The concept of a SmartThings-connected color bulb that changes its color based upon weather or other environmental data is not new or original to this example.
The [SmartThings Community](https://community.smartthings.com) has created several similar solutions in the past, including:
- [Color Changing Smart Weather Lamp](https://community.smartthings.com/t/color-changing-smart-weather-lamp-app/12046)
- [ColorCast - Color Changing Weather Lamp](https://community.smartthings.com/t/colorcast-color-changing-weather-lamp/13874)