Topic: FOSHKplugin - brief introduction

[Dead Weather]

I'll probably add PWSWeather first
I do not see in the examples where I add any Station ID, password etc?

Hi!

Do I just post one into my config file?

Of course, all these examples must be adapted to your requirements. You will therefore have to change any user names, passwords and, if necessary, destinations.
Otherwise, however, it is copy/paste.
For most destinations, however, you must first set up a corresponding account with the weather service provider in order to obtain the access data. For local services (such as InfluxDB or MQTT), the necessary conditions must also be created beforehand.
Where would you also like to send to?

Oliver

[olicat]

Hi!

I do not see in the examples where I add any Station ID, password etc?

Really?
There is even a recipe for PWSWeather.
You just have to adjust the myID and myPassword.

Oliver

[Dead Weather]

Ah, I was looking for a separate field/line but its in the url.
Thanks for pointing that out

Hi!

I do not see in the examples where I add any Station ID, password etc?

Really?
There is even a recipe for PWSWeather.
You just have to adjust the myID and myPassword.

Oliver

[mcrossley]

Oliver your web site links all redirect to https ://wiki.loxberry.de/ is that correct? I get a browser warning about that site being a possible "typosquatting"

[olicat]

Hi Mark,

your web site links all redirect to https ://wiki.loxberry.de/ is that correct?

that's perfectly fine.
I don't host the WIKI myself and so it has already moved - with broken links as a result. In order to have at least some room for manoeuvre, I use my domain as a redirector and can thus influence the actual destination and the published links. I am also in a position to host the WIKI myself at some point - without the links published until then going nowhere.

Oliver

[Dead Weather]

Hi Oliver,

I got my forwards working to multiple services but I noticed they do not seem to see the rain sensor as none of them list precipitation.
I have an Ecowitt WS90 with haptic rain sensor.

Anything I should check?

[olicat]

Hi!

Anything I should check?

Which version of FOSHKplugin do you use?
With v0.09 you should upgrade to FOSHKplugin v0.10 or follow this post.

Oliver

[Dead Weather]

I willl try the upgrade.

Under Installed Pllugins, its says Version 0.0.9, Up to Date.
Is that normal?

Hi!

Anything I should check?

Which version of FOSHKplugin do you use?
With v0.09 you should upgrade to FOSHKplugin v0.10 or follow this post.

Oliver

[olicat]

Hi!

Under Installed Pllugins, its says Version 0.0.9, Up to Date.

Interesting, so you are using the LoxBerry version of FOSHKplugin.
Unusual. Most people here use the generic version. But no problem at all.

The v0.0.9 is the latest (and therefore current) official version.
The v0.0.10 is still in beta status. Only when I (finally) publish the new version, LoxBerry will find a newer version.

Oliver

[Dead Weather]

Hi Oliver,

I am trying to install the generic version.
The end of the process gives me the below messages

createConfig: import failed: No module named requests
setWSConfig: import failed: No module named requests

Is that normal?
When its up and running, is there a web gui I can access?

Hi!

Under Installed Pllugins, its says Version 0.0.9, Up to Date.

Interesting, so you are using the LoxBerry version of FOSHKplugin.
Unusual. Most people here use the generic version. But no problem at all.

The v0.0.9 is the latest (and therefore current) official version.
The v0.0.10 is still in beta status. Only when I (finally) publish the new version, LoxBerry will find a newer version.

Oliver

[olicat]

Hi!

There are two versions of FOSHKplugin - the LoxBerry version and the generic version.
The LoxBerry version requires an existing LoxBerry installation - a widely used, free add-on with many additional options in the Loxone Smarthome system environment.
You have to assess for yourself whether it is worth the effort to install and maintain a LoxBerry system just to run the LoxBerry version of FOSHKplugin on it.
In general, the statement applies: without Loxone no LoxBerry and without LoxBerry no LoxBerry version of FOSHKplugin.

The generic version of FOSHKplugin is intended for the general public. This only requires any Linux as a basis (although Debian derivatives are preferable). Documentation is available in English.
Here you can install FOSHKplugin with very little effort - even on an existing Linux system. The installation is described step by step here: Installation of FOSHKplugin generic version

The code base and functionality is identical for the LoxBerry version and generic version.
The only difference is that some configuration changes in the LoxBerry version can be made via a web form. In the generic version, console access and an editor are required for all configurations.
As this is also necessary for advanced configurations (e.g. forwards) in the LoxBerry version, you can also do this in general.

In concrete terms, this means for you:
You can continue to use your existing LoxBerry installation.
In the LoxBerry plugin management, you can enter the URL https://foshkplugin.phantasoft.de/files/loxberry-FOSHKplugin-0.0.10Beta.zip in the field for "Install new plugin", enter your SecurePIN and click on the Install button (see image).

You can also install the generic version of FOSHKplugin and (important!) prevent the previous FOSHKplugin installation (LoxBerry) from starting via the "Activate the plugin" slider (set to No) in the LoxBerry plugin configuration.
Then click on the Save button at the bottom - the LoxBerry version should still be available but deactivated.

Oliver

Update: Now also available as a recipe in the WIKI filed.

[Dead Weather]

OK, I got the generic version up and running as I started from scratch.
Plugin is receiving data.  Now I just need to edit my config file and add my forwards.
I believe you said the service should be stopped before editing the config file. How do I stop the service so i can edit the config file?

Thanks!

Hi!

There are two versions of FOSHKplugin - the LoxBerry version and the generic version.
The LoxBerry version requires an existing LoxBerry installation - a widely used, free add-on with many additional options in the Loxone Smarthome system environment.
You have to assess for yourself whether it is worth the effort to install and maintain a LoxBerry system just to run the LoxBerry version of FOSHKplugin on it.
In general, the statement applies: without Loxone no LoxBerry and without LoxBerry no LoxBerry version of FOSHKplugin.

The generic version of FOSHKplugin is intended for the general public. This only requires any Linux as a basis (although Debian derivatives are preferable). Documentation is available in English.
Here you can install FOSHKplugin with very little effort - even on an existing Linux system. The installation is described step by step here: Installation of FOSHKplugin generic version

The code base and functionality is identical for the LoxBerry version and generic version.
The only difference is that some configuration changes in the LoxBerry version can be made via a web form. In the generic version, console access and an editor are required for all configurations.
As this is also necessary for advanced configurations (e.g. forwards) in the LoxBerry version, you can also do this in general.

In concrete terms, this means for you:
You can continue to use your existing LoxBerry installation.
In the LoxBerry plugin management, you can enter the URL https://foshkplugin.phantasoft.de/files/loxberry-FOSHKplugin-0.0.10Beta.zip in the field for "Install new plugin", enter your SecurePIN and click on the Install button (see image).

You can also install the generic version of FOSHKplugin and (important!) prevent the previous FOSHKplugin installation (LoxBerry) from starting via the "Activate the plugin" slider (set to No) in the LoxBerry plugin configuration.
Then click on the Save button at the bottom - the LoxBerry version should still be available but deactivated.

Oliver

Update: Now also available as a recipe in the WIKI filed.

[olicat]

Hi!

How do I stop the service so i can edit the config file?

Starting and stopping services depends on the Linux distribution used. However, it should work with the following commands:

STOP:

Code: [Select]

sudo service foshkplugin stop
START:

Code: [Select]

sudo service foshkplugin start
Provided it is a Debian-like distribution and FOSHKplugin is configured as a service with the name foshkplugin.

Success!

Oliver

[Dead Weather]

Great success! 
All sensors showing up and forwarding to multiple sites.

Thanks again for a great plugin and excellent support!!

Hi!

How do I stop the service so i can edit the config file?

Starting and stopping services depends on the Linux distribution used. However, it should work with the following commands:

STOP:

Code: [Select]

sudo service foshkplugin stop
START:

Code: [Select]

sudo service foshkplugin start
Provided it is a Debian-like distribution and FOSHKplugin is configured as a service with the name foshkplugin.

Success!

Oliver

[Rover1822]

You might want to send a monetary support amount to Oliver, as he has done all of this , on his own.  The level of effort he has done to provide this, pro  bono , and I get it , he likes doing it .

Or to a charity Oliver supports.

Few things amaze me, but Oliver's dedication to this , and effort , does.

Sorry Oliver If I made you blush. But your contribution and tireless efforts to not only provide this, and then support it, Needs mention

[Dead Weather]

I do not see anywhere in Olivers signature for sending donations?
Is there a link?

You might want to send a monetary support amount to Oliver, as he has done all of this , on his own.  The level of effort he has done to provide this, pro  bono , and I get it , he likes doing it .

Or to a charity Oliver supports.

Few things amaze me, but Oliver's dedication to this , and effort , does.

Sorry Oliver If I made you blush. But your contribution and tireless efforts to not only provide this, and then support it, Needs mention

[olicat]

Hi!

Thank you very much for the kind words.
Where do we want to start and where do we have to end?
There are so many people who sacrifice their free time for us and even bear the costs. Think of the people who make and maintain the forum here (and elsewhere), feed the WIKIs, distribute great software as freeware (e.g. CMX, PWSDashboard) and who help others with helpful information here in the forum, for example.
Free of charge!
It's nice that there is still a certain solidarity and community - especially in this day and age where everything seems to be about money, profit, influence and power.
And of course I'm happy (I'm sure the others are too!) when users realise this from time to time and act accordingly. In other words, show respect for the volunteers and don't harbour unfulfillable expectations or even make unreasonable demands.

Nobody has to feel obliged to give me money or any donations for my voluntary work. I do this as a hobby and will continue as long as I can afford it and enjoy it.
And as long as I'm not the last one ...

And as for actual voluntary donations: I will clarify what options are available.
Thanks!

Oliver

[olicat]

Hi!

There is a new public beta version of FOSHKplugin v0.10 - version Beta 250225. Since the last public beta from September 2024 the following (minor) things have been changed:

Code: [Select]

new: Config\RUN_DESC = note - string is output as additional information in push notifications (behind the IP address) and for internal html pages help, banner, fwdstat, keyhelp, scanWS in the headline
improved: fixed some warnings regarding Python >= 3.11 string handling ("DeprecationWarning: invalid escape sequence" and "SyntaxWarning: invalid escape sequence")
new: support of WH48 (guess!)
new: enable more keys (radcompensation, newVersion, upgrade, rainFallPriority, rainGain, rstRainDay, rstRainWeek, rstRainYear, piezo, rainN_gain (where N=1..5)) on supported consoles with Export\ADD_MORE = True (default: False)
fixed: queued data may not be forwarded to InfluxDB because the quotes were missing in the value (missed="value")
improved: Firmware-Update-Check for WebUI devices
new: overview pages for formats WU and IoT: http://ipaddress:portnumber/WU and http://ipaddress:portnumber/IoT
improved: variable Config\LB_IP falls back to "" instead of "LB_IP" if not configured
new: globally define the key containing snow depth (e.g. depth_ch1) with Weatherstation\SNOW_DEPTH = keyname - a forward specific FWD_OPTION = SNOW_DEPTH=depth_chN overrules this global setting
new: transmit snow depth to Awekas with AWEKAS forward - can be adjusted with FWD_OPTION = SNOW_DEPTH=depth_ch2 or the global setting Weatherstation\SNOW_DEPTH = keyname
new: with Export\ADD_VPD = True you can enable/disable the VPD calculation for all T/H sensors (outdoor sensor, WH31 and WH45/WH46) - default: False
  the keys are vpd (outdoor T/H sensor), vpdin (indoor T/H sensor), vpdN (WH31; where N=1..8), vpd_co2 (for WH45/WH46)
As usual, the complete changelog can be found here.

To upgrade:
I strongly recommend making a copy of the FOSHKplugin directory before upgrading. This way you have a fallback in case of unexpected problems.

Change via ssh to the directory in which FOSHKplugin is running - according to my recommendations, it could be /opt/FOSHKplugin.
If you run FOSHKplugin as root, you can do the following commands without sudo - if you run FOSHKplugin in a certain user context, the specification of that user would be important so that the permissions are correct:

Code: [Select]

sudo -u username ./generic-FOSHKplugin-install.sh -upgrade generic-FOSHKplugin-0.0.10Beta.zip
sudo -u username ./generic-FOSHKplugin-install.sh -repair

The "repair" is this time only important if you don't come from the previous Beta. But it does not hurt to do this in general - it checks and tries to install some needed packages via apt/pip.

If you just want to install as a separate installation you may download the file here and follow the usual installation process.

Please let me know if there're any problems or you need some explanations of the new functions. Most things should already be described on the website in topic "Version history".

Have fun!

Oliver

[KC5JIM]

I just updated it with no issues. The overview page is working perfectly.