Skip to content

Latest commit

 

History

History
35 lines (34 loc) · 2.16 KB

custom_updater.md

File metadata and controls

35 lines (34 loc) · 2.16 KB
Raw

Installing & Updating Custom Components & Python Scripts

The custom components and Python scripts in this repo can be installed manually or by using Custom Updater.

Manual Installation

See instructions provided on custom component's or Python script's doc page.

Custom Updater

custom_components.json and python_scripts.json provide the details Custom Updater needs. See Custom Updater Installation to install it.

Setup

Add the following to your configuration:

custom_updater:
  track:
    - components
    - python_scripts
  component_urls:
    - https://raw.githubusercontent.com/pnbruckner/homeassistant-config/master/custom_components.json
  python_script_urls:
    - https://raw.githubusercontent.com/pnbruckner/homeassistant-config/master/python_scripts.json

Home Assistant before 0.86

Use the following config for component_urls: instead:

  component_urls:
    - https://raw.githubusercontent.com/pnbruckner/homeassistant-config/master/custom_components_old.json

Installing

To install one of these custom components or Python scripts for the first time, use the custom_updater.install service with appropriate service data, such as:

{
  "element": "sensor.illuminance"
}

Updating

Once components/scripts are installed they can easily be updated using the Tracker card. If you're not using the Tracker card then you can use the custom_updater.update_all service.

NOTE: If you already have one or more of these custom components or Python scripts from before version numbers were added then they cannot be updated via the custom_updater.update_all service. In this case you will need to install them following the instructions above (as if they had not yet been installed. There should be no need to remove them first.)