Skip to content

WebUI

Jump to bottom
rednblkx edited this page Jul 1, 2024 · 2 revisions

Web Interface

With the release of version 0.3, an basic web interface was implemented and includes multiple core things for this project such as MQTT Broker parameters and defining the various topics that are used.

This is available over port 80

1. Structure

As it stands now, it very much lacks the CSS dazzle in order to save memory space so it looks like you are back in 1999, but hey...functionality over form right?

Its structure only consists three categories:

  • HK Info - this is where you will find all the relevant HomeKey IDs like your Issuer ID and Endpoint ID
  • MQTT Config - this is where you can configure the connection with the broker and assign a value for each topic as well as enable or disable MQTT Discovery
  • Misc - this category consists of three sections, Device Name & HomeSpan/MQTT settings, GPIO Options for HomeKey Events and the final section serves to options for GPIO Actions.

Miscellaneous

In the Miscellaneous page is where you will find the bonus stuff, here you will find:

  • HomeKey Events
    • If you are looking to have an attached buzzer or LED to be pulled LOW or HIGH whenever HomeKey is successful or has failed or whenever a regular NFC Tag is detected which will passed as success every time
  • Hardware Lock
    • This gives the posibility to assign a GPIO pin to an electric lock for example to be actioned when you interact with the Lock in the Home App or on a HomeKey Successful Event

This is also where you can change stuff like the HomeKit Setup Code or the color of the Key in Wallet from the 4 pre-established option from Apple (Tan, Gold, Silver or Black).

Note: The HomeKey Card Finish(color) needs to be chosen before pairing as otherwise it takes a long time for Wallet to refresh the property post-pairing.

Clone this wiki locally