homebridge-smartthings-oauth 1.0.0

package/.devcontainer/Dockerfile

@@ -0,0 +1,16 @@
+# See here for image contents: https://github.com/microsoft/vscode-dev-containers/tree/v0.224.2/containers/typescript-node/.devcontainer/base.Dockerfile
+
+# [Choice] Node.js version (use -bullseye variants on local arm64/Apple Silicon): 16, 14, 12, 16-bullseye, 14-bullseye, 12-bullseye, 16-buster, 14-buster, 12-buster
+ARG VARIANT="16-bullseye"
+FROM mcr.microsoft.com/vscode/devcontainers/typescript-node:0-${VARIANT}
+
+# [Optional] Uncomment this section to install additional OS packages.
+# RUN apt-get update && export DEBIAN_FRONTEND=noninteractive \
+#     && apt-get -y install --no-install-recommends <your-package-list-here>
+
+# [Optional] Uncomment if you want to install an additional version of node using nvm
+# ARG EXTRA_NODE_VERSION=10
+# RUN su node -c "source /usr/local/share/nvm/nvm.sh && nvm install ${EXTRA_NODE_VERSION}"
+
+# [Optional] Uncomment if you want to install more global node packages
+# RUN su node -c "npm install -g <your-package-list -here>"

package/.devcontainer/devcontainer.json

@@ -0,0 +1,36 @@
+// For format details, see https://aka.ms/devcontainer.json. For config options, see the README at:
+// https://github.com/microsoft/vscode-dev-containers/tree/v0.224.2/containers/typescript-node
+{
+	"name": "Node.js & TypeScript",
+	"build": {
+		"dockerfile": "Dockerfile",
+		// Update 'VARIANT' to pick a Node version: 16, 14, 12.
+		// Append -bullseye or -buster to pin to an OS version.
+		// Use -bullseye variants on local on arm64/Apple Silicon.
+		"args": { 
+			"VARIANT": "16-bullseye"
+		}
+	},
+
+	// Set *default* container specific settings.json values on container create.
+	"settings": {},
+
+
+	// Add the IDs of extensions you want installed when the container is created.
+	"extensions": [
+		"dbaeumer.vscode-eslint"
+	],
+
+	// Use 'forwardPorts' to make a list of ports inside the container available locally.
+	// "forwardPorts": [],
+
+	// Use 'postCreateCommand' to run commands after the container is created.
+	// "postCreateCommand": "yarn install",
+
+	// Comment out to connect as root instead. More info: https://aka.ms/vscode-remote/containers/non-root.
+	"remoteUser": "node",
+	"features": {
+		"git": "os-provided",
+		"sshd": "latest"
+	}
+}

package/LICENSE

@@ -0,0 +1,176 @@
+                                 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
+      (an example is provided in the Appendix below).
+
+      "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 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 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 those 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

package/README.md

@@ -0,0 +1,114 @@
+
+<p align="center">
+
+<img src="https://raw.githubusercontent.com/homebridge/branding/latest/logos/homebridge-color-round-stylized.png" width="150">
+
+</p>
+
+# Smartthings Homebridge Plugin 
+
+This is a smartthings plugin for Homebridge.  This requires no access to the legacy smartthings app, and doesn't
+require a lot of work to install.  It will discover devices automatically as well as unregister devices that are removed
+from your smarttthings network.  This is currently under development.
+
+This is a fork for the homebridge-smartthings plugin created by [@iklein99](https://github.com/iklein99/), which adds oauth support and access token refresh.
+
+# Getting Started
+- The [SmartThings CLI](https://github.com/SmartThingsCommunity/smartthings-cli#readme) installed
+- [ngrok](https://ngrok.com/) or similar tool to create a secure tunnel to a publicly available URL
+
+## Instructions
+
+### 1. Set up your server
+
+Start ngrok or similar tool to create a secure tunnel to your local server. Note that the free version of ngrok will
+change the subdomain part of the URL every time you restart it. 
+Alternately, you can use the paid version which supports reserved subdomains, or any other tool such as cloudflare zero trust tunnels which has a free tier:
+```
+ngrok http 3000
+```
+### 2. Register your SmartThings app
+
+Look at the log output of your local server, You should see something like this:
+```
+Target URL -- Copy this value into the targetUrl field of you app creation request:
+https://315e5367357f.ngrok.app
+
+Redirect URI -- Copy this value into redirectUris field of your app creation request:
+https://315e5367357f.ngrok.app/oauth/callback
+
+Website URL -- Visit this URL in your browser to log into SmartThings and connect your account:
+https://315e5367357f.ngrok.app
+```
+
+After Installaing the SmartThings CLI, Run the `smartthings apps:create` command to create a new smartthingsAPI app. You will be prompted for the required
+information. The following is an example of the output from the command:
+
+```bash
+~ % smartthings apps:create
+? What kind of app do you want to create? (Currently, only OAuth-In apps are supported.) OAuth-In App
+
+More information on writing SmartApps can be found at
+  https://developer.smartthings.com/docs/connected-services/smartapp-basics
+
+? Display Name My API Subscription App
+? Description Allows control of SmartThings devices
+? Icon Image URL (optional) 
+? Target URL (optional) https://315e5367357f.ngrok.app
+
+More information on OAuth 2 Scopes can be found at:
+  https://www.oauth.com/oauth2-servers/scope/
+
+To determine which scopes you need for the application, see documentation for the individual endpoints you will use in your app:
+  https://developer.smartthings.com/docs/api/public/
+
+? Select Scopes. r:devices:*, x:devices:*, r:locations:*
+? Add or edit Redirect URIs. Add Redirect URI.
+? Redirect URI (? for help) https://315e5367357f.ngrok.app/oauth/callback
+? Add or edit Redirect URIs. Finish editing Redirect URIs.
+? Choose an action. Finish and create OAuth-In SmartApp.
+Basic App Data:
+─────────────────────────────────────────────────────────────────────────────
+ Display Name     My API Subscription App                                    
+ App Id           3275eef3-xxxx-xxxx-xxxx-xxxxxxxxxxxx                       
+ App Name         amyapisubscriptionapp-aaea18b1-xxxx-xxxx-xxxx-xxxxxxxxxxxx 
+ Description      Allows control of SmartThings devices                      
+ Single Instance  true                                                       
+ Classifications  CONNECTED_SERVICE                                          
+ App Type         API_ONLY                                                   
+ Target URL       https://315e5367357f.ngrok.app                             
+ Target Status    PENDING                                                    
+─────────────────────────────────────────────────────────────────────────────
+
+
+OAuth Info (you will not be able to see the OAuth info again so please save it now!):
+───────────────────────────────────────────────────────────
+ OAuth Client Id      7a850484-xxxx-xxxx-xxxx-xxxxxxxxxxxx 
+ OAuth Client Secret  3581f317-xxxx-xxxx-xxxx-xxxxxxxxxxxx 
+───────────────────────────────────────────────────────────
+```
+
+Save the output of the create command for later use. It contains the client ID and secret of your app. You
+won't be able to see those values again.
+
+### 3. install the plugin
+
+Download the plugin files in your homebridge machine, once downloaded Use your favorite terminal to install the plugin, you need to be inside the project folder and run the following command, Starting by installing the plugin:
+```
+npm install -g
+```
+once installed, you can build the plugin:
+```
+npm run build
+```
+after building, link the plugin to homebridge:
+```
+npm link homebridge-smartthings@1.5.22
+```
+
+### 4. Configure the plugin
+After installing the plugin, you can configure the plugin from homebridge ui, you need the target url from step 1, and you need to add the client id and secret from the app you created in step 2.
+
+### 5. Authorize the plugin
+Once you have configured the plugin, you can authorize the plugin by clicking the authorize link found in the plugin log, after authorization proceed to restart homebridge.
+

package/config.schema.json

@@ -0,0 +1,134 @@
+{
+  "pluginAlias": "HomeBridgeSmartThings",
+  "pluginType": "platform",
+  "singular": true,
+  "schema": {
+    "type": "object",
+    "properties": {
+      "name": {
+        "title": "Name",
+        "type": "string",
+        "required": true,
+        "default": "Smartthings Plug (IK)"
+      },
+      "BaseURL": {
+        "title": "Base URL",
+        "type": "string",
+        "required": true,
+        "default": "https://api.smartthings.com/v1/"
+      },
+      "client_id": {
+        "title": "Client ID",
+        "type": "string",
+        "required": true,
+        "description": "OAuth2 Client ID from SmartThings"
+      },
+      "client_secret": {
+        "title": "Client Secret",
+        "type": "string",
+        "required": true,
+        "format": "password",
+        "description": "OAuth2 Client Secret from SmartThings"
+      },
+      "server_url": {
+        "title": "Server URL",
+        "type": "string",
+        "required": true,
+        "description": "The public URL of your server (e.g., https://your-domain.com)"
+      },
+      "webhook_port": {
+        "title": "Webhook Port",
+        "type": "integer",
+        "required": true,
+        "default": 3000,
+        "description": "Port for webhook server and OAuth callback"
+      },
+      "AccessToken": {
+        "title": "Access Token",
+        "type": "string",
+        "required": false,
+        "default": "",
+        "description": "Will be automatically populated during OAuth2 flow"
+      },
+      "WebhookToken": {
+        "title": "Webhook Token",
+        "type": "string",
+        "required": false,
+        "default": ""
+      },
+
+      "GarageDoorMaxPoll": {
+        "title": "Garage Door Max Poll",
+        "type": "integer",
+        "required": true,
+        "default": 40
+      },
+      "PollLocksSeconds": {
+        "title": "Poll Locks (zero = don't poll)",
+        "type": "integer",
+        "required": false,
+        "default": 10
+      },
+      "PollDoorsSeconds": {
+        "title": "Poll Garage Doors (zero = don't poll)",
+        "type": "integer",
+        "required": false,
+        "default": 10
+      },
+      "PollSensorsSeconds": {
+        "title": "Poll Sensors (zero = don't poll)",
+        "type": "integer",
+        "required": false,
+        "default": 5
+      },
+      "PollSwitchesAndLightsSeconds": {
+        "title": "Poll Switches and Lights (zero = don't poll)",
+        "type": "integer",
+        "required": false,
+        "default": 10
+      },
+      "PollWindowShadesSeconds": {
+        "title": "Poll Window Shades (zero = don't poll)",
+        "type": "integer",
+        "required": false,
+        "default": 20
+      },
+      "ExposeHumiditySensorForAirConditioners": {
+        "title": "Expose humidity Sensor for air Conditioners if available.",
+        "type": "boolean",
+        "required": false,
+        "default": false
+      },
+      "OptionalModeForAirConditioners": {
+        "title": "Select what optional mode to use as additional switch in air conditioners.",
+        "type": "string",
+        "required": false,
+        "enum": [
+          "Sleep",
+          "Speed",
+          "WindFree",
+          "WindFreeSleep"
+        ],
+        "default": "None"
+      },
+      "IgnoreLocations": {
+        "title": "Locations to Ignore",
+        "type": "array",
+        "items": {
+          "title": "Location Name",
+          "type": "string"
+        }
+      },
+      "IgnoreDevices": {
+        "title": "Devices to Ignore",
+        "type": "array",
+        "items": {
+          "title": "Device Name",
+          "type": "string"
+        }
+      }
+    }
+  },
+  "form": null,
+  "display": null
+}

package/dist/auth/auth.d.ts

@@ -0,0 +1,23 @@
+/// <reference types="node" />
+import { Logger } from 'homebridge';
+import * as http from 'http';
+import { IKHomeBridgeHomebridgePlatform } from '../platform';
+import { TokenManager, TokenData } from './tokenManager';
+import { WebhookServer } from '../webhook/webhookServer';
+export declare class SmartThingsAuth {
+    private readonly clientId;
+    private readonly clientSecret;
+    private readonly log;
+    private readonly platform;
+    private readonly webhookServer;
+    tokenManager: TokenManager;
+    private state;
+    constructor(clientId: string, clientSecret: string, log: Logger, platform: IKHomeBridgeHomebridgePlatform, storagePath: string, webhookServer: WebhookServer);
+    handleOAuthCallback(query: any, res: http.ServerResponse): Promise<void>;
+    private exchangeCodeForTokens;
+    refreshTokens(refreshToken: string): Promise<Partial<TokenData>>;
+    startAuthFlow(): void;
+    initialize(): Promise<boolean>;
+    getAccessToken(): string | null;
+}
+//# sourceMappingURL=auth.d.ts.map

package/dist/auth/auth.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"auth.d.ts","sourceRoot":"","sources":["../../src/auth/auth.ts"],"names":[],"mappings":";AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,YAAY,CAAC;AAGpC,OAAO,KAAK,IAAI,MAAM,MAAM,CAAC;AAC7B,OAAO,EAAE,8BAA8B,EAAE,MAAM,aAAa,CAAC;AAC7D,OAAO,EAAE,YAAY,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AACzD,OAAO,EAAE,aAAa,EAAE,MAAM,0BAA0B,CAAC;AAKzD,qBAAa,eAAe;IAKxB,OAAO,CAAC,QAAQ,CAAC,QAAQ;IACzB,OAAO,CAAC,QAAQ,CAAC,YAAY;IAC7B,OAAO,CAAC,QAAQ,CAAC,GAAG;IACpB,OAAO,CAAC,QAAQ,CAAC,QAAQ;IAEzB,OAAO,CAAC,QAAQ,CAAC,aAAa;IATzB,YAAY,EAAE,YAAY,CAAC;IAClC,OAAO,CAAC,KAAK,CAAuB;gBAGjB,QAAQ,EAAE,MAAM,EAChB,YAAY,EAAE,MAAM,EACpB,GAAG,EAAE,MAAM,EACX,QAAQ,EAAE,8BAA8B,EACzD,WAAW,EAAE,MAAM,EACF,aAAa,EAAE,aAAa;IAWlC,mBAAmB,CAAC,KAAK,EAAE,GAAG,EAAE,GAAG,EAAE,IAAI,CAAC,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC;YAwBvE,qBAAqB;IA2BtB,aAAa,CAAC,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;IA+BtE,aAAa,IAAI,IAAI;IA0Bf,UAAU,IAAI,OAAO,CAAC,OAAO,CAAC;IA4BpC,cAAc,IAAI,MAAM,GAAG,IAAI;CAGvC"}