Follow the setup process using your phone and Mi-Home app. From here you will be able to retrieve the key (password) from within the app following this tutorial.
To enable Xiaomi Gateway (Aqara) in your installation, add the following to your configuration.yaml file:
# You can leave mac empty if you only have one gateway.
+# You can leave MAC empty if you only have one gateway.
xiaomi_aqara:
discovery_retry: 5
gateways:
@@ -118,7 +118,7 @@
Multiple Gateways
-# 12 characters mac can be obtained from the gateway.
+# 12 characters MAC can be obtained from the gateway.
xiaomi_aqara:
gateways:
- mac: xxxxxxxxxxxx
@@ -159,13 +159,13 @@
host
- (string)(Optional)The host / ip address of the gateway. If this parameter is used the multicast discovery of the gateway is skipped.
+ (string)(Optional)The host/IP address of the gateway. If this parameter is used the multicast discovery of the gateway is skipped.
Services
The gateway provides the following services:
- Service xiaomi_aqara.play_ringtone
+ Service xiaomi_aqara.play_ringtone
Play a specific ringtone. The version of the gateway firmware must be 1.4.1_145 at least. Take a look at the examples below.
@@ -232,7 +232,7 @@
Custom ringtones (uploaded by the Mi Home app) starting from 10001
- Service xiaomi_aqara.stop_ringtone
+ Service xiaomi_aqara.stop_ringtone
Stops a playing ringtone immediately.
@@ -250,7 +250,7 @@
- Service xiaomi_aqara.add_device
+ Service xiaomi_aqara.add_device
@@ -267,7 +267,7 @@
- Service xiaomi_aqara.add_device
+ Service xiaomi_aqara.add_device
Enables the join permission of the Xiaomi Aqara Gateway for 30 seconds. A new device can be added afterwards by pressing the pairing button once.
@@ -285,7 +285,7 @@
- Service xiaomi_aqara.remove_device
+ Service xiaomi_aqara.remove_device
Removes a specific device. The removal is required if a device shall be paired with another gateway.
@@ -310,7 +310,7 @@
Examples
Long Press on Smart Button
-This example plays the sound of a dog barking when the button is held down, and stops the sound when the button is pressed once.
+This example plays the sound of a dog barking when the button is held down and stops the sound when the button is pressed once.
Note: The sound will stop playing automatically when it has ended.
- alias: Let a dog bark on long press
trigger:
@@ -341,7 +341,7 @@
Troubleshooting
Initial setup problem
-If you run into trouble initializing the gateway with your app, try another smartphone. I had trouble with the OnePlus 3, but it worked with a Nexus 5.
+If you run into trouble initializing the gateway with your app, try another smartphone. E.g., it didn’t work on an OnePlus 3, but it worked with a Nexus 5.
Connection problem
2017-08-20 16:51:19 ERROR (SyncWorker_0) [homeassistant.components.xiaomi] No gateway discovered
2017-08-20 16:51:20 ERROR (MainThread) [homeassistant.setup] Setup failed for xiaomi: Component failed to initialize.
@@ -351,14 +351,14 @@
- Make sure you have enabled LAN access.
- Turn off the firewall on the system where Home Assistant is running.
- - Ensure your router supports multicast as this is a requirement of the Xiaomi GW
+ - Ensure your router supports multicast as this is a requirement of the Xiaomi Gateway.
- Try to leave the MAC address
mac: blank.
- Try to set
discovery_retry: 10.
- Try to disable and then enable LAN access.
- Hard reset the gateway: Press the button of the gateway 30 seconds and start again from scratch.
- If you are using Home Assistant in Docker, make sure to use
--net=host.
- If you receive an
{"error":"Invalid key"} in your log while trying to control the gateway light, you should generate the key again using an Android Phone or alternativly an emulator such as bluestacks. In some instances there is an issue with keys being generated using the iOS application.
- - If the required library “PyXiaomiGateway” cannot be installed you will need to install some missing system dependencies
python3-dev, libssl-dev, libffi-dev manually (e.g. sudo apt-get install python3-dev libssl-dev libffi-dev).
+ - If the required library “PyXiaomiGateway” cannot be installed you will need to install some missing system dependencies
python3-dev, libssl-dev, libffi-dev manually (e.g., $ sudo apt-get install python3-dev libssl-dev libffi-dev).
diff --git a/docs/installation/raspberry-pi-all-in-one/index.html b/docs/installation/raspberry-pi-all-in-one/index.html
index 97d1a2a010..e6a75772a1 100644
--- a/docs/installation/raspberry-pi-all-in-one/index.html
+++ b/docs/installation/raspberry-pi-all-in-one/index.html
@@ -75,109 +75,9 @@
- The Raspberry Pi All-In-One Installer deploys a complete Home Assistant server including support for MQTT with websockets, Z-Wave, and the OpenZWave Control Panel.
-
-Please remember to ensure you’re using an appropriate power supply with your Pi. Mobile chargers may not be suitable, since some are designed to only provide the full power with that manufacturer’s handsets.
+
+ The All-In-One Installer is deprecated, you will have problems updating Home Assistant in 2018. Please move to another installation method.
-The only requirement is that you have a Raspberry Pi with a fresh installation of Raspbian Jessie (Stretch is not supported at this time) connected to your network.
-
-Note that as of 2016-11-30 SSH is disabled by default in the official Raspbian images. Adding an empty file called ssh to /boot/ on the FAT32 partition will enable it. More information is on the Raspberry Pi Foundation Blog.
-
-Irrespective of whether you use SSH to connect to the Pi from another computer or not, you need SSH to install Home Assistant. So go ahead and enable SSH.
-
- - Login to Raspberry Pi. For example with
ssh pi@your_raspberry_pi_ip
- - Run the following command:
-
-
- This command is a one-liner and not run as sudo.
-
-$ curl -O https://raw.githubusercontent.com/home-assistant/fabric-home-assistant/master/hass_rpi_installer.sh && sudo chown pi:pi hass_rpi_installer.sh && bash hass_rpi_installer.sh
-
-
-Installation will take approx. 1-2 hours depending on the Raspberry Pi model the installer is being run against. The installer will identitfy what Raspberry Pi hardware revision you are using and adjust commands accordingly. A complete log of the install is located at: /home/pi/fabric-home-assistant/installation_report.txt The installer has been updated to simply log any errors encountered, but resume installing. Please consult the “installation report” if your install encountered issues.
-BRUH automation has created a tutorial video explaining how to install Raspbian on your Raspberry Pi and install Home Assistant using the All-In-One Installer.
-Once rebooted, your Raspberry Pi will be up and running with Home Assistant. You can access it at http://your_raspberry_pi_ip:8123.
-The Home Assistant configuration is located at /home/homeassistant/.homeassistant (or /home/hass/.homeassistant if installed prior to December 2016). The virtualenv with the Home Assistant installation is located at /srv/homeassistant/homeassistant_venv. As part of the secure installation, a new user (homeassistant) is added to your Raspberry Pi to run Home Assistant. This is a system account and does not have login or other abilities by design. When editing your configuration.yaml files, you will need to run the commands with sudo or by switching user.
-
- Windows users: Setting up WinSCP to allow this seemlessly is at the end of this page.
-
-By default, installation makes use of a Python Virtualenv. If you wish to not follow this recommendation, you may add the flag -n to the end of the install command specified above.
-The All-In-One Installer script will do the following automatically:
-
- - Create all needed directories
- - Create needed service accounts
- - Install OS and Python dependencies
- - Setup a python virtualenv to run Home Assistant and components inside.
- - Run as
homeassistant service account
- - Install Home Assistant in a virtualenv
- - Install Mosquitto with websocket support running on ports 1883 and 9001
- - Build and Install Python-openzwave in the Home Assistant virtualenv
- - Build OpenZWave Control Panel in
/srv/homeassistant/src/open-zwave-control-panel
- - Add Home Assistant to systemd services to start at boot
-
- Upgrading
-To upgrade the All-In-One setup manually:
-
- - Login to Raspberry Pi
ssh pi@your_raspberry_pi_ip
- - Change to homeassistant user
sudo su -s /bin/bash homeassistant
- - Change to virtual environment
source /srv/homeassistant/homeassistant_venv/bin/activate
- - Update Home Assistant
pip3 install --upgrade homeassistant
- - Type
exit to logout the hass user and return to the pi user.
-
-
- If you deployed Home Assistant via the AiO installer prior to December 2016
-
- - Login to Raspberry Pi
ssh pi@your_raspberry_pi_ip
- - Change to homeassistant user
sudo su -s /bin/bash hass
- - Change to virtual environment
source /srv/hass/hass_venv/bin/activate
- - Update Home Assistant
pip3 install --upgrade homeassistant
- - Type
exit to logout the hass user and return to the pi user.
-
-
-After upgrading, you can restart Home Assistant a few different ways:
-
- - Restarting the Raspberry Pi
sudo reboot
- - Restarting the Home-Assistant Service
sudo systemctl restart home-assistant.service
-
- To change the MQTT default password
-
- - Login to Raspberry Pi
ssh pi@your_raspberry_pi_ip
- - Change password
sudo mosquitto_passwd /etc/mosquitto/pwfile pi
- - Restart mosquitto
sudo systemctl restart mosquitto.service
- - Be sure to update your
configuration.yaml to reflect the new password.
-
- Using the OZWCP web application
-To launch the OpenZWave Control Panel (OZWCP) web application:
-
- - Make sure Home Assistant is not running! So stop that first
- - Login to Raspberry Pi
ssh pi@your_raspberry_pi_ip
- - Change to the OZWCP directory
cd /srv/homeassistant/src/open-zwave-control-panel/
- - Launch the control panel
sudo ./ozwcp -p 8888
- - Open a web browser to
http://your_pi_ip:8888
- - Specify your Z-Wave controller, for example
/dev/ttyACM0 and hit initialize
-
-
- If OZWCP is running really slow verify that your not running Home Assistant or have another page running OZWCP open or strange errors might occur.
-
-
- If you deployed Home Assistant via the AiO installer prior to December 2016
-
- - Make sure Home Assistant is not running! So stop that first
- - Login to Raspberry Pi
ssh pi@your_raspberry_pi_ip
- - Change to the OZWCP directory
cd /srv/hass/src/open-zwave-control-panel/
- - Launch the control panel
sudo ./ozwcp -p 8888
- - Open a web browser to
http://your_pi_ip:8888
- - Specify your Z-Wave controller, for example
/dev/ttyACM0 and hit initialize
-
-
-
-Don’t check the USB box regardless of using a USB based device.
-
- Using the GPIOs
-The (homeassistant) user is added to the GPIO group as part of the install now.
- WinSCP
-If you are Windows users who is using WinSCP, please note that after running the installer, you will need to modify settings allowing you to “switch users” to edit your configuration files.
-First create a new session on WinSCP using Protocol SCP pointing to your Pi IP address and port 22 and then modify the needed setting by click on Advanced… -> Environment -> SCP/Shell -> Shell and selecting sudo su -.