All notable changes to homekit-ratgdo will be documented in this file. This project tries to adhere to Semantic Versioning.
- Bugfix... alignment of minHeap and minStack was wrong on chrome browsers.
- Bugfix... set WiFi hostname based on user provided device name.
- Bugfix... also set the browser page title to the user provided device name.
- New feature... allow user to set custom username for the webpage.
- New feature... allow user to set static IP address.
- New feature... add new system logs page (opens in new browser tab).
- New feature... add spinning page-loading icon to provide feedback on slow network links
- New feature... add option to obtain real time from NTP sever
- Cleanup... consolidated all code for retrieving user configured settings into one file (utilities.cpp).
- Same as v1.7.0
- 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.
- Random crashes inside the MDNSresponder code which usually occur shortly after booting or when something significant changes on the network that causes a storm of mDNS messages. Ratgdo always recovers. Tracked in #211, #223
- Random crashes inside the WiFi stack possibly associated with failing to connect to WiFi access point. Tracked in #215, #218, #223
- Occasional failure to connect to WiFi. Tracked in #217
- Fixes to SEC1.0 when no DIGITAL wall panel connected by @mitchjs in #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.
- Documentation updates and test HomeKit server running by @dkerr64 in #197
- Fix a bug in HomeKit library was not not always correctly updating characteristics by @jgstroud in #204 Thanks @hjdhjd for pointing me in the right direction
- Get status on boot by @jgstroud in #205
- Make obstruction detection ignore spurrious detections by @jgstroud in #206
- Firmware verification working branch by @dkerr64 in #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.
- Fixes / features for next release. by @dkerr64 and @jgstroud in #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.
- Fixes and features for next release by @dkerr64 in #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 #170
- v1.3.5 in changeling by @donavanbecker in #169
- Wait before publishing release to discord by @donavanbecker in #168
- Create CHANGELOG.md by @donavanbecker in #165
- Add check for pre-releases in firmware update dialog by @dkerr64 in #166
- Remove the visibility check as it was causing issues. by @jgstroud in #167
- New flash wear protection was causing problems with rolling code getting out of sync on some GDOs. Fix implemented
- OTA Flash CRC check was causing false failures and blocking OTA upgrade. Removed this check. MD5 check still in place.
Full Changelog: v1.3.2...v1.3.5
- Suspend certain activity when update underway, including comms and ho… by @dkerr64 in #153
- Time-to-close and further memory improvements by @dkerr64 in #145
- Include md5 in upload by @donavanbecker in #163 Fixes #60 Warning is now configurable in the setting page. User can set the duration of the delay before close. Lights will flash, but no beep. Controlling the beep is not yet possible.
Fixes #150 Allow user to set the WiFi transmit power. This combined with the ability to force 802.11g should fix #77
Added lots of additional error checking and safeguards to address #151 Note, you won't see the benefits of these changes until the next update.
- More stability enhancements. Memory improvements to free up additional heap.
- Store serial log to flash on crash
- Allow logging over the network to the javascript console. No longer need a USB cable to capture the logs Many thanks to @dkerr64 for all the work on this release.
Full Changelog: v1.2.1...v1.3.2
Hk update and ota fix by @jgstroud in #152
-
Fixed incorrect reporting of garage door state
-
A number of users have reported failed OTA updates requiring a USB reflash in #151 I believe this was introduced by: ee38a90
Reverted those changes
NOTE: since the OTA update failure is a result of the running code and not the incoming code, you may have to flash this release with a USB cable as well, but hopefully this will fix any future OTAs.
Full Changelog: v1.2.0...v1.2.1
- Fix Github typo by @SShah7433 in #137
- Add wifi RSSI to web page by @jgstroud in #136
- Include Elf file by @donavanbecker in #142
- Improve web page stability by @dkerr64 in #139
- Store crash dumps to flash by @dkerr64 and @jgstroud
- Changes to LwIP configuration to help prevent running out of memory when TCP connections die and when there are corrupt mDNS packets on the network by @jgstroud #147
- Update to HomeKit library to reduce memory footprint by @jgstroud #148
- @SShah7433 made their first contribution in #137
Full Changelog: v1.1.0...v1.2.0
- Improved pairing reliability by @jgstroud in #135
- Allow setting WiFi phy mode to 802.11B/G/N or auto by @dkerr64 in #133
Some users with eero networks having connectivity issues have reported improved reliability by setting PHY mode to 802.11G
Full Changelog: v1.0.0...v1.1.0
We've focuses this release on stability and believe we are good to finally make an official 1.0 release.
Many thanks to @thenewwazoo for starting this project and to @dkerr64 for his work on helping get this release out.
Loads of stability improvements.
-
Stability Improvements by @jgstroud in #129
Fixes #15, Fixes #36, Fixes #94, Fixes #103, Fixes #126, Fixes #130
Full Changelog: v0.12.0...v1.0.0
- Update Readme by @donavanbecker in #115
- Update README by @thenewwazoo in #123
- Security 1.0 support, and web page updates by @dkerr64 by @mitchjs in #117
- Add an option to auto reboot every X number of hours
- @mitchjs made their first contribution in #117 Full Changelog: v0.11.0...v0.12.0
- Add web authentication
- Automatically detect new releases on github
- Add door controls
Default login admin/password
- Discord Webhook after Release by @donavanbecker in #101
- Web page updates by @dkerr64 in #107 Full Changelog: v0.10.0...v0.11.0
The main reason for this release is to make the motion sensor service visible to only those that have one. After installing this release, you may have to re-pair your device to HK. If you have a motion detector, it won't show up initially, but should show up shortly after triggering it for the first time. From this point on, it will always be visible even after upgrades.
- Update Release Process by @donavanbecker in #86
- make the motion sensor dynamic. by @jgstroud in #85
- remove tag pattern check by @donavanbecker in 396 Full Changelog: v0.9.0...v0.10.0
- Add discord release notification by @donavanbecker in #83
- Add OTA to Readme by @donavanbecker in #84
- New webpage by @dkerr64 in #63 Full Changelog: v0.8.0...v0.9.0
- Fix the millis timer veriable data types by @jgstroud in #75
- Fix a few duplicate log messages by @tabacco in #73
- Pull in main branch of mrthiti's Homekit library to get mdns fix by @jgstroud in #76
- Add HTTPUpdateServer OTA support by @sstoiana and @donavanbecker in #72
- Update Releasing Notes, & Enforce Version Pattern by @donavanbecker in #82 Full Changelog: v0.7.0...v0.8.0
- Removes duplicate SSIDs from the wifi networks list, and shows only the one with the highest signal strength
- Slightly improves responsiveness at first startup and when controlling lights
- other minor improvements Thank you to all the contributors and testers!
(no, you're not feeling deja-vu, this is a re-release in order to fix a new release process) Full Changelog: v0.6.0...v0.7.0
This release fixes garage door lock behavior and a crash on early setup, as well as adds support for directly sensing obstructions using the wired connection (versus relying on the garage door to report).
Once again, many thanks to @jgstroud for doing all the work in this release, and to the many users testing and reporting issues. Full Changelog: v0.5.0...v0.6.0
Thanks to @jgstroud for adding locks and light support to this release! Full Changelog: v0.4.0...v0.5.0
This release enables multiple HomeKit-native RATGDOs to co-exist.
NOTE: THIS IS A BREAKING RELEASE. You will need to re-pair your device after flashing. Full Changelog: v0.3.1...v0.4.0
This tweaks the motion sensor service notifications to save some redundant updates Full Changelog: v0.3.0...v0.3.1
New in this release is support for motion sensors.
Full Changelog: v0.2.3...v0.3.0
- browser-based reboot button for the ratgdo device
- tweaks to wifi setup to improve reliability
- fixes to logic to make the Home UI more consistent
Full Changelog: v0.2.0...v0.2.3
- Changes the pairing code to 2510-2023
- Adds a scannable QR code to ease setup
- Adds a web server that permits un-pairing with HomeKit and shows the QR code for pairing when not paired
Full Changelog: v0.1.0...v0.2.0
- Improv support is still dicey (it will save the credentials but the device reboots and the page doesn't re-connect), but it will open and close a garage door pretty okay.
Full Changelog: v0.1.0