Skip to content
This repository has been archived by the owner on Feb 3, 2022. It is now read-only.

Latest commit

 

History

History
94 lines (68 loc) · 4.2 KB

README.md

File metadata and controls

94 lines (68 loc) · 4.2 KB

Java Spring Boot Example SmartApp java-logo spring-logo

This sample demonstrates a simple Java server using Spring Boot.

Requirements

Running the Example

Build and Run

Execute the following command from the project root directory:

./gradlew examples:java-springboot-smartapp:bootRun

Create SmartApp

Note: it is necessary for the application to be running before you create the SmartApp in the developer console. You will need to restart once configured.

Follow these steps using the developer workspace:

  1. Install the AWS CLI.

  2. Configure the CLI to use your account.

    1. Create a user with DynamoDB permissions.

      1. Find "My Security Credentials" under your account settings.
      2. Click on "Users" and then "Add User".
      3. Give the user a name like "DynamoDB", choose "programmatic" access for the access type and click "Next".
      4. Choose "Attach existing policies directly", find and add "AmazonDynamoDBFullAccess" and click "Next".
      5. Click "Next" on the tags page.
      6. Click "Create User".
      7. Copy and save both the key id and the key secret.

    2. Run aws configure and populate as follows:

      Option Value
      AWS Access Key ID id from above
      AWS Secret Access Key secret from above
      Default region name choose an AWS region geographically close to your end-user's location
      Default output format enter 'json' here

  3. Create a new project and choose "Automation for the SmartThings App".

  4. Give your project a unique name.

  5. Choose "Automation Connector | SmartApp" under "Develop" in the left-hand menu.

  6. Choose "WebHook Endpoint" and enter the URL of your endpoint and click "Next".

  7. Select the r:devices:* and x:devices:* scopes and click "Next".

  8. Give your application a name and hit "Save". Note that at this point, you will need to have the application running. (See Build and Run above.)

  9. Save the public key created to a file called smartthings_rsa.pub in the src/main/resources directory.

  10. In src/main/resources, copy application.yml.example to application.yml and update the client id and client secret with values from your newly created smartapp. If the secret is hidden, hit "regenerate" to get a new client id and client secret.

  11. Save the new project and click the "Deploy to Test" button.

  12. Restart your server (see Build and Run above). (This is necessary because we added the configuration options above.)

Install SmartApp

First, be sure to enable developer mode in your SmartThings application to see the self-published automation.

Now you should see your SmartApp listed (near the bottom) when you add a new Automation.

More about SmartThings

If you are not familiar with SmartThings, we have extensive on-line documentation.

To create and manage your services and devices on SmartThings, create an account in the developer workspace.

The SmartThings Community is a good place share and ask questions.

There is also a SmartThings reddit community where you can read and share information.

License and Copyright

Licensed under the Apache License, Version 2.0

Copyright 2019 SmartThings, Inc.