Skip to content
This repository has been archived by the owner on Apr 28, 2024. It is now read-only.

Commit

Permalink
v2.9.0
Browse files Browse the repository at this point in the history
  • Loading branch information
hjdhjd committed Jan 4, 2023
1 parent dffc76a commit baf7255
Show file tree
Hide file tree
Showing 12 changed files with 260 additions and 139 deletions.
4 changes: 4 additions & 0 deletions docs/Changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,10 @@

All notable changes to this project will be documented in this file. This project uses [semantic versioning](https://semver.org/).

## 2.9.0 (2023-01-03)
* Feature: new feature option to allow users to disable battery notifications for myQ devices with a battery-enabled door position sensor. You can disable low battery notifications by using `Disable.BatteryInfo`.
* Feature: new feature option to allow for setting garage door openers to read-only. You can configure garage door openers as read-only using `Enable.ReadOnly`.

## 2.8.3 (2022-12-27)
* More housekeeping.

Expand Down
10 changes: 8 additions & 2 deletions docs/FeatureOptions.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,13 +22,19 @@ Feature options allow you to enable or disable certain features in this plugin.
The `options` setting is an array of strings used to customize feature options. Available options:

- `Disable.<your_serial_number>` - hide the opener or gateway identified by `<your_serial_number>` from HomeKit.
- `Enable.<your_serial_number>` - show the opener or gateway identified by `<your_serial_number>` from HomeKit.
- `Enable.<your_serial_number>` (default) - show the opener or gateway identified by `<your_serial_number>` from HomeKit.

- `Disable.BatteryInfo` - disable low battery notification for battery-enabled door position sensors for myQ garage openers.
- `Enable.BatteryInfo` (default) - disable low battery notification for battery-enabled door position sensors for myQ garage openers.

- `Disable.ReadOnly` (default) - enable HomeKit commands to open and close myQ garage openers.
- `Enable.ReadOnly` - disable HomeKit commands from opening and closing myQ garage openers.

With both the `Disable` and `Enable` options, replace `<your_serial_number>` with the serial number for your specific device found within the device "Accessory Details" in the Home app.

The plugin will log all devices it encounters and knows about, and you can use that to guide what you'd like to hide or show.

Before using this feature, you should understand how gateways and openers work in myQ. Gateways are the devices in your home that actually communicate your status to myQ. Openers are attached to gateways. A typical home will have a single gateway and one, or more, openers. If you choose to hide a gateway, you will also hide all the openers associated with that gateway.
Before using these features, you should understand how gateways and openers work in myQ. Gateways are the devices in your home that actually communicate your status to myQ. Openers are attached to gateways. A typical home will have a single gateway and one, or more, openers. If you choose to hide a gateway, you will also hide all the openers associated with that gateway.

If you've hidden a gateway, and all it's openers with it, you can selectively enable a single opener associated with that gateway by explicitly setting a `Show.` feature option. This should give you a lot of richness in how you enable or disable devices for HomeKit use.

Expand Down
112 changes: 56 additions & 56 deletions package-lock.json

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

10 changes: 5 additions & 5 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "homebridge-myq",
"version": "2.8.3",
"version": "2.9.0",
"displayName": "Homebridge myQ",
"description": "HomeKit integration of myQ enabled devices such as those from LiftMaster and Chamberlain.",
"author": {
Expand Down Expand Up @@ -44,10 +44,10 @@
"main": "dist/index.js",
"devDependencies": {
"@types/node": "^18.11.18",
"@types/ws": "^8.5.3",
"@typescript-eslint/eslint-plugin": "^5.47.1",
"@typescript-eslint/parser": "^5.47.1",
"eslint": "^8.30.0",
"@types/ws": "^8.5.4",
"@typescript-eslint/eslint-plugin": "^5.48.0",
"@typescript-eslint/parser": "^5.48.0",
"eslint": "^8.31.0",
"homebridge": "=1.5.1",
"nodemon": "^2.0.20",
"rimraf": "^3.0.2",
Expand Down
2 changes: 1 addition & 1 deletion src/index.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
/* Copyright(C) 2017-2022, HJD (https://github.com/hjdhjd). All rights reserved.
/* Copyright(C) 2017-2023, HJD (https://github.com/hjdhjd). All rights reserved.
*
* index.ts: homebridge-myq plugin registration.
*/
Expand Down
2 changes: 1 addition & 1 deletion src/myq-accessory.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
/* Copyright(C) 2017-2022, HJD (https://github.com/hjdhjd). All rights reserved.
/* Copyright(C) 2017-2023, HJD (https://github.com/hjdhjd). All rights reserved.
*
* myq-accessory.ts: Base class for all myQ accessories.
*/
Expand Down
2 changes: 1 addition & 1 deletion src/myq-config.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
/* Copyright(C) 2017-2022, HJD (https://github.com/hjdhjd). All rights reserved.
/* Copyright(C) 2017-2023, HJD (https://github.com/hjdhjd). All rights reserved.
*
* myq-config.ts: Configuration options for the myQ plugin.
*/
Expand Down
Loading

0 comments on commit baf7255

Please sign in to comment.