glinet-router v1.6.1

CRITICAL ACTION REQUIRED: v1.5.9 to v1.6.0/v1.6.1 Migration Instructions

If you are updating from a version older than v1.6.0. Please follow these instructions.

Because of an underlying domain name change, your existing integration will stop being updated after this release. You must delete and re-add the integration to restore functionality.

Please follow these mandatory installation steps:

1. Delete your existing install: Go to Settings > Devices & Services, find the old GL-iNet integration, click the three dots, and select Delete.
2. Update the integration: Update to the latest version within HACS.
3. Delete the legacy files: Using a file manager (like Studio Code Server, Samba, or SSH), navigate to your Home Assistant config/custom_components/ directory and delete the old ha_glinet folder.
4. Restart Home Assistant (highly recommended to clear cache and apply changes).
5. Add the new integration: Go to Settings > Devices & Services > Add Integration, search for GL.iNet Router, and configure normally.

Automations Update

Any integration-specific automations will need to be updated. Edit the automations in YAML mode and replace any instance of ha_glinet with glinet_router.

---

Release Notes:

General

This release introduced official support for firmware v4.9.0. Please raise a issue if you encounter any issues.

There are known issues when using beta 4.9.0. If you do encounter any issues. As a first step. Please check to see if your router has any updates.

New Features

• Added Verify SSL option to support self-signed certificates. (a1e60ba)
• Introduced Cellular data usage sensors to monitor data consumption. (d3c1445)
• Implemented a central function to clean up orphaned sensors, improving resource management. (eb80057)
• Introduced support for WireGuard and OpenVPN client dashboard integration for firmware version 4.9.0. (81f3eb8)
• Added support for WireGuard with firmware 4.9, including logic for handling multiple firmware versions (official support starting from firmware version 4.8). (ef44205)

Enhancements

• Refactored cellular handling and introduced official support for cellular features on firmware version 4.9.0. (2778806)
• Updated all wiki links in documentation to point to updated URLs. (52fb5ae)
• Added a description for the Verify SSL option in the UI. (08336a5)

Documentation

• Added SSL verification documentation. (9ae59e1)
• Updated various documentation files with information on new features, integrations, and system architecture. (766ad32, 61aa31b)

Developer Updates

• Added Pull Request templates, CODEOWNERS, and improved contribution prep documentation for better development practices. (d048d85)
• Updated GitHub Actions for dependency bump and PR target checks. (38f4a93, 86c14be)

---

For more details, visit the release notes.

New contributors

• jezzaaa jeremy@laidman.org
  • Added Verify SSL option #58

HACS

Download the attached glinet_router zip archive or install/update through HACS.

glinet-router v1.6.0

CRITICAL ACTION REQUIRED: v1.6.0 Migration Instructions

Because of an underlying domain name change, your existing integration will stop being updated after this release. You must delete and re-add the integration to restore functionality.

Please follow these mandatory installation steps:

1. Delete your existing install: Go to Settings > Devices & Services, find the old GL-iNet integration, click the three dots, and select Delete.
2. Update the integration: Update to the latest version within HACS.
3. Delete the legacy files: Using a file manager (like Studio Code Server, Samba, or SSH), navigate to your Home Assistant config/custom_components/ directory and delete the old ha_glinet folder.
4. Restart Home Assistant (highly recommended to clear cache and apply changes).
5. Add the new integration: Go to Settings > Devices & Services > Add Integration, search for GL.iNet Router, and configure normally.

Automations Update

Any integration-specific automations will need to be updated. Edit the automations in YAML mode and replace any instance of ha_glinet with glinet_router.

---

Release Notes:

This release introduces a technical breaking change as we rename and restructure the integration to prepare for future updates.

What Changed?

• Repository/Project Name: Changed from ha-glinet to ha-glinet-router
• Display Name: Changed from GL-iNet to GL.iNet Router
• Domain: Changed from ha_glinet to glinet_router

Why the change?

GL.iNet also offers a KVM product line. To accommodate this, we are splitting the integrations to keep things clean and organized:

• glinet-router (This integration) – Dedicated entirely to GL.iNet router products.
• glinet-kvm (Coming in the near future if budget allows!) – A planned, dedicated integration specifically for GL.iNet KVM products.

Splitting these now ensures a much more logical and stable foundation for future updates. This is a one-time event that cannot be avoided due to the nature of the change. All future releases will be seamless once again. Thank you for your understanding and ongoing support!

---

If it's any consolation: Once this release/migration is complete, v1.6.1 will bring official support for GL.iNet firmware 4.9.0!

ha-glinet v1.5.0

Features

• Modem Status Support: Added support for retrieving modem status on firmware 4.9. (1ee4b0e)
• SMS Handling: Introduced slot-aware modem SMS handling for improved message management. (e612530)

Documentation Updates

• Added first example automation: SMS Notification feature, along with detailed documentation. (3cb2c03)
• Updated and improved the main README.md for better readability. (3ee2f2e)
• Added missing features and created additional documentation for smart fan, unknown devices, and other topics. (8e7f93d)
• Documented modem firmware compatibility details across relevant API references. (641fc63)

Note

• This release contains no functional changes for users running 4.8.0. This is mainly just a rough sketch for firmware 4.9.0 which should be functional but the code isn't as clean as I'd like. I am in discussion with GL.iNet about changes in 4.9 and will refactor this code as part of the outcome of that.

HACS

Download the attached ha_glinet zip archive or install/update through HACS.

ha-glinet v1.4.8

ha-glinet v1.4.8 Release Notes

Enhancements

• Implement individual sensors for IPv6 and IPv4 WAN IPs: Added separate sensors to monitor IPv6 and IPv4 WAN IP addresses for more granular tracking. (bd722ce)
• Replace text messages sensor with unread message count: Deprecated the text message sensor in favor of a new sensor that tracks the count of unread messages. (0694415)

Bug Fixes

• Auto-clean WAN IPv4 and IPv6 sensors: Ensures that unused WAN IPv4 and IPv6 sensors are automatically cleaned up when unmonitored. (7933b14)
• Fix for IPv4 showing in cellular sensors: Resolves an issue where the IPv4 address was displayed for both cellular sensors when IPv6 was unavailable. (4707e9b)
• Fix WAN total traffic sensors error: Corrected an error message caused by WAN total traffic sensors. (75717d7)

HACS

Download the attached ha_glinet zip archive or install/update through HACS.

ha-glinet v1.4.7

v1.4.7

• Fix: Improved router traffic sensor calculations to include totals from all clients regardless of if they are tracked or not.
  Files changed:
  • custom_components/ha_glinet/hub.py
  • tests/test_hub.py

HACS

Download the attached ha_glinet zip archive or install/update through HACS.

ha-glinet v1.4.6

Release Notes for v1.4.6 - ha-glinet

New Features

• Device Tracking Enhancements: Added support for whitelist/blacklist functionality to manage unknown devices.
  (config_flow.py, const.py, hub.py, strings.json, translations/en.json, entities.md, features.md, tests/conftest.py)
• WAN Traffic Sensors: Introduced new WAN traffic sensors for monitoring internet usage.
  (sensor.py, hub.py, test_hub.py)
• Client Traffic Sensors: Added sensors to monitor total download and upload data per client.
  (sensor.py, models.py, test_models.py)

Bug Fixes

• Improved Router Compatibility: Extended timeout durations in API to enhance support for older routers.
  (client.py, base.py, system.py, config_flow.py)

Other Updates

• Continuous Integration: Updated release workflow for the GitHub repository.
  (release.yml)
• Version Increment: Bumped integration version to 1.4.6.
  (manifest.json, pyproject.toml)

HACS

Download the attached ha_glinet zip archive or install/update through HACS.

ha-glinet v1.4.5

🚀 New Features

• Firmware Update Support: Added functionality to handle firmware updates, including new services and entities. ([97bdf87])
• kmwan Integration: Added support for kmwan functionality. ([1ba9f72])
• mwan3 Integration: Added support for mwan3 functionality. ([ad00d58])

🐛 Fixes

• Fixed error in firmware update popup. ([213f011])
• Fixed issue with IP addresses for connected clients not being parsed correctly. ([0ddb4a2])
• Resolved ruff failing checks. ([aa46773], [80bfdb4])
• Decapitalized kmwan and mwan3 in setup configuration flow. ([70ebe9c])
• Delinked firmware updater from scan interval and limited its check to once a day. ([4b8381d])
• Fixed issue where scan interval was not being adhered to. ([cb41859])
• Simplified TX and RX value calculation to literal raw values. ([1762795])
• Resolved issue where release notes were not always included, using a dynamically generated URL instead. ([c86a9ab])

🧪 CI/CD Improvements

• General continuous integration updates. ([7545578])
• Fixed and updated test cases for integration, config flow, hub, and update functionality. ([b4326ab], [2be1bc7])
• Added tests to verify update intervals. ([cd8634f])

📚 Documentation

• Updated documentation for various components and features:
  • Added details for firmware updates, kmwan, mwan3, services, and architecture. ([97bdf87], [1ba9f72], [ad00d58])
  • Refreshed general documentation. ([25679d4])

🔧 Miscellaneous

• Incremented version to 1.4.5. ([9f68164])

---

For more details, check the full changelog.

HACS

Download the attached ha_glinet zip archive or install/update through HACS.

ha-glinet v1.4.4

This is the first release since the integration was added to HACS. If you added this via custom repository. Please remove the custom repo. HACS will automatically repoint itself to use the official release.

Changes

Features

• Playground Feature Introduced
  • Added core support for Playground functionality.
  • Updated multiple files for new settings and capabilities:
    • api/client.py
    • config_flow.py
    • const.py
    • hub.py
    • services.py
    • services.yaml
    • strings.json
    • translations/en.json

Documentation

• Update install instructions in README.md.
• Added detailed Playground documentation:
  • Home.md
  • features.md
  • playground.md
  • services.md.

CI/CD Improvements

• Fixed existing tests in services.py.
• Added new test coverage:
  • tests/test_api_client.py
  • tests/test_services.py.
• Updated GitHub Actions actions/checkout to v7 for workflows:
  • .github/workflows/bandit.yml
  • .github/workflows/ci.yml
  • .github/workflows/codeql.yml
  • .github/workflows/hassfest.yaml
  • .github/workflows/release.yml
  • .github/workflows/wiki-sync.yml.

Miscellaneous

• Version increment in manifest.json and pyproject.toml.
• Updated logos for correct sizing:
  • brand/icon@2x.png
  • brand/logo@2x.png.

---

Updated Dependency

• actions/checkout upgraded:
  • From: v6
  • To: v7

HACS

Download the attached ha_glinet zip archive or install/update through HACS.

ha-glinet v1.4.3

ha-glinet 1.4.3

Channel: release

Release Notes for ha-glinet v1.4.3

Changes

• Bugfix: Resolved ScannerEntity deprecation warning introduced in Home Assistant Core 2027.6.
  • Updated import of ScannerEntity to the latest path (homeassistant.components.device_tracker).
  • Adjusted test configuration by adding ScannerEntity and SourceType mocks.

Affected Files

• custom_components/ha_glinet/entities/device_tracker.py
• tests/conftest.py

HACS

Download the attached ha_glinet zip archive or install/update through HACS.

ha-glinet v1.4.2

ha-glinet 1.4.2

Channel: release

ha-glinet v1.4.2 Release Notes

Enhancements

• Auto cleanup devices: Fixed overly restrictive logic in device cleanup functionality by removing unnecessary is_known condition. ([c3f66a9])

Testing & Continuous Integration

• Updated test cases to ensure reliability of the integration. ([66cd3c4])

Documentation

• Updated README with clarifications and improvements. ([8c02e99], [7e3f802])
• Enhanced documentation by separating features into individual pages for better clarity. ([5e9e13a])
• Revised and expanded multiple documentation pages: architecture, developer reference, entities, features, hub, repeater, and router API. ([f27d44d])

Miscellaneous

• Incremented version to 1.4.2 in the manifest and project files. ([004d904])

Files Modified

• custom_components/ha_glinet/manifest.json
• pyproject.toml
• custom_components/ha_glinet/hub.py
• tests/test_hub.py
• README.md
• Documentation files under docs/ directory

---

Enjoy the new release!

HACS

Download the attached ha_glinet zip archive or install/update through HACS.