Skip to content

Plugin settings

Johann Richard edited this page Dec 8, 2020 · 4 revisions

Plugin settings

The dingz Plugin offers a number of settings that can be used to tailor it to your specific setting. This includes:

The following paragraphs give more detail on each setting.

1. Motion-sensor polling

Allows you to switch between polling the motion sensor from the dingz or telling the dingz to push the status of the motion sensor to your Homebridge. Both modes have their advantages and disadvantages, depending on your needs and expectations you might want to chose either one. Default is poll. See the Motion sensor page for more details.

2. Auto-discovery

By default, the plugin will automatically discover all your dingz and supported myStrom devices -- provided they are in the same network and UDP broadcast is not inhibited by your network equipment. This is the easiest way and works reliably.

However, if you have a different setup, e.g. if your IoT devices reside on a different network segment for security reasons, or if you want to better control which devices are integrated via the Homebridge instance where the plugin is running, you can turn this off and add the devices manually.

3. Callback port, hostname override and action override

In order to implement dingz buttons and myStrom WiFi buttons, the plugin exposes an HTTP server. Every time the user or her cat pushes a button, it will send a request to that address and port. By default, we use the hostname of the server where Homebridge is running and port 180081.

If you have other services listening on the same port, or if you want to run several Homebridge instances along each other (e.g. for testing new versions of plugins), you might want to change this to a different port.

Depending on your setup or your needs, the hostname that the plugin detects might not be the right one. If you encounter significant delays or no button actions at all in HomeKit, you might also want to explicitly set the hostname/IP address that is used to set-up the dingz.

IMPORTANT : The plugin will attempt to set the callback URL of the dingz to the correct address itself. If you change the port and/or the hostname setting after you have installed the plugin and restarted Homebridge, you might end up with the dingz calling the old and the new URL:PORT combination at the same time. You should then reset the callback URLs of the dingz (see below), otherwise you risk significant delays in HomeKit's response when the buttons are pushed.

3.1. How to automatically reset the callback URLs

If you set the "Override generic callbacks" option to true and restart Homebridge, the action URL's of all concerned devices (dingz, myStrom buttons and PIR sensors) will be overriden and set to the one server where you have set this settings. This is useful for testing purposes with multiple HomeBridge servers and/or resetting your devices if you homebridge server's address changes.

If you disable the option and restart Homebridge again, the plugin will again add the respective callback to whatever action URLs are set on the devices.

3.2. How to manually reset the callback URLs

You can reset the Callback URLs quite easily in case you have issues with the callbacks or want to start from scratch, you can reset the configuration of the dingz related to the Homebridge plugin via the following commands in your terminal:

$ curl -X POST http://your-dingz/api/v1/action
$ curl -X POST http://your-dingz/api/v1/action/pir/single

This will also break other integrations you might have set-up. Please have a look at the API documentation for more details on how this work.