homebridge-slide-curtain
TypeScript icon, indicating that this package has built-in type declarations

1.0.3 • Public • Published

This plugin is still work in progress.

Homebridge Slide Remote Local API

npm

A homebridge plugin to use the Slide curtain motor in HomeKit using Homebridge with the Local API. For now I implemented the accessory type of homebridge, so no dynamic platform.

Installation

The following command can be used to install the plugin on the Homebridge server:

npm install -g homebridge-slide-curtain

After that you will need to enter the following details into the ~/.homebridge/config.json:

{
  "accessories": [
    {
      "accessory""slide-curtain"#REQUIRED 
      "name""name"#REQUIRED. Your desired name. 
      "ip""x.x.x.x"#REQUIRED. Fixed IP configured for your Slide on your router. 
      "code""xxxxxxxx"#REQUIRED. 8 digit code in the sticker on the top of your Slide. 
      "poll_interval": x #OPTIONAL. Time in seconds to poll the Slide curtain. Defaults to 5. 
      "tolerance": x, #OPTIONAL. Threshold in % to still consider state fully open or fully closed. Defaults to 7. 
      "closing_time": x #OPTIONAL. Time in seconds it takes your curtain to fully open/close. Defaults to 20. 
    }
 }

Now start or restart homebridge and your Slide should appear in the HomeKit app.

Known Issues

  • If you control your Slide from outside of homekit (with the Slide remote control or just by hand with the Touch & Go function) the status of the accesory will update in the worst case scenario in "poll_interval" seconds setted in the config.

  • The code is far from perfect or optimized, this is literally my first time coding in node.

Todo

  • Clean up and refactor code
  • Correctly report errors by marking the accessory as "Not responding" in the Home app.

Special thanks to renssies and his homebridge-slide-remote plugin which I heavily used to develop this plugin.

Readme

Keywords

Package Sidebar

Install

npm i homebridge-slide-curtain

Weekly Downloads

0

Version

1.0.3

License

Apache-2.0

Unpacked Size

41.3 kB

Total Files

14

Last publish

Collaborators

  • iandrono