README.md

MMM-Smartthings

This is a module for the MagicMirror².

MagicMirror module that connects to the Samsung Smartthings api to display device status information.

This is a fork of the MMM-Smartthings module made by buzzkc.

Example

Dependencies

• An installation of MagicMirror²
• npm
• smartthings-node

Installation

Setup the MagicMirror module

cd ~/MagicMirror/modules
git clone https://github.com/Bovive/MMM-Smartthings
cd MMM-Smartthings
npm install

Updating

Go to the module’s folder inside MagicMirror modules folder and pull the latest version from GitHub and install:

git pull

Using the module

To use this module, add the following configuration block to the modules array in the config/config.js file:

var config = {
    modules: [
        {
              module: "MMM-Smartthings",
              position: "top_left",
              header: "Smartthings",
              config: {
                personalAccessToken: 'your_smarthings_api_key',
                capabilities: [
                    'contactSensor',
                    'lock'
                ],
                title: "Doors & Locks",
                excludedDeviceNames: [
                    'Sense-', // Contains this text
                    'Virtual Lock Test' // Or is a specific device label
                ]
              }
        }
    ]
}

Configuration options

Option	Description
personalAccessToken	Required Setup your personal access token at https://account.smartthings.com/tokens
capabilities	Required An array of device capabilities to display statuses for. Supported capabilities: "switch", "contactSensor", "lock", "temperatureMeasurement", "relativeHumidityMeasurement", "alarm", "doorControl", & "motionSensor"
updateInterval	Optional The number of milliseconds between updates Type: int(milliseconds) Default 30000 milliseconds (30 seconds)
title	Optional The sub-heading title for device list
excludedDeviceNames	Optional An array of device names or strings contained in the device label, can be excluded by containing a given word or the full name. Be more specific if devices you want to see are getting excluded.
tempLowValue	Optional The low threshold for temperature monitoring Default: 65 Type: int
tempHighValue	Optional The high threshold for temperature monitoring Default: 80 Type: int
title	Optional The sub-heading title for device list

Future Enhancements

• Refactor to allow multiple instances of module.
• Add additional capabilities: https://developer.smartthings.com/docs/devices/capabilities/capabilities-reference/
• Filter by location, currently all devices for all locations shown.
• Filter out by device name.

Thanks To

• MichMich for developing MagicMirror²
• To the following for feedback and support sdetweil, cowboydude, & johnnyboy
• Examples on aduyng's MMM-IOTStatus project: