The name that will appear in your Homebridge log.
" }, "apiKey", { "type": "help", "helpvalue": "Stored in plain text in Homebridge's config.json. Treat the file with the same care as any password-bearing config.
" }, "applicationKey", { "type": "help", "helpvalue": "Stored in plain text in Homebridge's config.json. Treat the file with the same care as any password-bearing config.
" }, "temperatureSensors", "humiditySensors", "solarRadiationSensors", "co2Sensors", { "type": "help", "helpvalue": "Expose CO2 readings from AWN's AQIN family (co2_in_aqin) and any standalone CO2 sensor.
" }, "airQualitySensors", { "type": "help", "helpvalue": "Expose particulate readings (pm25, pm25_in_aqin, pm10_in_aqin) as HomeKit AirQualitySensor accessories with the corresponding density characteristic and an EPA-bucket-derived AirQuality enum.
" }, "extendedSensors", { "type": "help", "helpvalue": "Adds wind, rain, barometric pressure, UV index, and lightning sensors to HomeKit. These data types aren't natively supported by Apple's Home app, so live numeric values are only visible in the Eve or Controller for HomeKit apps. In Apple Home, each sensor appears as a Motion tile that triggers above your chosen threshold — useful for automations like 'close awning when wind speed exceeds 25 mph'. Default off; leave disabled if you only want the natively-supported sensor types above.
" }, "windSensors", "rainSensors", "pressureSensors", "uvSensors", "lightningSensors", { "type": "help", "helpvalue": "Lightning sensors are only available if your station has a WH31L-compatible sensor (Ecowitt catalogs the same hardware as a WH57) reporting lightning_day / lightning_distance / lightning_time on the AWN API.
", "condition": { "functionBody": "return model.extendedSensors === true;" } }, "extendedDisplayMode", "embedNameUpdateMinIntervalMinutes", { "type": "help", "helpvalue": "Show generic names (recommended): tiles show 'Wind Speed' with an on/off motion indicator. The live number is visible in Eve or Controller for HomeKit. Tile names stay stable.
Show live value in the tile name: tiles update to 'Wind Speed 14 mph' as readings change. Values are rounded to whole numbers so the tile name stays compatible with Apple Home's naming rules. The minimum interval between name updates is configurable below (default 2 minutes); within that window, intermediate value changes are coalesced.
If you rename a tile manually in Apple Home, the plugin detects this and stops overwriting it — your custom name wins. Some Homebridge log lines may mention name changes — these are informational and safe to ignore.
Known limitation 1 (Homebridge UI Accessories page): the HB UI tracks each tile's room placement by its display name. When the name updates, the UI moves the tile to the bridge's default room until the name reverts. Apple Home and Eve are NOT affected. If you primarily use the HB UI Accessories page, leave this on 'Show generic names' or accept the room churn.
Known limitation 2 (iOS battery drain): each tile-name update generates an HAP notification forwarded to every paired iOS device. Frequent updates have been observed to drain phone battery several times faster than normal idle. The 2-minute minimum interval below mitigates this, and 1.6.0 also automatically coerces the data source to 'polling' whenever embed mode is selected (the realtime data source's ~30s update cadence interacts badly with embed mode; polling's 2-minute cadence is fine).
Selecting None uses the recommended default.
", "condition": { "functionBody": "return model.extendedSensors === true;" } }, { "type": "fieldset", "title": "Motion thresholds for extended sensors", "condition": { "functionBody": "return model.extendedSensors === true;" }, "items": [ { "type": "help", "helpvalue": "Each sensor has an enable checkbox. When checked, the sensor appears in HomeKit and its motion event fires when the reading crosses the threshold (in both directions, so Apple Home automations can react to both \"crossing up\" and \"reverting back\"). When unchecked, the sensor is hidden from HomeKit entirely and the threshold field is not shown.
If you want a sensor visible in Eve / Controller for HomeKit (for the live numeric reading) without firing any automation, keep the checkbox enabled but set the threshold to a value the sensor can never reach (e.g. 99999 mph for wind, 99 for UV, 0 for the inverted-direction pressure and lightning-distance sensors since both readings are always positive). All threshold values are in AWN's native units regardless of your display-unit choice below.
Sensors without a configurable threshold (wind direction, rain accumulation totals, time-since-event sensors, lightning strike counts) always appear when their category is enabled at the top of the form — use Exclude Sensors below to hide them individually.
" }, "thresholds.windSpeedEnabled", { "key": "thresholds.windSpeedMph", "condition": { "functionBody": "return model.thresholds && model.thresholds.windSpeedEnabled !== false;" } }, { "type": "help", "helpvalue": "Fires when sustained wind speed equals or exceeds this. 25 mph ≈ Beaufort 6 (Strong breeze).
", "condition": { "functionBody": "return model.thresholds && model.thresholds.windSpeedEnabled !== false;" } }, "thresholds.windGustEnabled", { "key": "thresholds.windGustMph", "condition": { "functionBody": "return model.thresholds && model.thresholds.windGustEnabled !== false;" } }, { "type": "help", "helpvalue": "Fires when an instantaneous gust equals or exceeds this. Applies to both 'Wind Gust' and 'Max Daily Gust' sensors.
", "condition": { "functionBody": "return model.thresholds && model.thresholds.windGustEnabled !== false;" } }, "thresholds.rainRateEnabled", { "key": "thresholds.rainRateInHr", "condition": { "functionBody": "return model.thresholds && model.thresholds.rainRateEnabled !== false;" } }, { "type": "help", "helpvalue": "Fires when current rain rate equals or exceeds this. 0.01 in/hr is effectively 'any measurable rain'.
", "condition": { "functionBody": "return model.thresholds && model.thresholds.rainRateEnabled !== false;" } }, "thresholds.uvEnabled", { "key": "thresholds.uv", "condition": { "functionBody": "return model.thresholds && model.thresholds.uvEnabled !== false;" } }, { "type": "help", "helpvalue": "Fires when UV index equals or exceeds this. 3 = EPA 'Moderate' (sun protection recommended).
", "condition": { "functionBody": "return model.thresholds && model.thresholds.uvEnabled !== false;" } }, "thresholds.lightningDistanceEnabled", { "key": "thresholds.lightningDistanceMi", "condition": { "functionBody": "return model.thresholds && model.thresholds.lightningDistanceEnabled !== false;" } }, { "type": "help", "helpvalue": "Fires when the last strike is CLOSER than this distance. 10 mi ≈ 16 km, the conventional 'too close for outdoor activity' boundary.
", "condition": { "functionBody": "return model.thresholds && model.thresholds.lightningDistanceEnabled !== false;" } }, "thresholds.pressureEnabled", { "key": "thresholds.pressureInHg", "condition": { "functionBody": "return model.thresholds && model.thresholds.pressureEnabled !== false;" } }, { "type": "help", "helpvalue": "Fires when barometric pressure drops BELOW this value. 29.5 inHg ≈ 999 hPa, the conventional 'low pressure system' boundary.
", "condition": { "functionBody": "return model.thresholds && model.thresholds.pressureEnabled !== false;" } } ] }, { "type": "fieldset", "title": "Display units for extended sensors", "condition": { "functionBody": "return model.extendedSensors === true;" }, "items": [ { "type": "help", "helpvalue": "AWN reports US/imperial units regardless of station location. Choose a different unit here to convert at display time. Thresholds above stay in AWN's native units regardless of your choice here.
Each dropdown's None option (auto-added by the form library) uses the default unit shown next to its label.
" }, "units.windSpeed", "units.rain", "units.pressure", "units.distance" ] }, "dataSource", { "type": "help", "helpvalue": "Polling fetches the AWN REST endpoint every 2 minutes. Realtime opens a websocket to rt2.ambientweather.net and receives updates as the station reports them (typically ~30s indoors). Realtime is opt-in for now; the default will switch to realtime in a future release once it has been broadly validated.
Note (1.6.0+): if you also select 'Show live value in the tile name' above, the plugin coerces this back to polling at startup with a warning. The realtime + embed-tile-name combination causes elevated iOS battery drain on every paired phone (~5×-7× normal idle drain in one measured case). If you want live tile values, polling's 2-minute cadence is the supported mode; the data source itself can stay on realtime for the underlying value characteristics (visible in Eve / Controller for HomeKit) by leaving the display mode on 'Show generic names'.
Selecting None uses the default (polling).
" }, { "key": "stationFilter", "type": "array", "items": [ { "key": "stationFilter[]", "type": "string", "placeholder": "e.g. Backyard WS-2000" } ] }, { "type": "help", "helpvalue": "Include Only These Stations is a station-level allowlist (analogous to Include Only These Sensors below, but at station granularity rather than per-sensor). Leave blank to expose every station AWN returns. When set, only stations matching one of the listed names or MAC addresses pass; everything else is dropped before any per-sensor processing.
The primary use case is multi-Home setups: create one platform entry per HomeKit Home in your config.json (use the JSON Config menu) with its own _bridge block and its own allowlist pointing at the station(s) for that Home. See MultiHome.md for the full walkthrough.
Tip: setting a deliberately non-matching value (e.g. CLEAR) and restarting the child bridge is a no-filesystem way to wipe every accessory this instance exposes — useful for a clean slate before reconfiguring in Apple Home. Then remove or correct the filter and restart again to re-discover. Note: room assignments, automations, and any custom names set in Home.app are lost during the wipe, as is standard whenever a HomeKit accessory is removed.