Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Basic doc updates #7

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Basic doc updates #7

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
51eccee
Updated some broken links for python modules.
Rukkh May 18, 2015
4f28c45
Tweaked some link names to avoid sphinx warnings probably not required.
Rukkh May 18, 2015
6f01bf8
Update copyright date.
Rukkh May 18, 2015
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions source/changelog/changelog.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ This script can be installed using 'checkScript.sh install'. This adds it to cro
* Added pin list for DIY shield
* Parsing of the commit SHA in the Arduino version string

`All brewpi-script changes on GitHub <https://github.com/BrewPi/brewpi-script/compare/0.3.0...0.3.1>`_
`All brewpi-script changes on GitHub 0.3.0 -> 0.3.1 <https://github.com/BrewPi/brewpi-script/compare/0.3.0...0.3.1>`_


Arduino code (brewpi-avr) | 0.2.3.1 -> 0.2.4
Expand Down Expand Up @@ -79,15 +79,15 @@ The biggest changes in the Arduino code for this release are:
* Added a minimum for overshoot estimators. They could not recover from being zero before this fix.
* Include commit SHA in version number

`All brewpi-www changes on GitHub <https://github.com/BrewPi/brewpi-www/compare/0.2.3.1...0.2.4>`_
`All brewpi-www changes on GitHub 0.2.3.1 -> 0.2.4 <https://github.com/BrewPi/brewpi-www/compare/0.2.3.1...0.2.4>`_

Install and update tools (Brewpi-tools)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

* Update script now also checks Arduino version and can reprogram the Arduino. It downloads the latest hex file from the BrewPi server.
* Added Wifi check script to install (add to cron.d)

`All brewpi-tools changes on GitHub <https://github.com/BrewPi/brewpi-tools/compare/0.1.0...0.2.0>`_
`All brewpi-tools changes on GitHub 0.2.3.1 -> 0.2.4 <https://github.com/BrewPi/brewpi-tools/compare/0.1.0...0.2.0>`_


December 23, 2013
Expand Down Expand Up @@ -128,7 +128,7 @@ Web interface (brewpi-www) | 0.2 -> 0.3
* Room temp and fridge temp are now hidden by default to reduce clutter. Click the circles next to the graph to show them.
* Bug fixes and layout fixes

`All brewpi-www changes on GitHub <https://github.com/BrewPi/brewpi-www/compare/0.2.0...0.3.0>`_
`All brewpi-www changes on GitHub 0.2 -> 0.3 <https://github.com/BrewPi/brewpi-www/compare/0.2.0...0.3.0>`_

BrewPi Python scripts | 0.2 -> 0.3
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Expand All @@ -147,7 +147,7 @@ BrewPi Python scripts | 0.2 -> 0.3
* Commands to start/stop/pause logging (script side)
* Better error exception and lots of bug fixes

`All brewpi-script changes on GitHub <https://github.com/BrewPi/brewpi-script/compare/0.2.0...0.3.0>`_
`All brewpi-script changes on GitHub 0.2 -> 0.3 <https://github.com/BrewPi/brewpi-script/compare/0.2.0...0.3.0>`_

Arduino code (brewpi-avr) | 0.2.0 -> 0.2.3
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Expand All @@ -168,7 +168,7 @@ Arduino code (brewpi-avr) | 0.2.0 -> 0.2.3
* Inverted pin mode is now default for new devices
* Beep as first thing at boot, so you know when the bootloader ends and brewpi starts

`All brewpi-avr changes on GitHub <https://github.com/BrewPi/brewpi-avr/compare/0.2.0...0.2.3>`_
`All brewpi-avr changes on GitHub 0.2.0 -> 0.2.3 <https://github.com/BrewPi/brewpi-avr/compare/0.2.0...0.2.3>`_

BrewPi tools for bootstrapping and updating (brewpi-tools) | New
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Expand All @@ -183,7 +183,7 @@ BrewPi tools for bootstrapping and updating (brewpi-tools) | New
* Ask to stash changes on merge conflicts
* Switch branches

`All brewpi-tools changes on GitHub <https://github.com/BrewPi/brewpi-tools/compare/master%40%7B5years%7D...0.1.0>`_
`All brewpi-tools changes on GitHub New <https://github.com/BrewPi/brewpi-tools/compare/master%40%7B5years%7D...0.1.0>`_



4 changes: 2 additions & 2 deletions source/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@

# General information about the project.
project = u'BrewPi'
copyright = u'2013, BrewPi'
copyright = u'2015, BrewPi'

# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
Expand Down Expand Up @@ -94,7 +94,7 @@

# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
html_theme = 'default'
html_theme = 'classic'

# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
Expand Down
10 changes: 8 additions & 2 deletions source/manual-brewpi-install/python-setup.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,15 +6,21 @@ The Raspbian Wheezy images comes with python 2.7 already installed, but BrewPi u
* `pySerial <http://pyserial.sourceforge.net/pyserial_api.html>`_ For communication with the Arduino.
* `simplejson <http://simplejson.github.com/simplejson/>`_ To encode and decode JSON objects. Easier to use than the default JSON module.
* `ConfigObj <http://www.voidspace.org.uk/python/configobj.html>`_ For configuration files support.
* `psutil <http://code.google.com/p/psutil/ psutil>`_ To view running processes and close/kill them from within python
* `python-git <http://pythonhosted.org/GitPython/0.3.1/tutorial.html>`_ A Python library to work with git repositories. Used by the update script.
* `psutil <http://pythonhosted.org/psutil/>`_ To view running processes and close/kill them from within python
* `GitPython <http://gitpython.readthedocs.org/en/latest/intro.html>`_ A Python library to work with git repositories. Used by the update script.

All 5 modules can be easily installed with apt-get:

.. code-block:: bash

sudo apt-get install python-serial python-simplejson python-configobj python-psutil python-git

If you're not using a raspberryPi or other linux distro with apt-get available, you can alternatively use the python installer:

.. code-block:: pycon

pip install pyserial simplejson configobj psutil gitpython

Finally, the python script can reprogram the Arduino, but it needs avrdude to do so. Install arduino-core, which includes avrdude.

.. code-block:: bash
Expand Down