Domoticz Wiki - User contributions [en]

How to set up a virtual machine to run Domoticz

2020-04-24T03:29:23Z

Laurend: How to set up a virtual machine to run Domoticz

'''Virtual Machine Creation'''

# Download a virtual machine program to create tour virtual machine. VMware Workstation Pro can be downloaded here: <nowiki>https://www.vmware.com/products/workstation-pro/workstation-pro-evaluation.html</nowiki>
# Install VMware Workstation Pro.
# After installation is complete, open VMware Workstation Pro and choose the “Create a New Virtual Machine” option.
# Then, choose the “Typical (recommended)” configuration type and hit “Next.”
# The next step is to choose a guest operating system for your virtual machine and a version. For running Domoticz, you should choose a Linux operating system with a Ubuntu version.
# The next step will ask you to name your virtual machine and choose a location to store your virtual machine.
# The next decision is to choose the disk capacity of your virtual machine. The maximum disk size in GB should be set to 32GB and choose the split virtual disk into multiple files.
# The final step is to review the creation of your VM and in this step, there is an option to “Customize Hardware” which should be chosen.

The default settings of the hardware are shown below:

To successfully run Domoticz, you are going to want to change these settings so they match the configuration below:

'''Download Domoticz on VM'''

# On your virtual machine, open the terminal application.
# Then, type the following command in the terminal, which will copy all the files from Domoticz’s GitHub into a directory named “dev-domoticz”: git clone <nowiki>https://github.com/domoticz/domoticz.git</nowiki> dev-domoticz
# Next, you will need to get into the new directory you created (dev-domoticz), pull the most recent version of the code from Domoticz’s GitHub, and then start building the code. The commands you will need to do that are written below: cd dev-domoticz git pull cmake -DCMAKE_BUILD_TYPE=Release CMakeLists.txt -DUSE_OPENSSL_STATIC="NO" make
# Next, in order to run Domoticz on your VM, you should run the following commands: cd domoticz sudo ./domoticz

Then, in order to access the Domoticz interface via your virtual machine, you will need to open FireFox or another browser and go to: localhost:8080
[[File:Num 5.png|center|thumb|1158x1158px]]

Being able to access the Domoticz interface via the steps above ensures that you have Domoticz running correctly on your VM.

'''Download and Install Visual Studio Code'''

# Download and install Visual Studio Code on the VM you created.
# Then, open Visual Studio Code. File --> Open Folder --> dev-domoticz --> OK(top right corner). Following these actions will download all the Domoticz files into Visual Studio Code, so that you are able to make code changes in Visual Studio Code. This is what Visual Studio Code should look like when your Domoticz files download.

[[File:VS code.png|center|thumb|512x512px]]

'''Making Changes to Domoticz'''

# After making any code changes in the dev-domoticz files, you need to use Control + S to save any changes that you made to the code.
# Then, you need to go back to terminal and run the following commands to build the version of Domoticz complete with your code changes: cmake -DCMAKE_BUILD_TYPE=Release CMakeLists.txt -DUSE_OPENSSL_STATIC="NO" make
# Use the commands below to run Domoticz with your code changes cd domoticz sudo ./domoticz

Use a web browser on your VM to go to the address: localhost:8080 and use the interface to test your changes to see if they are correct

File:Dom running.png

2020-04-24T03:23:31Z

Laurend:

Running Domoticz

File:Num 5.png

2020-04-24T03:20:45Z

Laurend:

Domoticz

File:VS code.png

2020-04-24T03:18:46Z

Laurend:

What Visual Studio should look like when you download the Domoticz files

File:VMsettings.png

2020-04-24T02:53:42Z

Laurend:

VM settings

YeeLight

2020-04-24T01:28:19Z

Laurend: Added a few images to help explain how to connect your YeeLight to Domoticz

How to Connect Your YeeLight to Domoticz

Using YeeLight App to Enable Developer Mode

Before you are able to connect your YeeLight to Domoticz, you need to enable developer mode on your YeeLight. Enabling developer mode allows for your YeeLight to connect to third parties like Domoticz.

1. Download YeeLight app onto an iOS or Android device. You will need to create an account and choose your geographical location.
[[File:YeelightApp.jpg|none|thumb|342x342px]]

2. Navigate to the Device tab on the bottom right portion of the screen and click Add Device.

3. Then, you will have to choose the type of YeeLight you have and want to connect.

4. The app will then prompt you to reset the device by turning the light on and off 5 times in a row (turning on for 2 seconds, turning off for 2 seconds). The bulb should start flashing different colors then hold a solid color signifying it has been reset.

5. The next step is to connect to the Wifi network that you want the YeeLight to be connected to.

6. The YeeLight should then be automatically connected to the app. Then, select the light as the device to add and click next step.

7. For the next step, the app will attempt to connect the YeeLight to your home Wifi network, so it is pivotal that you keep the YeeLight close to your phone and the router while it attempts to connect.

8. After it is connected, the YeeLight will be visible under the Device tab on the YeeLight App. Click on the YeeLight device that you just added.
[[File:Yeelightdoc8.jpg|none|thumb]]

9. After clicking on your recently added device, there is three icons on the bottom of the screen. Click the triangle with a line icon on the bottom right.

10. This will reveal additional icons. Choose the LAN Control lightning bolt icon.

11. Then, use the toggle to enable LAN Control which enables your YeeLight to be connected to Domoticz.

Connecting YeeLight to Domoticz Interface

First, you need to get the Domoticz interface wherever you have it running. The Domoticz interface is shown below:
[[File:Yeelightdocbefore.png|none|thumb|512x512px]]

1. To begin connecting your YeeLight to Domoticz, navigate to the Setup tab showing the dropdown menu and select hardware.
[[File:Yeelightdoc1new.png|none|thumb]]

2. In the Hardware section, it will ask you to name the hardware you are intending to add, select the type of hardware (YeeLight LED) from the dropdown menu, and press add.

3. Navigate Setup Devices and check to see if the YeeLight you just added has been detected and is visible under devices. If the recently added YeeLight is visible in the Devices tab, proceed to Step 6.

4. If the recently added hardware is not visible under devices, return to Setup 🡪 Hardware. In the section that lists the hardware added, find the entry that was added in Step 2 and press the “Add Light” button next to that entry.

5. This will bring up a box asking you to name your device, enter the YeeLight’s IP address, and the light type from the dropdown menu. Now your YeeLight will be visible in the Devices tab.

Finding the IP address of your YeeLight
a) The IP address of your YeeLight can be found in the YeeLight app. Under the Devices tab of the YeeLight app, choose the YeeLight that you wish to know the IP address of.

Click the icon in the top right corner, which will open the Settings.

Then, there is an option to open “Device Info” which will reveal the IP address of your YeeLight.

b) There is also some benefit to having your YeeLight on a public IP address. This would allow for multiple people to connect and access the same YeeLight, regardless of geographical location, as long as they know the public IP address of the router that the YeeLight is connected to. This scenario would be particularly useful for developers who want to work and contribute to Domoticz but do not want to have to buy all the hardware. The link below explains the steps to finding the public IP address of your router:
https://nordvpn.com/blog/find-router-ip-address/

6. Under the Devices tab, you can find the YeeLight that is now connected to Domoticz. The entry showing the YeeLight has a green circle with an arrow in it and by clicking it, it will create a switch for the YeeLight that you just added.

7. The switch can be found under the Switches Tab, and this switch allows you to turn the light on and off and change the color of your newly connected YeeLight.

File:Yeelightdoc5new.png

2020-04-24T01:25:17Z

Laurend:

IP address info

File:Yeelightdoc4new.png

2020-04-24T01:24:20Z

Laurend:

Add Light

File:Yeelightdoc1new.png

2020-04-24T01:23:11Z

Laurend:

Dropdown menu

File:Yeelightdocbefore.png

2020-04-24T01:21:55Z

Laurend:

Domoticz Interface

File:Yeelightdoc11a.jpg

2020-04-24T01:20:48Z

Laurend:

What to do with Lan Control

File:Yeelightdoc10.jpg

2020-04-24T01:19:55Z

Laurend:

Explaining Lan option

File:Yeelightdoc8.jpg

2020-04-24T01:18:40Z

Laurend:

Yeelight device selection

File:Yeelightdoc4.jpg

2020-04-24T01:15:31Z

Laurend:

Yeelight

File:Yeelightdoc3.jpg

2020-04-24T01:14:04Z

Laurend:

devices

File:Yeelightdoc.jpg

2020-04-24T01:11:06Z

Laurend:

Connecting YeeLight

File:YeelightApp.jpg

2020-04-24T00:59:51Z

Laurend:

The Yeelight app in the app store