[bluelink] Document that forceRefreshInterval=0 disables refresh from vehicle (#21051)

Signed-off-by: Florian Hotze <dev@florianhotze.com>
This commit is contained in:
Florian Hotze
2026-06-25 14:57:23 +02:00
committed by GitHub
parent f9a1b46876
commit 88c27909bf
3 changed files with 9 additions and 9 deletions
@@ -46,11 +46,11 @@ The `username` field is not required for EU.
### `vehicle` Thing ### `vehicle` Thing
| Parameter | Required | Default | Description | | Parameter | Required | Default | Description |
|------------------------|----------|---------|---------------------------------------------------| |------------------------|----------|---------|---------------------------------------------------------------------------------------------|
| `vin` | Yes | - | Vehicle Identification Number (VIN) | | `vin` | Yes | - | Vehicle Identification Number (VIN) |
| `refreshInterval` | No | 30 | Status refresh interval in minutes (cached) | | `refreshInterval` | No | 30 | Status refresh interval in minutes (cached) |
| `forceRefreshInterval` | No | 240 | Status refresh interval in minutes (from vehicle) | | `forceRefreshInterval` | No | 240 | Status refresh interval in minutes (from vehicle), set to 0 to disable refresh from vehicle |
The `refreshInterval` parameter controls how often cached data is fetched from Kia/Hyundai servers. The `refreshInterval` parameter controls how often cached data is fetched from Kia/Hyundai servers.
In contrast, `forceRefreshInterval` controls fetching of data from the vehicle. In contrast, `forceRefreshInterval` controls fetching of data from the vehicle.
@@ -28,9 +28,9 @@ thing-type.config.bluelink.account.region.option.CA = Canada
thing-type.config.bluelink.account.region.option.EU = Europe thing-type.config.bluelink.account.region.option.EU = Europe
thing-type.config.bluelink.account.username.label = Username thing-type.config.bluelink.account.username.label = Username
thing-type.config.bluelink.account.username.description = Your Bluelink/Connect account email address (not required for EU region) thing-type.config.bluelink.account.username.description = Your Bluelink/Connect account email address (not required for EU region)
thing-type.config.bluelink.vehicle.forceRefreshInterval.label = Refresh Interval thing-type.config.bluelink.vehicle.forceRefreshInterval.label = Refresh Interval (Vehicle)
thing-type.config.bluelink.vehicle.forceRefreshInterval.description = Interval in minutes to refresh data from the vehicle. Set to 0 to disable periodic forced refresh. thing-type.config.bluelink.vehicle.forceRefreshInterval.description = Interval in minutes to refresh data from the vehicle. Set to 0 to disable periodic forced refresh.
thing-type.config.bluelink.vehicle.refreshInterval.label = Refresh Interval thing-type.config.bluelink.vehicle.refreshInterval.label = Refresh Interval (Bluelink Servers)
thing-type.config.bluelink.vehicle.refreshInterval.description = Interval in minutes to fetch cached data from the Hyundai/Kia servers thing-type.config.bluelink.vehicle.refreshInterval.description = Interval in minutes to fetch cached data from the Hyundai/Kia servers
thing-type.config.bluelink.vehicle.vin.label = VIN thing-type.config.bluelink.vehicle.vin.label = VIN
thing-type.config.bluelink.vehicle.vin.description = Vehicle Identification Number (VIN) thing-type.config.bluelink.vehicle.vin.description = Vehicle Identification Number (VIN)
@@ -32,13 +32,13 @@
<description>Vehicle Identification Number (VIN)</description> <description>Vehicle Identification Number (VIN)</description>
</parameter> </parameter>
<parameter name="refreshInterval" type="integer" min="0" unit="min" required="false"> <parameter name="refreshInterval" type="integer" min="0" unit="min" required="false">
<label>Refresh Interval</label> <label>Refresh Interval (Bluelink Servers)</label>
<description>Interval in minutes to fetch cached data from the Hyundai/Kia servers</description> <description>Interval in minutes to fetch cached data from the Hyundai/Kia servers</description>
<default>30</default> <default>30</default>
<advanced>true</advanced> <advanced>true</advanced>
</parameter> </parameter>
<parameter name="forceRefreshInterval" type="integer" min="0" unit="min" required="false"> <parameter name="forceRefreshInterval" type="integer" min="0" unit="min" required="false">
<label>Refresh Interval</label> <label>Refresh Interval (Vehicle)</label>
<description>Interval in minutes to refresh data from the vehicle. Set to 0 to disable periodic forced refresh.</description> <description>Interval in minutes to refresh data from the vehicle. Set to 0 to disable periodic forced refresh.</description>
<default>240</default> <default>240</default>
<advanced>true</advanced> <advanced>true</advanced>