/hass_myq

The MyQ component lets you control MyQ-Enabled garage doors and gates through Home Assistant

Primary LanguagePythonMIT LicenseMIT

GitHub all releases GitHub release (latest by SemVer)

GitHub Release License

hacs Project Maintenance

App icon

MyQ

Component to add myQ garage doors and gates to home assistant

The myQ component lets you control myQ-Enabled garage doors and gates through Home Assistant. Device names in Home Assistant are generated based on the names defined in your myQ Device mobile app.

This is a custom component replacing the core myQ integration in Homeassistant.

This component will set up the following platforms.

Platform Description
binary_sensor Represents myQ gateway.
cover For each garage door or gate discovered from myQ. Shows current state and allows opening or closing

Installation with HACS

This component is available through HACS. This is the easiest method to install, stay informed of new releases, and update.

  1. Within Home Assistant, open HACS (install HACS if not already installed, see HACS Installation)
  2. Go to the Integrations store
  3. Click on the 3 vertical dots in upper-right corner and select Custom Repositories
  4. At the bottom of the dialog box, enter https://github.com/ehendrix23/hass_myq for custom repository URL and select Integration as the Category. Click on Add.
  5. Click on the myQ repository and then click on INSTALL THIS REPOSITORY IN HACS
  6. The repository is now installed, a restart of HACS might be required

If myQ was not yet configured in HASS then perform the following steps to add it. If it was already configured as a core component from HASS then nothing further is required.

  1. Go to Configuration -> Integrations page
  2. On the bottom right of the page click on the Orange + sign to add an integration
  3. Search for myQ (if you don't see it, try refreshing your browser page to reload the cache)
  4. Enter your myQ account credentials

Manual Installation

  1. Using the tool of choice open the directory (folder) for your HA configuration (where you find configuration.yaml).
  2. If you do not have a custom_components directory (folder) there, you need to create it.
  3. In the custom_components directory (folder) create a new folder called myq.
  4. Download all the files from the custom_components/myq/ directory (folder) in this repository.
  5. Place the files you downloaded in the new directory (folder) you created.
  6. Restart Home Assistant

If myQ was not yet configured in HASS then perform the following steps to add it. If it was already configured as a core component from HASS then nothing further is required.

  1. Go to Configuration -> Integrations page
  2. On the bottom right of the page click on the Orange + sign to add an integration
  3. Search for myQ (if you don't see it, try refreshing your browser page to reload the cache)
  4. Enter your myQ account credentials

Configuration is done in the UI

Removal of HACS

  1. Within Home Assistant, open HACS
  2. Go to the Integrations store
  3. Find the myQ card in the list shown.
  4. Click on the 3 vertical dots shown on the card
  5. Click on uninstall to remove the component.
  6. Restart HASS

Uninstall from HACS will result in reverting to the myQ component part of HASS. To remove the configuration completely perform the following steps (note, these can also be done before removing the myQ HACS component)

  1. In HASS, click on Configuration -> Integrations
  2. Find the myQ card in the entries shown.
  3. Click on the 3 vertical dots on the myQ card
  4. Click on Delete

Contributions are welcome!

If you want to contribute to this please read the Contribution guidelines

Credits

This project was generated from @oncleben31's Home Assistant Custom Component Cookiecutter template.

Code template was mainly taken from @Ludeeus's integration_blueprint template