Skip to content

Latest commit

 

History

History
86 lines (64 loc) · 4.47 KB

info.md

File metadata and controls

86 lines (64 loc) · 4.47 KB

GitHub Release GitHub all releases GitHub release (latest by SemVer) GitHub Activity

License

hacs Project Maintenance BuyMeCoffee

Discord Community Forum

Create a custom component from a Home Assistant Integration Pull Request. Use this when you want to test a pull request that changes a built in integration.

Warning: This is experimental and may fail if the Pull Request is for a substantially different version of HA or modifies more than the integration. Do not report bugs to the core authors!

This component will set up the following platforms.

Platform Description
binary_sensor Show whether the Pull Request has been updated since install.
sensor Show's the timestamp of the last change to the Pull Request
switch Enable to automatically update to the latest on the next check.

{% if not installed %}

Installation

  1. Click install.
  2. Reboot Home Assistant.
  3. Hard refresh browser cache.

{% endif %}

Installing an Auto Generated Custom Component

  1. In the HA UI go to "Configuration" -> "Integrations" click "+" and search for "PR Custom Component".
  2. Provide the URL of the pull request you want to turn into a custom_component.

    For example, this will get a Tesla Pull Request: https://github.com/home-assistant/core/pull/46558

  3. After succesful install, you should see the PR Custom Component with title Tesla.
  4. Restart Home Assistant to enable the Tesla Custom Component to override the default.
  5. Hard refresh your browser to download any changes strings.
  6. Install Tesla Custom Component which has replaced the built in component.

Upgrading an Auto Generated Custom Component

  1. In the HA UI go to "Configuration" -> "Integrations", select the PR Custom Component with title Tesla Component's ... menu and reload. This will automatically download the latest files from the Pull Request.
    1. If the switch for autoupdate is enabled, an update is automatically downloaded at the next refresh.
  2. Restart Home Assistant.

Uninstalling an Auto Generated Custom Component

This uses Tesla as an example.

  1. In the HA UI go to "Configuration" -> "Integrations", select the Tesla Component's ... menu and delete. This will uninstall the configured Tesla custom component from the HA instance.
  2. Select the PR Custom Component with title Tesla Component's ... menu and delete. This will delete custom files and restore the default).
  3. Restart Home Assistant.
  4. Hard refresh your browser

Component built with integration_blueprint.