https://github.com/voronenko/openhab-remote-xiaomi
Notes on setup openhab supporting receiving multicasts from remote xiaomi gateway endpoints
https://github.com/voronenko/openhab-remote-xiaomi
Last synced: 8 months ago
JSON representation
Notes on setup openhab supporting receiving multicasts from remote xiaomi gateway endpoints
- Host: GitHub
- URL: https://github.com/voronenko/openhab-remote-xiaomi
- Owner: Voronenko
- Created: 2019-01-05T14:56:32.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2019-12-08T16:12:52.000Z (over 6 years ago)
- Last Synced: 2025-04-15T01:15:33.728Z (about 1 year ago)
- Language: Shell
- Size: 49.8 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# openhab-remote-xiaomi
Notes on setup openhab supporting receiving multicasts from remote xiaomi gateway endpoints
## Network setup
Xiaomi smarthome gateways after recent firmware update no longer provides REST interface for updates.
Instead, it provides updates purely in local network using multicast to group 224.0.0.50 and port 9898.
This requires us to
a) Connect to remote site using L2 layer, using vpn that supports that scenario (for example openvpn)
b) As OpenHab does not support multicast listening on multiple interfaces, and 224.0.0.50 can't be routed
using igmpproxy, pimd or smcroute - the only choice is configuring Bridge Networking on opehab server,
combining local ethernet (eth0) together with VPN interface (tap0)
## Openhab Server - Bridge Networking
Note, in some systems, like Raspbian necessary package might not be installed. Check additionally.
```sh
sudo apt-get install -y bridge-utils
```
`/etc/network/interfaces`
```conf
# Include files from /etc/network/interfaces.d:
source-directory /etc/network/interfaces.d
# The primary network interface - supress ip
auto eth0
iface eth0 inet manual
auto br0
iface br0 inet static
address 192.168.2.222
netmask 255.255.255.0
broadcast 192.168.2.0
gateway 192.168.2.1
dns-nameservers 8.8.8.8
bridge_ports eth0
bridge_stp off
bridge_fd 0
bridge_maxwait 0
```
## Openhab Server - Openvpn Client
`/etc/openvpn/client.conf`
```conf
client
dev tap
;dev tun
;proto tcp
proto udp
remote your.openvpn.server 1194
resolv-retry infinite
nobind
# Downgrade privileges after initialization (non-Windows only)
;user nobody
;group nogroup
# Try to preserve some state across restarts.
persist-key
persist-tun
# SSL/TLS parms.
ca /etc/openvpn/client/ca.crt
cert /etc/openvpn/client/client.crt
key /etc/openvpn/client/client.key
# Set log file verbosity.
verb 3
# Silence repeating messages
;mute 20
script-security 2
up /etc/openvpn/up.sh
down /etc/openvpn/down.sh
```
up.sh
```sh
#!/bin/sh
# tap0 | 1500 | 1573 | 192.168.1.246 | 255.255.255.0 | init
echo "$1 | $2 | $3 | $4 | $5 | $6"
if ip link show tap0 | grep "master br0" ; then
echo "Tap0 is already part of the bridge, skipping"
else
echo "Adding Tap0 to bridge"
ifconfig $1 0.0.0.0 promisc up
ip link set tap0 master br0
fi
```
down.sh
```
#!/bin/sh
if ip link show tap0 | grep "master br0" ; then
echo "Unbinding interface from bridge"
ip link set tap0 nomaster || true
else
echo "Tap0 is not part of the bridge"
fi
```
## Openhab Server - Validating setup
```sh
sudo tcpdump -i br0 dst host 224.0.0.50 and port 9898
listening on br0, link-type EN10MB (Ethernet), capture size 262144 bytes
16:06:24.485583 IP 192.168.2.214.4321 > 224.0.0.50.9898: UDP, length 136
16:06:27.723873 IP 192.168.1.10.4321 > 224.0.0.50.9898: UDP, length 135
```
## Openhab Server - Persisting configuration changes
I am running home automation on simple Raspberry PI 3. It has one drawback - for 24/7 work termals are not good even with passive cooling. SD card potentially might die quite soon, hardware - depends on plate cooling quality.
Thus I prefer to configure openhab via file configuration,
with set of deployment batches, that provision openhab server with updates. All configuration changes are stored in a private git repository.
Additionally, ansible plays are used for initial box configuration (zsh shell, docker daemon, prometheus exporters, openvpn configuration and so on)
This allows me
## Remote site - OpenVPN server
Ideally, you might have router that already supports L2 OpenVPN. Routers supporting custom firmwares (Padawan, Openwrt, Tomato - for sure), Microtics and so on.
If for any reason you don't have such router, this means you would need to place one more box on remote site (possible - the same raspberry pi) and install OpenVPN there.
## Tips and tricks
Design patterns
https://community.openhab.org/tags/designpattern
VS Code extension
https://github.com/openhab/openhab-vscode
OpenVPN configs generator by SparkLabs
https://github.com/thesparklabs/openvpn-configuration-generator
Delayed writes for log files
https://github.com/azlux/log2ram