Domoticz Open Source Home Automation System Manual date: February 2015 Author: Robbert E. Peters Email: Info@Domoticz.
Table of Contents Introduction ............................................................................................................................................................................ 5 System Requirements ............................................................................................................................................................. 5 Hardware .....................................................................................................................
Temperature ......................................................................................................................................................................... 18 Log ..................................................................................................................................................................................... 19 Edit .....................................................................................................................................
Participation .......................................................................................................................................................................... 36 Thanks ...................................................................................................................................................................................
Introduction Domoticz is a Home Automation system design to control various devices and receive input from various sensors.
Hardware There are various hardware components that the system can use. Some are specifically made for the Raspberry Pi. • • • • • • RF 433Mhz - RFXCOM RFXtrx433, http://www.rfxcom.com 1 RF Z-Wave - Razberry Z-Way http://razberry.z-wave.me 1 RF Z-Wave – OpenZWave, Aeon ZStick http://aeotec.com/z-wave-usb-stick 1 P1 Smart Meter (serial) 2 YouLess Energy Meter http://www.youless.nl TE923 Weather Station (Hideki weather station like IROX Pro X, Mebus TE923 or TFA Nexus) http://www.tdressler.
Installation Please consult the wiki pages for details. http://www.domoticz.com/wiki/Main_Page Raspberry Pi The easiest way to get started is to download the SD Card image from sourceforge. http://sourceforge.net/projects/domoticz/files/ Unix/Linux/Raspberry Pi/…. See the Install.txt file for installation/compile instructions. Windows Users An installer is provided for easy installation. http://sourceforge.
Command Line parameters The following command line parameters are available: -www port (for example -www 8080) -sslwww port (secure web port, for example -sslwww 443) -dbase file_path (for example D: \domoticz.db or /opt/domoticz/domoticz.db) -verbose x (where x=0 is none, x=1 is debug) -startupdelay seconds (default=0) -nowwwpwd (in case you forgot the webserver username/password) -nobrowser (do not start web browser) (Windows Only) -log file_path (for example D: \domoticz.
Unix Starup Script To start Domoticz automatically when the system starts perform the following steps: sudo cp domoticz.sh /etc/init.d sudo chmod +x /etc/init.d/domoticz.sh sudo update-rc.d domoticz.sh defaults Edit the startup script and change the USERNAME, DAEMON and DAEMON_ARGS parameters to reflect your current settings sudo vi /etc/init.d/domoticz.
Hardware Setup Before you can use the application to control devices you must setup the communication hardware device(s). Setting up a USB device First make sure the device is recognized in the system. Domoticz automatically detects the USB port. Setting up a LAN device First make sure you know the IP address and port of the device.
Sharing Devices It is possible to share your (Domoticz) sensors with your friends. For instance you can share your Rain Meter, but also lights/switches that other people can control. For this, you need to enter an Administrator username/password in the application settings. Then you can add users and assign sensors/switches to this user. Consult the documentation of the router on how to setup a Firewall/NAT/Forward rule.
Application Settings There are various application settings. For control of Light/Switches based on Sun Set /Sunrise timings, it is important to setup your location. Location Setup To setup your location click on the ‘Setup’ tab, and enter the Latitude/Longitude parameters. If you do not know these parameters, press the ‘Here’ link and enter your address: When pressing OK the parameters are accepted by the application. Press the SAVE button to store the settings.
Notification Setup Notifications can be send for example when a switch is pushed, electricity usage is too high, temperature to high and for many more options. The following systems are supported: Prowl and NMA Light/Switch History With this parameter you can specify the amount of Log days that a Light/Switch will hold. Short Log History Every meter/sensor data will be logged each 5 minutes. By default 1 day of 5 minute logs will be kept.
Website Protection By default no username/password is needed to access Domoticz via the web browser. If you wish to protect Domoticz (for instance if you have shared the port to the outside world), you can specify the Username/Password that needs to be entered to access the system. It is also possible to specify the ‘Local Networks’ that does not have to enter a Username/Password. Resetting the Website Username/Password To reset the website username/password incase this is lost… there are two options.
Software Updates The Domoticz system can be updated (Raspberry Pi) via the web interface. There are two options: - Stable versions (recommended) Beta versions (developer versions) Enabling/Disabling Tabs/Menus With this setting you can hide certain tabs you do not wish to see. For example if you do not own utility devices you can hide this tab. Email Setup If you enter your email details here, you can receive notifications/web cam screenshots and more.
Meter/Counter Setup Wind Meter Wind meter notation (m/s, km/h, mph or knots) OWL 113 display mode By default the OWL 113 is displaying the Current in Amperes. It is possible to display this in Energy (Watt). For this you need to supply the normal housing voltage. RFX/Meter Dividers Some utility devices might use another basic scale for their meter (turns/minute for example). << These are the default settings. It is also possible to enter the costs for Energy, Gas and Water here.
Devices Once the application is running it will collect all devices found/received and begin logging the messages. Devices can be Added/Removed from this tab. Light devices can also be added to the system from the ‘Lights/Switches’ tab. To Add temperature/weather sensors press the add button, and enter a name. You will now find them in their respective tabs.
Temperature The temperature tab includes all sensors that have a temperature sensor. A temperature sensor can also include a Humidity sensor. Each item has the following options: - Favorite push icon (to display this device on the Dashboard tab) Log (Displays the log) Edit (Edit device parameters) Notifications (see Notification chapter) By Dragging/Dropping the sensor items, you can change the position of the devices in the window.
Log By pressing the log button you can see the log of the sensor. It is possible to zoom in/out. By pressing the BACK button you return to the overview.
Edit In this dialog you can rename the device, remove, or replace it. Replace Some devices change their unique ID when a new battery is installed. To replace the old sensor data to the new device act as follow: First, add the new device to the system, and call it for example ‘New UV Meter’. Next press the Edit button on the Old device, select replace and select the new Device. (In this case the devices called ‘New UV Meter’. Next press OK. Now you can rename the new device back to ‘UV Meter’.
Notifications Each device has different notifications (depending on the hardware options). For example, in the above screenshot, you want to be notified if the temperature drops below -2 degrees. See the Notification chapter for more details.
Weather The weather tab includes all sensors that are related to weather... A weather sensor can be: - Rain Meter Wind Meter UV Meter Barometer Each item has the following options: - Favorite push icon (to display this device on the Dashboard tab) Log (Displays the log) Edit (Edit device parameters) Notifications (see Notification chapter) By Dragging/Dropping the sensor items, you can change the position of the devices in the window.
Log Rain 23
Utility The utility tab includes Meter Sensors (Energy / Gas / P1 / YouLess / Voltage / AD / Air Quality / …) Each item has the following options: - Favorite push icon (to display this device on the Dashboard tab) Log (Displays the log) Edit (Edit device parameters) Notifications (see Notification chapter) By Dragging/Dropping the sensor items, you can change the position of the devices in the window.
Lights/Switches The lights/switches tab includes devices like: - Light Switches Door sensors Blinds Doorbells Security Sirens … This chapter can be the most difficult part to setup.
Adding a Light/Switch by Auto Learning By pressing the ‘Learn Light/Switch’ button you have 5 seconds to press the remote/switch/sensor.
Adding a Light/Switch Manually If you know the switch brand/type/address it is also possible to enter the parameters by hand. It is also possible to create a new ‘virtual’ device that can control a light without having to buy a remote/switch.
Sub/Slave Devices (One of the most difficult chapters) What is a Sub/Slave Device Most Lights can be controlled from up to 6 remotes. See the following two examples: Example 1 (Outdoor Light) Imagine you have an outdoor light that is controlled by a switch (*a) from inside the house. It is possible to buy small remote controllers (*b) for on a keychain. When you also want to control the outside light from this small remote, the small remote (*b) is a Sub/Slave device from the main switch (*a).
Next we are going to add the keychain remote (*b), but instead of choosing to set it up as Main device, we are selecting ‘Sub/Slave’ device: When selecting ‘Sub/Slave’ Device, a new option will become visible, and here we select the ‘Main’ device, in this case the ‘Outdoor Light’.
Remember to select Sub/Slave Device: Select the First Floor Light (*a) as the Main device. Now that we have added the ‘Downstairs Light’ we can also make this a Sub/Slave device for another Main Device. To at the ‘Downstairs Light’ as a Sub/Slave device for the ‘Second Floor Light’ (*b) press the ‘Edit’ button: From the Sub/Slave devices select the Downstairs Light (*c) and press ADD. Now this Sub/Slave device is also assigned to this device.
*Note: When adding a Sub/Slave device, this will not be visible in the ‘Lights’ tab by default. You see this device in the ‘Edit’ screen from the device you added it too. If you also want to control or see the Sub/Slave device, you will have to add this device again, and set it up as Main device. EnOcean Please note that the EnOcean hardware can only transmit with its own DeviceID. This means it will receive the real switches, but it cannot control these directly.
Notifications What are Notifications? Notifications can be used when you want to know if a switch is pressed (for example a doorbell), or when a temperature is below/above a certain degree, or when you power usage is above xxx Watt, etc.
Replacing Batteries Some devices change their unique ID when a new battery is installed. To replace the old sensor data to the new device act as follow: First, add the new device to the system, and call it for example ‘New UV Meter’. Next press the Edit button on the Old device, select replace and select the new Device. (In this case the devices called ‘New UV Meter’. Next press OK. Now you can rename the new device back to ‘UV Meter’.
Custom Icons It is possible to upload/use custom icons for On/Off switches. This requires a ZIP file with the following contents: - icons.txt icon files You can find this option under the Settings->More menu icons.txt This is the file describing one or more icon.
Browser Cache The web frontend is set to be cached. This will speed up the application launch time, and is perfect if you create a shortcut on the home screen of an iPhone/iPad/…. If for some reason, the page does not load correctly in Firefox / Chrome, clear this cache. Chrome From inside the Chrome browser browse to the following URL: chrome://appcache-internals/ You will now see all web applications that are cached. Find the Domoticz cache and press ‘Remove’.
If X10 MS13 sensors are in use check the battery in this sensor because when the battery becomes almost empty the MS13 starts transmitting a weak continuous RF signal but just enough to disturb the sensitive RFXCOM receiving. IPhone / IPad If you browse on your iPhone/iPad to the Domoticz site (for example http://192.168.0.3:8080), and add a shortcut to the home screen, the application will launch 90% faster, and works as a stand-alone application.
