Skip to content

Setting Name Overrides

Ryler Hockenbury edited this page Mar 13, 2025 · 14 revisions

ℹ️ If you need additional help with setting name overrides, please file a help request.

Each name override requires setting a service identifier to specify which data on which device should have a custom name. The tricky part is getting the format of the service identifier set correctly.

The service identifier is specified in the form YYYY(CHZ):<data-property>.

YYYY is the device id (e.g. WH41)
(CHZ) is the optional channel id if the device uses a channel (e.g. CH1)
<data-property> is the name of the service that represents specific data (e.g. indoorTempeature)

Step 1. The device id (YYYY) and channel id (CHZ) can be found from the Home app (or third party apps) by looking for the "Serial Number" property of the service.

Serial Number in Home App Serial Number in Controller App

Finding the serial number for a service

Step 2. The data property will always be one of the following strings:

windDirection
windSpeed
windGustSpeed
windMaxDailySpeed
rainRate
rainEventTotal
rainHourlyTotal
rainDailyTotal
rainWeeklyTotal
rainMonthlyTotal
rainYearlyTotal
solarRadiation
uvIndex
temperature
humidity
indoorTemperature
indoorhumidity
soilMoisture
leafWetness
waterLeak
airQualityPM25
airQualityPM25Avg
airQualityPM10
airQualityPM10Avg
carbonDioxide
carbonDioxideAvg
lightningEvents
lightningDistance
lightningTime
airGap
currentDepth
totalDepth
battery

To get the right data property, navigate to the Supported Devices section of the README and look at the Service column once you find your device (from Step 1) in the table. The Service column will show the services (data properties) available for a particular device, and then this can be cross-referenced with the data property list above.

For example, from the Supported Devices table, the WH65 supports Wind Direction as shown in the Service column which would correlate to windDirection from the list above - which gives the full service identifier as WH65:windDirection to override the name of the wind direction property on the WH65 sensor array.

Some more examples of setting name overrides.

Service Id Name Override
WH51CH1:soilMoisture Monstera Pot
WH51CH2:soilMoisture Vege Patch
BASE:indoorTemperature Downstairs Temp
WH25:battery Utility Room Temp Batt
WH26:humidity Outside Humidity

The table above would translate to the following inside the Plugin UI:

Name Overrides in Plugin UI

Setting Name Overrides in Plugin UI

ℹ️ If you need additional help with setting name overrides, please file a help request.