MyDomoticz

From Domoticz
Jump to: navigation, search

Description of the MyDomoticz service

Introduction

The MyDomoticz service, as can be found on https://my.domoticz.com/, enables Domoticz users to access their Domoticz appliance (sometimes called an "instance") from outside their local network without having to forward a http port on their router or even knowing their IP address.
All communication occurs via a secure webpage and there is also no need to fiddle with certificates locally.
Using this service is purely optional and can be enabled in the settings menu of Domoticz.

Beta phase

Note that currently the MyDomoticz service is in Beta phase and is available through the normal Beta release update. To participate as a beta tester, you can just follow the steps below.

Getting started

In order to use the MyDomoticz service, you need to register on https://my.domoticz.com/. Click on the Register link and fill out your name and email address.
After clicking on “next”, a verification email will be sent with a link. If the email doesn’t appear immediately, make sure you check your SPAM folder.
In the e-mail you will find your MyDomoticz user ID. Make note of this, you will need it in a next step.
Click on the link in the e-mail and choose a password. A password strength meter is provided to show if your password is strong enough. Then click next again and you can now use your e-mail address and password to log in. You can leave the "2 factor code" field empty for now. Later you can enable this in your MyDomoticz settings (see below).

You won’t see your Domoticz instance yet. For this, you need to set up your local Domoticz. In the settings page of your local Domoticz, scroll down to “MyDomoticz settings”. The MyDomoticz instance id will be empty. It will be assigned automatically later and you cannot change it. Below that you can copy and paste the user id that you got in the registration mail, together with the password that you chose. Also here, you can indicate if you want to use MyDomoticz for accessing the web interface, Domoticz master-slave communication and or app support (see below).

After clicking on “Apply settings” your local Domoticz instance will automatically try to connect to the MyDomoticz service. If you browse back again to your settings, you will see that a MyDomoticz instance ID was assigned.
If not, look at your log for possible errors. You can use the same MyDomoticz User ID/password multiple times, for different Domoticz instances in case you have more than 1 Domoticz appliance running.

Now you can log in to https://my.domoticz.com/ and you will see that your Domoticz instance(s) appear in the dashboard. The dashboard refreshes automatically so if you were already logged in, it will appear automatically with the descriptive name "My Domoticz". To change this description you can click on that name and some settings will appear.

Right now the icon should be green and you can click on it to enter and see your devices. You can do this from anywhere on the Internet, also outside your local LAN. If the icon still appears red, check your Domoticz log files and make sure that the checkbox "Enabled" is checked.
On top of the dashboard, on the right side, there are two icons. The left one leads you to your personal profile. It lists your Domoticz User ID as a reference and your email address. Also it shows the IP address that you are currently browsing from. If you wish, you could add this to the “Local Networks” in your own Domoticz instance to be able to log in without a password from that IP. Also you can change your display name and password.

Two factor authentication

On the user settings page, there’s a tick box that says “2 factor enabled”. If you click on that and save your settings, you will be redirected to the settings screen again and you will now see a 2 factor secret and a QR code. You can use the secret in an application like Google Authenticator (or other TOTP app) for extra login security. For convenience, you can scan the QR code so you don’t have to type over the secret. If you choose to scan the QR code, do so with the Authenticator app. A normal barcode scanner won’t give the desired results. Important: If you enable this option, set up Google Authenticator first before logging out. If you forget your 2fa secret, you cannot log in anymore and you will need to apply for a password reset email. Note: Some TOTP authenticators on the iPhone platform are known not to be compatible.

Instance settings

General settings

From the dashboard, you can also click on the description (which is standard “My Domoticz”). This screen gives you control of how to log in to your instance. The Instance ID distinguishes your local Domoticz instance. It is displayed for informational purposes and you don’t really need it. The Version field displays your Domoticz version, at the time that it was connected last. You can change the description field to something more descriptive so you know which instance you are accessing (e.g. “Domoticz master garden”). Especially this is convenient if you register more than 1 Domoticz appliance to your account. In the “Allowed IP address” box, you can enter the (external) ip address that your Domoticz instance is allowed to connect from. The current IP address is displayed, along with a button to easily fill out the input field. For this to work, your Domoticz instance needs to be online.

The auto login username/password is used for single sign on purposes. It holds the credentials to log in to your Domoticz in case you set it up with “Basic Authentication” password protection. Note that even if you share this instance with other users (see below), these credentials will NOT be shared. Empty passwords are not supported.

Finally the remove instance link removes this instance from your dashboard. You can only do this when Domoticz is NOT connected. Note that if you want to do this, you will also need to remove your MyDomoticz credentials in the local Domoticz settings screen, or else it will re-register automatically and obtain a (different) instance id anew.

Instance sharing

Finally, on the bottom of the instance settings screen, you have the option to share access to your local Domoticz instance with other MyDomoticz users. This can sometimes be convenient, for instance to allow multiple family members to access the same Domoticz. Or your favorite tech support guru that helps you trouble shoot. Etc. You just enter their User ID or e-mail address and click on “Share”. On the dashboard of the party that you shared with, your Domoticz wil now appear automatically. After sharing, it’s easy to unshare again by just clicking the “Unshare” link. If another user shared their Domoticz instance with you, the Instance settings are a little bit different but the principle is the same.

Inter-Domoticz communication

It is also possible to add a Domoticz slave via MyDomoticz. To do so, add a new hardware, type "Domoticz - Remote server", like usual.
Instead of entering it's IP address, you can now enter the instance ID of the slave Domoticz. This slave needs to be in your MyDomoticz dashboard. If it is a Domoticz of somebody else, ask them to first share it with you. The port number in the Domoticz remote hardware settings is not used.
It is possible to change an existing slave from a direct connection to MyDomoticz communication. To do so, simply change the IP address that is currently configured to the Domoticz instance ID. This way, all the devices that were previously added will still be intact. Note that master-slave communication via MyDomoticz is even more beta than the service itself. Bug reports are welcome via the forum.

App support

In the settings menu, there is a checkbox for "App support". This feature is still being developed. Currently there are no apps available that can be connected via MyDomoticz.