From 6c079d13403d6cf446a63ee6efd0d97eed36e6e6 Mon Sep 17 00:00:00 2001 From: Luca Oliano Date: Mon, 5 Feb 2024 18:11:53 +0100 Subject: [PATCH 1/4] add docker build script --- Docker/Dockerfile | 48 +++++++++++++++++++++++++++++++++++++ Docker/README.md | 10 ++++++++ Docker/build_with_docker.sh | 6 +++++ 3 files changed, 64 insertions(+) create mode 100644 Docker/Dockerfile create mode 100644 Docker/README.md create mode 100755 Docker/build_with_docker.sh 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 From f66319620cbc392081080f538ce2eb2e3fc3645c Mon Sep 17 00:00:00 2001 From: iranl Date: Tue, 6 Feb 2024 17:15:00 +0100 Subject: [PATCH 2/4] Make Opener Sound Level a configurable number in HA --- Network.cpp | 20 +++++++++++++++++--- 1 file changed, 17 insertions(+), 3 deletions(-) diff --git a/Network.cpp b/Network.cpp index fe48b7c..a0366ff 100644 --- a/Network.cpp +++ b/Network.cpp @@ -1100,7 +1100,7 @@ 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", @@ -1111,11 +1111,13 @@ void Network::publishHASSConfigSoundLevel(char *deviceType, const char *baseTopi deviceType, "", "", - "diagnostic", + "config", mqtt_topic_config_sound_level, { { "ic", "mdi:volume-source" }, { "min", "0" }, - { "max", "255" }}); + { "max", "255" }, + { "mode", "slider" }, + { "step", "25.5" }}); } @@ -1366,6 +1368,18 @@ 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("/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); From 9463ee99788158e6602ba6c2e40b1449c4ff695e Mon Sep 17 00:00:00 2001 From: iranl Date: Tue, 6 Feb 2024 20:50:50 +0100 Subject: [PATCH 3/4] Fix Home Assistant discovery topics --- Network.cpp | 66 ++++++++++++++++++++++++++--------------------------- 1 file changed, 33 insertions(+), 33 deletions(-) diff --git a/Network.cpp b/Network.cpp index fe48b7c..0581b3c 100644 --- a/Network.cpp +++ b/Network.cpp @@ -749,7 +749,7 @@ void Network::publishHASSConfig(char* deviceType, const char* baseTopic, char* n "battery low", name, baseTopic, - mqtt_topic_battery_critical, + String("~") + mqtt_topic_battery_critical, deviceType, "battery", "", @@ -768,7 +768,7 @@ void Network::publishHASSConfig(char* deviceType, const char* baseTopic, char* n "keypad battery low", name, baseTopic, - mqtt_topic_battery_keypad_critical, + String("~") + mqtt_topic_battery_keypad_critical, deviceType, "battery", "", @@ -790,7 +790,7 @@ void Network::publishHASSConfig(char* deviceType, const char* baseTopic, char* n "battery voltage", name, baseTopic, - mqtt_topic_battery_voltage, + String("~") + mqtt_topic_battery_voltage, deviceType, "voltage", "measurement", @@ -806,7 +806,7 @@ void Network::publishHASSConfig(char* deviceType, const char* baseTopic, char* n "trigger", name, baseTopic, - mqtt_topic_lock_trigger, + String("~") + mqtt_topic_lock_trigger, deviceType, "", "", @@ -822,7 +822,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, "", "", @@ -840,12 +840,12 @@ void Network::publishHASSConfig(char* deviceType, const char* baseTopic, char* n "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 +860,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 +877,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, "", "", @@ -894,7 +894,7 @@ void Network::publishHASSConfig(char* deviceType, const char* baseTopic, char* n "NUKI Hub version", name, baseTopic, - mqtt_topic_info_nuki_hub_version, + _lockPath + mqtt_topic_info_nuki_hub_version, deviceType, "", "", @@ -911,12 +911,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 +931,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 +951,12 @@ void Network::publishHASSConfig(char* deviceType, const char* baseTopic, char* n "Unlatch", name, baseTopic, - mqtt_topic_mqtt_connection_state, + _lockPath + mqtt_topic_mqtt_connection_state, deviceType, "", "", "", - mqtt_topic_lock_action, + String("~") + mqtt_topic_lock_action, { { "enabled_by_default", "false" }, { "pl_prs", "unlatch" }}); @@ -974,12 +974,12 @@ void Network::publishHASSConfigAdditionalButtons(char *deviceType, const char *b "Lock 'n' Go", name, baseTopic, - mqtt_topic_mqtt_connection_state, + _lockPath + mqtt_topic_mqtt_connection_state, deviceType, "", "", "", - mqtt_topic_lock_action, + String("~") + mqtt_topic_lock_action, { { "enabled_by_default", "false" }, { "pl_prs", "lockNgo" }}); @@ -991,12 +991,12 @@ void Network::publishHASSConfigAdditionalButtons(char *deviceType, const char *b "Lock 'n' Go with unlatch", name, baseTopic, - mqtt_topic_mqtt_connection_state, + _lockPath + mqtt_topic_mqtt_connection_state, deviceType, "", "", "", - mqtt_topic_lock_action, + String("~") + mqtt_topic_lock_action, { { "enabled_by_default", "false" }, { "pl_prs", "lockNgoUnlatch" }}); } @@ -1016,7 +1016,7 @@ void Network::publishHASSConfigBatLevel(char *deviceType, const char *baseTopic, "battery level", name, baseTopic, - mqtt_topic_battery_level, + String("~") + mqtt_topic_battery_level, deviceType, "battery", "measurement", @@ -1041,7 +1041,7 @@ void Network::publishHASSConfigDoorSensor(char *deviceType, const char *baseTopi "door sensor", name, baseTopic, - mqtt_topic_lock_door_sensor_state, + String("~") + mqtt_topic_lock_door_sensor_state, deviceType, "door", "", @@ -1066,7 +1066,7 @@ void Network::publishHASSConfigRingDetect(char *deviceType, const char *baseTopi "ring detect", name, baseTopic, - mqtt_topic_lock_state, + String("~") + mqtt_topic_lock_state, deviceType, "sound", "", @@ -1087,12 +1087,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" }}); @@ -1107,12 +1107,12 @@ void Network::publishHASSConfigSoundLevel(char *deviceType, const char *baseTopi "Sound level", name, baseTopic, - mqtt_topic_config_sound_level, + String("~") + mqtt_topic_config_sound_level, deviceType, "", "", "diagnostic", - mqtt_topic_config_sound_level, + String("~") + mqtt_topic_config_sound_level, { { "ic", "mdi:volume-source" }, { "min", "0" }, { "max", "255" }}); @@ -1128,7 +1128,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 +1147,7 @@ void Network::publishHASSConfigKeypadAttemptInfo(char *deviceType, const char *b "Keypad status", name, baseTopic, - mqtt_topic_lock_log, + String("~") + mqtt_topic_lock_log, deviceType, "", "", @@ -1175,7 +1175,7 @@ void Network::publishHASSWifiRssiConfig(char *deviceType, const char *baseTopic, "wifi signal strength", name, baseTopic, - mqtt_topic_wifi_rssi, + _lockPath + mqtt_topic_wifi_rssi, deviceType, "signal_strength", "measurement", @@ -1198,7 +1198,7 @@ void Network::publishHASSBleRssiConfig(char *deviceType, const char *baseTopic, "bluetooth signal strength", name, baseTopic, - mqtt_topic_lock_rssi, + String("~") + mqtt_topic_lock_rssi, deviceType, "signal_strength", "measurement", @@ -1245,7 +1245,7 @@ void Network::publishHassTopic(const String& mqttDeviceType, { json["dev_cla"] = deviceClass; } - json["stat_t"] = String("~") + stateTopic; + json["stat_t"] = stateTopic; if(stateClass != "") { @@ -1257,7 +1257,7 @@ void Network::publishHassTopic(const String& mqttDeviceType, } if(commandTopic != "") { - json["cmd_t"] = String("~") + commandTopic; + json["cmd_t"] = commandTopic; } for(const auto& entry : additionalEntries) From ac58d23a088001c80bd9e43c6c9cf22a4e70b9cf Mon Sep 17 00:00:00 2001 From: iranl Date: Tue, 6 Feb 2024 22:13:21 +0100 Subject: [PATCH 4/4] Additional fixes --- Network.cpp | 16 +++++++++++----- 1 file changed, 11 insertions(+), 5 deletions(-) diff --git a/Network.cpp b/Network.cpp index 0581b3c..afe1973 100644 --- a/Network.cpp +++ b/Network.cpp @@ -951,7 +951,7 @@ void Network::publishHASSConfig(char* deviceType, const char* baseTopic, char* n "Unlatch", name, baseTopic, - _lockPath + mqtt_topic_mqtt_connection_state, + "", deviceType, "", "", @@ -974,7 +974,7 @@ void Network::publishHASSConfigAdditionalButtons(char *deviceType, const char *b "Lock 'n' Go", name, baseTopic, - _lockPath + mqtt_topic_mqtt_connection_state, + "", deviceType, "", "", @@ -991,7 +991,7 @@ void Network::publishHASSConfigAdditionalButtons(char *deviceType, const char *b "Lock 'n' Go with unlatch", name, baseTopic, - _lockPath + mqtt_topic_mqtt_connection_state, + "", deviceType, "", "", @@ -1245,8 +1245,12 @@ void Network::publishHassTopic(const String& mqttDeviceType, { json["dev_cla"] = deviceClass; } - json["stat_t"] = stateTopic; - + + if(stateTopic != "") + { + json["stat_t"] = stateTopic; + } + if(stateClass != "") { json["stat_cla"] = stateClass; @@ -1259,6 +1263,8 @@ void Network::publishHassTopic(const String& mqttDeviceType, { json["cmd_t"] = commandTopic; } + + json["avty"]["t"] = _lockPath + mqtt_topic_mqtt_connection_state; for(const auto& entry : additionalEntries) {