Skip to content

Commit

Permalink
Housekeeping.
Browse files Browse the repository at this point in the history
  • Loading branch information
hjdhjd committed Apr 28, 2024
1 parent 109c790 commit 97e16d8
Show file tree
Hide file tree
Showing 6 changed files with 130 additions and 86 deletions.
45 changes: 0 additions & 45 deletions .github/ISSUE_TEMPLATE/bug_report.md

This file was deleted.

29 changes: 29 additions & 0 deletions .github/ISSUE_TEMPLATE/feature-request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
name: Feature Request
description: Suggest an idea for an enhancement to HBR. Please read the HBR documentation first, including the feature options section, to verify what you're looking for isn't already implemented.
labels: enhancement
body:
- type: markdown
attributes:
value: |
### Before opening a feature request, please ensure you have read the [documentation](https://github.com/hjdhjd/homebridge-ratgdo#documentation), especially the [feature option](https://github.com/hjdhjd/homebridge-ratgdo/blob/main/docs/FeatureOptions.md) page to see if the feature you're looking for doesn't already exist.
- type: textarea
id: feature-request
attributes:
label: Describe the feature request
description: Please describe the feature you are requesting. If the feature request relates to a specific problem you are encountering, please describe the use case.
validations:
required: true
- type: textarea
id: proposed-solution
attributes:
label: Describe the proposed solution
description: Please describe the proposed solution to the problem or use case described above.
validations:
required: true
- type: textarea
id: alternatives
attributes:
label: Describe alternatives you have considered to the enhancement
description: Please describe alternative approaches you've explored or considered to address the requested feature.
validations:
required: true
22 changes: 0 additions & 22 deletions .github/ISSUE_TEMPLATE/feature_request.md

This file was deleted.

89 changes: 89 additions & 0 deletions .github/ISSUE_TEMPLATE/support-request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,89 @@
name: Support Request
description: Report a bug or request help. Please read the HBR documentation before creating a support request.
body:
- type: markdown
attributes:
value: |
### Before opening a support request, please ensure you have read the [documentation](https://github.com/hjdhjd/homebridge-ratgdo#documentation). Questions and topics already addressed in the documentation, or in prior issue reports, will be closed without a response.
- type: input
id: hbrversion
attributes:
label: Homebridge Ratgdo
description: Which version of Homebridge Ratgdo (HBR) are you running on?
placeholder: e.g. v2.1.0
validations:
required: true

- type: input
id: homebridgeos
attributes:
label: Homebridge Platform and OS
description: What hardware and operating system are you running Homebridge on?
placeholder: e.g. macOS Sonoma
validations:
required: true

- type: input
id: homebridge
attributes:
label: Homebridge Version
description: Which version of Homebridge are you running on?
placeholder: e.g. v1.7.0
validations:
required: true

- type: input
id: node
attributes:
label: Node Version
description: Which version of Node are you running on?
placeholder: e.g. v18.1.0
validations:
required: true

- type: input
id: ratgdo
attributes:
label: Ratgdo ESPHome Firmware Version
description: Which version of the Ratgdo ESPHome firmware is your Ratgdo running on?
placeholder: e.g. v2024.3.2
validations:
required: true

- type: textarea
id: what-happened
attributes:
label: Describe the problem
description: Please describe the issue you're encountering, and ensure you include steps to reproduce.
validations:
required: true

- type: textarea
id: config
attributes:
label: Homebridge HBR JSON configuration
description: Please copy and paste your Homebridge HBR JSON configuration. This will be automatically formatted into code, so no need for backticks.
placeholder: Paste your HBR configuration from Homebridge (gear icon in the Homebridge webUI next to HBR, then select JSON config). Copy and paste it here.
render: json
validations:
required: true

- type: textarea
id: logs
attributes:
label: Relevant log output
description: Please copy and paste any relevant Homebridge HBR log output. This will be automatically formatted into code, so no need for backticks.
placeholder: Please paste the relevant log entries here.
render: shell
validations:
required: true

- type: checkboxes
id: acknowledgment
attributes:
label: Acknowledgment that you are only running non-beta firmware releases from Apple, ESPHome, or Ratgdo
description: By submitting this issue, you are acknowledging that you are only using the official Ratgdo ESPHome firmware releases and that you are **not** running beta firmwares (or operating systems) from Apple, ESPHome, or Ratgdo. **All issues relating to beta firmwares or operating systems will be closed without comment.**
options:
- label: I acknowledge that I am not running any beta firmwares or operating systems from Apple, ESPHome, or Ratgdo.
required: true
18 changes: 0 additions & 18 deletions .github/workflows/issue-validate.yml

This file was deleted.

13 changes: 12 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,14 +35,25 @@ In the interest of the community seeking a solution outside of myQ, I've develop
* Automation switch and dimmer support, allowing you to set the garage door to any position.
* A rich webUI for configuration.

## Getting Started
## Installation
### Getting Started
To get started with `homebridge-ratgdo`:

* Install `homebridge-ratgdo` using the Homebridge webUI. Make sure you make `homebridge-ratgdo` a child bridge for the best performance.
* Install the [ESPHome Ratgdo firmware](https://ratgdo.github.io/esphome-ratgdo/). You'll need to use Chrome for this as Safari doesn't support installing firmware through a USB serial port.
* 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.

## Documentation
* Getting Started
* [Installation](#installation): installing this plugin, including system requirements.
* [Plugin Configuration](#getting-started): how to quickly get up and running.
* [Changelog](https://github.com/hjdhjd/homebridge-ratgdo/blob/main/docs/Changelog.md): changes and release history of this plugin, starting with v3.0.

* Additional Topics
* [Feature Options](https://github.com/hjdhjd/homebridge-ratgdo/blob/main/docs/FeatureOptions.md): granular options to allow you to set the camera quality individually, show or hide specific cameras, controllers, and more.
* [MQTT](https://github.com/hjdhjd/homebridge-ratgdo/blob/main/docs/MQTT.md): how to configure MQTT support.

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

Expand Down

0 comments on commit 97e16d8

Please sign in to comment.