From 714c1580c9428eabcfe673b72efee110fdcdc534 Mon Sep 17 00:00:00 2001 From: Jason Cheatham Date: Sat, 29 Feb 2020 09:51:58 -0500 Subject: [PATCH] Add a note about restarting home assistant --- README.md | 11 ++++++++++- info.md | 2 ++ 2 files changed, 12 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index d538ffb..16f2cd4 100644 --- a/README.md +++ b/README.md @@ -13,6 +13,7 @@ This integration uses [Hubitat’s](hubitat.com) [Maker API](https://docs.hubita * [Setup](#setup) * [Event server](#event-server) * [Device types](#device-types) +* [Updating](#updating) * [Developing](#developing) @@ -48,13 +49,15 @@ The following device types are currently supported. The first level bullets are ## Installation +Note that you will need to restart Home Assistant after installion, whichever method is used. + ### HACS Add this repository as a custom repository in HACS (Marketplace -> Settings). ### Manually -Clone this repository and copy the `hubitat` folder into your `/custom_components/` directory. Be sure to copy the entire directory, including the (possibly hidden) `.translations` subdirectory. +Clone this repository and copy the `custom_components/hubitat` folder into your `/custom_components/` directory (so you end up with `/custom_components/hubitat`). Be sure to copy the entire directory, including the (possibly hidden) `.translations` subdirectory. ## Setup @@ -77,6 +80,12 @@ To receive these events, the integration starts up a Python-based web server and The integration assigns Home Assistant device classes based on the capabilities reported by Hubitat. Sometimes the device type is ambiguous; a switchable outlet and a light switch may both only implement Hubitat’s [Switch](https://docs.hubitat.com/index.php?title=Driver_Capability_List#Switch) capability, and will therefore look like the same type of device to the integration. In some of these cases, the integration guesses the device class based on the device’s label (e.g., a switch named “Office Lamp” would be setup as a light in Home Assistant). This heuristic behavior is currently only used for lights and switches. +## Updating + +The update process depends on how the integration was installed. If it was installed with HACS, open the integration in HACS and click the “Upgrade” link. The process for manually updating is the same as for manual installation. + +Note that you will need to restart Home Assistant after updating, whichever method is used. + ## Developing To get setup for development, clone this repo and run `init.sh`. This script will setup the tools needed to validate typings and code style. Whenever you make a commit to the repo, validators will be automatically run. You can also run validators manually with pipenv: diff --git a/info.md b/info.md index 99c6b0d..f157ad8 100644 --- a/info.md +++ b/info.md @@ -5,3 +5,5 @@ This integration uses [Hubitat’s](hubitat.com) [Maker API](https://docs.hubitat.com/index.php?title=Hubitat™_Maker_API) to make Hubitat devices available for use with Home Assistant. Please see the [README](https://github.com/jason0x43/hacs-hubitat#hubitat-integration-for-home-assistant) for more details. + +Note that you will need to restart Home Assistant after installation.