Skip to content

Commit

Permalink
v2.0.0.
Browse files Browse the repository at this point in the history
  • Loading branch information
hjdhjd committed Apr 27, 2024
1 parent 3f5bb04 commit f70201c
Show file tree
Hide file tree
Showing 6 changed files with 110 additions and 290 deletions.
18 changes: 18 additions & 0 deletions CODE-OF-CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# Code of Conduct

By interacting with this GitHub repository, you agree that you'll follow this code of conduct.

### In short: Be nice. Be respectful. No harassment, trolling, or spamming.

Always be mindful that in the free / open source community, people are contributing their time away from friends and families to work on these projects. No one is being compensated for their work here. While feedback is useful, coming to this repository to make demands isn’t respectful.

* Harassment includes sexual language and imagery, deliberate intimidation, stalking, name-calling, unwelcome attention, libel, and any malicious hacking or social engineering. This repository should be a harassment-free experience for everyone, regardless of your background, identity, or experience level.

* Trolling includes posting inflammatory comments to provoke an emotional response or disrupt discussions.

* Spamming includes posting off-topic messages to disrupt discussions, promote a product, solicit donations, advertise a job / internship / gig, or flooding discussions with files or text.

#### The maintainers of this GitHub repository will take any action we deem appropriate, up to and including banning the offender from this repository.

##### Attribution
This code of conduct was inspired by and adapted from the [freeCodeCamp](https://www.freecodecamp.org/news/code-of-conduct/) code of conduct.
14 changes: 0 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,20 +42,6 @@ To get started with `homebridge-ratgdo`:
* Fully open and close the garage door one time. ESPHome Ratgdo will use this to determine how long it takes to open and close your garage door to enable precise control of the position of the garage door opener.
* That's it. Ensure `homebridge-ratgdo` is running and it will autodiscover your Ratgdo devices and make them available in HomeKit.

Deprecated instructions:
* Install the [MQTT Ratgdo firmware](https://paulwieland.github.io/ratgdo/flash.html). You'll need to use Chrome for this as Safari doesn't support installing firmware through a USB serial port.
* [Carefully](#known-caveats) edit the MQTT server and port on your Ratgdo device to the IP address of your Homebridge server, and port 18830 (unless you've changed the default port in `homebridge-ratgdo`).
* **Please note, MQTT Ratgdo firmware support in `homebridge-ratgdo` is now considered deprecated and will be removed in an upcoming release. I encourage everyone to upgrade to the [ESPHome Ratgdo firmware](https://ratgdo.github.io/esphome-ratgdo/) as soon as they can.

## Known Caveats
Ratgdo is a terrific solution that solves a problem for many stranded former myQ users and others. There are some quirks and caveats to note, however. As of MQTT Ratgdo firmware v2.57:

* Misconfiguring your MQTT server IP or port number in any way **will** lock up / brick the Ratgdo. The only fix for this I've discovered is to reflash the Ratgdo and don't misconfigure it the next time around.
* Ratgdo currently has no useful way to query it's state over MQTT. That means that on startup, the state of the garage door opener in Homebridge / HomeKit will be unknowable. Given that challenge, `homebridge-ratgdo` will assume the garage door opener is closed on startup. Once an action is taken, the state of the garage door opener will be accurately reflected in Homebridge / HomeKit. There is technically a *query* command available through the MQTT interface to Ratgdo, but all that currently does is to set the Ratgdo state information to an unknown state, awaiting the next state update from the garage door opener, rather than actually publish the current state, which is really what we need.
* In some wiring configurations, Ratgdo reads information from the garage door opener either incorrectly or inconsistently. I would advise closely checking and confirming the wiring you're using to ensure it's correct and the physical wiring used is good. If it is, I'd suggest filing a support request on the [Ratgdo support page](https://github.com/PaulWieland/ratgdo/issues).

I hope these issues can be addressed in future Ratgdo releases.

## Plugin Development Dashboard
This is mostly of interest to the true developer nerds amongst us.

Expand Down
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.0.0 (2024-04-27)
* Breaking change: Ratgdo MQTT firmware support has been removed. If you need support for it, please stick to 1.2.3. All development moving forward is going to focus on the Ratgdo ESPHome firmware.
* Fix: address edge cases to ensure connectivity robustness when network interruptions occur.

## 1.2.3 (2024-04-20)
* Change: Support for Ratgdo MQTT firmware is now deprecated and will be removed in the next point release.
* Housekeeping.
Expand Down
1 change: 0 additions & 1 deletion docs/FeatureOptions.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,6 @@ Feature options provide a rich mechanism for tailoring your `homebridge-ratgdo`
| Option | Description
|--------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
| `Device` | Make this device available in HomeKit. **(default: enabled)**.
| `Device.SyncName` | Synchronize the Ratgdo name of this device with HomeKit. Synchronization is one-way only, syncing the device name from Ratgdo to HomeKit. This option is only available on Ratgdo devices running MQTT firmware versions. **(default: disabled)**.

#### <A NAME="opener"></A>Opener feature options.

Expand Down
Loading

0 comments on commit f70201c

Please sign in to comment.