{"id":50992178,"url":"https://github.com/ageron/ha-quicnz","last_synced_at":"2026-06-20T04:32:26.613Z","repository":{"id":359503828,"uuid":"1246309875","full_name":"ageron/ha-quicnz","owner":"ageron","description":"Home Assistant custom integration for Quic Broadband (New Zealand)","archived":false,"fork":false,"pushed_at":"2026-05-30T23:14:32.000Z","size":165,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-05-31T01:10:34.217Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ageron.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2026-05-22T04:28:05.000Z","updated_at":"2026-05-30T23:14:36.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/ageron/ha-quicnz","commit_stats":null,"previous_names":["ageron/ha-quicnz"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/ageron/ha-quicnz","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ageron%2Fha-quicnz","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ageron%2Fha-quicnz/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ageron%2Fha-quicnz/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ageron%2Fha-quicnz/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ageron","download_url":"https://codeload.github.com/ageron/ha-quicnz/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ageron%2Fha-quicnz/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":34557551,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-06-20T02:00:06.407Z","response_time":98,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2026-06-20T04:32:26.090Z","updated_at":"2026-06-20T04:32:26.604Z","avatar_url":"https://github.com/ageron.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# ha-quicnz\n\nHome Assistant custom integration for [Quic Broadband](https://quic.nz/) (New Zealand).\n\nExposes your Quic broadband session and service details as Home Assistant entities via the [quicnz](https://github.com/ageron/quicnz) library.\n\n\u003e **Disclaimer:** This project is independent and community-maintained. It is not affiliated with, endorsed by, or supported by Quic Broadband / Vetta Trading Ltd in any way. Use it at your own risk.\n\n---\n\n## Features\n\n| Entity | Type | Description |\n|---|---|---|\n| Connected | Binary sensor | `on` when the session status is `connected` |\n| Session Status | Sensor | Raw session status string (e.g. `connected`) |\n| Session Type | Sensor | `DHCP` or `PPPoE` |\n| IPv4 Address | Sensor | Assigned public IPv4 address |\n| IPv6 Prefix | Sensor | Assigned IPv6 prefix |\n| Last RADIUS Update | Sensor | Timestamp of the last RADIUS accounting update |\n| Session Expires | Sensor | Timestamp when the current session expires |\n| Local Fibre Company | Sensor | LFC name (e.g. `Chorus`) |\n| Service Status | Sensor | Service account status (e.g. `active`) |\n| Data Cap | Sensor | Monthly data cap in GB (`unavailable` when uncapped) |\n| Network Weather Map | Image | JPEG snapshot of the Quic network weather map |\n\nSession data is refreshed every **5 minutes**; the weather map every **6 minutes** — both matching the Quic API's server-side cache TTLs.\n\n---\n\n## Requirements\n\n- Home Assistant 2024.4.0 or newer\n- A Quic Broadband account with an API key\n\n## Getting an API key\n\nLog in to the [Quic portal](https://account.quic.nz/), select a service, scroll to the bottom of the page and copy your API key. If the field is empty, click **Roll API Key** to generate one.\n\n---\n\n## Installation\n\n### HACS (recommended)\n\n1. Open HACS → **Integrations** → ⋮ menu → **Custom repositories**.\n2. Add `https://github.com/ageron/ha-quicnz` with category **Integration**.\n3. Search for **Quic Broadband** and install it.\n4. Restart Home Assistant.\n\n### Manual\n\n1. Copy the `custom_components/quicnz` folder into your HA `config/custom_components/` directory.\n2. Restart Home Assistant.\n\n---\n\n## Configuration\n\n1. Go to **Settings → Devices \u0026 Services → Add Integration**.\n2. Search for **Quic Broadband**.\n3. Enter your API key. If your account has multiple services you will be asked to pick one.\n\nEach service you add becomes its own device with all entities listed above.\n\n---\n\n## Displaying the weather map\n\nThe **Network Weather Map** image entity is not shown on the default dashboard automatically. To add it:\n\n1. Go to your dashboard and click the **pencil** (edit) icon.\n2. Click **Add card** and search for **Picture**.\n3. Set **Entity** to `image.quic_\u003cservice_id\u003e_network_weather_map`.\n4. Save.\n\nIf you cannot find the entity, it may be disabled. To enable it:\n\n1. Go to **Settings → Devices \u0026 Services → Quic Broadband → your device**.\n2. Find **Network Weather Map** in the entity list (it may appear as *disabled*).\n3. Click it, toggle **Enable**, and confirm.\n\nThen add it to your dashboard as described above.\n\n---\n\n## Licence\n\n[MIT](LICENSE)\n\n---\n\n## Trademark notice\n\nThe Quic Broadband name and logo are trademarks of Vetta Trading Ltd t/a Quic Broadband. They are used here solely for identification purposes and do not imply any affiliation with or endorsement by Quic Broadband.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fageron%2Fha-quicnz","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fageron%2Fha-quicnz","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fageron%2Fha-quicnz/lists"}