setup.md

Setup

• Initial start-up Fist time access to the Device
• Setup the adapter Setup the ioBroker Adapter
  • TCP/IP Network Settings Setup the adapter network
  • Controllers Settings Device setup
    • Broadcast
      • Serial Number
    • Dedicated network setup
      • Serial Number
      • Device network address
      • Exposed Server Host address
      • Exposed Server Host port

Initial start-up

When you connect the device for the first time, it may be useful to enter the network data.

These steps are optional and only required to use the device on another, remote network outside of the local network of the ioBroker instance

• To do this...
  • Connect the device to the same network in which ioBroker is also located. No Docker, VPN or other subnet. ¹
  • Install and start the adapter with default settings.
  • Got to the Configuration and switch to the "Device Remote Setup" tab
  • Run the device scan. There are two possible error messages that result in no devices being found², ³
  • If you have more than one device active, select the one you want in the "Device Id" dropdown box.
  • Put the desired address data in the appropriate input fields⁴
  • Now install the device in the target network

Door Access Controllers Settings

TCP/IP Network Settings

Network interface

From the list, select the network host adapter to which you have connected your device. ⁴

• Special addresses
  • 0.0.0.0 All available interfaces (Default)
  • 127.0.0.1 Only local host network (for the simulator)
  • All others can be used if you know what you want. e.g. VPN, Docker etc...

Sender-Port

Default is 60000. Without error message from the network there is no need the change that.

Receiver-Port

Default is 60001. Without error message from the network there is no need the change that. I redefined port 60099 for the adapter. If something doesn't work, change this back to the default.

Connection Timeout in milli seconds

Default is 2500 (2,5 seconds). Timeout for any communication over the network. Do not change without consultation. Values below 1000 and above 10000 can work for the time being, but always lead to errors in real operation.

Heartbeat Interval in milli seconds

Default is 300000 (300 seconds == 5 minutes). Time in between two attempts to establish a standard connection to the device to decide if it's alive. Values below 60000 and above 900000 can cause unwanted side effects that are difficult to analyze.

Maximum time deviation in milliseconds

Default is 60000 (60 seconds == 1 minute) Maximum time deviation in milliseconds. If the deviation is larger, the controller clock is recalibrated. Values below 1200 milliseconds are ignored and the calibration is switched off.

Low Level Debug

Default off. If enabled the raw network communication was logged to the debug log. No need to change without a request from a developer.

Controllers Settings

Device setup for forward and reverse channel via the network. Use the + / add and the trash per available device. There are two options for communication between the host (ioBroker) and the device. Limited Broadcast and dedicated network setup (Unicast & Directed Broadcast). ⁵

Serial Number

The serial number of your device.

Model Type

Enter the Door Model

Limited Broadcast ⁵

Add only the serial number and the Model-Type and no other address / network data.

In this case, all components must be in the same subnet. This includes both the sender (controller) and the receiver (ioBroker). This can be recognized by the same gateway address and network mask on both components.

In all other cases, ALWAYS use "dedicated network setup".

Dedicated network setup (Unicast & Directed Broadcast) ⁵

Please enter all address data...

Device network address ⁵

The publicly known IP address (Unicast) of the device on the remote network. ^{4 6}

Exposed Server Host address ⁵

The publicly known IP address (Unicast) of the ioBroker instance on the remote network. ^{4 6}

Exposed Server Host port ⁵

The publicly known IP port of the ioBroker instance on the remote network after NAT ⁷ and Docker-Exposed ⁸ .

Footnotes

1. If you are unable to connect the device to the same local network as the ioBroker instance, you must set the IP addresses in another alternative way ↩

2. ↩

3. ↩

4. The device only allows IPv4 addresses. ↩ ↩² ↩³ ↩⁴

5. ↩ ↩² ↩³ ↩⁴ ↩⁵ ↩⁶

6. You can replace the "Unicast Address" with the "Directed Broadcast Address" in the configuration. ↩ ↩²

7. NAT RFC#2663 ↩

8. Docker CLI: Port ↩