Skip to content
vinceskahan edited this page May 2, 2024 · 435 revisions

Welcome to the WeeWX wiki!

This is the place to go for information about the many extensions available for WeeWX, as well as random "how to" tips. For information on how to download, install, and configure WeeWX, see the WeeWX web site.

Edit this page as you see fit; this wiki uses Markdown syntax, not HTML. To add a new page, reference it within brackets, e.g.: [SamplePage].

✔️ = Tested with weewx4 and python3

General

Basic principles

Hardware recommendations

Guides (How to ...)

WeeWX configuration and installation

Operating system configuration

Data management

Troubleshooting

Hardware

Extensions to WeeWX

Use extensions to add capabilities to a WeeWX installation. Drivers enable WeeWX to collect data from various sources, services collect and emit data, skins contain the templates for generating reports, XType extensions add new observation and aggregation types, and uploaders transfer data to online services.

Drivers

  • airlink - Collect data from Davis AirLink air quality sensor
  • airmar - Collect data from Airmar 150WX
  • ambientweatherapi-json - Collect data from the Ambient Weather API without the need for any additional hardware
  • atmocom - Collect data from Atmocom station
  • aws - Collect data from an Arduino connected to a Davis anemometer
  • BCRobotics - Collect data from a BC Robotics and Pi based PWS ✔️
  • byows_rpi - Collect data from the Build Your Own Weather Station - Raspberry Pi
  • cm1 - Collect data from Dyacon CM1 weather station interface
  • columbia_ms - Collect data from Columbia Weather MicroServer supported sensors ✔️
  • envoy - Collect data from Enphase Envoy solar controller
  • gw1000 - Collect data from Ecowitt GW1000/GW1100/GW2000 ✔️
  • hackulink - Collect data from AcuLink Internet Bridge via OpenWRT
  • Hp1000 - collect data from HP1000, (WS1001, XC0422 etc.) via WiFi connection ✔️
  • id5001 - Collect data from Heathkit ID5001 with serial port option
  • interceptor - Collect data from Acurite Bridge, Fine Offset HP1000/WH2600, OS LW301/LW302, LaCross GW1000U, or any station that sends to WU
  • ip100 - Collect data from RainWise IP100 ✔️
  • ipwx - Collect data from AcuLink Internet Bridge via Raspberry Pi
  • klimalogg - Collect data from Klimalogg Pro ✔️
  • mate - Collect data from Outback MATE3 solar/battery controller
  • maxbotix - Augment station data with data from maxbotix ultrasonic rangefinder ✔️
  • meteostick - Collect data from Meteostick ✔️
  • MQTTSubscribe - Collect data from JSON, keyword, or individual topic MQTT messages ✔️
  • netatmo - Collect data from netatmo
  • nm150 - Collect data from New Mountain NM150
  • observerip - Collect data from ObserverIP (Fine Offset HP1000)
  • owfs - Collect data from one-wire sensors ✔️
  • purpleair - Collect data from PurpleAir particulate sensor ✔️
  • rmyro - Collect data from RM Young ResponseOne (92000 only)
  • rtldavis - Collect data from software-defined radio (SDR) for Davis Vantage stations ✔️
  • sdr - Collect data from software-defined radio (SDR) receiver ✔️
  • sds011 - Collect data from SDS011 particulate sensor
  • si1000 - Collect data from Si1000 radio receiver (for Davis stations)
  • socketlogger - Collect data from ObserverIP (Fine Offset HP1000) by intercepting traffic
  • swb - Collect data from SMA Sunny WebBox
  • tempestWS - Collect data from the Weatherflow Tempest Websocket API
  • tfrc - Collect data from software-defined radio using tfrec ✔️
  • tracer - Collect data from Tracer solar charge controllers
  • twi - Collect data from Texas Weather Instruments hardware ✔️
  • uradmon - Collect data from a Uradmon Environmental Monitor ✔️
  • vedirect - Collect data from Victron MPPT solar/battery controller
  • w820 - Collect data from Ventus W820 bluetooth station
  • wanet - Collect data from Wanet Wario ME11/12 meteo station
  • weatherflow - Collect data from WeatherFlow hardware
  • WeatherLink Live - Collect data from Davis WeatherLink Live using both polling and UDP broadcast API ✔️
  • WeatherLink Live JSON - Collect data from Davis WeatherLink Live via periodic polling
  • WeatherLink Live UDP - Collect data from Davis WeatherLink Live (with 2.5s UDP updates) ✔️
  • WeatherLink Live - Collect data from Davis WeatherLink Live (including Weatherlink.com) when data is lost ✔️
  • WeatherLink Live WLL - Collect data from Davis WeatherLink Live devices
  • weewxMQTT - Collect data by subscribing to MQTT topics ✔️
  • wh23xx - Collect data from Fine Offset WH23xx (Tycon TP2700)
  • wlink - Collect data from weatherlink.com
  • wmII - Collect data from Davis Weather Monitor II, Wizzard, Perception
  • wmr89 - Collect data from the Oregon Scientific WMR89 ✔️
  • ws6in1 - Collect data WS 6 in 1 weather stations with PC console ✔️
  • wxt5x0 - Collect data from Vaisala WXT5x0 stations

Services

  • airQ - Retrieve air quality data from Air-Q device of Corant GmbH (PM1.0, PM2.5, PM10.0, TVOC, CO, CO2, O2, O3, NO2, H2S, SO2, noise, health index, performance index)
  • aprs - Generate APRS-compliant weather packets
  • aqi - Calculate Air Quality Index
  • as3935 - Augment station data with lightning strike data from AS3935 attached to RPi
  • bme280wx - Use temp/pressure/humidity data from a BME280 attached to a Raspberry Pi
  • cmon - Monitor CPU, Memory, Disk, and Network on the computer running weewx
  • crt - Emit a Cumulus realtime.txt file whenever sensor readings change ✔️
  • csv - Emit loop or archive data to a file in CSV format
  • cwxn - Emit a Cumulus wxnow.txt file whenever sensor readings change
  • davishealthapi - Record and display Davis sensor health telemetry from the online API (signal strength, battery, etc.)
  • DWD - forecast and warnings data for WeeWX and Belchertown skin, augment WeeWX data by readings from governmental weather stations (possible data sources: DWD Germany, ZAMG Austria, and by the Open-Meteo API MeteoFrance, MSC Canada, NOAA U.S.A., ECMWF E.U., MET Norway, JMA Japan), process DWD radar data and create animated GIFs
  • filepile - Add additional types to a WeeWX data stream via a file ✔️
  • forecasting - Download, generate, and display forecasts and tides
  • Healthchecks - Use Healthchecks.io to monitor WeeWX
  • knx - Send EIBnet/IP packets with weather information
  • luxtronik - Augment station data with data from Luxtronik heatpump controller ✔️
  • maxbotix - Augment station data with data from maxbotix ultrasonic rangefinder ✔️
  • MQTTSubscribe - Augment station data with JSON, keyword, or individual topic MQTT messages ✔️
  • nmea-xdr - Augment data from a source of NMEA 0183 XDR sentences ✔️
  • opsgenie - Send heartbeats and alerts to cloud alerting service OpsGenie
  • owfs - Augment station data with data from one-wire sensors ✔️
  • photovoltaics - Retrieve live data from E3/DC S10 solar system, save to a database, output to MQTT, and present in skins ✔️
  • PiSenseHat - Add measure to loop data from PiSense Hat sensor set ✔️
  • PrecipMeter - Receive, process and save data from disdrometers like Ott Parsivel2 or Thies LNM or other devices that send data in ASCII format, includes precipitation intensity and kind (drizzle, rain snow, hail etc.), metorological optical range, radar reflectivity factor, etc.
  • Pushover - Send alerts via Pushover when WeeWX observations are out of a specified range
  • sds011 - Add pm measure to loop data (forked from SDS011 driver updated for python3) ✔️
  • snmp - Retrieve data by SNMP (for sensors that speak SNMP and for monitoring equipment like UPS) ✔️
  • sunduration - Augment station data with sunshine duration - for Davis Vantage Pro 2 with solar radiation sensor ✔️
  • tristar - Augment station data with solar controller data from a Tristar Charge Controller
  • weewx-nws - NWS Weather Forecast and Alerts WeeWX Extention ✔️
  • WXgraphic - Weather Graphic: A php driven generator to create a weather graphic image via your web server ✔️
  • wxobs - Provides a php driven report page to extract archival data as Daily Summaries ✔️
  • zabbix - Emit loop data to a zabbix server

Skins

XType extensions

  • weewx-aqi-xtype - Calculate the AQI for a given air pollutant value.
  • weewx-xaggs - A grab-bag of new aggregation types, such as the historical highs or lows for a date. ✔️
  • weewx-GTS - Provides "Grünlandtemperatursumme" (GTS), a kind of growing degree days, the date, when it exceeds the magic value of 200, the total solar energy received during some arbitrary timespan, dayET and ET24 as opposite to dayRain and rain24, absolute humidity, (saturation) vapor pressure, mixing ratio, (potential) equivalent temperature ✔️
  • weewx-phenology - Growing Degree-Days development models for various insect pests, showing when to apply control strategies to minimize crop damage ✔️

Generators

  • sftp - Upload data using SFTP (not FTPS) ✔️
  • weewx-svg2png - Create thumbnail images, weather mini-pics, and webcam images with weather data by converting WeeWX-created SVG files to PNG ✔️

Uploaders

Development notes

Clone this wiki locally