Skip to content

Commit

Permalink
More documentation updates
Browse files Browse the repository at this point in the history
Signed-off-by: Jim Easterbrook <jim@jim-easterbrook.me.uk>
  • Loading branch information
jim-easterbrook committed Aug 23, 2018
1 parent 1f0a458 commit 582db92
Show file tree
Hide file tree
Showing 3 changed files with 18 additions and 5 deletions.
16 changes: 14 additions & 2 deletions src/doc/guides/integration.rst
Original file line number Diff line number Diff line change
Expand Up @@ -31,13 +31,25 @@ This is easy to do:

#. Stop all pywws software
#. Copy the ``yowindow.xml`` example template to your text template directory.
#. If you haven't already done so, edit ``weather.ini`` and set the ``local_files`` entry in the ``[paths]`` section to a suitable directory for your yowindow file.
#. Add the yowindow template to the ``[live]`` tasks in ``weather.ini``. Set its flags to ``'L'`` so the result is copied to your local directory instead of being uploaded to an ftp site::
#. Add the yowindow template to the ``[live]`` tasks in ``weather.ini``.
Set its flags to ``'L'`` so that pywws doesn't try to upload it to an ftp site::

[live]
text = [('yowindow.xml', 'L')]
#. Restart pywws live logging.

This will write the file to the ``output`` subdirectory of the ``work`` directory set in :ref:`weather.ini <weather_ini-paths>`.
If you prefer to store the file somewhere else you can use the :py:mod:`pywws.service.copy` service to copy it there. For example::

[copy]
directory = /home/heavyweather/

[live]
text = ['yowindow.xml']
services = [('copy', 'yowindow.xml')]

In this case a ``'L'`` flag is not required as there is a service using the template output.

You can check the file is being updated every 48 seconds by using ``more`` or ``cat`` to dump it to the screen.

Finally configure yowindow to use this file.
Expand Down
3 changes: 2 additions & 1 deletion src/doc/guides/weather_ini.rst
Original file line number Diff line number Diff line change
Expand Up @@ -107,6 +107,8 @@ You must update all your stored data by running :py:mod:`pywws.reprocess` after
The default is to save the files every hour, to reduce "wear" on solid state memory such as the SD cards used with Raspberry Pi computers.
If your weather data directory is stored on a conventional disc drive you can set ``frequent writes`` to ``True``.

.. _weather_ini-paths:

paths: directories in which templates etc. are stored
-----------------------------------------------------
::
Expand All @@ -115,7 +117,6 @@ paths: directories in which templates etc. are stored
templates = /home/$USER/weather/templates/
graph_templates = /home/$USER/weather/graph_templates/
work = /tmp/weather
local_files = /home/$USER/weather/results/
user_calib = /home/$USER/weather/modules/usercalib
modules = /home/$USER/weather/modules/

Expand Down
4 changes: 2 additions & 2 deletions src/pywws/__init__.py
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
__version__ = '18.8.0'
_release = '1588'
_commit = 'a49f727'
_release = '1589'
_commit = '1f0a458'

0 comments on commit 582db92

Please sign in to comment.