Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

homebridge-mysmartblinds-bridge

apexad218MIT3.0.1TypeScript support: included

Homebrige plugin for mysmartblinds (using hardware bridge)

homebridge-plugin, mysmartblinds, tiltsmarthome, category-hubs, category-climate

readme

Homebridge Verified

homebridge-mysmartblinds-bridge

mit license npm npm verified-by-homebridge donate

Homebridge plugin which communicates with MySmartBlinds through the MySmartBlinds Smart Bridge.
Configure your blinds and bridge with the official iOS or Android app first in order to use this Homebridge plugin.

This plugin is not affiliated with the MySmartBlinds product.

Features

  1. Uses bridge to auto-detect all blinds setup in the MySmartBlinds app, no need to specify each blind
  2. Supports blind percentages
  3. Shows battery level for each blind (updated only when blind is open/closed)
  4. Issues a low battery indicator if battery is below 20%
  5. Logging (via Homebridge) of all actions done
  6. Blinds can close down or up (via config option)
  7. Polling so that blinds update if changed outside of HomeKit

Notes

  1. Use the 'MySmartBlinds' app to calibrate a blind if it is not opening perfectly straight
  2. If switching to closeUp it's best to Open all blinds first and then restart Homebridge
  3. If you see duplicate blinds, make sure to delete any 'disconnected'/invalid blinds within the iOS/Android app. (see #23)
  4. Polling Interval will be ignored if the (auth0) API Rate Limit Policy is reached

Configuration

This easiest way to use this plugin is to use homebridge-config-ui-x.
To configure manually, add to the platforms section of Homebridge's config.json after installing the plugin.

Config:

{
  "platform": "MySmartBlindsBridge",
  "name": "MySmartBlindsBridge",
  "username": "<email address>",
  "password": "<password>"
}
Field Description
platform Must always be "MySmartBlindsBridge"
name Best to set to "MySmartBlindsBridge"
username MySmartBlinds app username (usually email address)
password MySmartBlinds app password
closeUp (optional true/false, defaults to false) Blinds close in the upwards position
statusLog (optional true/false, defaults to false) logs position changes
allowDebug (optional true/false, defaults to false) Outputs a lot of debug info to stdout
pollingInterval (optional) Polling Interval (in minutes)

Testing

Use npx homebridge-mysmartblinds-bridge to test your credentials.

Sponsors

mrferreira89 (reddit user) - primary tester/sponsor and provided project hardware
gregmichael - sponsor and tester
name99-org - sponsor

Code credits

ianlevesque/smartblinds-client - used to understand mysmartblinds bridge API
Nicnl/homebridge-minimal-http-blinds - used as an example of blind accessory
crashtestoz/homebridge-http-window-blinds - also used as an example of blind accessory homebridge/homebridge-plugin-template - v2.0 rewrite based on this template

changelog

Changelog

All notable changes to this project will be documented in this file. See standard-version for commit guidelines.

3.0.1 (2023-06-20)

2.2.9 (2021-04-07)

Bug Fixes

  • do not let -1 batteryLevel happen, fixes #66 (33e37fc)

2.2.8 (2021-04-05)

Bug Fixes

  • failed blind state check/no battery now logs and does not crash, fixes #56 (7b5ba35)

2.2.7 (2021-04-05)

Bug Fixes

  • correct current position for when blind is above 100 threshold, fixes #66 (de3142a)

2.2.6 (2021-04-02)

2.2.5 (2021-04-02)

Bug Fixes

  • stop warning about current position being -1 (afd31df)
  • update dependencies (da48799)

2.2.4 (2020-12-03)

2.2.3 (2020-11-27)

Bug Fixes

  • set correct intial battery level (3b11a0c)
  • set correct intial blindPosition (b7be91b)

2.2.2 (2020-11-25)

Features

  • errors: silence error messages, just display sttus code (92fd3e6)
  • headers: fix headers, send user agent (bcf5c1c)

Code Changes (No change in functionality)

  • plugin code: fix npx/bin to run login test (add test file runner for npx) (7912e8f)

2.2.1 (2020-11-25)

Features

  • plugin code: add npx/bin to run login test (501c8c1)

2.2.0 (2020-11-25)

Features

  • plugin code(testing too): add test:mysmartblinds-login script for testing (231a44c)

Code Changes (No change in functionality)

Documentation

  • package.json: Update engines for Node 14.x and Homebridge 1.1.x (06a6aad)
  • github: Add dependabot (09d4622)
  • github: Create issue no response configuration (98571b9)
  • readme: correct link to smart bridge (for mysmartblinds) (c6bb143)

2.1.2 (2020-11-15)

Features

  • bugfix: cleaned up the code a bit, using corret types for auth0 (login)
  • bugfix: corrected reuest calls so that blind is controllable before refresh

Documentation

  • documentation: update changelog to be in version sync again
  • documentatin: added polling to feature list in the README

2.1.1 (2020-11-12)

Features

  • documentation: update changelog

2.1.0 (2020-11-12)

Features

  • feature: adds polling via pollingInterval config (a0de8b1)

2.0.4 (2020-11-06)

Features

  • bug fix: fix blind/room name bug in 2.0.3

2.0.3 (2020-11-06)

Features

  • cleanup: cleanup deleted blind checking (31dd73a)

Documentation

  • package.json: update dependencies/re-generate package-lock/remove lodash

2.0.2 (2020-11-06)

Features

  • bug fix: fix duplicate uuid/handle deleted blinds better (2db9d28)

2.0.1 (2020-11-02)

Features

2.0.0 (2020-11-02)

Documentation

  • config schema: renamed status_log and allow_debug to statusLog and allowDebug for conistency
  • config schema: removed section about adding bluetooth blind control (not going to do this)
  • readme: updates to reflect change in config varibale names
  • readme: updated paypal link to use direct linkt instead of button
  • license: updated year
  • package.json: update dependencies/re-generate package-lock

Features

  • plugin feature: now a dynamic platform (which uses homeebridge cache) instead of a static platform
  • plugin code change: re-written fron the ground up to use typescript

1.5.6 (2020-10-14)

Documentation

  • package.json: add funding link

  • package.json: update dependencies

1.5.4 (2020-06-04)

Documentation

  • config schema: remove old report99Open config option (ea7adee)

  • package.json: add version script (7c3e5bb)

Features

  • plugin feature: add encodedPasskey to logs, json stringify parsedBody in logs/closes #15 (0552d31)

  • plugin feature: removed addAccessory (8ca2d51)

1.5.3 (2020-06-03)

Documentation

  • config schema: add informaton regarding bridge use by thus plugin (750a027)

1.5.2 (2020-05-12)

Features

  • plugin feature/config option: fix config schema (8f7119a) closes #12

Documentation

  • changelog: fix version link (8f7119a)

1.5.1 (2020-05-12)

Features

  • plugin feature/config option: add config option status_log to stop logging status functions (a320e63)

1.5.0 (2020-04-18)

Features

  • plugin feature/config option: add a allow_debug option (ecc16cf)

1.4.1 (2020-03-29)

Documentation

  • readme: add Homebridge/MySmartBlinds branding (7be4845)

  • mit license file: corrected copyright name in MIT LICENSE (3196174)

1.4.0 (2020-03-29)

Bug Fixes

  • plugin-code: additonal error checking/fail gracefully code (808aba6)

Documentation

  • changeloge: fix link (to a commit) (6ff8357)

  • readme: add homebridge:verified badge (55cd18)

1.3.5 (2020-03-28)

Bug Fixes

  • plugin-code: if plugin has no config, return (a2d5efa)

Documentation

  • readme: update badges (MIT, PayPal) (ee629c7)

1.3.4 (2020-03-27)

Bug Fixes

  • plugin-code: plugin now fails gracefully with no config (a046905)

Documentation

  • package.json: bump node engine to node v10 (f4dcebb)

  • readme: update homebridge link (cace02a)

  • readme: switch badges to badgen.net (27b6fd3)

1.3.3 (2020-03-11)

Documentation

  • readme: minor corrections to README.md (296ede0)

  • github: Add bug report/feature request templates (dd0dfc2, 4ebd272)

1.3.2 (2020-03-11)

Documentation

  • readme: remove to do section (68b5adb)

1.3.1 (2020-03-11)

Documentation

  • readme: added info about blinds down or up (2b20cf6)

1.3.0 (2020-03-08)

Features

  • plugin feature/config option: done with todo item: option to close blinds up (533788d), closes #6

  • removed config option: removed report99Open config option, this is now always true (cb66d31))

Bug Fixes

  • config schema: mark closeUp (and report99Open prior to removal) as optional (from required: true) (37d402b)

Documentation

  • funding: if you like this plugin and/or my work on it, consider donating via paypal (140536f)

  • readme: removed all fields required verbage, remove report99Open, add closeUp (40d0a70)

  • readme: add sponsor gregmichael (979d0e3)

  • readme: separate sponsors/code credit (5136231)

  • changelog: finally added a changelog (2983a288)

1.2.5 (2020-02-09)

Bug Fixes

  • plugin code: fix spelling of currentPosition (2110ccc)

Documentation

  • funding: if you like this plugin and/or my work on it, consider funding my future work on this plugin and others via Sponsor button (ad2d72e5)

1.2.4 (2020-01-25)

Bug Fixes

  • config schema: add report99Open to config schema (8f9f542)

1.2.3 (2020-01-25)

Features

  • plugin feature/config option: add report99Open option to correct restart issue where blinds report 99% (0099f2a))

1.2.2 (2020-01-16)

Features

Documentaation

  • readme: small correction to readme (3442369)

1.2.1 (2020-01-16)

Bug Fixes

  • plugin code:: do not report -1 battery status, likely an incorrect value (96bfccb)

  • plugin code: handle errors via catch for all requests (c898a25)

Documentation

  • readme: clean up fields list (da02d15)

  • readme: fix readme spelling (d9b42a5)

  • readme: update readme with todo for polling (12c87ab)

1.2.0 (2020-01-11)

Bug Fixes

  • plugin code: fix token refresh to have this/platform context (3accd2d)

Documentation