Skip to content

Commit 41c17ad

Browse files
authored
Speedtestdotnet - Remove section on manual polling (home-assistant#28614)
1 parent fc95d51 commit 41c17ad

10 files changed

+61
-13
lines changed
Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
2+
3+
If you want to define a specific interval at which your device is being polled for data, you can disable the default polling interval and create your own polling service.
4+
5+
1. Go to {% my integrations title="**Settings** > **Devices & Services**" %}, and select your integration.
6+
2. On the integration entry, select the three dots.
7+
- Then, select **System options** and toggle the button to disable polling.
8+
![Disable polling for updates](/images/screenshots/custom_polling_01.png)
9+
3. To define your custom polling interval, create an automation.
10+
- Go to {% my automations title="**Settings** > **Automations & Scenes**" %} and create a new automation.
11+
- Define any trigger and condition you like.
12+
- Under action, select **Call service** and use the [`homeassistant.update_entity` service](/integrations/homeassistant/#service-homeassistantupdate_entity).
13+
![Update entity](/images/screenshots/custom_polling_02.png)
14+
- Example in YAML.
15+
16+
```yaml
17+
automation:
18+
- alias: "Only update weather information every 20 minutes when I'm home"
19+
trigger:
20+
- platform: time_pattern
21+
minutes: "/20"
22+
condition:
23+
- condition: state
24+
entity_id: device_tracker.cynthia
25+
state: home
26+
action:
27+
- service: homeassistant.update_entity
28+
target:
29+
entity_id: weather.home
30+
```
31+
32+
4. Save your new automation to poll for data.

source/_includes/common-tasks/enable_entities.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,5 +8,5 @@ Some entities are disabled by default. To enable them, follow these steps:
88
![Select entity from list](/images/screenshots/enable_entities_01.png)
99
4. In the pop-up, select the cogwheel.
1010
5. Toggle the **Enabled** button.
11-
![Enable entities](/images/screenshots/enable_entities_03.png)
11+
![Enable entities](/images/screenshots/enable_entities_03.png)
1212
6. To save the changes, select **Update**.

source/_integrations/goodwe.markdown

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ The best supported are the inverters of ET/EH families, where the sensors `Meter
3838

3939
For the other inverter families, if such sensors are not directly available by the inverter, they can be calculated from existing sensors. [Template Sensor](/integrations/template/) can be used to separate buy and sell power values and [Riemann Sum](/integrations/integration/) can be used to convert these instant power (W) values into cumulative energy values (Wh), which then can be used within the energy dashboard.
4040

41-
## Inverter polling frequency
41+
## Inverter polling interval
4242

4343
The integration will poll the inverter for new values every 10 seconds. If you wish to receive fresh inverter data less (or more) frequently, you can disable the automatic refresh in the integration's system options (Enable polling for updates) and create your own automation with your desired polling frequency.
4444

@@ -58,3 +58,9 @@ The integration will poll the inverter for new values every 10 seconds. If you w
5858
<div class='note'>
5959
It has been observed in some rare situations that frequent polling conflicts with updates to the Goodwe SEMS cloud portal and do not receive any updates anymore. Reducing polling frequency to 30 seconds or 1 minute seems to help in such cases.
6060
</div>
61+
62+
For more detailed steps on how to define a custom polling interval, follow the procedure below.
63+
64+
### Defining a custom polling interval
65+
66+
{% include common-tasks/define_custom_polling.md %}

source/_integrations/google_travel_time.markdown

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -30,9 +30,6 @@ Notes:
3030

3131
- Origin and Destination can be the address or the GPS coordinates of the location (GPS coordinates have to be separated by a comma). You can also enter an entity ID that provides this information in its state, an entity ID with latitude and longitude attributes, or zone friendly name (case sensitive).
3232

33-
## Manual Polling
34-
35-
Using automatic polling can lead to calls that exceed your API limit, especially when you are tracking multiple travel times using the same API key. To use more granular polling, disable automated polling in your config entry's System Options. To manually trigger a polling request, call the [`homeassistant.update_entity` service](/integrations/homeassistant/#service-homeassistantupdate_entity) as needed, either manually or via automations.
3633

3734
## Dynamic Configuration
3835

@@ -65,7 +62,9 @@ Destination: Eddies House
6562

6663
## Updating sensors on-demand using Automation
6764

68-
You can also use the `homeassistant.update_entity` service to update the sensor on-demand. For example, if you want to update `sensor.morning_commute` every 2 minutes on weekday mornings, you can use the following automation:
65+
Using automatic polling can lead to calls that exceed your API limit, especially when you are tracking multiple travel times using the same API key. To use more granular polling, disable automated polling.
66+
67+
You can use the `homeassistant.update_entity` service to update the sensor on-demand. For example, if you want to update `sensor.morning_commute` every 2 minutes on weekday mornings, you can use the following automation:
6968

7069
```yaml
7170
- id: update_morning_commute_sensor
@@ -90,3 +89,9 @@ You can also use the `homeassistant.update_entity` service to update the sensor
9089
target:
9190
entity_id: sensor.morning_commute
9291
```
92+
93+
For more detailed steps on how to define a custom polling interval, follow the procedure below.
94+
95+
### Defining a custom polling interval
96+
97+
{% include common-tasks/define_custom_polling.md %}

source/_integrations/landisgyr_heat_meter.markdown

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -68,8 +68,6 @@ Either heat usage or volume usage can be used as "Gas" on the energy dashboard.
6868

6969
Polling is by default done only once per day (and once right after adding the integration). Every time the Heat Meter values are read, battery time of the device will (supposedly) go down by about 30 minutes.
7070

71-
For detailed control on polling and time of polling, consider disabling polling in the integration panel and poll manually. For instructions, see below.
72-
7371
### Polling manually (optional)
7472

7573
For detailed control on when the device is polled, disable the default polling for this integration and create an automation that will update one of the entities (the other entities will be updated as well)
@@ -86,3 +84,9 @@ action:
8684
target:
8785
entity_id: sensor.heat_meter_heat_usage_gj
8886
```
87+
88+
For more detailed steps on how to define a custom polling interval, follow the procedure below.
89+
90+
#### Defining a custom polling interval
91+
92+
{% include common-tasks/define_custom_polling.md %}

source/_integrations/speedtestdotnet.markdown

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,9 +22,9 @@ The Speedtest.net integration uses the [Speedtest.net](https://speedtest.net/) w
2222

2323
Most Speedtest.net servers require TCP port 8080 outbound to function. Without this port open you may experience significant delays or no results at all. See note on their [help page](https://www.speedtest.net/help).
2424

25-
## Manual Polling
25+
By default, a speed test will be run every hour. You can disable polling using system options and use the `update_entity` service to automate the speed test frequency.
2626

27-
By default, a speed test will be run every hour. To customize polling, you can disable automated polling. Go to {% my integrations title="**Settings** > **Devices & Services**" %}, and select the **Speedtest** integration. On the integration entry, select the three dots. Then, select **System options** and toggle the button to disable polling. To manually trigger a polling request, call the [`homeassistant.update_entity` service](/integrations/homeassistant/#service-homeassistantupdate_entity) as needed, either manually or via automations.
27+
{% include common-tasks/define_custom_polling.md %}
2828

2929
## Integration Sensors
3030

source/_integrations/waze_travel_time.markdown

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,9 +25,9 @@ Notes:
2525
- The string inputs for `Substring *` allow you to force the integration to use a particular route or avoid a particular route in its time travel calculation. These inputs are case insensitive and matched against the description of the route.
2626
- When using the `Avoid Toll Roads?`, `Avoid Subscription Roads?` and `Avoid Ferries?` options, be aware that Waze will sometimes still route you over toll roads or ferries if a valid vignette/subscription is assumed. Default behavior is that Waze will route you over roads having subscription options. It is therefor best is to set both `Avoid Toll Roads?` and `Avoid Subscription Roads?` or `Avoid Ferries?` if needed and experiment to ensure the desired outcome.
2727

28-
## Manual Polling
28+
## Defining a custom polling interval
2929

30-
Some users want more control over polling intervals. To use more granular polling, you can disable automated polling. Go to {% my integrations title="**Settings** > **Devices & Services**" %}, and select the **Waze Travel Time** integration. On the integration entry, select the three dots. Then, select **System options** and toggle the button to disable polling. To manually trigger a polling request, call the [`homeassistant.update_entity` service](/integrations/homeassistant/#service-homeassistantupdate_entity) as needed, either manually or via automations.
30+
{% include common-tasks/define_custom_polling.md %}
3131

3232
## Example using dynamic destination
3333

source/common-tasks/general.markdown

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,4 +5,5 @@ installation_name: "Installation independent"
55
---
66
This section provides tasks that do not depend on a specific Home Assistant installation type or a specific integration. They may be referenced in other procedures.
77

8-
{% include common-tasks/enable_entities.md %}
8+
{% include common-tasks/enable_entities.md %}
9+
{% include common-tasks/define_custom_polling.md %}
36.1 KB
Loading
48.4 KB
Loading

0 commit comments

Comments
 (0)