+ 
+
+
+ Hass.io
(Beginner friendly)
+
+
+ (Beginner friendly)
+ 
+
+
+ On top of an existing Python 3.5+ installation
+
diff --git a/source/_docs/installation/virtualenv.markdown b/source/_docs/installation/virtualenv.markdown
index 0deb3349e45..a1b4c25c876 100644
--- a/source/_docs/installation/virtualenv.markdown
+++ b/source/_docs/installation/virtualenv.markdown
@@ -9,113 +9,39 @@ sharing: true
footer: true
redirect_from: /getting-started/installation-virtualenv/
---
--Beginners should check our [getting started guide](/getting-started/) first. + +If you already have Python 3.5 or later installed, you can easily give Home Assistant a spin. + +It's recommended when installing Python packages that you use a virtual environment. This will make sure that your Python installation and Home Assistant installation won't impact one another. + +_(If you're on a Debian based system, you will need to install Python virtual environment support using `apt-get install python3-pip python3-venv`)_ + + 1. Create a virtual environment: + ``` + python3 -m venv homeassistant + ``` + 2. Open virtual environment: + ``` + cd homeassistant + ``` + 3. Activate virtual environment: + ``` + source bin/activate + ``` + 4. Install Home Assistant: + ``` + python3 -m pip install --upgrade homeassistant + ``` + 5. Run Home Assistant: + ``` + hass --open-ui + ``` + +### {% linkable_title Notes %} + +- In the future, if you want to start Home Assistant again, follow step 2, 3 and 5. +- If you want to upgrade Home Assistant, follow step 2 and 3 and 4. + +
+Looking for more advanced guides? Check our available guides.
- -There are several reasons why it makes sense to run Home Assistant in a virtual environment. A [virtual environments (or short `venv`)](https://docs.python.org/3.6/library/venv.html) encapsulates all aspect of a Python environment within a single directory tree. That means the Python packages you install for Home Assistant won't interact with the rest of your system and vice-versa. It means a random upgrade for some other program on your computer won't break Home Assistant, and it means you don't need to install Python packages as root. - -Virtual environments are pretty easy to setup. We'll be using Debian in this example (as many Home Assistant users are running Raspbian on a Raspberry Pi), but all of the Python related steps should be the same on just about any platform. - -### {% linkable_title Basic guide %} - -The basic guide is for testing Home Assistant. Also check the advanced guide for instances used in production. - -## {% linkable_title Step 1: Install dependencies %} - -```bash -$ sudo apt-get update -$ sudo apt-get upgrade -$ sudo apt-get install python3-pip python3-dev python3-venv -$ sudo pip3 install --upgrade virtualenv -``` - -## {% linkable_title Step 2: Setup virtualenv %} - -```bash -$ python3 -m venv $HOME/homeassistant -``` - -## {% linkable_title Step 3: Install or update Home Assistant %} - -```bash -$ source $HOME/homeassistant/bin/activate -(homeassistant)$ pip3 install --upgrade homeassistant -``` - -## {% linkable_title Step 4: Run Home Assistant %} - -```bash -$ $HOME/homeassistant/bin/hass -``` - -### {% linkable_title Advanced guide %} -## {% linkable_title Separate user & group for Home Assistant (Basic guide step 2) %} - -It's a good idea to give services like Home Assistant their own user. It gives you more granular control over permissions, and reduces the exposure to the rest of your system in the event there is a security related bug in Home Assistant. This is a reasonably Linux oriented step, and will look different on other operating systems (or even other Linux distributions). - -```bash -$ sudo adduser --system homeassistant -$ sudo addgroup homeassistant -``` - -Home Assistant stores its configuration in `$HOME/.homeassistant` by default, so in this case, it would be in `/home/homeassistant/.homeassistant`. - -If you plan to use a Z-Wave controller, you will need to add this user to the `dialout` group: - -```bash -$ sudo usermod -G dialout -a homeassistant -``` - -## {% linkable_title Custom installation directory for Home Assistant (Basic guide step 2) %} - -This can be anywhere you want. We chose to put it in `/srv`. You also need to change the ownership of the directory to the user you created above. - -```bash -$ sudo mkdir /srv/homeassistant -$ sudo chown homeassistant:homeassistant /srv/homeassistant -``` - -Switching to your `homeassistant` user is obviously only necessary if you created a `homeassistant` user, but if you did, be sure to switch to that user whenever you install things in your virtual environment, otherwise you'll end up with mucked up permissions. - -```bash -$ sudo su -s /bin/bash homeassistant -``` - -The `su` command means 'switch' user. We use the '-s' flag because the `homeassistant` user is a system user and doesn't have a default shell by default (to prevent attackers from being able to log in as that user). - -Now, you can setup your virtual environment. - -```bash -$ python3 -m venv /srv/homeassistant -``` - -## {% linkable_title Install or update Home Assistant %} - -With [`pip`](https://pip.pypa.io/en/stable/quickstart/) you are now able to install Home Assistant in your virtual environment. - -```bash -$ source /srv/homeassistant/bin/activate -(homeassistant)$ pip3 install homeassistant -``` - -Or updating: - -```bash -$ source /srv/homeassistant/bin/activate -(homeassistant)$ pip3 install --upgrade homeassistant -``` - -## {% linkable_title Run Home Assistant (Basic guide step 4) %} - -There are two ways to launch Home Assistant. If you are **in** the virtual environment, you can just run `hass` and it will work as normal. If the virtual environment is not activated, you just use the `hass` executable in the `bin` directory mentioned earlier. There is one caveat. Because Home Assistant stores its configuration in the user's home directory, we need to be the user `homeassistant` or specify the configuration with `-c`. - -```bash -$ sudo -u homeassistant -H /srv/homeassistant/bin/hass -``` - -The `-H` flag is important. It sets the `$HOME` environment variable to `/home/homeassistant` so `hass` can find its configuration. - -## {% linkable_title Starting Home Assistant on boot %} - -The [autostart instructions](/getting-started/autostart/) will work just fine, just be sure to replace `/usr/bin/hass` with `/srv/homeassistant/bin/hass` and specify the `homeassistant` user where appropriate. diff --git a/source/_posts/2017-12-17-introducing-home-assistant-cloud.markdown b/source/_posts/2017-12-17-introducing-home-assistant-cloud.markdown new file mode 100644 index 00000000000..8a8aaa10fc1 --- /dev/null +++ b/source/_posts/2017-12-17-introducing-home-assistant-cloud.markdown @@ -0,0 +1,61 @@ +--- +layout: post +title: Introducing Home Assistant Cloud +description: "Use Alexa to control any device that is connected to Home Assistant." +date: 2017-12-17 03:00:00 +date_formatted: "December 17, 2017" +author: Paulus Schoutsen +author_twitter: balloob +comments: true +categories: Announcements +--- + +Today we’re introducing the next step in the Home Assistant saga: the Home Assistant Cloud. The goal of the Home Assistant Cloud is to bridge the gap between your local Home Assistant instance and services in the cloud while delivering the maximum possible security and privacy. + +The first service that is supported via the Home Assistant Cloud is the Amazon Alexa Smart Home skill. This integration will allow you to control all your devices in Home Assistant via Amazon Alexa. You will be able to say _“Alexa, turn on the kitchen lights”_ and your local Home Assistant will turn on the lights. Because Alexa talks to Home Assistant, it doesn’t matter what kind of lights they are! Anything that is linked to Home Assistant will work. IKEA lights, a 10 year old X10 switch or something you’ve made yourself. As long as Home Assistant can control it, you can control it via Alexa. + +We have designed the Home Assistant Cloud with security in mind. When you activate the new Cloud component, your instance will setup a secure connection to the Home Assistant Cloud. Alexa will deliver messages to our cloud which we will forward to your local instance for processing. We just forward the response back to Alexa. This means that we do not have to store the state of your house in our cloud, we’re just the messenger! + +We are making the beta of the Home Assistant Cloud publicly available today. During the beta period the Home Assistant Cloud will be free to use. We are currently planning to run a beta till March 1, 2018 0:00 UTC. Once the beta ends, the Home Assistant Cloud will be part of our Community Support package which will run at $5 USD/month. + +By subscribing to the Community Support package you will show your support for the Home Assistant organization, its projects and its community. It will help fund development, cover our operating costs and gives you access to use Home Assistant Cloud. + +So if you ever felt like donating money to support the development of Home Assistant and Hass.io: sign up for the Home Assistant Cloud! + +### {% linkable_title Why not take donations? %} + +With donations you have to convince people to keep donating and it will be hard to plan around the amount of available money. The biggest concern is what do you do when there is not enough money. We could shut down the servers or again depend on the wallets of our developers. We could run Wikipedia style advertisements for donating, but those are even more annoying than running advertisements. + +## {% linkable_title Getting started %} + +Upgrade Home Assistant to 0.60 and enable the [`cloud`](/components/cloud/) and [`config`](/components/config/) components: + +```yaml +# Example configuration.yaml entry +cloud: +config: +``` + +Now restart Home Assistant and navigate to the configuration panel. It will offer a new cloud section. Here you can create an account and login. Once logged in, your instance will connect to the cloud. + +The next step is to configure Alexa. This can be done by enabling the Home Assistant skill for Alexa and link your Home Assistant cloud account. + +Once you’re done, ask Alexa to discover devices (“Alexa, discover devices”) and you are all set to control them: “Alexa, turn on <device name>”. + +## {% linkable_title FAQ %} + +**Will Home Assistant and Hass.io remain open source?** + +Yes. Yes. Yes! Home Assistant is the work of hundreds of developers all working together in creating something amazing. The only thing that will require a subscription is the optional cloud functionality. + +**What other features will come to the cloud?** + +We have a lot of ideas! We are not going to make any promises but here are some things that we’re looking into: + +- Google Home / Google Assistant Smart Home skill +- Allow easy linking of other cloud services to Home Assistant. No more local juggling with OAuth flows. For example, link your Fitbit account and the Fitbit component will show up in Home Assistant. +- Encrypted backups of your Hass.io data +- Text to speech powered by AWS Polly +- Generic HTTP cloud endpoint for people to send messages to their local instance. This will allow people to build applications on - top of the Home Assistant cloud. +- IFTTT integration +- Alexa shopping list integration diff --git a/source/_posts/2017-12-17-release-60.markdown b/source/_posts/2017-12-17-release-60.markdown new file mode 100644 index 00000000000..bb3ff0867f5 --- /dev/null +++ b/source/_posts/2017-12-17-release-60.markdown @@ -0,0 +1,356 @@ +--- +layout: post +title: "0.60: Beckhoff/TwinCAT, WebDav, Gearbest, iAlarm" +description: "Use Home Assistant for your production line or track prices and the stock market." +date: 2017-12-17 02:00:00 +date_formatted: "December 17, 2017" +author: Fabian Affolter +author_twitter: fabaff +comments: true +categories: Release-Notes +og_image: /images/blog/2017-12-0.60/components.png +--- + +
+
+The biggest change for 0.60 will be covered in a separate [blog post](/blog/2017/12/17/introducing-home-assistant-cloud/). Thus, we will keep it short here. Just one thing: This is the last release in 2017. We will be back to our bi-weekly release cycle in 2018.
+
+A big "Thank you" to all people who supported us to make this release possible.
+
+## {% linkable_title TwinCAT %}
+With the brand-new [ADS (automation device specification)][ads docs] component by [@stlehmann] allows you to hook Home Assistant into this fieldbus independent interface which is often used between Beckhoff devices running with TwinCAT.
+
+## {% linkable_title WebDav calendar %}
+Thanks to [@maxlaverse] Home Assistant support now [WebDav calendars][calendar.caldav docs].
+
+## {% linkable_title Tracking prices %}
+With the new [`gearbest` sensor][sensor.gearbest docs] there is now an additional sensor available to track the price of a product.
+
+## {% linkable_title Financial details %}
+Yahoo! has discontinued their financial service. To fill this gap we have now the [`alpha_vantage` sensor][sensor.alpha_vantage docs] which is intruded in this release and allows you to monitor the stock market.
+
+## {% linkable_title New Platforms %}
+
+- Add iAlarm support ([@RyuzakiKK] - [#10878]) ([alarm_control_panel.ialarm docs]) (new-platform)
+- Add Alpha Vantage sensor ([@fabaff] - [#10873]) ([sensor.alpha_vantage docs]) (new-platform)
+- Add ADS component ([@stlehmann] - [#10142]) ([ads docs]) ([binary_sensor.ads docs]) ([light.ads docs]) ([sensor.ads docs]) ([switch.ads docs]) (new-platform)
+- Gearbest sensor ([@HerrHofrat] - [#10556]) ([sensor.gearbest docs]) (new-platform)
+- Add Ziggo Mediabox XL media_player ([@b10m] - [#10514]) ([media_player.ziggo_mediabox_xl docs]) (new-platform)
+- Meraki AP Device tracker ([@masarliev] - [#10971]) ([device_tracker.meraki docs]) (new-platform)
+- Added Vera scenes ([@alanfischer] - [#10424]) ([vera docs]) ([scene.vera docs]) (new-platform)
+- Add support for Canary component and platforms ([@snjoetw] - [#10306]) ([canary docs]) ([camera.canary docs]) ([sensor.canary docs]) (new-platform)
+- Add support for Logitech UE Smart Radios. ([@GreenTurtwig] - [#10077]) ([media_player.ue_smart_radio docs]) (new-platform)
+- Added support for cover in tellstick ([@perfalk] - [#10858]) ([tellstick docs]) ([cover.tellstick docs]) (new-platform)
+- Add a caldav calendar component ([@maxlaverse] - [#10842]) ([calendar.caldav docs]) (new-platform)
+- Refactor hue to split bridge support from light platform ([@andreacampi] - [#10691]) ([hue docs]) ([light.hue docs]) (breaking change) (new-platform)
+
+## {% linkable_title Breaking Changes %}
+
+- Update snips to listen on new mqtt topic and utilize rawValue ([@tschmidty69] - [#11020]) ([snips docs]) (breaking change)
+- Refactor hue to split bridge support from light platform ([@andreacampi] - [#10691]) ([hue docs]) ([light.hue docs]) (breaking change) (new-platform)
+- Use luftdaten module ([@fabaff] - [#10970]) ([sensor.luftdaten docs]) (breaking change)
+- ISY994 sensor improvements ([@OverloadUT] - [#10805]) ([isy994 docs]) ([binary_sensor.isy994 docs]) (breaking change)
+- Homematic next ([@pvizeli] - [#11156]) ([homematic docs]) (breaking change)
+
+## {% linkable_title If you need help... %}
+
+...don't hesitate to use our very active [forums](https://community.home-assistant.io/) or join us for a little [chat](https://discord.gg/c5DvZ4e). The release notes have comments enabled but it's preferred if you use the former communication channels. Thanks.
+
+## {% linkable_title Reporting Issues %}
+
+Experiencing issues introduced by this release? Please report them in our [issue tracker](https://github.com/home-assistant/home-assistant/issues). Make sure to fill in all fields of the issue template.
+
+
+## {% linkable_title All changes %}
+
+- Update ecobee version to fix stack-trace issue ([@PhracturedBlue] - [#10894]) ([ecobee docs])
+- Pybotvac multi ([@raymccarthy] - [#10843]) ([neato docs])
+- More declarative timeout syntax for manual alarm control panel. ([@bonzini] - [#10738]) ([alarm_control_panel.manual docs]) ([alarm_control_panel.manual_mqtt docs])
+- Unpacking RESTful sensor JSON results into attributes. ([@nickovs] - [#10753]) ([sensor.rest docs])
+- Bump dev to 0.60.0.dev0 ([@fabaff] - [#10912])
+- Update eliqonline.py ([@molobrakos] - [#10914]) ([sensor.eliqonline docs])
+- Add iAlarm support ([@RyuzakiKK] - [#10878]) ([alarm_control_panel.ialarm docs]) (new-platform)
+- Correction of Samsung Power OFF behaviour ([@RiRomain] - [#10907]) ([media_player.samsungtv docs])
+- Add Alpha Vantage sensor ([@fabaff] - [#10873]) ([sensor.alpha_vantage docs]) (new-platform)
+- Don't repeat getting receiver name on each update / pushed to denonavr 0.5.5 ([@scarface-4711] - [#10915]) ([media_player.denonavr docs])
+- Add Min and Event Count Metrics To Prometheus ([@bah2830] - [#10530]) ([prometheus docs])
+- Update coveragerc ([@balloob] - [#10931])
+- Report availability of TP-Link smart sockets ([@DanNixon] - [#10933]) ([switch.tplink docs])
+- Set percent unit for battery level so that history displays properly; edited variable name for consistency ([@nbougues] - [#10932]) ([sensor.tesla docs])
+- Export climate status and target temperature to Prometheus ([@hudashot] - [#10919]) ([prometheus docs])
+- Tado ignore invalid devices ([@dasos] - [#10927]) ([climate.tado docs])
+- don't ignore voltage data if sensor data changed ([@PaulAnnekov] - [#10925]) ([xiaomi_aqara docs])
+- Add ADS component ([@stlehmann] - [#10142]) ([ads docs]) ([binary_sensor.ads docs]) ([light.ads docs]) ([sensor.ads docs]) ([switch.ads docs]) (new-platform)
+- Gearbest sensor ([@HerrHofrat] - [#10556]) ([sensor.gearbest docs]) (new-platform)
+- Add Ziggo Mediabox XL media_player ([@b10m] - [#10514]) ([media_player.ziggo_mediabox_xl docs]) (new-platform)
+- Generic thermostat initial_operation_mode ([@ziotibia81] - [#10690]) ([climate.generic_thermostat docs])
+- Use new build path for dev translations ([@armills] - [#10937])
+- Add option to set default hide if away for new devices ([@masarliev] - [#10762]) ([device_tracker docs])
+- Allow disabling the LEDs on TP-Link smart plugs ([@DanNixon] - [#10980]) ([switch.tplink docs])
+- Meraki AP Device tracker ([@masarliev] - [#10971]) ([device_tracker.meraki docs]) (new-platform)
+- Update tradfri.py ([@pvizeli] - [#10991]) ([light.tradfri docs])
+- webostv: Ensure source exists before use ([@OddBloke] - [#10959]) ([media_player.webostv docs])
+- Ensure Docker script files uses LF line endings to support Docker for Windows. ([@R1chardTM] - [#10067])
+- Added Vera scenes ([@alanfischer] - [#10424]) ([vera docs]) ([scene.vera docs]) (new-platform)
+- Fix Egardia alarm status shown as unknown after restart ([@jeroenterheerdt] - [#11010]) ([alarm_control_panel.egardia docs])
+- Handle OSError when forcibly turning off media_player.samsungtv ([@lwis] - [#10997]) ([media_player.samsungtv docs])
+- Shuffle support in Sonos ([@mar-schmidt] - [#10875]) ([media_player.sonos docs])
+- Add support for Canary component and platforms ([@snjoetw] - [#10306]) ([canary docs]) ([camera.canary docs]) ([sensor.canary docs]) (new-platform)
+- Ignore Sonos players with unknown hostnames ([@amelchio] - [#11013])
+- Support LIFX Mini products ([@amelchio] - [#10996]) ([light.lifx docs])
+- Update snips to listen on new mqtt topic and utilize rawValue ([@tschmidty69] - [#11020]) ([snips docs]) (breaking change)
+- Change default js version to auto ([@andrey-git] - [#10999])
+- Serialize mochad requests ([@mtreinish] - [#11029]) ([mochad docs]) ([light.mochad docs]) ([switch.mochad docs])
+- In dev mode expose only relevant sources ([@andrey-git] - [#11026])
+- Added force_update for REST sensor ([@foxel] - [#11016]) ([sensor.miflora docs]) ([sensor.mqtt docs]) ([sensor.rest docs])
+- Add support for Logitech UE Smart Radios. ([@GreenTurtwig] - [#10077]) ([media_player.ue_smart_radio docs]) (new-platform)
+- Make notify.html5 depend on config ([@balloob] - [#11052]) ([notify.html5 docs])
+- This change fixes the error `OSError: [WinError 193]` on Windows debuggers (i.e. PyCharm) ([@tringler] - [#11034])
+- Added support for cover in tellstick ([@perfalk] - [#10858]) ([tellstick docs]) ([cover.tellstick docs]) (new-platform)
+- Add a caldav calendar component ([@maxlaverse] - [#10842]) ([calendar.caldav docs]) (new-platform)
+- Add GPS coords to meraki ([@addelovein] - [#10998]) ([device_tracker.meraki docs])
+- Refactor hue to split bridge support from light platform ([@andreacampi] - [#10691]) ([hue docs]) ([light.hue docs]) (breaking change) (new-platform)
+- add custom bypass status to total connect ([@uchagani] - [#11042]) ([alarm_control_panel.totalconnect docs])
+- Volvo on call: Optional use of Scandinavian miles. Also add average fuel consumption property ([@molobrakos] - [#11051]) ([volvooncall docs]) ([sensor.volvooncall docs])
+- Allow tradfri to read the available state of the device ([@pvizeli] - [#11056]) ([light.tradfri docs])
+- Upgrade aiohttp to 2.3.6 ([@fabaff] - [#11079])
+- Upgrade yarl to 0.16.0 ([@fabaff] - [#11078])
+- Upgrade psutil to 5.4.2 ([@fabaff] - [#11083]) ([sensor.systemmonitor docs])
+- Upgrade youtube_dl to 2017.12.10 ([@fabaff] - [#11080]) ([media_extractor docs])
+- Upgrade shodan to 1.7.7 ([@fabaff] - [#11084]) ([sensor.shodan docs])
+- Update tellcore-net to 0.4 ([@pvizeli] - [#11087]) ([tellstick docs])
+- Bump pymusiccast to version 0.1.6 ([@jalmeroth] - [#11091]) ([media_player.yamaha_musiccast docs])
+- Use luftdaten module ([@fabaff] - [#10970]) ([sensor.luftdaten docs]) (breaking change)
+- Bump pyatv to 0.3.9 ([@postlund] - [#11104]) ([apple_tv docs])
+- Report availability for TP-Link smart bulbs ([@DanNixon] - [#10976]) ([light.tplink docs])
+- Fix incorrect comment. ([@emosenkis] - [#11111])
+- Update Warrant ([@balloob] - [#11101]) ([cloud docs])
+- Fixed typo in automation.py ([@ryanm101] - [#11116]) ([config.automation docs])
+- Add media position properties ([@pschmitt] - [#10076]) ([media_player.liveboxplaytv docs])
+- update pyripple ([@nkgilley] - [#11122]) ([sensor.ripple docs])
+- Skip HASS emulated Hue bridges from detection. ([@andreacampi] - [#11128]) ([hue docs])
+- Always consume the no_throttle keyword argument. ([@andreacampi] - [#11126])
+- Add problem device class ([@armills] - [#11130]) ([binary_sensor docs])
+- set default utc offset to 0 ([@pollett] - [#11114]) ([sensor.efergy docs])
+- Allow using more than one keyboard remote ([@BryanJacobs] - [#11061]) ([keyboard_remote docs])
+- ISY994 sensor improvements ([@OverloadUT] - [#10805]) ([isy994 docs]) ([binary_sensor.isy994 docs]) (breaking change)
+- Disable html5 notify dependency ([@balloob] - [#11135]) ([notify.html5 docs])
+- Upgrade Homematic ([@danielperna84] - [#11149]) ([homematic docs])
+- Fix X10 commands for mochad light turn on ([@mtreinish] - [#11146]) ([light.mochad docs])
+- Homematic next ([@pvizeli] - [#11156]) ([homematic docs]) (breaking change)
+- Resolve hostnames ([@pvizeli] - [#11160]) ([homematic docs])
+- Perform logbook filtering on the worker thread ([@armills] - [#11161]) ([logbook docs])
+- Don't connect to cloud if subscription expired ([@balloob] - [#11163]) ([cloud docs]) ([cloud.const docs])
+- Add install mode to homematic ([@pvizeli] - [#11164]) ([homematic docs])
+- convert alarmdecoder interface from async to sync ([@PhracturedBlue] - [#11168]) ([alarmdecoder docs])
+- Remove logging ([@cmsimike] - [#11173]) ([sensor.octoprint docs])
+- Revbump to SoCo 0.13 and add support for Night Sound and Speech Enhancement. ([@rbdixon] - [#10765]) ([media_player.sonos docs])
+
+[#10067]: https://github.com/home-assistant/home-assistant/pull/10067
+[#10076]: https://github.com/home-assistant/home-assistant/pull/10076
+[#10077]: https://github.com/home-assistant/home-assistant/pull/10077
+[#10142]: https://github.com/home-assistant/home-assistant/pull/10142
+[#10306]: https://github.com/home-assistant/home-assistant/pull/10306
+[#10424]: https://github.com/home-assistant/home-assistant/pull/10424
+[#10514]: https://github.com/home-assistant/home-assistant/pull/10514
+[#10530]: https://github.com/home-assistant/home-assistant/pull/10530
+[#10556]: https://github.com/home-assistant/home-assistant/pull/10556
+[#10690]: https://github.com/home-assistant/home-assistant/pull/10690
+[#10691]: https://github.com/home-assistant/home-assistant/pull/10691
+[#10738]: https://github.com/home-assistant/home-assistant/pull/10738
+[#10753]: https://github.com/home-assistant/home-assistant/pull/10753
+[#10762]: https://github.com/home-assistant/home-assistant/pull/10762
+[#10765]: https://github.com/home-assistant/home-assistant/pull/10765
+[#10805]: https://github.com/home-assistant/home-assistant/pull/10805
+[#10842]: https://github.com/home-assistant/home-assistant/pull/10842
+[#10843]: https://github.com/home-assistant/home-assistant/pull/10843
+[#10858]: https://github.com/home-assistant/home-assistant/pull/10858
+[#10873]: https://github.com/home-assistant/home-assistant/pull/10873
+[#10875]: https://github.com/home-assistant/home-assistant/pull/10875
+[#10878]: https://github.com/home-assistant/home-assistant/pull/10878
+[#10894]: https://github.com/home-assistant/home-assistant/pull/10894
+[#10907]: https://github.com/home-assistant/home-assistant/pull/10907
+[#10912]: https://github.com/home-assistant/home-assistant/pull/10912
+[#10914]: https://github.com/home-assistant/home-assistant/pull/10914
+[#10915]: https://github.com/home-assistant/home-assistant/pull/10915
+[#10919]: https://github.com/home-assistant/home-assistant/pull/10919
+[#10925]: https://github.com/home-assistant/home-assistant/pull/10925
+[#10927]: https://github.com/home-assistant/home-assistant/pull/10927
+[#10931]: https://github.com/home-assistant/home-assistant/pull/10931
+[#10932]: https://github.com/home-assistant/home-assistant/pull/10932
+[#10933]: https://github.com/home-assistant/home-assistant/pull/10933
+[#10937]: https://github.com/home-assistant/home-assistant/pull/10937
+[#10959]: https://github.com/home-assistant/home-assistant/pull/10959
+[#10970]: https://github.com/home-assistant/home-assistant/pull/10970
+[#10971]: https://github.com/home-assistant/home-assistant/pull/10971
+[#10976]: https://github.com/home-assistant/home-assistant/pull/10976
+[#10980]: https://github.com/home-assistant/home-assistant/pull/10980
+[#10991]: https://github.com/home-assistant/home-assistant/pull/10991
+[#10996]: https://github.com/home-assistant/home-assistant/pull/10996
+[#10997]: https://github.com/home-assistant/home-assistant/pull/10997
+[#10998]: https://github.com/home-assistant/home-assistant/pull/10998
+[#10999]: https://github.com/home-assistant/home-assistant/pull/10999
+[#11010]: https://github.com/home-assistant/home-assistant/pull/11010
+[#11013]: https://github.com/home-assistant/home-assistant/pull/11013
+[#11016]: https://github.com/home-assistant/home-assistant/pull/11016
+[#11020]: https://github.com/home-assistant/home-assistant/pull/11020
+[#11026]: https://github.com/home-assistant/home-assistant/pull/11026
+[#11029]: https://github.com/home-assistant/home-assistant/pull/11029
+[#11034]: https://github.com/home-assistant/home-assistant/pull/11034
+[#11042]: https://github.com/home-assistant/home-assistant/pull/11042
+[#11051]: https://github.com/home-assistant/home-assistant/pull/11051
+[#11052]: https://github.com/home-assistant/home-assistant/pull/11052
+[#11056]: https://github.com/home-assistant/home-assistant/pull/11056
+[#11061]: https://github.com/home-assistant/home-assistant/pull/11061
+[#11078]: https://github.com/home-assistant/home-assistant/pull/11078
+[#11079]: https://github.com/home-assistant/home-assistant/pull/11079
+[#11080]: https://github.com/home-assistant/home-assistant/pull/11080
+[#11083]: https://github.com/home-assistant/home-assistant/pull/11083
+[#11084]: https://github.com/home-assistant/home-assistant/pull/11084
+[#11087]: https://github.com/home-assistant/home-assistant/pull/11087
+[#11091]: https://github.com/home-assistant/home-assistant/pull/11091
+[#11101]: https://github.com/home-assistant/home-assistant/pull/11101
+[#11104]: https://github.com/home-assistant/home-assistant/pull/11104
+[#11111]: https://github.com/home-assistant/home-assistant/pull/11111
+[#11114]: https://github.com/home-assistant/home-assistant/pull/11114
+[#11116]: https://github.com/home-assistant/home-assistant/pull/11116
+[#11122]: https://github.com/home-assistant/home-assistant/pull/11122
+[#11126]: https://github.com/home-assistant/home-assistant/pull/11126
+[#11128]: https://github.com/home-assistant/home-assistant/pull/11128
+[#11130]: https://github.com/home-assistant/home-assistant/pull/11130
+[#11135]: https://github.com/home-assistant/home-assistant/pull/11135
+[#11146]: https://github.com/home-assistant/home-assistant/pull/11146
+[#11149]: https://github.com/home-assistant/home-assistant/pull/11149
+[#11156]: https://github.com/home-assistant/home-assistant/pull/11156
+[#11160]: https://github.com/home-assistant/home-assistant/pull/11160
+[#11161]: https://github.com/home-assistant/home-assistant/pull/11161
+[#11163]: https://github.com/home-assistant/home-assistant/pull/11163
+[#11164]: https://github.com/home-assistant/home-assistant/pull/11164
+[#11168]: https://github.com/home-assistant/home-assistant/pull/11168
+[#11173]: https://github.com/home-assistant/home-assistant/pull/11173
+[@BryanJacobs]: https://github.com/BryanJacobs
+[@DanNixon]: https://github.com/DanNixon
+[@GreenTurtwig]: https://github.com/GreenTurtwig
+[@HerrHofrat]: https://github.com/HerrHofrat
+[@OddBloke]: https://github.com/OddBloke
+[@OverloadUT]: https://github.com/OverloadUT
+[@PaulAnnekov]: https://github.com/PaulAnnekov
+[@PhracturedBlue]: https://github.com/PhracturedBlue
+[@R1chardTM]: https://github.com/R1chardTM
+[@RiRomain]: https://github.com/RiRomain
+[@RyuzakiKK]: https://github.com/RyuzakiKK
+[@addelovein]: https://github.com/addelovein
+[@alanfischer]: https://github.com/alanfischer
+[@amelchio]: https://github.com/amelchio
+[@andreacampi]: https://github.com/andreacampi
+[@andrey-git]: https://github.com/andrey-git
+[@armills]: https://github.com/armills
+[@b10m]: https://github.com/b10m
+[@bah2830]: https://github.com/bah2830
+[@balloob]: https://github.com/balloob
+[@bonzini]: https://github.com/bonzini
+[@cmsimike]: https://github.com/cmsimike
+[@danielperna84]: https://github.com/danielperna84
+[@dasos]: https://github.com/dasos
+[@emosenkis]: https://github.com/emosenkis
+[@fabaff]: https://github.com/fabaff
+[@foxel]: https://github.com/foxel
+[@hudashot]: https://github.com/hudashot
+[@jalmeroth]: https://github.com/jalmeroth
+[@jeroenterheerdt]: https://github.com/jeroenterheerdt
+[@lwis]: https://github.com/lwis
+[@mar-schmidt]: https://github.com/mar-schmidt
+[@masarliev]: https://github.com/masarliev
+[@maxlaverse]: https://github.com/maxlaverse
+[@molobrakos]: https://github.com/molobrakos
+[@mtreinish]: https://github.com/mtreinish
+[@nbougues]: https://github.com/nbougues
+[@nickovs]: https://github.com/nickovs
+[@nkgilley]: https://github.com/nkgilley
+[@perfalk]: https://github.com/perfalk
+[@pollett]: https://github.com/pollett
+[@postlund]: https://github.com/postlund
+[@pschmitt]: https://github.com/pschmitt
+[@pvizeli]: https://github.com/pvizeli
+[@raymccarthy]: https://github.com/raymccarthy
+[@rbdixon]: https://github.com/rbdixon
+[@ryanm101]: https://github.com/ryanm101
+[@scarface-4711]: https://github.com/scarface-4711
+[@snjoetw]: https://github.com/snjoetw
+[@stlehmann]: https://github.com/stlehmann
+[@tringler]: https://github.com/tringler
+[@tschmidty69]: https://github.com/tschmidty69
+[@uchagani]: https://github.com/uchagani
+[@ziotibia81]: https://github.com/ziotibia81
+[ads docs]: https://home-assistant.io/components/ads/
+[alarm_control_panel.egardia docs]: https://home-assistant.io/components/alarm_control_panel.egardia/
+[alarm_control_panel.ialarm docs]: https://home-assistant.io/components/alarm_control_panel.ialarm/
+[alarm_control_panel.manual docs]: https://home-assistant.io/components/alarm_control_panel.manual/
+[alarm_control_panel.manual_mqtt docs]: https://home-assistant.io/components/alarm_control_panel.manual_mqtt/
+[alarm_control_panel.totalconnect docs]: https://home-assistant.io/components/alarm_control_panel.totalconnect/
+[alarmdecoder docs]: https://home-assistant.io/components/alarmdecoder/
+[apple_tv docs]: https://home-assistant.io/components/apple_tv/
+[binary_sensor docs]: https://home-assistant.io/components/binary_sensor/
+[binary_sensor.ads docs]: https://home-assistant.io/components/binary_sensor.ads/
+[binary_sensor.isy994 docs]: https://home-assistant.io/components/binary_sensor.isy994/
+[calendar.caldav docs]: https://home-assistant.io/components/calendar.caldav/
+[camera.canary docs]: https://home-assistant.io/components/camera.canary/
+[canary docs]: https://home-assistant.io/components/canary/
+[climate.generic_thermostat docs]: https://home-assistant.io/components/climate.generic_thermostat/
+[climate.tado docs]: https://home-assistant.io/components/climate.tado/
+[cloud docs]: https://home-assistant.io/components/cloud/
+[cloud.const docs]: https://home-assistant.io/components/cloud.const/
+[config.automation docs]: https://home-assistant.io/components/config.automation/
+[cover.tellstick docs]: https://home-assistant.io/components/cover.tellstick/
+[device_tracker docs]: https://home-assistant.io/components/device_tracker/
+[device_tracker.meraki docs]: https://home-assistant.io/components/device_tracker.meraki/
+[ecobee docs]: https://home-assistant.io/components/ecobee/
+[homematic docs]: https://home-assistant.io/components/homematic/
+[hue docs]: https://home-assistant.io/components/hue/
+[isy994 docs]: https://home-assistant.io/components/isy994/
+[keyboard_remote docs]: https://home-assistant.io/components/keyboard_remote/
+[light.ads docs]: https://home-assistant.io/components/light.ads/
+[light.hue docs]: https://home-assistant.io/components/light.hue/
+[light.lifx docs]: https://home-assistant.io/components/light.lifx/
+[light.mochad docs]: https://home-assistant.io/components/light.mochad/
+[light.tplink docs]: https://home-assistant.io/components/light.tplink/
+[light.tradfri docs]: https://home-assistant.io/components/light.tradfri/
+[logbook docs]: https://home-assistant.io/components/logbook/
+[media_extractor docs]: https://home-assistant.io/components/media_extractor/
+[media_player.denonavr docs]: https://home-assistant.io/components/media_player.denonavr/
+[media_player.liveboxplaytv docs]: https://home-assistant.io/components/media_player.liveboxplaytv/
+[media_player.samsungtv docs]: https://home-assistant.io/components/media_player.samsungtv/
+[media_player.sonos docs]: https://home-assistant.io/components/media_player.sonos/
+[media_player.ue_smart_radio docs]: https://home-assistant.io/components/media_player.ue_smart_radio/
+[media_player.webostv docs]: https://home-assistant.io/components/media_player.webostv/
+[media_player.yamaha_musiccast docs]: https://home-assistant.io/components/media_player.yamaha_musiccast/
+[media_player.ziggo_mediabox_xl docs]: https://home-assistant.io/components/media_player.ziggo_mediabox_xl/
+[mochad docs]: https://home-assistant.io/components/mochad/
+[neato docs]: https://home-assistant.io/components/neato/
+[notify.html5 docs]: https://home-assistant.io/components/notify.html5/
+[prometheus docs]: https://home-assistant.io/components/prometheus/
+[scene.vera docs]: https://home-assistant.io/components/scene.vera/
+[sensor.ads docs]: https://home-assistant.io/components/sensor.ads/
+[sensor.alpha_vantage docs]: https://home-assistant.io/components/sensor.alpha_vantage/
+[sensor.canary docs]: https://home-assistant.io/components/sensor.canary/
+[sensor.efergy docs]: https://home-assistant.io/components/sensor.efergy/
+[sensor.eliqonline docs]: https://home-assistant.io/components/sensor.eliqonline/
+[sensor.gearbest docs]: https://home-assistant.io/components/sensor.gearbest/
+[sensor.luftdaten docs]: https://home-assistant.io/components/sensor.luftdaten/
+[sensor.miflora docs]: https://home-assistant.io/components/sensor.miflora/
+[sensor.mqtt docs]: https://home-assistant.io/components/sensor.mqtt/
+[sensor.octoprint docs]: https://home-assistant.io/components/sensor.octoprint/
+[sensor.rest docs]: https://home-assistant.io/components/sensor.rest/
+[sensor.ripple docs]: https://home-assistant.io/components/sensor.ripple/
+[sensor.shodan docs]: https://home-assistant.io/components/sensor.shodan/
+[sensor.systemmonitor docs]: https://home-assistant.io/components/sensor.systemmonitor/
+[sensor.tesla docs]: https://home-assistant.io/components/sensor.tesla/
+[sensor.volvooncall docs]: https://home-assistant.io/components/sensor.volvooncall/
+[snips docs]: https://home-assistant.io/components/snips/
+[switch.ads docs]: https://home-assistant.io/components/switch.ads/
+[switch.mochad docs]: https://home-assistant.io/components/switch.mochad/
+[switch.tplink docs]: https://home-assistant.io/components/switch.tplink/
+[tellstick docs]: https://home-assistant.io/components/tellstick/
+[vera docs]: https://home-assistant.io/components/vera/
+[volvooncall docs]: https://home-assistant.io/components/volvooncall/
+[xiaomi_aqara docs]: https://home-assistant.io/components/xiaomi_aqara/
diff --git a/source/developers/development_environment.markdown b/source/developers/development_environment.markdown
index dcc8bfde1f7..0ff14d5c567 100644
--- a/source/developers/development_environment.markdown
+++ b/source/developers/development_environment.markdown
@@ -85,21 +85,23 @@ $ git remote add upstream https://github.com/home-assistant/home-assistant.git
### {% linkable_title Setting up virtual environment %}
-If you plan on providing isolation to your environment using [`venv`](https://docs.python.org/3.4/library/venv.html). Within the `home-assistant` directory, create and activate your virtual environment.
+To isolate your environment from the rest of the system, set up a [`venv`](https://docs.python.org/3.4/library/venv.html). Within the `home-assistant` directory, create and activate your virtual environment.
```bash
-$ python3 -m venv venv
-$ source venv/bin/activate
+$ python3 -m venv .
+$ source bin/activate
```
-
-### {% linkable_title Setup and Run %}
+Install the requirements with a provided script named `setup`.
```bash
-$ cd home-assistant
$ script/setup
```
-* Run `hass` to invoke your local installation.
+Invoke your installation.
+
+```bash
+$ hass
+```
### {% linkable_title Logging %}
diff --git a/source/getting-started/configuration.markdown b/source/getting-started/configuration.markdown
index 360ef56f009..5814b3c1cb1 100644
--- a/source/getting-started/configuration.markdown
+++ b/source/getting-started/configuration.markdown
@@ -9,19 +9,59 @@ sharing: true
footer: true
---
-When launched for the first time, Home Assistant will write a default configuration file, called `configuration.yaml`, enabling the web interface and [device discovery](/components/discovery/). It can take up to a minute for your devices to be discovered and appear in the user interface.
+If you made it here, awesome! That means that you got Home Assistant up and running. It might have already found some of your networked devices. This is going to be fun!
-The `configuration.yaml` is written in [YAML](/docs/configuration/yaml/), stored in [`.homeassistant`](/docs/configuration/), and can be modified with a text editor.
+Home Assistant stores its configuration in a file called `configuration.yaml`. A default one is created when Home Assistant is started for the first time. Some of the things in the configuration file can be edited via the user interface, other parts require you to edit the configuration file directly.
-See the [components overview page](/components/) to find sample entries for your devices and services. For a sensor that is showing [random values](/components/sensor.random/), the entry would look like the sample below:
+There are two common approaches to edit your configuration: via Samba/Windows Networking and via the HASS Configurator. Both of these are [official add-ons for Hass.io](/addons/).
+
+## {% linkable_title Installing Hass.io add-ons %}
+
+Hass.io add-ons are installed from the add-on store embedded in the Hass.io panel:
+
+ - Open Home Assistant by navigating to [http://hassio.local:8123][local].
+ - Click on the menu icon in the top left and select Hass.io in the sidebar.
+ - The Hass.io panel opens, now open the add-on store by clicking the shopping bag.
+
+[local]: http://hassio.local:8123
+
+
+
+From the Hass.io main panel open the add-on store.
+
YAML can be a little daunting at first. A lot is possible! [Here is some more info.](/docs/configuration/devices/)
### [Next step: Automate Home Assistant »](/getting-started/automation/) diff --git a/source/getting-started/index.markdown b/source/getting-started/index.markdown index 6c15f7caac3..79d410fb25f 100644 --- a/source/getting-started/index.markdown +++ b/source/getting-started/index.markdown @@ -9,30 +9,39 @@ sharing: true footer: true --- -First you will need to install Home Assistant before we can get started: +The goal of this getting started guide is to install Hass.io on a Raspberry Pi 3. Hass.io is our own all in one solution that turns your Raspberry PI into the utlimate home automation hub. -We have developed **Hass.io** to turn your device into a dedicated Home Assistant hub controlled by a nice webinterface. -For Raspberry Pi and Intel NUC we offer configured images. Flash the image, setup WiFi (if required) and everything else can be done inside the Hass.io webinterface. Great, isn't it? +Follow this guide if you want to easily get started with Home Assistant or if you have none or little Linux experience. For advanced users, check our [alternative installation methods](/docs/installation/). -Also Home Assistant runs on any other device that supports **Python 3**. -
-
-
-
-
-
-
- Install Home Assistant using Hass.io
-
-
-
-
-
-
- Install Home Assistant on your computer
-
-+### {% linkable_title Hardware requirements %} -For alternative installation methods, please take a look at the [installation documentation](/docs/installation/). +We will need a few things to get started with installing Home Assistant. Links below are linking to Amazon US. If you're not in the US, you should be able to find these items in web stores in your country. -If you run into any issues, please see [the troubleshooting page](/docs/installation/troubleshooting/) or [communication channels](/help/). It contains solutions to many commonly encountered issues. + - [Raspberry Pi 3 model B](http://a.co/gEfMqL4) + [Power Supply](http://a.co/cgKUgkt) (atleast 2.5A) + - [Micro SD Card](http://a.co/gslOydD). Get one that is Class 10 as they are more reliable. Size 32GB or bigger recommended. + - SD Card reader. Part of most laptops. Also available as [standalone USB sticks](http://a.co/5FCyb0N) (brand doesn't matter, just pick cheapest) + - Ethernet cable (optional, Hass.io can work with WiFi too) + +### {% linkable_title Software requirements %} + + - Download [Hass.io image for Raspberry Pi 3][pi3] + - Download [Etcher] to write the image to an SD card + - Text Editor like [Visual Studio Code](https://code.visualstudio.com/) + +[Etcher]: https://etcher.io/ +[pi3]: https://github.com/home-assistant/hassio-build/releases/download/1.1/resinos-hassio-1.1-raspberrypi3.img.bz2 + +### Installing Hass.io + + 1. Put the SD card in your SD card reader, + 2. Open Etcher, select the Hass.io image and flash it to the SD card. + 3. WiFi setup only: open the file `system-connections/resin-sample` with a text editor. Change `ssid` to be your network name and `psk` to be your password. + 4. Unmount the SD card and remove it from your SD card reader. + 5. Insert the SD card into your Raspberry Pi 3. If you are going to use an Ethernet cable to supply Internet, connect that too. + 6. Connect your Raspberry Pi to the power supply so it turns on. + 7. The Raspberry Pi will now boot up, connect to the Internet and download the latest version of Home Assistant. This will take about 20 minutes. + 8. Home Assistant will be available at [http://hassio.local:8123][local]. + +[local]: http://hassio.local:8123 ### [Next step: Configuring Home Assistant »](/getting-started/configuration/) diff --git a/source/images/blog/2017-12-0.60/components.png b/source/images/blog/2017-12-0.60/components.png new file mode 100644 index 00000000000..8f82d418023 Binary files /dev/null and b/source/images/blog/2017-12-0.60/components.png differ diff --git a/source/images/supported_brands/gearbest.png b/source/images/supported_brands/gearbest.png new file mode 100644 index 00000000000..d9789055083 Binary files /dev/null and b/source/images/supported_brands/gearbest.png differ diff --git a/source/index.html b/source/index.html index bbb78b9dc34..a847b2632b9 100644 --- a/source/index.html +++ b/source/index.html @@ -33,6 +33,14 @@ description: Open-source home automation platform running on Python 3. Track and Chat
