diff --git a/Docker/Dockerfile b/Docker/Dockerfile
new file mode 100644
index 0000000..7d4b323
--- /dev/null
+++ b/Docker/Dockerfile
@@ -0,0 +1,48 @@
+FROM eclipse-temurin:11-jdk-jammy AS builder
+
+RUN set -ex && \
+ apt-get update && \
+ apt-get install -y git cmake xz-utils python3 python3-serial
+
+RUN curl -L "https://downloads.arduino.cc/arduino-1.8.19-linux64.tar.xz" -o /tmp/arduino-ide.tar.xz
+RUN tar -xf /tmp/arduino-ide.tar.xz --directory ~/
+
+RUN cd ~/arduino* && \
+ ./install.sh && \
+ ./arduino --pref "boardsmanager.additional.urls=https://raw.githubusercontent.com/espressif/arduino-esp32/gh-pages/package_esp32_index.json" --save-prefs && \
+ ./arduino --install-boards esp32:esp32:2.0.9
+
+RUN git clone --recurse-submodules https://github.com/technyon/Arduino-CMake-Toolchain.git ~/Arduino-CMake-Toolchain
+
+COPY icon /usr/src/nuki_hub/icon
+COPY include /usr/src/nuki_hub/include
+COPY lib /usr/src/nuki_hub/lib
+COPY networkDevices /usr/src/nuki_hub/networkDevices
+COPY CMakeLists.txt /usr/src/nuki_hub
+COPY index.html /usr/src/nuki_hub
+COPY *.h /usr/src/nuki_hub
+COPY *.cpp /usr/src/nuki_hub
+
+RUN mkdir -p /usr/src/nuki_hub/build
+
+RUN cd /usr/src/nuki_hub/build && \
+ echo "# Espressif ESP32 Partition Table" > partitions.csv && \
+ echo "# Name, Type, SubType, Offset, Size, Flags" >> partitions.csv && \
+ echo "nvs, data, nvs, 0x9000, 0x5000," >> partitions.csv && \
+ echo "otadata, data, ota, 0xe000, 0x2000," >> partitions.csv && \
+ echo "app0, app, ota_0, 0x10000, 0x1E0000," >> partitions.csv && \
+ echo "app1, app, ota_1, 0x1F0000,0x1E0000," >> partitions.csv && \
+ echo "spiffs, data, spiffs, 0x3D0000,0x30000," >> partitions.csv
+
+RUN set -ex && \
+ cd /usr/src/nuki_hub/build && \
+ cmake -D CMAKE_TOOLCHAIN_FILE=~/Arduino-CMake-Toolchain/Arduino-toolchain.cmake .. && \
+ make
+
+FROM builder AS runtime
+
+COPY --from=builder /usr/src/nuki_hub/build/nuki_hub.bin /usr/src/nuki_hub/build/release/nuki_hub.bin
+COPY --from=builder /usr/src/nuki_hub/build/nuki_hub.partitions.bin /usr/src/nuki_hub/build/release/nuki_hub.partitions.bin
+COPY --from=builder /root/.arduino15/packages/esp32/hardware/esp32/2.0.9/tools/partitions/boot_app0.bin /usr/src/nuki_hub/build/release/boot_app0.bin
+
+CMD ["/bin/bash"]
\ No newline at end of file
diff --git a/Docker/README.md b/Docker/README.md
new file mode 100644
index 0000000..17caad5
--- /dev/null
+++ b/Docker/README.md
@@ -0,0 +1,10 @@
+# Build with Docker
+
+You can build this project using Docker. Just run the following commands in the console:
+
+```console
+cd Docker
+./build_with_docker.sh
+```
+
+once the script is complete you will find the nuki_nub binary in the `nuki_hub/build/release` folder.
diff --git a/Docker/build_with_docker.sh b/Docker/build_with_docker.sh
new file mode 100755
index 0000000..8ec1712
--- /dev/null
+++ b/Docker/build_with_docker.sh
@@ -0,0 +1,6 @@
+set -ex
+docker build -f ./Dockerfile -t nuki_hub ..
+docker create --name nuki_hub nuki_hub
+rm -rf ../build
+docker cp nuki_hub:/usr/src/nuki_hub/build/ ../
+docker rm -f nuki_hub
diff --git a/MqttTopics.h b/MqttTopics.h
index b5ae1ff..650a054 100644
--- a/MqttTopics.h
+++ b/MqttTopics.h
@@ -41,6 +41,7 @@
#define mqtt_topic_info_hardware_version "/info/hardwareVersion"
#define mqtt_topic_info_firmware_version "/info/firmwareVersion"
#define mqtt_topic_info_nuki_hub_version "/info/nukiHubVersion"
+#define mqtt_topic_info_nuki_hub_ip "/info/nukiHubIp"
#define mqtt_topic_keypad "/keypad"
#define mqtt_topic_keypad_command_action "/keypad/command/action"
diff --git a/Network.cpp b/Network.cpp
index fe48b7c..23a1730 100644
--- a/Network.cpp
+++ b/Network.cpp
@@ -491,6 +491,7 @@ bool Network::reconnect()
}
publishString(_maintenancePathPrefix, mqtt_topic_mqtt_connection_state, "online");
+ publishString(_maintenancePathPrefix, mqtt_topic_info_nuki_hub_ip, _device->localIP().c_str());
_mqttConnectionState = 2;
for(const auto& callback : _reconnectedCallbacks)
@@ -719,6 +720,18 @@ void Network::publishHASSConfig(char* deviceType, const char* baseTopic, char* n
json["dev"]["mf"] = "Nuki";
json["dev"]["mdl"] = deviceType;
json["dev"]["name"] = name;
+
+ String cuUrl = _preferences->getString(preference_mqtt_hass_cu_url);
+
+ if (cuUrl != "")
+ {
+ json["dev"]["cu"] = cuUrl;
+ }
+ else
+ {
+ json["dev"]["cu"] = "http://" + _device->localIP();
+ }
+
json["~"] = baseTopic;
json["name"] = nullptr;
json["unique_id"] = String(uidString) + "_lock";
@@ -746,10 +759,10 @@ void Network::publishHASSConfig(char* deviceType, const char* baseTopic, char* n
"battery_low",
uidString,
"_battery_low",
- "battery low",
+ "Battery low",
name,
baseTopic,
- mqtt_topic_battery_critical,
+ String("~") + mqtt_topic_battery_critical,
deviceType,
"battery",
"",
@@ -765,10 +778,10 @@ void Network::publishHASSConfig(char* deviceType, const char* baseTopic, char* n
"keypad_battery_low",
uidString,
"_keypad_battery_low",
- "keypad battery low",
+ "Keypad battery low",
name,
baseTopic,
- mqtt_topic_battery_keypad_critical,
+ String("~") + mqtt_topic_battery_keypad_critical,
deviceType,
"battery",
"",
@@ -787,10 +800,10 @@ void Network::publishHASSConfig(char* deviceType, const char* baseTopic, char* n
"battery_voltage",
uidString,
"_battery_voltage",
- "battery voltage",
+ "Battery voltage",
name,
baseTopic,
- mqtt_topic_battery_voltage,
+ String("~") + mqtt_topic_battery_voltage,
deviceType,
"voltage",
"measurement",
@@ -803,10 +816,10 @@ void Network::publishHASSConfig(char* deviceType, const char* baseTopic, char* n
"trigger",
uidString,
"_trigger",
- "trigger",
+ "Trigger",
name,
baseTopic,
- mqtt_topic_lock_trigger,
+ String("~") + mqtt_topic_lock_trigger,
deviceType,
"",
"",
@@ -822,7 +835,7 @@ void Network::publishHASSConfig(char* deviceType, const char* baseTopic, char* n
"MQTT connected",
name,
baseTopic,
- mqtt_topic_mqtt_connection_state,
+ _lockPath + mqtt_topic_mqtt_connection_state,
deviceType,
"",
"",
@@ -837,15 +850,15 @@ void Network::publishHASSConfig(char* deviceType, const char* baseTopic, char* n
"reset",
uidString,
"_reset",
- "Restart NUKI Hub",
+ "Restart Nuki Hub",
name,
baseTopic,
- mqtt_topic_reset,
+ String("~") + mqtt_topic_reset,
deviceType,
"",
"",
"diagnostic",
- mqtt_topic_reset,
+ String("~") + mqtt_topic_reset,
{ { "ic", "mdi:restart" },
{ "pl_on", "1" },
{ "pl_off", "0" },
@@ -860,7 +873,7 @@ void Network::publishHASSConfig(char* deviceType, const char* baseTopic, char* n
"Firmware version",
name,
baseTopic,
- mqtt_topic_info_firmware_version,
+ String("~") + mqtt_topic_info_firmware_version,
deviceType,
"",
"",
@@ -877,7 +890,7 @@ void Network::publishHASSConfig(char* deviceType, const char* baseTopic, char* n
"Hardware version",
name,
baseTopic,
- mqtt_topic_info_hardware_version,
+ String("~") + mqtt_topic_info_hardware_version,
deviceType,
"",
"",
@@ -890,11 +903,11 @@ void Network::publishHASSConfig(char* deviceType, const char* baseTopic, char* n
publishHassTopic("sensor",
"nuki_hub_version",
uidString,
- "_nuki_hub__version",
- "NUKI Hub version",
+ "_nuki_hub_version",
+ "Nuki Hub version",
name,
baseTopic,
- mqtt_topic_info_nuki_hub_version,
+ _lockPath + mqtt_topic_info_nuki_hub_version,
deviceType,
"",
"",
@@ -903,6 +916,23 @@ void Network::publishHASSConfig(char* deviceType, const char* baseTopic, char* n
{ { "enabled_by_default", "true" },
{"ic", "mdi:counter"}});
+ // NUKI Hub IP Address
+ publishHassTopic("sensor",
+ "nuki_hub_ip",
+ uidString,
+ "_nuki_hub_ip",
+ "Nuki Hub IP",
+ name,
+ baseTopic,
+ _lockPath + mqtt_topic_info_nuki_hub_ip,
+ deviceType,
+ "",
+ "",
+ "diagnostic",
+ "",
+ { { "enabled_by_default", "true" },
+ {"ic", "mdi:ip"}});
+
// LED enabled
publishHassTopic("switch",
"led_enabled",
@@ -911,12 +941,12 @@ void Network::publishHASSConfig(char* deviceType, const char* baseTopic, char* n
"LED enabled",
name,
baseTopic,
- mqtt_topic_config_led_enabled,
+ String("~") + mqtt_topic_config_led_enabled,
deviceType,
"",
"",
"config",
- mqtt_topic_config_led_enabled,
+ String("~") + mqtt_topic_config_led_enabled,
{ { "ic", "mdi:led-variant-on" },
{ "pl_on", "1" },
{ "pl_off", "0" },
@@ -931,12 +961,12 @@ void Network::publishHASSConfig(char* deviceType, const char* baseTopic, char* n
"Button enabled",
name,
baseTopic,
- mqtt_topic_config_button_enabled,
+ String("~") + mqtt_topic_config_button_enabled,
deviceType,
"",
"",
"config",
- mqtt_topic_config_button_enabled,
+ String("~") + mqtt_topic_config_button_enabled,
{ { "ic", "mdi:radiobox-marked" },
{ "pl_on", "1" },
{ "pl_off", "0" },
@@ -951,12 +981,12 @@ void Network::publishHASSConfig(char* deviceType, const char* baseTopic, char* n
"Unlatch",
name,
baseTopic,
- mqtt_topic_mqtt_connection_state,
+ "",
deviceType,
"",
"",
"",
- mqtt_topic_lock_action,
+ String("~") + mqtt_topic_lock_action,
{ { "enabled_by_default", "false" },
{ "pl_prs", "unlatch" }});
@@ -974,12 +1004,12 @@ void Network::publishHASSConfigAdditionalButtons(char *deviceType, const char *b
"Lock 'n' Go",
name,
baseTopic,
- mqtt_topic_mqtt_connection_state,
+ "",
deviceType,
"",
"",
"",
- mqtt_topic_lock_action,
+ String("~") + mqtt_topic_lock_action,
{ { "enabled_by_default", "false" },
{ "pl_prs", "lockNgo" }});
@@ -991,12 +1021,12 @@ void Network::publishHASSConfigAdditionalButtons(char *deviceType, const char *b
"Lock 'n' Go with unlatch",
name,
baseTopic,
- mqtt_topic_mqtt_connection_state,
+ "",
deviceType,
"",
"",
"",
- mqtt_topic_lock_action,
+ String("~") + mqtt_topic_lock_action,
{ { "enabled_by_default", "false" },
{ "pl_prs", "lockNgoUnlatch" }});
}
@@ -1013,10 +1043,10 @@ void Network::publishHASSConfigBatLevel(char *deviceType, const char *baseTopic,
"battery_level",
uidString,
"_battery_level",
- "battery level",
+ "Battery level",
name,
baseTopic,
- mqtt_topic_battery_level,
+ String("~") + mqtt_topic_battery_level,
deviceType,
"battery",
"measurement",
@@ -1038,10 +1068,10 @@ void Network::publishHASSConfigDoorSensor(char *deviceType, const char *baseTopi
"door_sensor",
uidString,
"_door_sensor",
- "door sensor",
+ "Door sensor",
name,
baseTopic,
- mqtt_topic_lock_door_sensor_state,
+ String("~") + mqtt_topic_lock_door_sensor_state,
deviceType,
"door",
"",
@@ -1063,10 +1093,10 @@ void Network::publishHASSConfigRingDetect(char *deviceType, const char *baseTopi
"ring",
uidString,
"_ring_detect",
- "ring detect",
+ "Ring detect",
name,
baseTopic,
- mqtt_topic_lock_state,
+ String("~") + mqtt_topic_lock_state,
deviceType,
"sound",
"",
@@ -1087,12 +1117,12 @@ void Network::publishHASSConfigLedBrightness(char *deviceType, const char *baseT
"LED brightness",
name,
baseTopic,
- mqtt_topic_config_led_brightness,
+ String("~") + mqtt_topic_config_led_brightness,
deviceType,
"",
"",
"config",
- mqtt_topic_config_led_brightness,
+ String("~") + mqtt_topic_config_led_brightness,
{ { "ic", "mdi:brightness-6" },
{ "min", "0" },
{ "max", "5" }});
@@ -1100,22 +1130,24 @@ void Network::publishHASSConfigLedBrightness(char *deviceType, const char *baseT
void Network::publishHASSConfigSoundLevel(char *deviceType, const char *baseTopic, char *name, char *uidString)
{
- publishHassTopic("sensor",
+ publishHassTopic("number",
"sound_level",
uidString,
"_sound_level",
"Sound level",
name,
baseTopic,
- mqtt_topic_config_sound_level,
+ String("~") + mqtt_topic_config_sound_level,
deviceType,
"",
"",
- "diagnostic",
- mqtt_topic_config_sound_level,
+ "config",
+ String("~") + mqtt_topic_config_sound_level,
{ { "ic", "mdi:volume-source" },
{ "min", "0" },
- { "max", "255" }});
+ { "max", "255" },
+ { "mode", "slider" },
+ { "step", "25.5" }});
}
@@ -1128,7 +1160,7 @@ void Network::publishHASSConfigAccessLog(char *deviceType, const char *baseTopic
"Last action authorization",
name,
baseTopic,
- mqtt_topic_lock_log,
+ String("~") + mqtt_topic_lock_log,
deviceType,
"",
"",
@@ -1147,7 +1179,7 @@ void Network::publishHASSConfigKeypadAttemptInfo(char *deviceType, const char *b
"Keypad status",
name,
baseTopic,
- mqtt_topic_lock_log,
+ String("~") + mqtt_topic_lock_log,
deviceType,
"",
"",
@@ -1172,10 +1204,10 @@ void Network::publishHASSWifiRssiConfig(char *deviceType, const char *baseTopic,
"wifi_signal_strength",
uidString,
"_wifi_signal_strength",
- "wifi signal strength",
+ "WIFI signal strength",
name,
baseTopic,
- mqtt_topic_wifi_rssi,
+ _lockPath + mqtt_topic_wifi_rssi,
deviceType,
"signal_strength",
"measurement",
@@ -1195,10 +1227,10 @@ void Network::publishHASSBleRssiConfig(char *deviceType, const char *baseTopic,
"bluetooth_signal_strength",
uidString,
"_bluetooth_signal_strength",
- "bluetooth signal strength",
+ "Bluetooth signal strength",
name,
baseTopic,
- mqtt_topic_lock_rssi,
+ String("~") + mqtt_topic_lock_rssi,
deviceType,
"signal_strength",
"measurement",
@@ -1245,8 +1277,12 @@ void Network::publishHassTopic(const String& mqttDeviceType,
{
json["dev_cla"] = deviceClass;
}
- json["stat_t"] = String("~") + stateTopic;
-
+
+ if(stateTopic != "")
+ {
+ json["stat_t"] = stateTopic;
+ }
+
if(stateClass != "")
{
json["stat_cla"] = stateClass;
@@ -1257,8 +1293,10 @@ void Network::publishHassTopic(const String& mqttDeviceType,
}
if(commandTopic != "")
{
- json["cmd_t"] = String("~") + commandTopic;
+ json["cmd_t"] = commandTopic;
}
+
+ json["avty"]["t"] = _lockPath + mqtt_topic_mqtt_connection_state;
for(const auto& entry : additionalEntries)
{
@@ -1366,6 +1404,24 @@ void Network::removeHASSConfig(char* uidString)
path.concat("/battery_level/config");
_device->mqttPublish(path.c_str(), MQTT_QOS_LEVEL, true, "");
+ path = discoveryTopic;
+ path.concat("/sensor/");
+ path.concat(uidString);
+ path.concat("/sound_level/config");
+ _device->mqttPublish(path.c_str(), MQTT_QOS_LEVEL, true, "");
+
+ path = discoveryTopic;
+ path.concat("/sensor/");
+ path.concat(uidString);
+ path.concat("/nuki_hub_ip/config");
+ _device->mqttPublish(path.c_str(), MQTT_QOS_LEVEL, true, "");
+
+ path = discoveryTopic;
+ path.concat("/number/");
+ path.concat(uidString);
+ path.concat("/sound_level/config");
+ _device->mqttPublish(path.c_str(), MQTT_QOS_LEVEL, true, "");
+
path = discoveryTopic;
path.concat("/binary_sensor/");
path.concat(uidString);
diff --git a/PreferencesKeys.h b/PreferencesKeys.h
index b658772..13757d5 100644
--- a/PreferencesKeys.h
+++ b/PreferencesKeys.h
@@ -20,6 +20,7 @@
#define preference_mqtt_crt "mqttcrt"
#define preference_mqtt_key "mqttkey"
#define preference_mqtt_hass_discovery "hassdiscovery"
+#define preference_mqtt_hass_cu_url "hassConfigUrl"
#define preference_ip_dhcp_enabled "dhcpena"
#define preference_ip_address "ipaddr"
#define preference_ip_subnet "ipsub"
@@ -64,7 +65,7 @@ private:
preference_mqtt_user, preference_mqtt_password, preference_mqtt_log_enabled, preference_lock_enabled,
preference_mqtt_lock_path, preference_opener_enabled, preference_mqtt_opener_path,
preference_lock_max_keypad_code_count, preference_opener_max_keypad_code_count, preference_mqtt_ca,
- preference_mqtt_crt, preference_mqtt_key, preference_mqtt_hass_discovery,
+ preference_mqtt_crt, preference_mqtt_key, preference_mqtt_hass_discovery, preference_mqtt_hass_cu_url,
preference_ip_dhcp_enabled, preference_ip_address, preference_ip_subnet, preference_ip_gateway, preference_ip_dns_server,
preference_network_hardware, preference_network_wifi_fallback_disabled, preference_rssi_publish_interval,
preference_hostname, preference_network_timeout, preference_restart_on_disconnect,
diff --git a/WebCfgServer.cpp b/WebCfgServer.cpp
index 07f1446..d6a1372 100644
--- a/WebCfgServer.cpp
+++ b/WebCfgServer.cpp
@@ -352,6 +352,11 @@ bool WebCfgServer::processArgs(String& message)
configChanged = true;
}
}
+ else if(key == "HASSCUURL")
+ {
+ _preferences->putString(preference_mqtt_hass_cu_url, value);
+ configChanged = true;
+ }
else if(key == "HOSTNAME")
{
_preferences->putString(preference_hostname, value);
@@ -764,6 +769,7 @@ void WebCfgServer::buildMqttConfigHtml(String &response)
response.concat("Advanced MQTT and Network Configuration
");
response.concat("");
printInputField(response, "HASSDISCOVERY", "Home Assistant discovery topic (empty to disable; usually homeassistant)", _preferences->getString(preference_mqtt_hass_discovery).c_str(), 30);
+ printInputField(response, "HASSCUURL", "Home Assistant device configuration URL (empty to use http://LOCALIP; fill when using a reverse proxy for example)", _preferences->getString(preference_mqtt_hass_cu_url).c_str(), 261);
printTextarea(response, "MQTTCA", "MQTT SSL CA Certificate (*, optional)", _preferences->getString(preference_mqtt_ca).c_str(), TLS_CA_MAX_SIZE, _network->encryptionSupported(), true);
printTextarea(response, "MQTTCRT", "MQTT SSL Client Certificate (*, optional)", _preferences->getString(preference_mqtt_crt).c_str(), TLS_CERT_MAX_SIZE, _network->encryptionSupported(), true);
printTextarea(response, "MQTTKEY", "MQTT SSL Client Key (*, optional)", _preferences->getString(preference_mqtt_key).c_str(), TLS_KEY_MAX_SIZE, _network->encryptionSupported(), true);
diff --git a/networkDevices/EthLan8720Device.cpp b/networkDevices/EthLan8720Device.cpp
index d550fbb..9270743 100644
--- a/networkDevices/EthLan8720Device.cpp
+++ b/networkDevices/EthLan8720Device.cpp
@@ -138,3 +138,8 @@ int8_t EthLan8720Device::signalStrength()
{
return -1;
}
+
+String EthLan8720Device::localIP()
+{
+ return ETH.localIP().toString();
+}
diff --git a/networkDevices/EthLan8720Device.h b/networkDevices/EthLan8720Device.h
index 14fb742..b26d1b0 100644
--- a/networkDevices/EthLan8720Device.h
+++ b/networkDevices/EthLan8720Device.h
@@ -33,6 +33,8 @@ public:
virtual bool isConnected();
int8_t signalStrength() override;
+
+ String localIP() override;
private:
void onDisconnected();
diff --git a/networkDevices/NetworkDevice.h b/networkDevices/NetworkDevice.h
index 7c945ee..9721be4 100644
--- a/networkDevices/NetworkDevice.h
+++ b/networkDevices/NetworkDevice.h
@@ -31,6 +31,8 @@ public:
virtual bool isConnected() = 0;
virtual int8_t signalStrength() = 0;
+
+ virtual String localIP() = 0;
virtual void mqttSetClientId(const char* clientId);
virtual void mqttSetCleanSession(bool cleanSession);
diff --git a/networkDevices/W5500Device.cpp b/networkDevices/W5500Device.cpp
index d7b45d3..3b8720a 100644
--- a/networkDevices/W5500Device.cpp
+++ b/networkDevices/W5500Device.cpp
@@ -220,3 +220,8 @@ int8_t W5500Device::signalStrength()
{
return 127;
}
+
+String W5500Device::localIP()
+{
+ return Ethernet.localIP().toString();
+}
diff --git a/networkDevices/W5500Device.h b/networkDevices/W5500Device.h
index 916198c..a3407f5 100644
--- a/networkDevices/W5500Device.h
+++ b/networkDevices/W5500Device.h
@@ -31,6 +31,8 @@ public:
virtual bool isConnected();
int8_t signalStrength() override;
+
+ String localIP() override;
private:
void resetDevice();
diff --git a/networkDevices/WifiDevice.cpp b/networkDevices/WifiDevice.cpp
index 11139c4..7a2d18f 100644
--- a/networkDevices/WifiDevice.cpp
+++ b/networkDevices/WifiDevice.cpp
@@ -154,6 +154,11 @@ int8_t WifiDevice::signalStrength()
return WiFi.RSSI();
}
+String WifiDevice::localIP()
+{
+ return WiFi.localIP().toString();
+}
+
void WifiDevice::clearRtcInitVar(WiFiManager *)
{
memset(WiFiDevice_reconfdetect, 0, sizeof WiFiDevice_reconfdetect);
diff --git a/networkDevices/WifiDevice.h b/networkDevices/WifiDevice.h
index 952b45f..0e5c164 100644
--- a/networkDevices/WifiDevice.h
+++ b/networkDevices/WifiDevice.h
@@ -23,6 +23,8 @@ public:
virtual bool isConnected();
int8_t signalStrength() override;
+
+ String localIP() override;
private:
static void clearRtcInitVar(WiFiManager*);