npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

homebridge-web-garage

v1.2.1

Published

Homebridge plugin for a web-based garage

Downloads

31

Readme

homebridge-web-garage

npm npm

Description

This homebridge plugin exposes a web-based garage opener to Apple's HomeKit. Using HTTP requests, you can open/close the garage and update the plugin with the garage's real-time position. The plugin achieves this by setting up a listen server which listens for changes in state from your device and then feeds them real-time into HomeKit.

Installation

  1. Install homebridge
  2. Install this plugin: npm install -g homebridge-web-garage
  3. Update your config.json

Configuration

"accessories": [
     {
       "accessory": "GarageDoorOpener",
       "name": "Garage",
       "apiroute": "http://myurl.com"
     }
]

Core

| Key | Description | Default | | --- | --- | --- | | accessory | Must be GarageDoorOpener | N/A | | name | Name to appear in the Home app | N/A | | apiroute | Root URL of your device | N/A |

Optional fields

| Key | Description | Default | | --- | --- | --- | | autoLock | Whether your garage should auto-close after being opened | false | | autoLockDelay | Time (in seconds) until your garage will automatically close (if enabled) | 10 | | autoReset | Whether obstruction detection should automatically change the state back to 0 after being triggered | false | | autoResetDelay | Time (in seconds) until the obstruction detection will automatically reset (if enabled) | 5 |

Additional options

| Key | Description | Default | | --- | --- | --- | | pollInterval | Time (in seconds) between device polls | 300 | | port | Port for your HTTP listener (only one listener per port) | 2000 | | timeout | Time (in milliseconds) until the accessory will be marked as Not Responding if it is unreachable | 3000 | | http_method | HTTP method used to communicate with the device | GET | | username | Username if HTTP authentication is enabled | N/A | | password | Password if HTTP authentication is enabled | N/A | | model | Appears under the Model field for the accessory | plugin | | serial | Appears under the Serial field for the accessory | apiroute | | manufacturer | Appears under the Manufacturer field for the accessory | author | | firmware | Appears under the Firmware field for the accessory | version |

API Interfacing

Your API should be able to:

  1. Return JSON information when it receives /status:
{
    "currentDoorState": INT_VALUE,
    "targetDoorState": INT_VALUE
}
  1. Open/close the garage when it receives:
/setTargetDoorState/INT_VALUE_0_TO_1
  1. Update currentDoorState as it opens/closes by messaging the listen server:
/currentDoorState?value=INT_VALUE_0_TO_3
  1. Update targetDoorState following a manual override by messaging the listen server:
/targetDoorState?value=INT_VALUE_0_TO_1
  1. Update obstructionDetected when an obstruction is detected by messaging the listen server (should notify 0 after obstruction moves unless autoReset is enabled):
/obstructionDetected?value=INT_VALUE_0_TO_1

DoorState Key

| Number | Name | | --- | --- | | 0 | Open | | 1 | Closed | | 2 | Opening | | 3 | Closing |