Update README and services cleanup

- Revised the README.md to enhance clarity on integration features and usage, including a new section on advanced automations.
- Updated the features list to provide a more detailed overview of supported rules and configurations.
- Removed the `reset_rate_limit` service from services.yaml and its implementation in system_services.py to streamline functionality.
- Added examples for using services in Home Assistant to improve user guidance.

Author: sirkirby

README.md

@@ -10,24 +10,27 @@
 
 [!["Buy Me A Coffee"](https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png)](https://www.buymeacoffee.com/sirkirby)
 
-UniFi Network Rules is a custom integration for Home Assistant that integrates with your UniFi Dream Machine/Router to both provide and help you create useful interactions and automations for your Home Lab. The goal of this integration is to simplify policy and rule management for real world use cases. I built this because I wanted to enable things like screen time controls for my kids, game server access controls, and more with the push of a button in Home Assistant. Functionality that can be shared with anyone in your home.
+UniFi Network Rules is a custom integration for Home Assistant that integrates with your UniFi Dream Machine/Router to both provide and help you create useful interactions and automations for your Home Lab. The goal of this integration is to simplify policy and rule management for real world use cases. I built this because I wanted to unlock the power of my UniFi firewall. From simple things like screen time and game server access controls for my kids, to more advanced like getting notified when a critical rule is changed. And most importantly, make all of this easy to use and share with anyone in your home or home lab. I hope you find it useful!
 
-## Features
+## What this integration provides
 
-- Switch entities for all rules, including firewall policies (zone-based firewall), traffic/firewall rules (non-zone-based firewall), forwarding rules, traffic routes.
-- VPN management including both client and server configurations for OpenVPN and WireGuard.
-- Service actions for full backup and restore of all rules that are managed by this integration.
-- Service actions for batch enabling and disabling rules by pattern matching rule names or IDs.
-- Service actions for deleting rules by ID.
-- LED toggle switch for UniFi access points and other LED capable devices to control LED on/off.
+### Switches for enabling and disabling rules and configuration
 
-Request a feature [here](https://github.com/sirkirby/unifi-network-rules/issues).
+- Firewall policies (zone-based firewall)
+- Traffic/firewall rules (non-zone-based firewall)
+- Port Forwarding rules
+- Traffic Routes & Traffic Route Kill Switch
+- QoS rules
+- OpenVPN Client and Server configurations
+- WireGuard Client and Server configurations
+- UniFi Device LEDs
+- WLAN SSIDs
 
-## Requirements
+### Advanced automations powered by [Custom Triggers](#real-time-triggers-) and [Custom Services](#services)
 
-- A UniFi device running network application 9.0.92 or later.
-- A local account with Admin privileges to the network application. Must not be a UniFi Cloud account.
-- Home Assistant 2025.2 or later with network access to the UniFi device.
+The included [Triggers](#real-time-triggers-) and [Services](#services) provide a framework for building custom UDM automations to cover a wide range of use cases. For example, you can [backup](#3-backup-trigger---save-config-on-important-changes) and [restore](#full-and-selective-restore) all rules when a change is detected, ensure game server port [forwarding rules get disabled](#2-game-server-management---auto-disable-after-hours) at bedtime, [create and maintain an audit log](#1-security-monitoring---alert-on-unexpected-rule-changes) of all UDM configuration changes, and so much more. Get inspired by the many examples below.
+
+> Questions, ideas, help, or feedback? [Discussions](https://github.com/sirkirby/unifi-network-rules/discussions). Errors or bugs? [Issues](https://github.com/sirkirby/unifi-network-rules/issues).
 
 ## Installation
 
@@ -49,35 +52,35 @@ THEN
 4. Search for "UniFi Network Rule Manager" and select it.
 5. Enter credentials of a local admin user on your UDM and click on the "Submit" button.
 
+### Requirements
+
+- A UniFi device running network application 9.0.92 or later.
+- A local account with Admin privileges to the network application. Must not be a UniFi Cloud account.
+- Home Assistant 2025.2 or later with network access to the UniFi device.
+
 ## Configuration
 
-**Host**: The IP address or hostname of your UniFi Device.
+**Host**: The IP address or hostname of your UniFi Device. ex. `192.168.1.1` or `udm.mydomain.com`
 
-**Username**: The local admin account on the UDM.
+**Username**: The local admin account on the UDM. ex. `admin`
 
-**Password**: The password for the UDM account.
+**Password**: The password for the UDM account. ex. `password`
 
 **Site**: The UniFi site name to connect to (defaults to "default" if not specified).
 
 **Update Interval**: The automatic refresh interval in minutes. Can be longer since updates real-time.
 
 **Verify SSL**: Enable SSL certificate verification (defaults to disabled for self-signed certificates).
 
-## Usage
-
-Once you have configured the integration, you will be able to see the policies, rules, and routes configured on your UniFi Network as switches in Home Assistant. Add the switch to a custom dashboard or use it in automations just like any other Home Assistant switch.
-
 ## Services
 
 The integration provides several services focused on managing and automating existing UniFi Network rules:
 
 ### Getting Started with Services
 
-There are two main ways to use these services in Home Assistant:
-
-#### Method 1: Using an Input Button Helper with Automation
+Here are some examples of how to get started with services in Home Assistant:
 
-This is the simplest method:
+#### Example 1: Using an Input Button Helper with Automation
 
 1. Go to Settings → Devices & Services → Helpers
 2. Add a Button helper (e.g., "Refresh UniFi Rules")
@@ -106,7 +109,7 @@ mode: single
 
 <img src="./assets/backup_unr_button.png" alt="Backup UNR Button" width="200" />
 
-#### Method 2: Using Scripts with a Lovelace Button Card (More Customizable)
+#### Example 2: Using Scripts with a Lovelace Button Card (More Customizable)
 
 First, create a script in your Settings → Automations & Scenes → Scripts:
 
@@ -135,6 +138,8 @@ name: Backup my Network Rules
 icon: mdi:cloud-upload
 ```
 
+See below for more automation examples using [Services with Triggers](#service-automation-examples).
+
 ### Services Reference
 
 | Service | Description | Parameters |
@@ -145,7 +150,6 @@ icon: mdi:cloud-upload
 | `unifi_network_rules.bulk_update_rules` | Enable or disable multiple rules by name pattern | `state`: true (enable) or false (disable)<br>`name_filter`: String to match in rule names |
 | `unifi_network_rules.delete_rule` | Delete an existing firewall policy by ID | `rule_id`: ID of the rule to delete |
 | `unifi_network_rules.refresh_data` | Refresh data for a specific integration instance or all | `entry_id`: (Optional) Specific integration instance ID |
-| `unifi_network_rules.reset_rate_limit` | Reset API rate limiting if you hit request limits | None |
 | `unifi_network_rules.websocket_diagnostics` | Run diagnostics on WebSocket connections and try to repair if needed | None |
 | `unifi_network_rules.force_cleanup` | Force cleanup of all entities in the integration | None |
 | `unifi_network_rules.force_remove_stale` | Force removal of stale or broken entities | `remove_all`: (Optional) Remove all entities instead of just stale ones |

custom_components/unifi_network_rules/services.yaml

@@ -238,10 +238,6 @@ force_remove_stale:
       selector:
         boolean:
 
-reset_rate_limit:
-  name: Reset Rate Limit
-  description: Reset the rate limiter for the UniFi API connection
-
 websocket_diagnostics:
   name: WebSocket Diagnostics
   description: Run diagnostics on the WebSocket connection and attempt to repair if needed

custom_components/unifi_network_rules/services/system_services.py

@@ -49,22 +49,6 @@ async def async_refresh_data(hass: HomeAssistant, coordinators: Dict, call: Serv
             LOGGER.debug("Refreshing coordinator for entry %s", entry_id)
             await coordinator.async_refresh()
 
-async def async_reset_rate_limit(hass: HomeAssistant, coordinators: Dict, call: ServiceCall) -> None:
-    """Handle reset rate limit service call."""
-    # Reset rate limit for all APIs
-    for entry_data in hass.data[DOMAIN].values():
-        if "api" in entry_data:
-            api = entry_data["api"]
-            if hasattr(api, "reset_rate_limit"):
-                try:
-                    success = await api.reset_rate_limit()
-                    if success:
-                        LOGGER.info("Rate limit reset successful")
-                    else:
-                        LOGGER.warning("Rate limit reset failed")
-                except Exception as e:
-                    LOGGER.error("Error resetting rate limit: %s", e)
-
 async def async_websocket_diagnostics(hass: HomeAssistant, coordinators: Dict, call: ServiceCall) -> None:
     """Run diagnostics on WebSocket connections and try to repair if needed."""
     results = {}
@@ -213,10 +197,6 @@ async def handle_refresh(call: ServiceCall) -> None:
     async def handle_refresh_data(call: ServiceCall) -> None:
         await async_refresh_data(hass, coordinators, call)
 
-    # Handle the reset rate limit service  
-    async def handle_reset_rate_limit(call: ServiceCall) -> None:
-        await async_reset_rate_limit(hass, coordinators, call)
-        
     # Handle the websocket diagnostics service
     async def handle_websocket_diagnostics(call: ServiceCall) -> None:
         return await async_websocket_diagnostics(hass, coordinators, call)
@@ -230,10 +210,6 @@ async def handle_websocket_diagnostics(call: ServiceCall) -> None:
         DOMAIN, SERVICE_REFRESH_DATA, handle_refresh_data, schema=REFRESH_DATA_SCHEMA
     )
 
-    hass.services.async_register(
-        DOMAIN, SERVICE_RESET_RATE_LIMIT, handle_reset_rate_limit, schema=vol.Schema({})
-    )
-    
     hass.services.async_register(
         DOMAIN, SERVICE_WEBSOCKET_DIAGNOSTICS, handle_websocket_diagnostics, schema=vol.Schema({})
     )