Files
OpenMQTTGateway/docs/use/webui.md
Peter Lambrechtsen 2d29ee4524 [BLE] Add support for decrypting PVVX, BTHome v2 and Victron BLE frames (#2219)
* Changing WebUI to include display device name, and change it to select drop down rather than checkbox

* Fix mqttDiscovery to require WebUI and ESP32 for displayDeviceName

* Fix mqttDiscovery to require WebUI and ESP32 and ESP8266 for displayDeviceName and ForceDeviceName

* Changing WebUI to include display device name, and change it to select drop down rather than checkbox

* Fixes for WebUI and BT for supporting custom setting Display name

* Fixes for WebUI and BT for supporting custom setting Display name

* Move DISPLAY_DEVICE_NAME to User_config.h

* Update docs to include change for Display temperature

* Update docs to include change for Display temperature

* Fix minor cosmetic bug where devices were not linking in HA to the gateway using via_device as it should be the gateway mac address not name

* Add support for decrypting BTHome v2 frames

* Add support for decrypting BTHome v2 frames

* Add support for decrypting BTHome v2 frames

* BTHome fix issue with theengs-plug

* BTHome fix issue with theengs-plug

* Adding support for all BLE encrypted methods, support in UI and gatewayBT for specific MACAddress AES Keys

* Fix lint

* Fix build issue with theengs-bridge-v11 and esp32dev-all-test and revert the documentation to Units of measurement displayed

* Revert docs

* Revert displayDeviceName and Units of measurement

* Revert displayDeviceName and Units of measurement

* Revert displayDeviceName and Units of measurement

* Revert minor typo

* Revert minor typo

* Revert minor typo

* Bug in Victron as nonce should be 16 bytes

* Shortened the client side javascript for BLE key validation that is commented out due to image constrains on theengs-bridge-v11
2025-08-06 19:59:33 -05:00

1.9 KiB

WebUI

For ESP32 based environments a WebUI is available to provide basic configuration and monitoring of your OpenMQTTGateway Device. Functions included are:

  • Configuration
  • Information
  • Firmware Upgrade
  • Console
  • Restart

Login Authentication

By default access to the WebUI uses basic authentication to control access to your OpenMQTTGateway Device. The login is admin and the password is your gateway password (if unchanged during onboarding there is no password).

::: warning The communication with the WebUI is not encrypted, which means that your data may be visible on your local network. :::

Configuration Options

WiFi

Ability to change the SSID and password for your WiFi, if the change is unsuccessful it will revert back to the previous WiFi settings.

MQTT

Ability to change the mqtt settings, if the change is unsuccessful it will revert back to the previous mqtt settings.

WebUI

Ability to change the display of sensor to Metric or Imperial, and disable the WebUI Authentication

Bluetooth Low Energy - BLE

Ability to add the default AES BLE decryption key, and multiple per-device macaddress:aeskey allowing for devices that cannot have their AES key changed.

Logging

Ability to temporarily change the logging level.

Information

Details of OpenMQTTGateway Device status

Firmware Upgrade

Ability to upgrade firmware by URL or to latest version.

Console

Ability to view messages from the OpenMQTTGateway console. The scope of messages visible in the UI is limited to just the OpenMQTTGateway codebase, messages from the ESP hardware or other libraries are not visible,

Ability to inject commands to OpenMQTTGateway for processing. The commands accepted are of the form mqtt topic then json message. And as you are already on the target device, you do not need to include the device name ie

commands/MQTTtoSYS/config {"cmd":"restart"}

This works for all modules in your environment.