From 1eed2dbacd9d73d2cd994d6dbff6a25e7ebd2bb0 Mon Sep 17 00:00:00 2001 From: kyleboyer Date: Mon, 22 Jul 2024 22:56:31 -0500 Subject: [PATCH] Casing consistency --- README.md | 20 ++++++++++---------- package-lock.json | 4 ++-- package.json | 2 +- src/accessory/base.ts | 2 +- 4 files changed, 14 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 28304e5..fe442f5 100644 --- a/README.md +++ b/README.md @@ -6,14 +6,14 @@ -# Homebridge Plugin for Konnected's GDO BlaQ +# Homebridge Plugin for Konnected's GDO blaQ -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 @@ -27,9 +27,9 @@ 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 @@ -37,9 +37,9 @@ Please request these features via the issues section on this repo if you would f ### 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 { @@ -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 diff --git a/package-lock.json b/package-lock.json index f390e5f..aff385d 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "homebridge-blaq", - "version": "0.2.17", + "version": "0.2.18", "lockfileVersion": 3, "requires": true, "packages": { "": { "name": "homebridge-blaq", - "version": "0.2.17", + "version": "0.2.18", "funding": [ { "type": "github", diff --git a/package.json b/package.json index 9b1d61c..f4429ea 100644 --- a/package.json +++ b/package.json @@ -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", diff --git a/src/accessory/base.ts b/src/accessory/base.ts index 3ef574b..6d61d7c 100644 --- a/src/accessory/base.ts +++ b/src/accessory/base.ts @@ -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.