Metainformationen zur Seite
Unterschiede
Hier werden die Unterschiede zwischen zwei Versionen angezeigt.
| Beide Seiten der vorigen RevisionVorhergehende ÜberarbeitungNächste Überarbeitung | Vorhergehende Überarbeitung | ||
| plugins:foshkplugin:foshkplugin_generic_version [2024/02/09 12:01] – Oliver Engel | plugins:foshkplugin:foshkplugin_generic_version [2024/04/15 19:32] (aktuell) – Oliver Engel | ||
|---|---|---|---|
| Zeile 74: | Zeile 74: | ||
| * changed: all incoming get-requests will be URL-decoded now | * changed: all incoming get-requests will be URL-decoded now | ||
| * new: enable signal quality acquisition on supported consoles with Export\ADD_SIGNAL = True (default: False) | * new: enable signal quality acquisition on supported consoles with Export\ADD_SIGNAL = True (default: False) | ||
| + | * new: with the option FWD_OPTION = blacklist=False, | ||
| + | * new: Introduction of a naming scheme for beta versions ("Beta YYMMDD" | ||
| + | * new: ADD_SCRIPT - offers the possibility to integrate data from third party devices - see https:// | ||
| + | * changed: postroot.sh - check Pillow installation fixed (newer versions named pillow instead of Pillow) - LoxBerry only | ||
| + | * changed: sed is now working globally in postinstall.sh & postupgrade.sh - LoxBerry only | ||
| + | * new: enable debug mode if file debug.enable found in the config directory\\ enable debug mode with bin/ | ||
| + | * changed: **changed default SUN_COEF from 0.8 to 0.92** - should fit better for Germany (too little sunshine recorded: decrease value; too much: increase) | ||
| + | * changed: all sun related values (e.g. sunshine, srsum, sunhours, ...) are only transmitted if solarradiation is present | ||
| + | * improved: better integration with Home Assistant (MQTT discovery) - see [[https:// | ||
| Zeile 330: | Zeile 339: | ||
| | / | | / | ||
| | / | | / | ||
| - | | / | + | | / |
| | / | | / | ||
| | / | | / | ||
| Zeile 2938: | Zeile 2947: | ||
| \\ | \\ | ||
| These values are only available via UDP and getvalue as well as in forwards of type UDP, BANNER, TAGFILE, MQTT and InfluxDB. If these values are also to be sent with a forward in Ecowitt format, an additional <code syntaxhighlighter-pre> | These values are only available via UDP and getvalue as well as in forwards of type UDP, BANNER, TAGFILE, MQTT and InfluxDB. If these values are also to be sent with a forward in Ecowitt format, an additional <code syntaxhighlighter-pre> | ||
| + | |||
| + | ++++ | ||
| + | |||
| + | ---- | ||
| + | |||
| + | {{anchor: | ||
| + | |||
| + | ++++ Provide additional data from third-party devices globally for weather services (script) | | ||
| + | |||
| + | **Provide additional data from third-party devices globally for weather services (script)** | ||
| + | |||
| + | With the FWD_EXEC function, it has long been possible to modify the output line for a forward shortly before it is actually sent to the respective weather station service using a script. This script only works on a forward-specific basis and must therefore be set up for each individual forward.\\ | ||
| + | However, if, for example, you want to use the data from an Luftdaten.info fine dust sensor as data from a virtual WH45/WH46 for sending to several services, you would have to set up a separate script for each individual service.\\ | ||
| + | And depending on the target format or FWD_TYPE (Ecowitt format, WU, Awekas, Ambient Weather etc.), this script must also have different content.\\ | ||
| + | \\ | ||
| + | As of v0.10, ADD_SCRIPT can be used to define a global script that receives the data originally coming from the weather station and makes it modifiable. After the change, FOSHKplugin receives the modified or extended data back and only then starts to process this data for each individual forward.\\ | ||
| + | This means that there is a centralised data manipulation option that is valid for all output formats.\\ | ||
| + | \\ | ||
| + | Example:\\ | ||
| + | The particulate matter sensor from Luftdaten.info can be queried locally via a web interface. The link http:// | ||
| + | \\ | ||
| + | JSON - depending on the software version of the device, however, the structure of the JSON may be different: | ||
| + | <code syntaxhighlighter-pre> | ||
| + | { | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | { | ||
| + | " | ||
| + | " | ||
| + | }, | ||
| + | { | ||
| + | " | ||
| + | " | ||
| + | }, | ||
| + | { | ||
| + | " | ||
| + | " | ||
| + | }, | ||
| + | { | ||
| + | " | ||
| + | " | ||
| + | }, | ||
| + | { | ||
| + | " | ||
| + | " | ||
| + | }, | ||
| + | { | ||
| + | " | ||
| + | " | ||
| + | }, | ||
| + | { | ||
| + | " | ||
| + | " | ||
| + | } | ||
| + | ] | ||
| + | } | ||
| + | </ | ||
| + | |||
| + | SDS_P1 corresponds here to the PM10 value and SDS_P2 to the PM2.5 value.\\ | ||
| + | The WH45 recognises the keys tf_co2 (temperature in °F), humi_co2 (humidity), pm25_co2 (the PM2.5 value), pm25_24h_co2 (the 24h mean value of PM2.5), pm10_co2 (PM10 value), pm10_24h_co2 (24h mean value PM10) in Ecowitt format, co2 (CO2) and co2_24h (24h average CO2). If we do not have a real WH45/WH46 ourselves, we can use the PM10 and PM2.5 values of the luftdaten.info sensor and emulate a WH45 - at least partially - by using the WH45/WH46 keys.\\ | ||
| + | We therefore assign the value of SDS_P2 to the pm25_co2 key and the value of SDS_P1 to the pm10_co2 key using a script.\\ | ||
| + | \\ | ||
| + | For a better understanding, | ||
| + | 1. FOSHKplugin receives the general weather data from the console\\ | ||
| + | 2. When the data is received, the configured script is started, which executes the following steps:\\ | ||
| + | 2.1 Query foreign data - the values must come from somewhere\\ | ||
| + | 2.2 merge with the real data from the weather station\\ | ||
| + | 2.3 Return to FOSHKplugin\\ | ||
| + | 3. FOSHKplugin sends the merged data to all configured weather services\\ | ||
| + | \\ | ||
| + | Here is the example script that executes the complete point 2:\\ | ||
| + | <code syntaxhighlighter-pre> | ||
| + | #!/bin/bash | ||
| + | # complements the output line of FOSHKplugin with values of the particulate matter sensor from Luftdaten.info and emulates a WH41 | ||
| + | # the channel number of the virtual WH41 is defined via the variable WH41 | ||
| + | # depending on the output format, the output strings must be modified - in Ecowitt format, the individual components are combined | ||
| + | # using an "&" | ||
| + | # needs curl and jq - install with sudo apt-get install curl jq | ||
| + | # general help: https:// | ||
| + | |||
| + | # define the local ip address of the Sensor | ||
| + | ADR=192.168.15.229 | ||
| + | |||
| + | # define the channel number of the virtual WH41; 9 = emulate WH45 instead | ||
| + | WH41=9 | ||
| + | |||
| + | #JSON=`cat luftdaten2.json` | ||
| + | JSON=`curl -s http:// | ||
| + | |||
| + | # the original output data from FOSHKplugin | ||
| + | instr=" | ||
| + | |||
| + | # PM2.5 | ||
| + | pm2=`echo ${JSON}|jq " | ||
| + | if [ ! -z " | ||
| + | if [ " | ||
| + | fi | ||
| + | |||
| + | # PM10 | ||
| + | pm1=`echo ${JSON}|jq " | ||
| + | if [ ! -z " | ||
| + | if [ " | ||
| + | fi | ||
| + | |||
| + | # temp in °C - must be converted to °F - F = (C*9/5)+32 - | ||
| + | temp=`echo ${JSON}|jq " | ||
| + | temp=`echo " | ||
| + | if [ ! -z " | ||
| + | if [ " | ||
| + | fi | ||
| + | |||
| + | # pressure - not supported by WH41, WH45, WH46 - you could override the original pressure from wether station | ||
| + | # not used | ||
| + | pressure=`echo ${JSON}|jq " | ||
| + | if [ ! -z " | ||
| + | if [ " | ||
| + | fi | ||
| + | |||
| + | #humidity | ||
| + | humidity=`echo ${JSON}|jq " | ||
| + | if [ ! -z " | ||
| + | if [ " | ||
| + | fi | ||
| + | |||
| + | # merge the original string with the new components | ||
| + | echo " | ||
| + | </ | ||
| + | |||
| + | The script here is somewhat more extensive because it can provide data for either a WH41 or WH45.\\ | ||
| + | \\ | ||
| + | For installation/ | ||
| + | 1. save the enclosed file as addLDdata.sh in the installation directory of FOSHKplugin (/ | ||
| + | 2. customise addLDdata.sh - adjust the IP address of your particulate matter sensor at ADR\\ | ||
| + | 3. make the script executable: chmod ug+x addLDdata.sh\\ | ||
| + | 4. make sure that the required tools are available: sudo apt-get install curl jq\\ | ||
| + | 5. manual test of the script: ./ | ||
| + | 6. customise the forward to PWSDashboard - the line FWD_EXEC = ./ | ||
| + | 7. restart FOSHKplugin - sudo service foshkplugin restart\\ | ||
| + | \\ | ||
| + | <WRAP center round important 100%> | ||
| + | **Attention!**\\ | ||
| + | **This is a very powerful feature that should be used with caution. Errors in the script can lead to trouble with the target weather service or even to the failure of FOSHKplugin.**\\ | ||
| + | **As an immediate measure, always insert an exit line in the script below the shebang "# | ||
| + | **Scripts should be well tested - even under conditions that are not intended - ideally locally. A text line can be specified as a parameter to which the additional keys and values are appended.**\\ | ||
| + | **The SND log file logs the script call and any errors detected.** | ||
| + | </ | ||
| + | |||
| + | ++++ | ||
| + | |||
| + | ---- | ||
| + | |||
| + | {{anchor: | ||
| + | |||
| + | ++++ Further processing of data from FOSHKplugin in Home Assistant | | ||
| + | |||
| + | **Further processing of data from FOSHKplugin in Home Assistant** | ||
| + | |||
| + | There are various ways of integrating data from an Ecowitt weather station into Home Assistant.\\ | ||
| + | \\ | ||
| + | The easiest way to do this is via the Ecowitt integration contained in the core of HA. This provides most of the keys of the current Ecowitt weather stations.\\ | ||
| + | However, the additional keys generated by FOSHKplugin are of course not processed and therefore do not end up in HA.\\ | ||
| + | \\ | ||
| + | Another option - if an MQTT broker is available - is to transmit the data via [[https:// | ||
| + | However, this entails longer configuration work because you have to make an entry in a YAML for each desired data point the Home Assistant: | ||
| + | |||
| + | <code syntaxhighlighter-pre> | ||
| + | mqtt: | ||
| + | sensor: | ||
| + | - state_topic: | ||
| + | name: "WH45 Temperature" | ||
| + | unit_of_measurement: | ||
| + | device_class: | ||
| + | icon: " | ||
| + | </ | ||
| + | |||
| + | This is very time-consuming (with 200 or even 450 topics).\\ | ||
| + | \\ | ||
| + | With v0.10, FOSHKplugin now also supports the MQTT discovery of Home Assistant.\\ | ||
| + | HA automatically finds FOSHKplugin as a device with all entities without the need for any configuration measures. Icon, unit and device class are already pre-assigned.\\ | ||
| + | A forward block in the configuration file foshkplugin.conf should look something like this:\\ | ||
| + | |||
| + | <code syntaxhighlighter-pre> | ||
| + | [Forward-60] | ||
| + | FWD_TYPE = MQTTMET | ||
| + | FWD_CMT = MQTT-Forward of metric values to LoxBerry | ||
| + | FWD_URL = 192.168.15.236: | ||
| + | FWD_ENABLE = True | ||
| + | FWD_OPTION = MQTTCYCLE=5, | ||
| + | FWD_SID = MQTT-username | ||
| + | FWD_PWD = MQTT-password | ||
| + | FWD_STATUS = True | ||
| + | </ | ||
| + | |||
| + | MQTTMET should be selected as the forward type FWD_TYPE for metric values - MQTTIMP should be selected accordingly for imperial measurement systems.\\ | ||
| + | The destination - i.e. the MQTT broker together with the desired hierarchy - must be specified in the FWD_URL. The structure of the address is MQTTipaddress: | ||
| + | In the FWD_OPTION line, at least hass=True must be entered to activate auto-discovery. The name of the device is defined with devame=name (default: FOSHKplugin).\\ | ||
| + | By default, FOSHKplugin only sends the data to the broker when the value changes. In addition, an interval in minutes can be entered via MQTTCYCLE in which ALL topics - regardless of value changes - are sent to the broker.\\ | ||
| + | With an interval of 0, ALL topics are sent at every send interval.\\ | ||
| + | To minimise data transfer, I recommend entering an interval of 10 or 5 minutes for regular operation.\\ | ||
| + | If the MQTT broker requires a login, the credentials can be configured with FWD_SID (user name) and FWD_PWD (password).\\ | ||
| + | \\ | ||
| + | By default, all values including the min/max values (if configured) are transmitted via MQTT. To prevent the transmission of the min/max values, minmax=False can be set as an additional option in FWD_OPTION. If the status messages from FOSHKplugin are also to be made available via MQTT, FWD_STATUS should be set to True. Alternatively, | ||
| + | The time format for the output of timestamps (e.g. lightning_time and all min/max times) can be defined with dtime_format. For possible formatting options, see the recipe [[plugins: | ||
| + | If the sensor data is to be separated from the diagnostic data (info data, battery and signal values), this can be realised via the additional option diagnostic=True in the FWD_OPTION. Two separate cards for sensor data and diagnostic data are then generated in the Home Assistant. If diagnostic=False is set or the diagnostic option is missing within the FWD_OPTION, all data is displayed together in one card.\\ | ||
| + | \\ | ||
| + | <WRAP center round important 100%> | ||
| + | **Attention!**\\ | ||
| + | </ | ||
| + | |||
| + | In Home Assistant, select and configure the MQTT integration (address, port and credentials if necessary) under Settings/ | ||
| + | \\ | ||
| + | \\ | ||
| + | {{: | ||
| + | \\ | ||
| + | \\ | ||
| + | You will then find the MQTT button under the configured integrations, | ||
| + | \\ | ||
| + | \\ | ||
| + | {{: | ||
| + | \\ | ||
| + | \\ | ||
| + | After clicking on the MQTT button, information about this integration appears, such as the number of devices and the number of entities in this integration: | ||
| + | \\ | ||
| + | \\ | ||
| + | {{: | ||
| + | \\ | ||
| + | \\ | ||
| + | In the device info you can finally see all information about the FOSHKplugin device and change it if necessary: | ||
| + | \\ | ||
| + | \\ | ||
| + | {{: | ||
| + | \\ | ||
| + | \\ | ||
| + | All data points generated by FOSHKplugin should now be available within Home Assistant for further use and visualisation.\\ | ||
| + | \\ | ||
| + | {{: | ||
| + | \\ | ||
| + | \\ | ||
| + | **Advantages of the connection via FOSHKplugin and MQTT** | ||
| + | * Signal quality values of the sensors are transmitted (if the console supports the http/JSON API) | ||
| + | * Additional values available such as wind chill, dew point (also for all indoor sensors), spread, feelslike, heat index, AQI for WH41/ | ||
| + | * Any values from other sensors can be integrated | ||
| + | * Availability of min/max values with respective times | ||
| + | * Warnings (thunderstorm, | ||
| + | |||
| + | **Note:**\\ | ||
| + | The [[https:// | ||
| + | |||
| ++++ | ++++ | ||