node-red-contrib-samsung-smartthings 1.0.0

package/LICENSE

@@ -0,0 +1,189 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work.
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to the Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by the Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding any notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   Copyright 2026 Layer-IT
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,108 @@
+# node-red-contrib-samsung-smartthings
+
+Professional Node-RED nodes for Samsung SmartThings device control and automation.
+
+This package provides a complete set of nodes to interact with the [SmartThings REST API](https://developer.smartthings.com/docs/api/public), enabling you to manage locations, rooms, devices, scenes, and execute device commands directly from Node-RED flows.
+
+## Features
+
+- **Full SmartThings API coverage** — Locations, Rooms, Devices, Status, Commands, Scenes, and Events
+- **Real-time event monitoring** — Polling-based change detection that outputs messages only when device values change
+- **Dynamic & static configuration** — Use editor dropdowns for quick setup, or override any parameter via `msg` properties at runtime
+- **Shared configuration** — A single config node securely stores your API token and is shared across all SmartThings nodes
+- **Energy monitoring** — Read energy and power meter data from compatible devices
+- **Cascading dropdowns** — Device, capability, and command selectors populate dynamically based on your SmartThings account
+- **Professional error handling** — Rate limiting, retry logic, and visual node status indicators
+
+## Installation
+
+Install via the Node-RED Palette Manager, or run:
+
+```bash
+cd ~/.node-red
+npm install node-red-contrib-samsung-smartthings
+```
+
+## Prerequisites
+
+You need a SmartThings Personal Access Token (PAT) for authentication:
+
+1. Navigate to [https://account.smartthings.com/tokens](https://account.smartthings.com/tokens)
+2. Sign in with your Samsung account
+3. Generate a new token with the required scopes (Devices, Locations, Scenes)
+4. Copy the token — you will need it for the configuration node
+
+> **Note:** For production integrations, use OAuth 2.0. PATs are intended for testing and personal use.
+
+## Nodes
+
+| Node | Description |
+|------|-------------|
+| **smartthings-config** | Configuration node — stores API token and base URL (shared by all nodes) |
+| **smartthings-locations** | Retrieve SmartThings locations |
+| **smartthings-rooms** | Retrieve rooms within a location |
+| **smartthings-devices** | List and filter devices by location, room, or capability |
+| **smartthings-status** | Get device status including energy/power meter readings |
+| **smartthings-command** | Execute commands on devices (switch, dim, color, lock, etc.) |
+| **smartthings-scenes** | List and execute SmartThings scenes |
+| **smartthings-events** | Monitor device changes in real-time via intelligent polling |
+
+## Quick Start
+
+1. Drag a **smartthings-devices** node onto your flow
+2. Double-click and create a new **SmartThings Config** — enter your API token
+3. Select a location filter (optional) and deploy
+4. Connect an **inject** node to trigger it and a **debug** node to see the output
+5. Deploy and click the inject button to retrieve your devices
+
+## Dynamic Usage
+
+Every node supports dynamic override via `msg` properties. Static dropdown values serve as defaults; `msg` values always take priority.
+
+**Example: Dynamic device command**
+
+```json
+{
+    "deviceId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
+    "component": "main",
+    "capability": "switch",
+    "command": "on",
+    "arguments": []
+}
+```
+
+Send this as the `msg` object to a **smartthings-command** node (with no static configuration) and it will execute the command dynamically.
+
+## Event Monitoring
+
+The **smartthings-events** node monitors a device and outputs a message only when its status changes. This provides a subscription-like experience using intelligent polling.
+
+**Setup:**
+1. Select a device, optionally filter by component/capability
+2. Set the polling interval (default: 10 seconds)
+3. Connect to a debug node or downstream flow
+
+**Dynamic control via input:**
+
+```json
+{
+    "action": "start",
+    "deviceId": "your-device-id",
+    "capability": "energyMeter",
+    "interval": 5
+}
+```
+
+Send `{ "action": "stop" }` to pause monitoring.
+
+## API Reference
+
+This package communicates with the SmartThings REST API v1:
+
+- Base URL: `https://api.smartthings.com`
+- [API Documentation](https://developer.smartthings.com/docs/api/public)
+- [Capabilities Reference](https://developer.smartthings.com/docs/devices/capabilities/capabilities-reference)
+
+## License
+
+Apache-2.0 — Copyright 2026 Layer-IT

package/docker-compose.yml

@@ -0,0 +1,15 @@
+services:
+  nodered:
+    image: nodered/node-red:latest
+    container_name: smartthings-nodered
+    ports:
+      - "1880:1880"
+    volumes:
+      - nodered-data:/data
+      - ./:/opt/smartthings:ro
+    environment:
+      - TZ=Europe/Amsterdam
+    restart: unless-stopped
+
+volumes:
+  nodered-data:

package/examples/basic-device-control.json

@@ -0,0 +1,182 @@
+[
+    {
+        "id": "st-flow-basic",
+        "type": "tab",
+        "label": "SmartThings Basic Device Control",
+        "disabled": false,
+        "info": "Example flow demonstrating basic SmartThings device control.\n\n1. List all devices\n2. Turn a switch on/off dynamically\n3. Read device status"
+    },
+    {
+        "id": "st-inject-devices",
+        "type": "inject",
+        "z": "st-flow-basic",
+        "name": "Get All Devices",
+        "props": [],
+        "repeat": "",
+        "crontab": "",
+        "once": false,
+        "onceDelay": 0.1,
+        "topic": "",
+        "x": 150,
+        "y": 80,
+        "wires": [["st-devices-list"]]
+    },
+    {
+        "id": "st-devices-list",
+        "type": "smartthings-devices",
+        "z": "st-flow-basic",
+        "name": "List Devices",
+        "config": "",
+        "locationId": "",
+        "roomId": "",
+        "capability": "",
+        "deviceId": "",
+        "x": 370,
+        "y": 80,
+        "wires": [["st-debug-devices"]]
+    },
+    {
+        "id": "st-debug-devices",
+        "type": "debug",
+        "z": "st-flow-basic",
+        "name": "Device List",
+        "active": true,
+        "tosidebar": true,
+        "console": false,
+        "tostatus": true,
+        "complete": "payload",
+        "targetType": "msg",
+        "statusVal": "payload.length",
+        "statusType": "msg",
+        "x": 580,
+        "y": 80,
+        "wires": []
+    },
+    {
+        "id": "st-inject-on",
+        "type": "inject",
+        "z": "st-flow-basic",
+        "name": "Switch ON",
+        "props": [
+            { "p": "capability", "v": "switch", "vt": "str" },
+            { "p": "command", "v": "on", "vt": "str" }
+        ],
+        "repeat": "",
+        "crontab": "",
+        "once": false,
+        "onceDelay": 0.1,
+        "topic": "",
+        "x": 150,
+        "y": 200,
+        "wires": [["st-func-set-device"]]
+    },
+    {
+        "id": "st-inject-off",
+        "type": "inject",
+        "z": "st-flow-basic",
+        "name": "Switch OFF",
+        "props": [
+            { "p": "capability", "v": "switch", "vt": "str" },
+            { "p": "command", "v": "off", "vt": "str" }
+        ],
+        "repeat": "",
+        "crontab": "",
+        "once": false,
+        "onceDelay": 0.1,
+        "topic": "",
+        "x": 150,
+        "y": 260,
+        "wires": [["st-func-set-device"]]
+    },
+    {
+        "id": "st-func-set-device",
+        "type": "function",
+        "z": "st-flow-basic",
+        "name": "Set Device ID",
+        "func": "// Replace with your actual device ID\nmsg.deviceId = \"YOUR-DEVICE-ID-HERE\";\nreturn msg;",
+        "outputs": 1,
+        "timeout": "",
+        "noerr": 0,
+        "initialize": "",
+        "finalize": "",
+        "libs": [],
+        "x": 370,
+        "y": 230,
+        "wires": [["st-command-switch"]]
+    },
+    {
+        "id": "st-command-switch",
+        "type": "smartthings-command",
+        "z": "st-flow-basic",
+        "name": "Execute Command",
+        "config": "",
+        "deviceId": "",
+        "component": "main",
+        "capability": "",
+        "command": "",
+        "arguments": "",
+        "x": 580,
+        "y": 230,
+        "wires": [["st-debug-command"]]
+    },
+    {
+        "id": "st-debug-command",
+        "type": "debug",
+        "z": "st-flow-basic",
+        "name": "Command Result",
+        "active": true,
+        "tosidebar": true,
+        "console": false,
+        "tostatus": false,
+        "complete": "payload",
+        "targetType": "msg",
+        "x": 790,
+        "y": 230,
+        "wires": []
+    },
+    {
+        "id": "st-inject-status",
+        "type": "inject",
+        "z": "st-flow-basic",
+        "name": "Get Status",
+        "props": [
+            { "p": "deviceId", "v": "YOUR-DEVICE-ID-HERE", "vt": "str" }
+        ],
+        "repeat": "",
+        "crontab": "",
+        "once": false,
+        "onceDelay": 0.1,
+        "topic": "",
+        "x": 150,
+        "y": 360,
+        "wires": [["st-status-device"]]
+    },
+    {
+        "id": "st-status-device",
+        "type": "smartthings-status",
+        "z": "st-flow-basic",
+        "name": "Device Status",
+        "config": "",
+        "deviceId": "",
+        "component": "",
+        "capability": "",
+        "x": 370,
+        "y": 360,
+        "wires": [["st-debug-status"]]
+    },
+    {
+        "id": "st-debug-status",
+        "type": "debug",
+        "z": "st-flow-basic",
+        "name": "Status Output",
+        "active": true,
+        "tosidebar": true,
+        "console": false,
+        "tostatus": false,
+        "complete": "payload",
+        "targetType": "msg",
+        "x": 580,
+        "y": 360,
+        "wires": []
+    }
+]

package/examples/energy-monitoring.json

@@ -0,0 +1,187 @@
+[
+    {
+        "id": "st-flow-energy",
+        "type": "tab",
+        "label": "SmartThings Energy Monitoring",
+        "disabled": false,
+        "info": "Example flow for monitoring energy consumption.\n\n1. Discovers all energy meter devices\n2. Polls energy and power readings every 5 minutes\n3. Outputs structured energy data"
+    },
+    {
+        "id": "st-inject-energy-devices",
+        "type": "inject",
+        "z": "st-flow-energy",
+        "name": "Find Energy Meters",
+        "props": [
+            { "p": "capability", "v": "energyMeter", "vt": "str" }
+        ],
+        "repeat": "",
+        "crontab": "",
+        "once": false,
+        "onceDelay": 0.1,
+        "topic": "",
+        "x": 170,
+        "y": 80,
+        "wires": [["st-devices-energy"]]
+    },
+    {
+        "id": "st-devices-energy",
+        "type": "smartthings-devices",
+        "z": "st-flow-energy",
+        "name": "Energy Meter Devices",
+        "config": "",
+        "locationId": "",
+        "roomId": "",
+        "capability": "energyMeter",
+        "deviceId": "",
+        "x": 410,
+        "y": 80,
+        "wires": [["st-debug-energy-devices"]]
+    },
+    {
+        "id": "st-debug-energy-devices",
+        "type": "debug",
+        "z": "st-flow-energy",
+        "name": "Energy Devices",
+        "active": true,
+        "tosidebar": true,
+        "console": false,
+        "tostatus": true,
+        "complete": "payload",
+        "targetType": "msg",
+        "statusVal": "payload.length",
+        "statusType": "msg",
+        "x": 640,
+        "y": 80,
+        "wires": []
+    },
+    {
+        "id": "st-inject-poll",
+        "type": "inject",
+        "z": "st-flow-energy",
+        "name": "Every 5 minutes",
+        "props": [
+            { "p": "deviceId", "v": "YOUR-ENERGY-METER-DEVICE-ID", "vt": "str" },
+            { "p": "component", "v": "main", "vt": "str" },
+            { "p": "capability", "v": "energyMeter", "vt": "str" }
+        ],
+        "repeat": "300",
+        "crontab": "",
+        "once": false,
+        "onceDelay": 0.1,
+        "topic": "",
+        "x": 170,
+        "y": 220,
+        "wires": [["st-status-energy"]]
+    },
+    {
+        "id": "st-status-energy",
+        "type": "smartthings-status",
+        "z": "st-flow-energy",
+        "name": "Read Energy",
+        "config": "",
+        "deviceId": "",
+        "component": "",
+        "capability": "",
+        "x": 400,
+        "y": 220,
+        "wires": [["st-func-format-energy"]]
+    },
+    {
+        "id": "st-func-format-energy",
+        "type": "function",
+        "z": "st-flow-energy",
+        "name": "Format Energy Data",
+        "func": "var energy = msg.payload.energy || {};\nmsg.payload = {\n    deviceId: msg.deviceId,\n    energy_kWh: energy.value || 0,\n    unit: energy.unit || 'kWh',\n    timestamp: energy.timestamp || new Date().toISOString(),\n    readAt: new Date().toISOString()\n};\nreturn msg;",
+        "outputs": 1,
+        "timeout": "",
+        "noerr": 0,
+        "initialize": "",
+        "finalize": "",
+        "libs": [],
+        "x": 630,
+        "y": 220,
+        "wires": [["st-debug-energy-output"]]
+    },
+    {
+        "id": "st-debug-energy-output",
+        "type": "debug",
+        "z": "st-flow-energy",
+        "name": "Energy Reading",
+        "active": true,
+        "tosidebar": true,
+        "console": false,
+        "tostatus": true,
+        "complete": "payload",
+        "targetType": "msg",
+        "statusVal": "payload.energy_kWh",
+        "statusType": "msg",
+        "x": 860,
+        "y": 220,
+        "wires": []
+    },
+    {
+        "id": "st-inject-power",
+        "type": "inject",
+        "z": "st-flow-energy",
+        "name": "Every 1 minute",
+        "props": [
+            { "p": "deviceId", "v": "YOUR-ENERGY-METER-DEVICE-ID", "vt": "str" },
+            { "p": "component", "v": "main", "vt": "str" },
+            { "p": "capability", "v": "powerMeter", "vt": "str" }
+        ],
+        "repeat": "60",
+        "crontab": "",
+        "once": false,
+        "onceDelay": 0.1,
+        "topic": "",
+        "x": 160,
+        "y": 360,
+        "wires": [["st-status-power"]]
+    },
+    {
+        "id": "st-status-power",
+        "type": "smartthings-status",
+        "z": "st-flow-energy",
+        "name": "Read Power",
+        "config": "",
+        "deviceId": "",
+        "component": "",
+        "capability": "",
+        "x": 400,
+        "y": 360,
+        "wires": [["st-func-format-power"]]
+    },
+    {
+        "id": "st-func-format-power",
+        "type": "function",
+        "z": "st-flow-energy",
+        "name": "Format Power Data",
+        "func": "var power = msg.payload.power || {};\nmsg.payload = {\n    deviceId: msg.deviceId,\n    power_W: power.value || 0,\n    unit: power.unit || 'W',\n    timestamp: power.timestamp || new Date().toISOString(),\n    readAt: new Date().toISOString()\n};\nreturn msg;",
+        "outputs": 1,
+        "timeout": "",
+        "noerr": 0,
+        "initialize": "",
+        "finalize": "",
+        "libs": [],
+        "x": 630,
+        "y": 360,
+        "wires": [["st-debug-power-output"]]
+    },
+    {
+        "id": "st-debug-power-output",
+        "type": "debug",
+        "z": "st-flow-energy",
+        "name": "Power Reading",
+        "active": true,
+        "tosidebar": true,
+        "console": false,
+        "tostatus": true,
+        "complete": "payload",
+        "targetType": "msg",
+        "statusVal": "payload.power_W",
+        "statusType": "msg",
+        "x": 860,
+        "y": 360,
+        "wires": []
+    }
+]