Getting started: Difference between revisions

From Domoticz
Jump to navigation Jump to search
Walter vl (talk | contribs)
mNo edit summary
Walter vl (talk | contribs)
mNo edit summary
 
Line 4: Line 4:
The core application runs at the background, and has a web-based user interface.   
The core application runs at the background, and has a web-based user interface.   


The default port of the web interface is 8080. For a local setup you can connect to http://127.0.0.1:8080 or https://127.0.0.1 From every other network device in your local network you can connect to http://&#x3C;IP-of-Domoticz-server&#x3E;:8080  or https://&#x3C;IP-of-Domoticz-server&#x3E;:443<blockquote>'''From 2023.1 Stable:''' By default Domoticz is protected by a username (''admin'') and password (''domoticz'').
 
 
The default port of the web interface is 8080. For a local setup you can connect to http://127.0.0.1:8080 or https://127.0.0.1 From every other network device in your local network you can connect to http://&#x3C;IP-of-Domoticz-server&#x3E;:8080  or https://&#x3C;IP-of-Domoticz-server&#x3E;:443
 
By default Domoticz is protected by a username (''admin'') and password (''domoticz'').


Please either change the password as soon as possible (menu [[MyProfile|'''Setup -> My Profile''']]) or create a different admin user and remove the default (admin) user trough [[User Management|User management]] (menu '''Setup -> Users''')
Please either change the password as soon as possible (menu [[MyProfile|'''Setup -> My Profile''']]) or create a different admin user and remove the default (admin) user trough [[User Management|User management]] (menu '''Setup -> Users''')


More information on securing your Domoticz setup can be found in the [[Security]] wiki page.</blockquote>To access the system from a remote location, consult your router manual to forwarding/NAT a port to your system. Be aware that you need to [[Security|secure your Domoticz environment with a user/password!]]
More information on securing your Domoticz setup can be found in the [[Security]] wiki page.
 
To access the system from a remote location, consult your router manual to forwarding/NAT a port to your system. Be aware that you need to [[Security|secure your Domoticz environment with a user/password!]]


==Navigation==
==Navigation==
Line 15: Line 21:
[[File:Domoticz Navigation.png]]  
[[File:Domoticz Navigation.png]]  


Most tabs are automatically refreshed every 10 seconds. (Except Devices/Hardware/Setup) . In the menu [[Application Settings|Setup - Settings]] you can set the tabs you want to display.  
Most tabs are automatically refreshed every 10 seconds. (Except Devices/Hardware/Setup) .  
 
In the tabs the active devices are shown, see the next paragraph how to add devices.
 
In the [[Application Settings|menu '''Setup -> Users''']] you can set the tabs you want to display for each user.  


==Connecting your first devices==
==Connecting your first devices==
Line 21: Line 31:
In the '''Setup''' menu of Domoticz you can find links to [[Hardware Setup|Hardware]], [[Setup Devices|Devices]] and [[Application Settings|Settings]].  
In the '''Setup''' menu of Domoticz you can find links to [[Hardware Setup|Hardware]], [[Setup Devices|Devices]] and [[Application Settings|Settings]].  


*[[Hardware Setup|Hardware]] is where you connect devices that can talk directly to Domoticz. Examples are some thermostats or mediaplayers. Most like you'll want to install a dongle of some sort that will let you connect to wireless devices that you own. These 'gateways' act like bridges to devices that may communicate via [[Zwave-JS-UI|Z-wave]], [[Zigbee]], Wifi, Bluetooth, 433Mhz, and so forth.
*[[Hardware Setup|Menu Setup- Hardware]] is where you connect devices that can talk directly to Domoticz. Examples are some thermostats or mediaplayers. Most like you'll want to install a dongle of some sort that will let you connect to wireless devices that you own. These 'gateways' act like bridges to devices that may communicate via [[Zwave-JS-UI|Z-wave]], [[Zigbee]], Wifi, Bluetooth, 433Mhz, and so forth.
*[[Setup Devices|Devices]]. This is an overview page where all the things that your gateways detect will show up. You can then 'import' them into Domoticz by giving them a name and pressing the green import button. So these are the switches, lamps, blinds actuators, temperature sensors, energy counters you will see in the tabs Switches, Temperature, Weather and Utility.
*[[Setup Devices|Menu Setup - Devices]]. This is an overview page where all the things that your gateways detect will show up. You can then 'import' them into Domoticz by giving them a name and pressing the green import button. So these are the switches, lamps, blinds actuators, temperature sensors, energy counters you will see in the tabs Switches, Temperature, Weather and Utility.
*[[Application Settings|Settings]]. This is the page where you will find lots of general settings that relate to Domoticz itself, like setting a password, choosing a theme, or entering your location (which allows your devices to react to the weather, or automatically turn on at night time).
*[[Application Settings|Menu Setup - Settings]]. This is the page where you will find lots of general settings that relate to Domoticz itself, like setting a password, choosing a theme, or entering your location (which allows your devices to react to the weather, or automatically turn on at night time).


Basic steps to add devices:
'''Basic steps to add devices:'''


#Go to menu Setup - [[Application Settings|Settings]] to set your location (important for day/night timing).
#Go to menu '''Setup - [[Application Settings|Settings]]''' to set your location (important for day/night timing).
#Go to menu Setup - [[Hardware Setup|Hardware]] and add an hardware gateway. Follow the instructions for that particular hardware gateway. Devices that are not supported by the build in Domoticz Hardware but by Python plugins can be found on the following page: '''[[Plugins]]'''
#Go to menu '''Setup - [[Hardware Setup|Hardware]]''' and add an hardware gateway. Follow the instructions for that particular hardware gateway. Devices that are not supported by the build in Domoticz Hardware but by Python plugins can be found on the following page: '''[[Plugins]]'''
#Go to menu Setup - [[Setup Devices|Devices]] to enable (if disabled) the devices created by the hardware gateway
#Go to menu '''Setup - [[Setup Devices|Devices]]''' to enable (if disabled) the devices created by the hardware gateway


Popular Hardware Gateways are:
Popular Hardware Gateways are:
Line 40: Line 50:
Once you have added your first devices, they will appear as widgets in the tabs Switches, Temperature, Weather and Utility and other options will become relevant:
Once you have added your first devices, they will appear as widgets in the tabs Switches, Temperature, Weather and Utility and other options will become relevant:


*Adding some devices as your '[[Managing Devices#Dashboard|favorites]]' by clicking on the yellow star on the device Widget. These devices will show up on your [[Managing Devices#Dashboard|dashboard]], to give you easy access.
*Adding some devices as your '[[Managing Devices#Dashboard|favorites]]' by clicking on the star on the device Widget. These devices will show up on your [[Managing Devices#Dashboard|dashboard]], to give you easy access.
*Setup device [[Managing Devices#Edit Notifications|notifications]] when for example sensors are going to a predefined level (eg temp < 0 degrees).
*Setup device [[Managing Devices#Edit Notifications|notifications]] when for example sensors are going to a predefined level (eg temp < 0 degrees).
*Setup device [[Managing Devices#Edit Device Timers|Timers]] to switch devices on or off in a time schedule. These timers can be fixed times or based on sunset/sunrise. Also triggered every day or some days per week or month. It is also possible to setup a holiday timer scheme of various lights with a [[Timer Plan]]
*Setup device [[Managing Devices#Edit Device Timers|Timers]] to switch devices on or off in a time schedule. These timers can be fixed times or based on sunset/sunrise. Also triggered every day or some days per week or month. It is also possible to setup a holiday timer scheme of various lights with a [[Timer Plan]]
Line 60: Line 70:
==Automating==
==Automating==
[[File:Blockymonday.PNG|frame]]
[[File:Blockymonday.PNG|frame]]
Once you're familiar and have some devices connected, you could use some logic to switch devices depending on situations that cannot be handled only by timers. For example switch lights based on movement detection sensors or switch a fan based on temperatures. For this try creating your first automation. A good startingpoint is the [[Automation]] and [[Scripting in Domoticz|scripting]] page. Also here you can read about using [[Blockly]], an easy drag-and-drop scripting interface without coding.
Once you're familiar and have some devices connected, you could use some logic to switch devices depending on situations that cannot be handled only by timers. For example switch lights based on movement detection sensors or switch a fan based on temperatures. For this try creating your first automation. A good starting point is the [[Automation]] and [[Scripting in Domoticz|scripting]] page. Also here you can read about using [[Blockly]], an easy drag-and-drop scripting interface without coding.


If you need more complexity and flexibility use [[DzVents: next generation Lua scripting|dzVents]] scripting language.
If you need more complexity and flexibility use the [[DzVents: next generation Lua scripting|dzVents]] scripting language.


With [[User variables|User Variables]] you can store custom values to be managed in scripts
With [[User variables|User Variables]] you can store custom values to be managed in scripts

Latest revision as of 07:58, 24 June 2025

So, you've installed Domoticz. That means it's time to connect all kinds of devices, and then create your first automation.

Usage

The core application runs at the background, and has a web-based user interface. 


The default port of the web interface is 8080. For a local setup you can connect to http://127.0.0.1:8080 or https://127.0.0.1 From every other network device in your local network you can connect to http://<IP-of-Domoticz-server>:8080 or https://<IP-of-Domoticz-server>:443

By default Domoticz is protected by a username (admin) and password (domoticz).

Please either change the password as soon as possible (menu Setup -> My Profile) or create a different admin user and remove the default (admin) user trough User management (menu Setup -> Users)

More information on securing your Domoticz setup can be found in the Security wiki page.

To access the system from a remote location, consult your router manual to forwarding/NAT a port to your system. Be aware that you need to secure your Domoticz environment with a user/password!

Navigation

Navigation is done by pressing the tabs at the top of the webpage. 

Most tabs are automatically refreshed every 10 seconds. (Except Devices/Hardware/Setup) .

In the tabs the active devices are shown, see the next paragraph how to add devices.

In the menu Setup -> Users you can set the tabs you want to display for each user.

Connecting your first devices

In the Setup menu of Domoticz you can find links to Hardware, Devices and Settings.

  • Menu Setup- Hardware is where you connect devices that can talk directly to Domoticz. Examples are some thermostats or mediaplayers. Most like you'll want to install a dongle of some sort that will let you connect to wireless devices that you own. These 'gateways' act like bridges to devices that may communicate via Z-wave, Zigbee, Wifi, Bluetooth, 433Mhz, and so forth.
  • Menu Setup - Devices. This is an overview page where all the things that your gateways detect will show up. You can then 'import' them into Domoticz by giving them a name and pressing the green import button. So these are the switches, lamps, blinds actuators, temperature sensors, energy counters you will see in the tabs Switches, Temperature, Weather and Utility.
  • Menu Setup - Settings. This is the page where you will find lots of general settings that relate to Domoticz itself, like setting a password, choosing a theme, or entering your location (which allows your devices to react to the weather, or automatically turn on at night time).

Basic steps to add devices:

  1. Go to menu Setup - Settings to set your location (important for day/night timing).
  2. Go to menu Setup - Hardware and add an hardware gateway. Follow the instructions for that particular hardware gateway. Devices that are not supported by the build in Domoticz Hardware but by Python plugins can be found on the following page: Plugins
  3. Go to menu Setup - Devices to enable (if disabled) the devices created by the hardware gateway

Popular Hardware Gateways are:

Zwave-JS-UI for Zwave devices

Zigbee2MQTT for Zigbee devices (Philips Hue, Ikea Tradfri etc)

Managing your devices

Once you have added your first devices, they will appear as widgets in the tabs Switches, Temperature, Weather and Utility and other options will become relevant:

  • Adding some devices as your 'favorites' by clicking on the star on the device Widget. These devices will show up on your dashboard, to give you easy access.
  • Setup device notifications when for example sensors are going to a predefined level (eg temp < 0 degrees).
  • Setup device Timers to switch devices on or off in a time schedule. These timers can be fixed times or based on sunset/sunrise. Also triggered every day or some days per week or month. It is also possible to setup a holiday timer scheme of various lights with a Timer Plan
  • Adding a floorplan. If you want you can create a floorplan, and place buttons on there for all your devices. You can even set this as your dashboard if you want.
  • Show Device Log files or graphs per day/month/year. Generate yearly reports for further analysis

See for more information the page Managing Devices


Managing Users

By default Domoticz is protected by a username (admin) and password (domoticz).

Please either change the password as soon as possible (menu Setup -> My Profile) or create a different admin user and remove the default (admin) user trough User management (menu Setup -> Users)

With Domoticz you can have separate users logging in into your Domoticz environment with different access rights (admin/user/viewer).Create one or more Users to allow different people to control Domoticz. Assign the proper rights to each User.

More information on securing your Domoticz setup can be found in the Security wiki page.

Automating

Once you're familiar and have some devices connected, you could use some logic to switch devices depending on situations that cannot be handled only by timers. For example switch lights based on movement detection sensors or switch a fan based on temperatures. For this try creating your first automation. A good starting point is the Automation and scripting page. Also here you can read about using Blockly, an easy drag-and-drop scripting interface without coding.

If you need more complexity and flexibility use the dzVents scripting language.

With User Variables you can store custom values to be managed in scripts



Continue with more information

Go to Configuration of your Domoticz environment