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

Commit

Permalink
Merge pull request #38 from rossiam/apidocs
Browse files Browse the repository at this point in the history 
update documentation to reflect new developer workspace
  • Loading branch information
@rossiam
rossiam committed Jun 25, 2019
2 parents 1c235ca + 83e0220 commit 93ce37c
Show file tree
Hide file tree
Showing 4 changed files with 72 additions and 63 deletions.
23 changes: 10 additions & 13 deletions examples/java-lambda-smartapp/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -89,19 +89,16 @@ First, you'll need to determine the target ARN for the function you just deploye
function you just deployed in the AWS Console and you will find the ARN in the upper right
corner.

In the [developer workspace](https://devworkspace.developer.samsung.com/smartthingsconsole/iotweb/site/index.html),
choose "Automations" on the left navigation bar and create a new WebHook endpoint automation using the following
settings:

| Option | Value |
|--------------------|-------------------------------------|
| SmartApp Instances | Single |
| Hosting Type | AWS Lambda |
| Target ARN | The ARN you found above |
| Scopes | `r:devices:*` and `x:devices:*` |
| App Settings | leave blank |

Once created, self-publish the automation for testing and you will be ready to test it.
Then, follow these steps using the
[developer workspace](https://smartthings.developer.samsung.com/workspace/):

1. Create a new project and choose "Automation for the SmartThings App".
1. Give your project a unique name.
1. Choose "Automation Connector | SmartApp" under "Develop" in the left-hand menu.
1. Choose "AWS Lambda" and enter the target ARN you found above.
1. Select the `r:devices:*` and `x:devices:*` scopes and click "Next".
1. Give your application a name and hit "Save".
1. Save the new project and click the "Deploy to Test" button.

### Install SmartApp

Expand Down
35 changes: 20 additions & 15 deletions examples/java-ratpack-guice-smartapp/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@ for dependency injection.

## Running the Example

### Build and Run

Execute the following command from the project root directory:

```
Expand All @@ -20,21 +22,24 @@ Execute the following command from the project root directory:

### Create SmartApp

Note: it is necessary for the application to be running before you create the SmartApp
in the developer console.

In the [developer workspace](https://devworkspace.developer.samsung.com/smartthingsconsole/iotweb/site/index.html),
choose "Automations" on the left navigation bar and create a new WebHook endpoint automation using the following
settings:

| Option | Value |
|--------------------|-------------------------------------|
| SmartApp Instances | Single |
| Hosting Type | WebHook endpoint |
| Target URL | Enter the URL of your endpoint here |
| Scopes | `r:devices:*` and `x:devices:*` |

Once created, self-publish the automation for testing and you will be ready to test it.
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](https://smartthings.developer.samsung.com/workspace/):

1. Create a new project and choose "Automation for the SmartThings App".
1. Give your project a unique name.
1. Choose "Automation Connector | SmartApp" under "Develop" in the left-hand menu.
1. Choose "WebHook Endpoint" and enter the URL of your endpoint and click "Next".
1. Select the `r:devices:*` and `x:devices:*` scopes and click "Next".
1. 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.)
1. Save the public key created to a file called `smartthings_rsa.pub` in the
`src/main/resources` directory.
1. Save the new project and click the "Deploy to Test" button.
1. Restart your server (see [Build and Run](#build-and-run) above). (This is
necessary because we added the configuration options above.)

### Install SmartApp

Expand Down
42 changes: 22 additions & 20 deletions examples/java-springboot-smartapp/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,26 +20,28 @@ Execute the following command from the project root directory:

### Create SmartApp

Note: it is necessary for the application to be running before you create the SmartApp
in the developer console.

In the [developer workspace](https://devworkspace.developer.samsung.com/smartthingsconsole/iotweb/site/index.html),
choose "Automations" on the left navigation bar and create a new WebHook endpoint automation using the following
settings:

| Option | Value |
|--------------------|-------------------------------------|
| SmartApp Instances | Single |
| Hosting Type | WebHook endpoint |
| Target URL | Enter the URL of your endpoint here |
| Scopes | `r:devices:*` and `x:devices:*` |

Once created, self-publish the automation for testing and you will be ready to test it.

### Configure Public Key

Copy the public key created in the previous step into a file called `smartthings_rsa.pub` in `src/main/resources`
and restart your server (see [Build and Run](#build-and-run) above).
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](https://smartthings.developer.samsung.com/workspace/):

1. Create a new project and choose "Automation for the SmartThings App".
1. Give your project a unique name.
1. Choose "Automation Connector | SmartApp" under "Develop" in the left-hand menu.
1. Choose "WebHook Endpoint" and enter the URL of your endpoint and click "Next".
1. Select the `r:devices:*` and `x:devices:*` scopes and click "Next".
1. 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.)
1. Save the public key created to a file called `smartthings_rsa.pub` in the
`src/main/resources` directory.
1. 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.
1. Save the new project and click the "Deploy to Test" button.
1. Restart your server (see [Build and Run](#build-and-run) above). (This is
necessary because we added the configuration options above.)

### Install SmartApp

Expand Down
35 changes: 20 additions & 15 deletions examples/kotlin-smartapp/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ This sample demonstrates a simple [Kotlin](https://kotlinlang.org/)-based server

## Running the Example

### Build and Run

From the root project directory:

```
Expand All @@ -16,21 +18,24 @@ From the root project directory:

### Create SmartApp

Note: it is necessary for the application to be running before you create the SmartApp
in the developer console.

In the [developer workspace](https://devworkspace.developer.samsung.com/smartthingsconsole/iotweb/site/index.html),
choose "Automations" on the left navigation bar and create a new WebHook endpoint automation using the following
settings:

| Option | Value |
|--------------------|-------------------------------------|
| SmartApp Instances | Single |
| Hosting Type | WebHook endpoint |
| Target URL | Enter the URL of your endpoint here |
| Scopes | `r:devices:*` and `x:devices:*` |

Once created, self-publish the automation for testing and you will be ready to test it.
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](https://smartthings.developer.samsung.com/workspace/):

1. Create a new project and choose "Automation for the SmartThings App".
1. Give your project a unique name.
1. Choose "Automation Connector | SmartApp" under "Develop" in the left-hand menu.
1. Choose "WebHook Endpoint" and enter the URL of your endpoint and click "Next".
1. Select the `r:devices:*` and `x:devices:*` scopes and click "Next".
1. 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.)
1. Save the public key created to a file called `smartthings_rsa.pub` in the
`src/main/resources` directory.
1. Save the new project and click the "Deploy to Test" button.
1. Restart your server (see [Build and Run](#build-and-run) above). (This is
necessary because we added the configuration options above.)

### Install SmartApp

Expand Down

0 comments on commit 93ce37c

Please sign in to comment.