UniFi Hotspot Manager as a Custom Component for Home Assistant.
This integration facilitates user-friendly management of guest Wi-Fi vouchers. By integrating with Home Assistant, users can swiftly and easily generate and display personalized access codes. These vouchers can then be shared with guests, granting temporary access to the Wi-Fi network.
Key features of the integration include:
- Voucher Creation: Users can effortlessly generate new access codes, with various configuration options such as validity period and available data volume.
- Display of Voucher: The last created voucher is presented in the Home Assistant interface. As soon as the voucher has been used, the next one will be displayed.
- QR Code Display: The integration enables the display of a QR code for the guest Wi-Fi, facilitating quick connectivity for guests.
- Automation: The integration can be integrated into existing automations and allows, for example, the time-controlled creation of vouchers.
- User-Friendliness: The integration is designed to offer an intuitive user experience, utilizing the Home Assistant interface as a central control center for guest Wi-Fi management.
The UniFi Hotspot Manager Integration provides a practical solution for the temporary provision of Wi-Fi access, seamlessly integrating into the Home Assistant environment for intuitive use.
The most UniFi Network Controller by Ubiquiti Networks, inc., e.g. Cloud Key 2, UDM, UDM Pro are supported.
The voucher can be presented together with the QR code on a lovelace card:
Blueprint of the example
The example shown can be implemented as follows. The image file for the background must be stored in the `/config/www/` folder.type: picture-elements
image: /local/hotspot-bg.jpg
elements:
- type: state-label
entity: image.123456789073fdb051c706194_qr_code
attribute: wlan_name
style:
top: 15%
left: 50%
color: white
font-size: 200%
font-weight: bold
cursor: default
tap_action:
action: none
hold_action:
action: none
- type: image
entity: image.123456789073fdb051c706194_qr_code
style:
top: 53%
left: 20%
width: 30%
cursor: default
- type: state-label
entity: sensor.123456789073fdb051c706194_voucher
style:
top: 53%
left: 67%
background: rgba(11, 11, 11, 70%)
padding: 10px
height: 60px
color: white
border-radius: 12px
font-size: 275%
font-weight: bold
cursor: default
tap_action:
action: none
hold_action:
action: none
- type: state-label
entity: sensor.123456789073fdb051c706194_voucher
attribute: duration
prefix: 'Duration: '
style:
top: 61%
left: 67%
color: white
cursor: default
tap_action:
action: none
hold_action:
action: none
- type: service-button
title: Refresh
style:
transform: none
bottom: 5%
left: 5%
service: button.press
service_data:
entity_id: button.123456789073fdb051c706194_update
- type: service-button
title: Create
style:
transform: none
bottom: 5%
right: 5%
service: button.press
service_data:
entity_id: button.123456789073fdb051c706194_createImportant
Requires Home Assistant 2024.8.0 or newer.
Installation using Home Assistant Community Store (HACS) is recommended.
-
If HACS is not installed, follow HACS installation and configuration at https://hacs.xyz/.
-
Click the button below or visit the HACS Integrations pane and add
https://github.com/ufozone/ha-unifi-voucher.gitas anIntegrationby following these instructions. -
Install the integration.
-
Restart Home Assistant!
-
Make sure that you refresh your browser window too.
-
Download the
unifi_voucher.zipfile from the repository release section.Do not download directly from the
mainbranch. -
Extract and copy the content into the path
/config/custom_components/unifi_voucherof your HA installation. -
Restart Home Assistant!
-
Make sure that you refresh your browser window too.
Start setup:
-
Click this button:
-
Or use the "Add Integration" in Home Assistant, Settings, Devices & Services and select "UniFi Hotspot Manager".
- All configuration options are offered from the front end.
- For UniFi OS a local-only user needs to be created. A user who uses the Ubiquiti cloud will not work.
- The user needs super admin, site admin or hotspot privileges in order to manage guest vouchers.
-
create
Attributes:
last_poll -
delete
Attributes:
last_poll -
update
Attributes:
last_poll
This entity is disabled by default. You have to activate it if you want to use it.
-
qr_code
Attributes:
wlan_name, last_poll
These entities are disabled by default. You have to activate it if you want to use it.
-
voucher_quota
Attributes:
last_poll -
voucher_duration
Attributes:
last_poll -
voucher_usage_quota
Attributes:
last_poll -
voucher_rate_max_up
Attributes:
last_poll -
voucher_rate_max_down
Attributes:
last_poll
-
voucher
Attributes:
wlan_name, id, quota, used, duration, status, create_time, start_time, end_time, status_expires, usage_quota, rate_max_up, rate_max_down, last_poll
-
unifi_voucher.list:Get a list of all valid vouchers.
-
unifi_voucher.create:Create a new voucher with your own parameters or the default settings of the integration.
-
unifi_voucher.delete:Delete a special voucher or the last created voucher.
-
unifi_voucher.update:Fetch data from UniFi Controller immediately.
To enable debug logging for this integration you can control this in your Home Assistant configuration.yaml file.
Set the logging to debug with the following settings in case of problems:
logger:
default: warn
logs:
aiounifi: debug
custom_components.unifi_voucher: debugAfter a restart detailed log entries will appear in /config/home-assistant.log.
![dependabot[bot] avatar](https://avatars.githubusercontent.com/in/29110?v=4 "dependabot[bot]")
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent