Skip to content

Commit

Permalink
Remove info about dependency manipulation (#1480)
Browse files Browse the repository at this point in the history
This causes way more harm than help. We will no longer support this type of modification.
  • Loading branch information
dmulcahey committed Apr 9, 2022
1 parent 6baa04e commit d660948
Showing 1 changed file with 0 additions and 48 deletions.
48 changes: 0 additions & 48 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -535,54 +535,6 @@ def test_ts0121_signature(assert_signature_matches_quirk):
assert_signature_matches_quirk(zhaquirks.tuya.ts0121_plug.Plug, signature)
```

# Testing new releases

Testing a new release of the zha-quirks package before it is released in Home Assistant.

If you are using Supervised Home Assistant (formerly known as the Hassio/Hass.io distro):

- Add <https://github.com/home-assistant/hassio-addons-development> as "add-on" repository
- Install "Custom deps deployment" addon
- Update config like:

```yml
pypi:
- zha-quirks==0.0.38
apk: []
```

where 0.0.38 is the new version

- Start the addon

If you are instead using some custom python installation of Home Assistant then do this:

- Activate your python virtual env
- Update package with `pip`

```bash
pip install zha-quirks==0.0.38
```

# Testing quirks in development in docker based install

If you are using Supervised Home Assistant (formerly known as the Hassio/Hass.io distro) you will need to get access to the home-assistant docker container. Directions below are given for using the portainer add-on to do this, there are other methods as well not covered here.

- Install the portainer add-on (<https://github.com/hassio-addons/addon-portainer>) from Home Assistant Community Add-ons.
- Follow the add-on documentation to un-hide the home-assistant container (<https://github.com/hassio-addons/addon-portainer/blob/master/portainer/DOCS.md>)
- Stage the update quirk in a directory within your config directory
- Use portainer to access a console in the home-assistant container:

<img src="https://user-images.githubusercontent.com/11084412/88719260-fdfa7700-d0f0-11ea-8791-88ed3e26915d.png" width=400 >

- Access the quirks directory
- on HA > 0.113: /usr/local/lib/python3.8/site-packages/zhaquirks/
- on HA < 0.113: /usr/local/lib/python3.7/site-packages/zhaquirks/
- Copy updated/new quirk to zhaquirks directory: `cp -a /config/temp/NEW_QUIRK ./`
- Remove the **pycache** folder so it is regenerated `rm -rf ./__pycache__/`
- Close out the console and restart HA.
- Note: The added/update quirk will not survive a HA version update.

# Thanks

- Special thanks to damarco for the majority of the device tracker code
Expand Down

0 comments on commit d660948

Please sign in to comment.