### W4L current.dat response example Source: https://foshkplugin.phantasoft.de Example of the data structure returned by the /w4l/current.dat endpoint. ```text 1617139459 | Tue, 30 Mar 2021 23:24:19 +0200 | CET | Europe/Berlin | +0200 | Hohen Neuendorf | DE | 52.669481 | 13.266531 | 53 | 8.2 | 8.2 | 92 | Westsüdwest | 256 | 0.0 | 0.0 | 8.2 | 1027.09 | 7.0 | 0.00 | 7.5 | 0 | 0.0 | 0.0 | ``` -------------------------------- ### GET /FOSHKplugin/pushover=enable Source: https://foshkplugin.phantasoft.de Temporarily enables push notifications via Pushover. Pushover must already be correctly configured. ```APIDOC ## GET /FOSHKplugin/pushover=enable ### Description Temporarily enables push notifications via Pushover. Pushover must already be correctly configured. ### Method GET ### Endpoint /FOSHKplugin/pushover=enable ### Response #### Success Response (200) - **body** (string) - Confirmation message. #### Response Example Pushover enabled ``` -------------------------------- ### GET /clientraw.txt Source: https://foshkplugin.phantasoft.de Outputs data via HTTP as clientraw.txt (Weather Display export file). ```APIDOC ## GET /clientraw.txt ### Description Outputs data via HTTP as clientraw.txt (Weather Display export file). ### Method GET ### Endpoint /clientraw.txt ### Response #### Success Response (200) - **body** (string) - Content of the clientraw.txt file. #### Response Example clientraw.txt content ``` -------------------------------- ### GET /realtime.txt Source: https://foshkplugin.phantasoft.de Outputs data via HTTP as realtime.txt (Cumulus export file). ```APIDOC ## GET /realtime.txt ### Description Outputs data via HTTP as realtime.txt (Cumulus export file). ### Method GET ### Endpoint /realtime.txt ### Response #### Success Response (200) - **body** (string) - Content of the realtime.txt file. #### Response Example realtime.txt content ``` -------------------------------- ### GET /FOSHKplugin/state Source: https://foshkplugin.phantasoft.de Returns the status of the service. If active, it returns 'running'. ```APIDOC ## GET /FOSHKplugin/state ### Description Returns the status of the service. If active, it returns 'running'. ### Method GET ### Endpoint /FOSHKplugin/state ### Response #### Success Response (200) - **body** (string) - 'running' if the service is active. #### Response Example running ``` -------------------------------- ### GET /FOSHKplugin/debug=enable Source: https://foshkplugin.phantasoft.de Enables debug mode for extended messages in the logfile. ```APIDOC ## GET /FOSHKplugin/debug=enable ### Description Enables debug mode for extended messages in the logfile. ### Method GET ### Endpoint /FOSHKplugin/debug=enable ### Response #### Success Response (200) - **body** (string) - Confirmation message. #### Response Example Debug mode enabled ``` -------------------------------- ### Ecowitt-Format data transmission Source: https://foshkplugin.phantasoft.de Example of weather data transmitted in the Ecowitt format, which supports more sensor values than the WU format. ```text PASSKEY=00010203040506070809101112131415&stationtype=GW1000A_V1.5.4&dateutc=2019-12-24+22:29:23&tempinf=74.7&humidityin=38&baromrelin=29.692&baromabsin=29.542&tempf=41.0&humidity=97&winddir=172&windspeedmph=0.00&windgustmph=0.00&maxdailygust=4.47&solarradiation=0.00&uv=0&rainratein=0.000&eventrainin=0.150&hourlyrainin=0.000&dailyrainin=0.150&weeklyrainin=0.197&monthlyrainin=1.209&yearlyrainin=1.228&totalrainin=1.228&temp2f=71.96&humidity2=43&temp3f=73.58&humidity3=41&soilmoisture1=51&soilmoisture2=49&wh65batt=0&batt2=0&batt3=0&soilbatt1=1.7&soilbatt2=1.7&freq=868M&model=GW1000_Pro ``` -------------------------------- ### GET /FOSHKplugin/debug=disable Source: https://foshkplugin.phantasoft.de Disables debug mode for extended messages in the logfile. ```APIDOC ## GET /FOSHKplugin/debug=disable ### Description Disables debug mode for extended messages in the logfile. ### Method GET ### Endpoint /FOSHKplugin/debug=disable ### Response #### Success Response (200) - **body** (string) - Confirmation message. #### Response Example Debug mode disabled ``` -------------------------------- ### GET / (root) Source: https://foshkplugin.phantasoft.de Displays a simple web page with the current metric data in table form. Adding 'status' shows status messages. Adding units=e outputs values in the US system (inch, mph, etc.). ```APIDOC ## GET / (root) ### Description Displays a simple web page with the current metric data in table form. Adding 'status' shows status messages. Adding units=e outputs values in the US system (inch, mph, etc.). ### Method GET ### Endpoint / ### Parameters #### Query Parameters - **status** (flag) - Optional - If present, includes status messages. - **units** (string) - Optional - Set to 'e' to output values in the US system. ### Response #### Success Response (200) - **body** (text/html) - HTML page with current data. #### Response Example ... ``` -------------------------------- ### WU-Format data transmission Source: https://foshkplugin.phantasoft.de Example of weather data transmitted in the Weather Underground format. ```text ID=id&PASSWORD=key&tempf=41.0&humidity=97&dewptf=40.3&windchillf=41.0&winddir=172&windspeedmph=0.00&windgustmph=0.00&rainin=0.000&dailyrainin=0.150&weeklyrainin=0.197&monthlyrainin=1.209&yearlyrainin=1.228&solarradiation=0.00&UV=0&indoortempf=74.8&indoorhumidity=38&baromin=29.695&soilmoisture=51&soilmoisture2=49&lowbatt=0&dateutc=now&softwaretype=GW1000A_V1.5.4&action=updateraw&realtime=1&rtfreq=5 ``` -------------------------------- ### GET /getvalue?key=keyname Source: https://foshkplugin.phantasoft.de Returns the value for the given key. The key can be a RAW or converted key. Useful for queries via curl or wget. ```APIDOC ## GET /getvalue?key=keyname ### Description Returns the value for the given key. The key can be a RAW or converted key. Useful for queries via curl or wget. ### Method GET ### Endpoint /getvalue ### Parameters #### Query Parameters - **key** (string) - Required - The key name for which the value is requested. ### Response #### Success Response (200) - **body** (string) - The value corresponding to the key. #### Response Example 12.5 ``` -------------------------------- ### GET /RAW Source: https://foshkplugin.phantasoft.de Outputs the data record delivered by the weather station unchanged via HTTP. The separator can be changed with separator=Z, where Z is a single character. ```APIDOC ## GET /RAW ### Description Outputs the data record delivered by the weather station unchanged via HTTP. The separator can be changed with separator=Z, where Z is a single character. ### Method GET ### Endpoint /RAW ### Parameters #### Query Parameters - **separator** (string) - Optional - A single character used as separator. Default is the station's separator. ### Response #### Success Response (200) - **body** (string) - The raw data record. #### Response Example raw data ``` -------------------------------- ### GET /UDP Source: https://foshkplugin.phantasoft.de Outputs the last UDP string via HTTP. Adding 'status' to the URL also outputs the current statuses. ```APIDOC ## GET /UDP ### Description Outputs the last UDP string via HTTP. Adding 'status' to the URL also outputs the current statuses. ### Method GET ### Endpoint /UDP ### Parameters #### Query Parameters - **status** (flag) - Optional - If present, includes current statuses in the output. ### Response #### Success Response (200) - **body** (string) - The last UDP string, optionally with statuses. #### Response Example UDP string content ``` -------------------------------- ### GET /FOSHKplugin/status Source: https://foshkplugin.phantasoft.de Displays status messages for thunderstorm, storm, battery, missing sensor, station watchdog, etc. as a simple web page. ```APIDOC ## GET /FOSHKplugin/status ### Description Displays status messages for thunderstorm, storm, battery, missing sensor, station watchdog, etc. as a simple web page. ### Method GET ### Endpoint /FOSHKplugin/status ### Response #### Success Response (200) - **body** (text/html) - HTML page with status messages. #### Response Example ... ``` -------------------------------- ### GET /STRING Source: https://foshkplugin.phantasoft.de Outputs the converted data record and the current status with separator ';' via HTTP. Adding units=e outputs imperial values. The separator can be changed with separator=Z. Adding 'status' to the URL also outputs the current statuses. ```APIDOC ## GET /STRING ### Description Outputs the converted data record and the current status with separator ';' via HTTP. Adding units=e outputs imperial values. The separator can be changed with separator=Z. Adding 'status' to the URL also outputs the current statuses. ### Method GET ### Endpoint /STRING ### Parameters #### Query Parameters - **units** (string) - Optional - Set to 'e' to output imperial values. - **separator** (string) - Optional - A single character used as separator. Default is ';'. - **status** (flag) - Optional - If present, includes current statuses in the output. ### Response #### Success Response (200) - **body** (string) - Converted data record with statuses, separated by the specified separator. #### Response Example value1;value2;status1;status2 ``` -------------------------------- ### GET /JSON Source: https://foshkplugin.phantasoft.de Outputs data via HTTP as JSON (metric by default; units=e outputs imperial values). Adding 'status' to the URL also outputs the current statuses. ```APIDOC ## GET /JSON ### Description Outputs data via HTTP as JSON (metric by default; units=e outputs imperial values). Adding 'status' to the URL also outputs the current statuses. ### Method GET ### Endpoint /JSON ### Parameters #### Query Parameters - **units** (string) - Optional - Set to 'e' to output imperial values. - **status** (flag) - Optional - If present, includes current statuses in the output. ### Response #### Success Response (200) - **body** (object) - JSON object containing the weather data, optionally with statuses. #### Response Example {"temperature":20.5,"humidity":60} ``` -------------------------------- ### GET /CSV Source: https://foshkplugin.phantasoft.de Outputs all reported metric values of the last data record as semicolon-separated CSV. If units=e is specified, imperial values are output. ```APIDOC ## GET /CSV ### Description Outputs all reported metric values of the last data record as semicolon-separated CSV. If units=e is specified, imperial values are output. ### Method GET ### Endpoint /CSV ### Parameters #### Query Parameters - **units** (string) - Optional - Set to 'e' to output imperial values. ### Response #### Success Response (200) - **body** (string) - Semicolon-separated values. #### Response Example value1;value2;value3 ``` -------------------------------- ### GET /CSVHDR Source: https://foshkplugin.phantasoft.de Outputs the field names (header) of the last data record as semicolon-separated CSV. If units=e is specified, the fields for imperial values are output. ```APIDOC ## GET /CSVHDR ### Description Outputs the field names (header) of the last data record as semicolon-separated CSV. If units=e is specified, the fields for imperial values are output. ### Method GET ### Endpoint /CSVHDR ### Parameters #### Query Parameters - **units** (string) - Optional - Set to 'e' to output imperial field names. ### Response #### Success Response (200) - **body** (string) - Semicolon-separated field names. #### Response Example field1;field2;field3 ``` === COMPLETE CONTENT === This response contains all available snippets from this library. No additional content exists. Do not make further requests.