Skip to content

Commit

Permalink
Casing consistency
Browse files Browse the repository at this point in the history
  • Loading branch information
KyleBoyer committed Jul 23, 2024
1 parent 192f89a commit 1eed2db
Show file tree
Hide file tree
Showing 4 changed files with 14 additions and 14 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 GDO BlaQ
# Homebridge Plugin for Konnected's GDO blaQ

</span>

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)
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 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:
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 @@ -27,19 +27,19 @@ This plugin enables the use of a GDO BlaQ device with Homebridge (and derivative
It *could*, but does not currently, support:

* Toggle Only Mode
* Restart GDO BlaQ Device
* Resync GDO BlaQ Device
* Factory Reset GDO 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 GDO BlaQ device. If you have not purchased one, you can do so here: [Konnected Store](https://konnected.io/KYLEBOYER)
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 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:
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 @@ -65,7 +65,7 @@ The `mac` field is optional, but is quite helpful if provided - this field is us

### Implementation

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.
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
4 changes: 2 additions & 2 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"private": false,
"displayName": "Konnected BlaQ",
"name": "homebridge-blaq",
"version": "0.2.17",
"version": "0.2.18",
"description": "Control and view your garage door(s) remotely with real-time updates using Konnected's BlaQ hardware",
"license": "Apache-2.0",
"type": "module",
Expand Down
2 changes: 1 addition & 1 deletion src/accessory/base.ts
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ export class BaseBlaQAccessory implements BaseBlaQAccessoryInterface {
// set accessory information
this.accessoryInformationService
.setCharacteristic(this.platform.characteristic.Manufacturer, 'Konnected')
.setCharacteristic(this.platform.characteristic.Model, 'GDO BlaQ')
.setCharacteristic(this.platform.characteristic.Model, 'GDO blaQ')
.setCharacteristic(this.platform.characteristic.SerialNumber, this.serialNumber)
.setCharacteristic(this.platform.characteristic.Name, this.friendlyName);
// Publish firmware version; this may not be initialized yet, so we set a getter.
Expand Down

0 comments on commit 1eed2db

Please sign in to comment.