Skip to content

Commit

Permalink
Update README. CHANGELOG and web page screen shots
Browse files Browse the repository at this point in the history
  • Loading branch information
dkerr64 committed Aug 10, 2024
1 parent 2a4c210 commit 301a161
Show file tree
Hide file tree
Showing 5 changed files with 85 additions and 1 deletion.
67 changes: 67 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,73 @@

All notable changes to `homekit-ratgdo` will be documented in this file. This project tries to adhere to [Semantic Versioning](http://semver.org/).

## v1.7.0 (2024-08-10)

### What's Changed

* Removed the heap fragmentation tracking introduced in v1.6.1... it was occasionally crashing inside Arduino library.
* Bugfix... device reboot countdown timer from 30 seconds to zero was not always displaying.
* New feature... add _reset door_ button. This resets the Sec+ 2.0 rolling code and whether the door has a motion sensor or not.
* New feature... add option to trigger motion sensor on user pressing wall panel buttons (door open/close, light and/or lock).
* New feature... add option to trigger motion sensor on door obstruction.
* New feature... add option for user to select whether the LED light remains on while device is idle or turns off. Any activity causes the LED to flash.

### Known Issues
* Random crashes inside the MDNSresponder code which usually occur shortly after booting or when something significant changes on the network that causes a strom of mDNS messages. Ratgdo always recovers. Tracked in https://github.com/ratgdo/homekit-ratgdo/issues/211, https://github.com/ratgdo/homekit-ratgdo/issues/223
* Random crashes inside the WiFi stack possibly associated with failing to connect to WiFi access point. Tracked in https://github.com/ratgdo/homekit-ratgdo/issues/215, https://github.com/ratgdo/homekit-ratgdo/issues/218, https://github.com/ratgdo/homekit-ratgdo/issues/223
* Occasional failure to connect to WiFi. Tracked in https://github.com/ratgdo/homekit-ratgdo/issues/217

## v1.6.1 (2024-07-28)

### What's Changed
* Fixes to SEC1.0 when no DIGITAL wall panel connected by @mitchjs in https://github.com/ratgdo/homekit-ratgdo/pull/208
* Improve memory heap usage tracking and logging to assist with future debugging
* Cleaned up numerous compiler warnings

The only functional change in this release is to better support Sec+ 1.0 garage door openers when there is no digital wall panel. Upgrading is therefore optional if your GDO is Sec+ 2.0.

## v1.6.0 (2024-06-17)

### What's Changed
* Documentation updates and test HomeKit server running by @dkerr64 in https://github.com/ratgdo/homekit-ratgdo/pull/197
* Fix a bug in HomeKit library was not not always correctly updating characteristics by @jgstroud in https://github.com/ratgdo/homekit-ratgdo/pull/204 Thanks @hjdhjd for pointing me in the right direction
* Get status on boot by @jgstroud in https://github.com/ratgdo/homekit-ratgdo/pull/205
* Make obstruction detection ignore spurrious detections by @jgstroud in https://github.com/ratgdo/homekit-ratgdo/pull/206

## v1.5.0 (2024-06-03)

### What's Changed
* Firmware verification working branch by @dkerr64 in https://github.com/ratgdo/homekit-ratgdo/pull/193

Fixes several critical bugs. Recommended for all users to upgrade. @dak64 identified some storage issues in the homekit library and corrected them. This should address #194 #189 #184

**NOTE: You will need to re-pair with HomeKit after installing this update.**
The most reliable way to do this is 1) erase from Apple Home, 2) reset/re-pair button on ratgdo, 3) kill Apple Home and restart it and 4) scan the QR code.

## v1.4.0 (2024-05-30)

### What's Changed
* Fixes / features for next release. by @dkerr64 and @jgstroud in https://github.com/ratgdo/homekit-ratgdo/pull/191
* Remove old redundant code
* Save logs on clean shutdown
* Check flash CRC on upload complete
* Add a full flash verify on upload to make sure contents are written properly to flash
* Change wifi persist to false. was writing wifi settings to flash multiple times on each boot. known to cause issues. #192

Lots of changes mainly focuses on trying to prevent flash corruptions.

## v1.4.0 (2024-05-21)

### What's Changed
* Fixes and features for next release by @dkerr64 in https://github.com/ratgdo/homekit-ratgdo/pull/175
- Back out usage of secondary IRAM heap. This was causing some users to not be able to access the webUI. Fixes #173
- Change webUI structure for memory optimization
- Add script to remotely monitor logs
- Document CLI control in the README
* New prerelease check by @jgstroud in https://github.com/ratgdo/homekit-ratgdo/pull/170
* v1.3.5 in changeling by @donavanbecker in https://github.com/ratgdo/homekit-ratgdo/pull/169
* Wait before publishing release to discord by @donavanbecker in https://github.com/ratgdo/homekit-ratgdo/pull/168

## v1.3.5 (2024-05-01)

### What's Changed
Expand Down
18 changes: 17 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -94,13 +94,25 @@ You can select up-to 60 second delay before door starts closing. During the dela

If selected then all the action buttons _except reboot_, and access to the settings page, will require authentication. Default is not required.

### LED on when idle

If selected then the LED light on the ratgdo device will remain illuminated when the device is idle and flash off when there is activity. If you prefer the LED to remain off while idle then unselect this checkbox and the LED to flash on with activity.

### Motion Triggers

This allows you to select what causes the HomeKit motion sensor accessory to trigger. The default is to use the motion sensor built into the garage door opener, if it exists. This checkbox is not selectable because presence of the motion sensor is detected automatically... based on detecting motion in the garage. If your door opener does not have a motion sensor then the checkbox will show as un-checked.

Motion can also be triggered by the obstruction sensor and by pressing the door, light or lock buttons on the door opener wall panel. These are disabled by default but may be selected on the web page.

Changing this setting will cause a reboot only if changing from no motion sensor to any selection that triggers motion, or vis versa.

### Receive Logs

This option is not available on mobile devices. On a desktop browser all server firmware logs can be displayed in the javascript console log. On some browsers you may need to enable developer mode before you can open the javascript console.

### Door Protocol

Set the protocol for your model of garage door opener. This defaults to Security+ 2.0 and you should only change this if necessary.
Set the protocol for your model of garage door opener. This defaults to Security+ 2.0 and you should only change this if necessary. Note that the changing the door protocol also resets the door opener rolling codes and whether there is a motion sensor (this will be automatically detected after reset).

### WiFi Version

Expand All @@ -114,6 +126,10 @@ You can set the WiFi transmit power to between 0 and 20 dBm. It defaults to the

During early devlopment there were several reports that the ratgdo device would reset itself and loose its pairing with HomeKit. To reduce the chance of this occuring a regular (e.g. daily) reboot of the device provided a work-around. The firmware is far more stable now and it is hoped that this is no longer required. This setting may be removed in future versions.

### Reset Door

This button resets the Sec+ 2.0 rolling codes and whether your door opener has a motion sensor. This may be necessary if the ratgdo device gets out-of-sync with what the door opener expects. Selecting this button requires the ratgdo to reboot and does not save any new settings.

## How do I upgrade?

Over-the-Air (OTA) updates are supported, either directly from GitHub or by selecting a firmware binary file on your computer. Follow the steps below to update:
Expand Down
Binary file modified docs/webpage/password.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/webpage/webpage.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions src/www/status.json
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@
"wifiPower": 10,
"TTCseconds": 10,
"motionTriggers": 3,
"LEDidle": 1,
"lastDoorUpdateAt": 847155,
"checkFlashCRC": false
}

0 comments on commit 301a161

Please sign in to comment.