This repository holds everything needed to set up a Raspberry Pi to act as a SmartThings direct connected device.
02/14/22 UPDATE: Fix was implemented to solve hostapd service detection issue on Bullseye OS (problem was seen during device provisioning process)
09/16/22 UPDATE: The new Raspberry Pi OS provides a new option to use Network Manager instead of dhcpcd. You must stay with dhcpcd.
The SmartThings platform is evolving. In the not-too-distant future there will be three methods for IOT devices to integrate with SmartThings: 1) zwave and zigbee devices that talk directly to the SmartThings hub, 2) cloud-connected devices, and 3) direct-connected devices. Former devices that were developed in the SmartThings IDE using device type handlers with Groovy code will need to be migrated to one of the those three new options.
- Hub-connected: an option realistically only available to manufacturers of zigbee and zwave devices; not likely an option for the home-automation do-it-yourselfer
- Cloud-connected: requires you to run your code on a cloud server - either your own, self-managed server or on AWS. Most hobbiests will not want to open their home LAN to the internet, which would be required to host your own cloud server, due to complexity and security risks. The AWS alternative may be more practical, but having your devices running from cloud to cloud may not give the best performance.
- Direct-connected: this alternative allows you to connect directly to SmartThing's cloud, without an intermediate cloud server as in above. In this approach, your device apps are running on your own computer (i.e. Raspberry Pi), on a local LAN with internet access, using an SDK API to talk to the SmartThings platform.
SmartThings's concept for "direct-connected" devices are wifi-enabled microcontroller-based IOT devices. In fact the SDK that was developed in support of this very much revolves around MCUs like the popular ESP32 system-on-a-chip microcontroller with integrated wifi. However with modifications, the SDK can be implemented on a Raspberry Pi as well. The only downside to this approach is the way devices must be individually provisioned. However, what direct connected devices enables is an environment where you can write and run applications totally under your control, with full integration with SmartThings. No cloud server to manage, no IDE, no Groovy code - just a simple API to send and receive commands and attributes for whatever kind of IOT device application you can dream up and implement on a Raspberry Pi using either C or Python.
UPDATE: There is now a fourth method to integrate with SmartThings: via their new Edge platform (still in beta as of Feb 2022). This provides the option of writing device drivers that run locally on the SmartThings hub. Interfacing these drivers with Pi-based applications can allow for total local execution, but requires some method of LAN discovery, command, and notification protocol to be implemented on both ends (driver and Pi app).
- Raspberry Pi Model 3 or 4 or Zero W
- must include the standard capabilities including integrated wireless with AP (Access Point) capability
-
Samsung SmartThings developer account for developer workspace: https://smartthings.developer.samsung.com/workspace/
-
Github account (if you're reading this I guess you already have one!)
-
Raspberry Pi O/S (Version 10 Buster or Bullseye preferred, but as far back as Jessie can also work) Full or Lite - Python 3.5 or later (required for SDK tools: keygen and qrgen)
- additional packages: pynacl, qrcode, pillow (via pip installer)
- only limited testing has been done on 64-bit Raspberry Pi OS; the Python wrapper works only on 32-bit OS
-
RPI SmartThings device enabling package (this repository)
-
SmartThings core SDK (will be installed by the setup script, including additional dependencies)
- Official developer documentation for direct connected devices: https://smartthings.developer.samsung.com/docs/devices/direct-connected-devices/overview.html
- SmartThings API Reference: https://github.com/SmartThingsCommunity/st-device-sdk-c/blob/master/doc/APIs.md
- How to build Direct Connect Devices on ST Community: https://community.smartthings.com/t/how-to-build-direct-connected-devices/204055
- Note that the above community post is not for Raspberry Pi, so any reference to toolchains and MCU boards can be ignored
- Also, those instructions should only be referenced as specified in the Configuration Guide in this repository
- Quickstart Guide for Raspberry Pi: https://github.com/toddaustin07/rpi-st-device/blob/main/QuickstartGuide.pdf
- Configuration Guide for Raspberry Pi: https://github.com/toddaustin07/rpi-st-device/blob/main/ConfigGuide.pdf
- Use a fully-automated bash script to quickly get up and running ('mastersetup')
- Follow step-by-step MANUAL configuration guide
For either option, start here ==> http://toddaustin07.github.io