Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/smartthingscommunity/smartapp-sdk-java
A collection of consumer-oriented Java (JVM) libraries for creating SmartApps and using the public API
https://github.com/smartthingscommunity/smartapp-sdk-java
groovy java kotlin smartapp smartthings smartthings-api smartthings-smartapp
Last synced: 3 months ago
JSON representation
A collection of consumer-oriented Java (JVM) libraries for creating SmartApps and using the public API
- Host: GitHub
- URL: https://github.com/smartthingscommunity/smartapp-sdk-java
- Owner: SmartThingsCommunity
- License: apache-2.0
- Archived: true
- Created: 2019-01-24T18:47:48.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2022-02-03T15:35:15.000Z (almost 3 years ago)
- Last Synced: 2024-09-27T15:05:25.715Z (3 months ago)
- Topics: groovy, java, kotlin, smartapp, smartthings, smartthings-api, smartthings-smartapp
- Language: Java
- Homepage:
- Size: 803 KB
- Stars: 51
- Watchers: 91
- Forks: 46
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Archived
> This SDK is no longer being maintained and should not be chosen for new projects.
# SmartThings SmartApp SDK Java (Preview)  
> **Welcome!** This SDK is currently in _**preview**_ and is not recommended for use in production applications at this time. We welcome your bug reports, feature requests, and contributions.
## Getting Started
This SDK includes a set of JVM libraries for building Webhook and AWS Lambda SmartApps, and interacting with the public SmartThings API.
### Prerequisites
* Java 1.8+
* A Samsung account
### What is a SmartApp?
SmartApps are custom applications that execute outside of the SmartThings Platform. All of the SmartApp execution will happen on the server or Lambda that you control. The complexity of execution and the number of expected users will need to be examined to understand the hardware or execution requirements your app needs to handle. Your application will respond to lifecycle events sent from SmartThings to perform actions on behalf of your users and will execute any scheduled tasks that you have created in the SmartApp. Creating a SmartApp allows you to control and get status notifications from SmartThings devices using the [SmartThings API](https://developer-preview.smartthings.com/api/public#section/Overview).
> Visit the [SmartThings developer documentation](https://developer-preview.smartthings.com/docs/connected-services/smartapp-basics) to earn more about SmartApps.
### Hosting Your SmartApp
There are two distinct options for hosting your SmartApp: AWS Lambda and Webhook.
**Webhook** SmartApps are any publicly-accessible web server that will receive a POST request payload.
**AWS Lambda** SmartApps are hosted in the Amazon Web Services cloud and are invoked by **ARN** instead of a public-DNS address.
The best hosting option for your Automation depends on a number of factors, both objective and subjective.
To learn more about SmartApps, including [choosing the best hosting option for your SmartApp](https://developer-preview.smartthings.com/docs/connected-services/hosting/choose-a-solution), visit the [SmartThings developer documentation](https://developer-preview.smartthings.comd).
### Declaring Your SmartApp
Take a quick look at how SmartApps are declared in various languages.
Kotlin
```kotlin
package app
val smartApp: SmartApp = SmartApp.of { spec ->
spec
.configuration(Configuration())
.install {
Response.ok(InstallResponseData())
}
.update {
Response.ok(UpdateResponseData())
}
.event {
Response.ok(EventResponseData())
}
.uninstall {
Response.ok(UninstallResponseData())
}
}
fun Application.main() {
install(Routing) {
post("/smartapp") {
call.respond(smartApp.execute(call.receive()))
}
}
}
```
Groovy
```groovy
SmartApp smartApp = SmartApp.of { spec ->
spec
.install({ req ->
// create subscriptions
Response.ok()
})
.update({ req ->
// delete subscriptions
// create subscriptions
Response.ok()
})
.configuration({ req ->
ConfigurationResponseData data = ...// build config
Response.ok(data)
})
.event(EventHandler.of { eventSpec ->
eventSpec
.onSubscription("switch", { event ->
// do something
})
.onSchedule("nightly", { event ->
// do something
})
.onEvent(
{ event ->
// test event
true
},
{ event ->
// do something
}
)
})
}
```
Java
```java
private final SmartApp smartApp = SmartApp.of(spec ->
spec
.install(request -> {
return Response.ok();
})
.update(request -> {
return Response.ok(UpdateResponseData.newInstance());
})
.configuration(request -> {
return Response.ok(ConfigurationReponseData.newInstance());
})
.event(request -> {
EventData eventData = request.getEventData();
EventHandler.of(eventSpec ->
eventSpec
.onEvent(event -> {
// when this predicate is true...
return true;
}, event -> {
// ...do something with event
})
.onSchedule("nightly", event -> {
// do something
})
.onSubscription("switch", event -> {
// do something
})
);
return Response.ok(EventResponseData.newInstance());
})
);
```
## Modules and Extension Libraries
### Modules
- The [smartapp-core](/smartapp-core) module provides the core SmartApp framework, enabling you to define a SmartApp that can be used in many different environments including AWS Lambda, Dropwizard, Ratpack, and more.
- The [smartthings-client](/smartthings-client) module is an API library that provides useful utilities for working with the Subscription, Schedules, and Device APIs.
### Extension Libraries
- The [smartapp-guice](/smartapp-guice) extension library provides support for building a SmartApp with Guice dependency injection.
- The [smartapp-spring](/smartapp-spring) extension library provides support for building a SmartApp with Spring dependency injection.
- The [smartapp-contextstore-dynamodb](/smartapp-contextstore-dynamodb) extension library implements a [context store](smartapp-core/README.md#context-store) using DynamoDB.
## Adding the SDK to your build
Several artifacts are published to the Maven central repository under the `com.smartthings.sdk` group.
* `smartapp-core` - Core SmartApp Framework
* `smartapp-guice` - Extension library for use with Google Guice
* `smartapp-spring` - Extension library for use with Spring Dependency Injection
* `smartapp-contextstore-dynamodb` - Extension library to use DynamoDB to
store installed application context data.
* `smartthings-client` - Library for working with SmartThings APIs
Import the library dependencies as needed:
Apache Maven
```xml
com.smartthings.sdk
smartapp-core
0.0.4-PREVIEW
pom
```
Gradle Groovy DSL
```groovy
implementation 'com.smartthings.sdk:smartapp-core:0.0.4-PREVIEW'
```
If you prefer, the artifacts can be downloaded directly from [Maven Central](https://search.maven.org/search?q=g:com.smarrthings.sdk).
## Examples
Several simple, runnable examples of using the SDK are included in the examples directory.
#### [kotlin-smartapp](examples/kotlin-smartapp) ([Documentation](examples/kotlin-smartapp/README.md))  
This Kotlin example implements the Java `smartapp-core` library with a simple [Ktor](https://ktor.io/) server.
#### [java-ratpack-guice-smartapp](examples/java-ratpack-guice-smartapp) ([Documentation](examples/java-ratpack-guice-smartapp/README.md))  
This Java example implements the Java `smartapp-core` library with a Ratpack server and uses Guice for dependency management.
#### [java-springboot-smartapp](examples/java-springboot-smartapp) ([Documentation](examples/java-springboot-smartapp/README.md))  
This Java example implements the Java `smartapp-core` library using Spring Boot.
#### [java-lambda-smartapp](examples/java-lambda-smartapp) ([Documentation](examples/java-lambda-smartapp/README.md))  
This Java example implements the Java `smartapp-core` library as an AWS Lambda.
## More about SmartThings
Check out our complete developer documentation [here](https://developer-preview.smartthings.com).
To create and manage your services and devices on SmartThings, create an account in the
[developer workspace](https://devworkspace.developer.samsung.com/).
The [SmartThings Community](https://community.smartthings.com/c/developers/) is a good place share and
ask questions.
There is also a [SmartThings reddit community](https://www.reddit.com/r/SmartThings/) where you
can read and share information.
## License and Copyright
Licensed under the [Apache License, Version 2.0](https://www.apache.org/licenses/LICENSE-2.0)
Copyright 2019 SmartThings, Inc.