https://github.com/techgaun/xmart-things
Elixir client for Smart Things
https://github.com/techgaun/xmart-things
elixir internet-of-things samsung sdk-elixir smartthings
Last synced: about 1 year ago
JSON representation
Elixir client for Smart Things
- Host: GitHub
- URL: https://github.com/techgaun/xmart-things
- Owner: techgaun
- License: apache-2.0
- Created: 2016-12-09T09:20:34.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2018-07-15T20:16:17.000Z (almost 8 years ago)
- Last Synced: 2024-04-14T06:05:50.983Z (about 2 years ago)
- Topics: elixir, internet-of-things, samsung, sdk-elixir, smartthings
- Language: Elixir
- Size: 15.6 KB
- Stars: 3
- Watchers: 5
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# xmart_things
[](https://hex.pm/packages/xmart_things) 
> SmartThings OAuth2 Strategy and Client for Elixir
This was implemented while I followed [this](http://docs.smartthings.com/en/latest/smartapp-web-services-developers-guide/overview.html) but can be used for all the needs to build Web Services SmartApps with SmartThings.
## Installation
If [available in Hex](https://hex.pm/docs/publish), the package can be installed as:
- Add `xmart_things` to your list of dependencies in `mix.exs`:
```elixir
def deps do
[{:xmart_things, "~> 0.1.0"}]
end
```
- Ensure `xmart_things` is started before your application:
```elixir
def application do
[applications: [:xmart_things]]
end
```
## Configuration
Add a configuration block as below in your configuration:
```elixir
config :xmart_things,
client_id: System.get_env("ST_CLIENT_ID"),
client_secret: System.get_env("ST_CLIENT_SECRET"),
redirect_uri: System.get_env("ST_REDIRECT_URI"),
scope: "app"
# , app_uuid: "" # set this if you wish to explicitly specify site/smartapp base uri to call
```
## Usage
```elixir
# Generate the authorization to redirect client for authorization
XmartThings.authorize_url!
# Capture the `code` from redirect in your callback handler route
st_client = XmartThings.get_token!(code: code)
# Use the access token to access resources
locks = XmartThings.get!(st_client, "/locks").body
# or
case XmartThings.get(st_client, "/locks") do
{:ok, %OAuth2.Response{status_code: 401, body: body}} ->
{:error, "unauthorized token"}
{:ok, %OAuth2.Response{status_code: status_code, body: locks}} when status_code in [200..399] ->
locks
{:error, %OAuth2.Error{reason: reason}} ->
{:error, reason}
end
# Use `endpoints/1` or `endpoints!/1` to get the list of endpoints that you can use to talk with SmartApp
XmartThings.endpoints!(st_client)
# It can return bunch of responses. Pick one of those (usually the first one) to perform your requests to SmartApp
[%{"uri" => uri} | _] = XmartThings.endpoints!(st_client).body
# and now send the requests to URLs like below:
XmartThings.get(%{st_client | site: uri}, "/locks")
# if you set `app_uuid` on your config, you don't need to update `site` in the `st_client` struct
XmartThings.get(st_client, "/locks")
```
## Parent-Child Apps
If you have parent and child apps on smartthings and you get an error with oAuth, you might need to add `oauth: true` in your child apps definition. This happens when your child apps have access to devices but parents have access only through the child apps.
```groovy
definition(
name: "Some Child App",
namespace: "techgaun",
author: "techgaun",
description: "Some child app",
category: "",
oauth: true,
parent: "smartthings_something:sometest"
)
```
## Example
A sample implementation that interacts with *Locks* is available [HERE](https://github.com/techgaun/xmart-things-demo)
## Author
- [techgaun](https://github.com/techgaun)