Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
  • Loading branch information
KyleBoyer committed Jul 13, 2024
2 parents 14304b3 + 0c9778b commit 9008c54
Showing 1 changed file with 10 additions and 10 deletions.
20 changes: 10 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,14 @@

<span align="center">

# Homebridge Plugin for Konnected's BlaQ
# Homebridge Plugin for Konnected's GDO BlaQ

</span>

Konnected's BlaQ device is an interface to garage door openers from Liftmaster, Chamberlain, and others.
You can purchase a BlaQ device here: [Konnected Store](https://konnected.io/products/smart-garage-door-opener-blaq-myq-alternative)
Konnected's GDO BlaQ device is an interface to garage door openers from Liftmaster, Chamberlain, and others.
You can purchase a GDO BlaQ device here: [Konnected Store](https://konnected.io/KYLEBOYER)

This plugin enables the use of a BlaQ device with Homebridge (and derivatives like HOOBS). It supports most of the same features available to the BlaQ REST API. This includes garage door/light/lock controls as well as some sensor data. The full list is below:
This plugin enables the use of a GDO BlaQ device with Homebridge (and derivatives like HOOBS). It supports most of the same features available to the GDO BlaQ REST API. This includes garage door/light/lock controls as well as some sensor data. The full list is below:

* Garage Door Status/Control
* Garage Light Status/Control
Expand All @@ -26,19 +26,19 @@ This plugin enables the use of a BlaQ device with Homebridge (and derivatives li
It *could*, but does not currently, support:

* Toggle Only Mode
* Restart BlaQ Device
* Resync BlaQ Device
* Factory Reset BlaQ Device
* Restart GDO BlaQ Device
* Resync GDO BlaQ Device
* Factory Reset GDO BlaQ Device
* Reset door timings
* Security protocol selection

Please request these features via the issues section on this repo if you would find them useful.

### Configuration

First, ensure you have fully setup your BlaQ device. If you have not purchased one, you can do so here: [Konnected Store](https://konnected.io/products/smart-garage-door-opener-blaq-myq-alternative)
First, ensure you have fully setup your GDO BlaQ device. If you have not purchased one, you can do so here: [Konnected Store](https://konnected.io/KYLEBOYER)

Once you've installed this plugin into Homebridge, it will automatically attempt to discover BlaQ devices using mDNS. If auto discovery does not work, the configuration is very straightforward - just use the GUI. If, for whatever reason, you don't want to do so, all you need to supply is a name, port, and host, like so:
Once you've installed this plugin into Homebridge, it will automatically attempt to discover GDO BlaQ devices using mDNS. If auto discovery does not work, the configuration is very straightforward - just use the GUI. If, for whatever reason, you don't want to do so, all you need to supply is a name, port, and host, like so:

```json
{
Expand All @@ -64,7 +64,7 @@ The `mac` field is optional, but is quite helpful if provided - this field is us

### Implementation

BlaQ devices expose a [real-time event source API](https://esphome.io/web-api/index.html?highlight=events#event-source-api) as `/events`. This allows the plugin to stay up to date with no lag. The plugin caches the most recent status we've received for each accessory, enabling immediate replies to any status checks. For controlling, the BlaQ devices have a [REST API](https://konnected.readme.io/v2.0/reference/introduction) that is automatically enabled. Therefore, this plugin uses the API routes exposed for sending commands to control different accessories.
GDO BlaQ devices expose a [real-time event source API](https://esphome.io/web-api/index.html?highlight=events#event-source-api) as `/events`. This allows the plugin to stay up to date with no lag. The plugin caches the most recent status we've received for each accessory, enabling immediate replies to any status checks. For controlling, the GDO BlaQ devices have a [REST API](https://konnected.readme.io/v2.0/reference/introduction) that is automatically enabled. Therefore, this plugin uses the API routes exposed for sending commands to control different accessories.

### Legal

Expand Down

0 comments on commit 9008c54

Please sign in to comment.