Skip to content

Latest commit

 

History

History
38 lines (24 loc) · 3.95 KB

README.md

File metadata and controls

38 lines (24 loc) · 3.95 KB
Raw

SmartThings Monitor

Graph data gathered from SmartThings devices!

This project is an experiment learning to interact with SmartThings. I didn't have a specific goal at the outset other than to see what data the service offers and to make some graphs. I expanded the scope as I developed before I even got to any graphing in hopes this could be made useful for others, and to get some experience with a few more technologies. Then I moved out of the house I was using for testing, and no longer have a SmartThings setup. Thus I will no longer be developing this, for now at least.

How to use

SmartThings Monitor has two main parts:

  1. Web Services SmartApp that must be installed to a SmartThings location
  2. External application (powered by the code in this repository) to query the API provided by the SmartApp and generate charts, etc.

SmartThings requires approval before SmartApps can be published by SmartThings and installed automatically. I have not sought such approval, so for now, if anyone else wants to use this app, they must install the code themselves as a custom SmartApp in their own account. That SmartApp code I used is in monitor.groovy.

While the external application code is available in this repository, end users don't need to install anything from here, as it's already running at https://votecharlie.com/projects/monitor. Anyone can sign up for an account there and use the service provided they have installed the requisite SmartApp.

How it works

As mentioned above, the SmartThings side API is provided by a Web Services SmartApp users can install to their SmartThings locations and configure with specific permissions for devices. That app is written in Groovy.

The application code in this repository is based on the Python web framework web.py. User registration and login is provided by a modified version of webpy-mongodb-sessions, which relies on MongoDB and its provided PyMongo module.

Application files in monitor:

  • index.py: Main controller for web.py app that allows users to register and connect to an external API to retrieve data for graphing and other uses.
  • processor.py: Used by the user results page for graph generation and data handling for display.
  • smartthings.example.json: This file should be copied to smartthings.json (removing the .example from the filename) and modified to contain the client ID and client secret corresponding to your own installed copy of the Web Services SmartApp. This will not be necessary if I get my own copy approved and published by SmartThings, but for now you'll have to install your own copy of the app from code and get your own ID and secret.
  • smartthings.py: Main code for interacting with SmartThings and caching the data in a local database.
  • tasks.py: Script designed for scheduled execution to keep data up to date for all users of the app, even when they don't visit the web page and request data for an extended period.
  • test.py: Not needed for app; just used for development and testing.

The files in monitor/templates are processed by web.py to serve front end pages according to the rules defined in routes in index.py.