Skip to content

Commit

Permalink
Prep for v0.1.0
Browse files Browse the repository at this point in the history
  • Loading branch information
Gadgetoid committed Mar 14, 2018
1 parent 4be639a commit a709aac
Show file tree
Hide file tree
Showing 8 changed files with 139 additions and 9 deletions.
7 changes: 7 additions & 0 deletions library/CHANGELOG.txt
Original file line number Diff line number Diff line change
@@ -1,3 +1,10 @@
0.1.0
-----

* Fix: Defer setup to avoid import side effects
* Fix: Slowed LED update rate
* Improvement: Switched to warnings to notify about unsupported features on pHAT

0.0.4
-----

Expand Down
2 changes: 1 addition & 1 deletion library/MANIFEST.in
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
include CHANGELOG.txt
include LICENSE.txt
include README.txt
include README.rst
include setup.py
include automationhat/*.py
111 changes: 111 additions & 0 deletions library/README.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,111 @@
Automation HAT
==============

.. image:: https://raw.githubusercontent.com/pimoroni/automation-hat/master/autohat_360.png
:alt: Automation HAT

* https://shop.pimoroni.com/products/automation-hat
* https://shop.pimoroni.com/products/automation-phat

Automation HAT/pHAT is a home monitoring and automation controller
featuring relays, analog channels, powered outputs, and buffered inputs
(all 24V tolerant).

Installing
----------

Full install (recommended):
~~~~~~~~~~~~~~~~~~~~~~~~~~~

We've created an easy installation script that will install all
pre-requisites and get your Automation HAT/pHAT up and running with
minimal efforts. To run it, fire up Terminal which you'll find in Menu
-> Accessories -> Terminal on your Raspberry Pi desktop, as illustrated
below:

.. image:: http://get.pimoroni.com/resources/github-repo-terminal.png
:alt: Finding the terminal

In the new terminal window type the command exactly as it appears below
(check for typos) and follow the on-screen instructions:

.. code:: bash
curl https://get.pimoroni.com/automationhat | bash
Alternatively, on Raspbian, you can download the ``pimoroni-dashboard``
and install your product by browsing to the relevant entry:

.. code:: bash
sudo apt-get install pimoroni
(you will find the Dashboard under 'Accessories' too, in the Pi menu -
or just run ``pimoroni-dashboard`` at the command line)

If you choose to download examples you'll find them in
``/home/pi/Pimoroni/automationhat/``.

Manual install:
~~~~~~~~~~~~~~~

Library install for Python 3:
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

on Raspbian:

.. code:: bash
sudo apt-get install python3-automationhat
other environments:

.. code:: bash
sudo pip3 install automationhat
Library install for Python 2:
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

on Raspbian:

.. code:: bash
sudo apt-get install python-automationhat
other environments:

.. code:: bash
sudo pip2 install automationhat
Development:
~~~~~~~~~~~~

If you want to contribute, or like living on the edge of your seat by
having the latest code, you should clone this repository, ``cd`` to the
library directory, and run:

.. code:: bash
sudo python3 setup.py install
(or ``sudo python setup.py install`` whichever your primary Python
environment may be)

In all cases you will have to enable the i2c bus.

Documentation & Support
-----------------------

- Guides and tutorials
* https://learn.pimoroni.com/automation-hat
* https://learn.pimoroni.com/automation-phat
- Function reference
* https://github.com/pimoroni/automation-hat/tree/master/documentation
- GPIO Pinout
* https://pinout.xyz/pinout/automation\_hat
* https://pinout.xyz/pinout/automation\_phat
- Get help
* http://forums.pimoroni.com/c/support

4 changes: 0 additions & 4 deletions library/README.txt

This file was deleted.

2 changes: 1 addition & 1 deletion library/automationhat/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
from .ads1015 import ads1015
from .pins import ObjectCollection, AsyncWorker, StoppableThread

__version__ = '0.0.4'
__version__ = '0.1.0'


RELAY_1 = 13
Expand Down
6 changes: 3 additions & 3 deletions library/setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -70,13 +70,13 @@ def run(self):

setup(
name = 'automationhat',
version = '0.0.4',
version = '0.1.0',
author = 'Philip Howard',
author_email = '[email protected]',
description = 'Automation HAT Driver',
long_description= open('README.txt').read() + open('CHANGELOG.txt').read(),
long_description= open('README.rst').read() + "\n" + open('CHANGELOG.txt').read(),
license = 'MIT',
keywords = 'Raspberry Pi automation controller',
keywords = ['Raspberry Pi', 'automation controller'],
url = 'http://www.pimoroni.com',
classifiers = classifiers,
py_modules = [],
Expand Down
8 changes: 8 additions & 0 deletions packaging/CHANGELOG
Original file line number Diff line number Diff line change
@@ -1,3 +1,11 @@
automationhat (0.1.0) stable; urgency=low

* Fix: Defer setup to avoid import side effects
* Fix: Slowed LED update rate
* Improvement: Switched to warnings to notify about unsupported features on pHAT

-- Phil Howard <[email protected]> Wed, 14 Mar 2018 12:00:00 +0000

automationhat (0.0.4) stable; urgency=low

* Fix for HAT/pHAT detection
Expand Down
8 changes: 8 additions & 0 deletions packaging/debian/changelog
Original file line number Diff line number Diff line change
@@ -1,3 +1,11 @@
automationhat (0.1.0) stable; urgency=low

* Fix: Defer setup to avoid import side effects
* Fix: Slowed LED update rate
* Improvement: Switched to warnings to notify about unsupported features on pHAT

-- Phil Howard <[email protected]> Wed, 14 Mar 2018 12:00:00 +0000

automationhat (0.0.4) stable; urgency=low

* Fix for HAT/pHAT detection
Expand Down

0 comments on commit a709aac

Please sign in to comment.