Skip to content

Commit

Permalink
Udpated documentation
Browse files Browse the repository at this point in the history
Added note to getting started guide about waiting after setting logging
interval.

Signed-off-by: Jim Easterbrook <jim@jim-easterbrook.me.uk>
  • Loading branch information
jim-easterbrook committed Sep 10, 2015
1 parent f32c5f3 commit 4dcf9d0
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 9 deletions.
16 changes: 10 additions & 6 deletions src/doc/guides/getstarted.rst
Original file line number Diff line number Diff line change
Expand Up @@ -36,11 +36,11 @@ Easy installation

The easiest way to install pywws is with the pip command::

sudo pip install pywws --pre
sudo pip install pywws

Upgrading pywws is also a one line command::

sudo pip install -U pywws --pre
sudo pip install -U pywws

Now you are ready to :ref:`test-weather-station`.

Expand Down Expand Up @@ -84,14 +84,14 @@ To upgrade you use git to pull any changes::
cd ~/weather/pywws
git pull

Install scripts
^^^^^^^^^^^^^^^
Install pywws
^^^^^^^^^^^^^

If you have not installed pywws with pip, you need to use setup.py to generate the "entry point" scripts for common pywws tasks::
If you have downloaded or cloned the pywws source files, you need to use setup.py to install it::

cd ~/weather/pywws
python setup.py build
sudo python setup.py develop
sudo python setup.py install

Note to Python 3 users: this will generate and use Python 3 versions of the pywws software in ``~/weather/pywws/build/lib``.

Expand Down Expand Up @@ -175,6 +175,10 @@ Use :py:mod:`pywws.SetWeatherStation` to set the interval::

pywws-setweatherstation -r 5

Note that the weather station will not start using the new interval until the current 30 minute logging period is finished.
This may cause "station is not logging data" errors when running pywws logging.
If this happens you need to wait until the 30 minute logging period ends.

Log your weather station data
-----------------------------

Expand Down
6 changes: 3 additions & 3 deletions src/pywws/__init__.py
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
__version__ = '15.09.0.dev1309'
_release = '1309'
_commit = 'f67d2ea'
__version__ = '15.09.0.dev1310'
_release = '1310'
_commit = 'f32c5f3'

0 comments on commit 4dcf9d0

Please sign in to comment.