From 589eeda776ac8fac193a2e091662839c02cd59a0 Mon Sep 17 00:00:00 2001 From: Alexander Vasarab Date: Sun, 29 Nov 2020 15:43:47 -0800 Subject: [PATCH] Update README with custom Wx info --- README.md | 28 ++++++++++++++++++++++++---- 1 file changed, 24 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 8bbe60e..681feac 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,9 @@ InfoEx AutoWx (IEAW) ============= -This program fetches data from an NRCS SNOTEL or MesoWest station and -pushes it into the InfoEx system using the new automated weather system -implementation. +This program fetches data from an NRCS SNOTEL or MesoWest station, or +your own custom data source, and pushes it into the InfoEx system using +the new automated weather system implementation. Licensed under the ISC license (see file: LICENSE). @@ -199,6 +199,13 @@ This program supports custom weather station data by allowing the user to specify the path to an external Python program. The external Python program should emit its data in the form expected by infoex-autowx. +This is a powerful feature which enables the user to upload data from +any source imaginable into InfoEx. Common examples are a local database +or a remote web page which requires some custom parsing. + +Please see the program located at examples/custom-wx.example.py for a +complete description of what's required. + A note on supported measurements -------------------------------- @@ -208,7 +215,6 @@ weather station may not record them. In this case, the data will simply be ignored (i.e. it will NOT log "0" when there's no measurement available). - InfoEx provides a mechanism for inspecting your automated weather station data, so use that after setting this program up and compare it with the data you see in your web browser. @@ -234,6 +240,20 @@ wind\_speed wind\_direction wind\_gust +**Custom Wx program** +*infoex-autowx expects a custom Wx data provider to provide at least one +of the following:* +precipitationGauge +tempPres +tempMaxHour +tempMinHour +hS +baro +rH +windSpeedNum +windDirectionNum +windGustSpeedNum + Future plans ------------ -- 2.30.2