Merge branch 'master' of github.com:RPi-Distro/python-gpiozero

Damn, forgot to push the debian/changelog changes after the last release.

Author: waveform80

.gitignore

@@ -27,3 +27,6 @@ coverage
 .coverage
 .tox
 .cache
+
+# Generated documentation
+docs/_build

CONTRIBUTING.md

@@ -1 +1,2 @@
 include README.rst
+recursive-include tests *.py

MANIFEST.in

@@ -2,13 +2,19 @@
 gpiozero
 ========
 
-.. image:: https://badge.fury.io/py/gpiozero.svg
-    :target: https://badge.fury.io/py/gpiozero
-    :alt: Latest Version
+.. ifconfig:: html_theme == 'sphinx_rtd_theme'
 
-.. image:: https://travis-ci.org/RPi-Distro/python-gpiozero.svg?branch=master
-    :target: https://travis-ci.org/RPi-Distro/python-gpiozero
-    :alt: Build Tests
+    .. image:: https://badge.fury.io/py/gpiozero.svg
+        :target: https://badge.fury.io/py/gpiozero
+        :alt: Latest Version
+
+    .. image:: https://travis-ci.org/RPi-Distro/python-gpiozero.svg?branch=master
+        :target: https://travis-ci.org/RPi-Distro/python-gpiozero
+        :alt: Build Tests
+
+    .. image:: https://img.shields.io/codecov/c/github/RPi-Distro/python-gpiozero/master.svg?maxAge=2592000
+        :target: https://codecov.io/github/RPi-Distro/python-gpiozero
+        :alt: Code Coverage
 
 A simple interface to everyday GPIO components used with Raspberry Pi.
 
@@ -69,7 +75,7 @@ or::
 Documentation
 =============
 
-Comprehensive documentation is available at https://gpiozero.readthedocs.org/.
+Comprehensive documentation is available at https://gpiozero.readthedocs.io/.
 
 Development
 ===========
@@ -95,8 +101,8 @@ Contributors
 .. _Raspberry Pi Foundation: https://www.raspberrypi.org/
 .. _GitHub: https://github.com/RPi-Distro/python-gpiozero
 .. _issues: https://github.com/RPi-Distro/python-gpiozero/issues
-.. _recipes: http://gpiozero.readthedocs.org/en/latest/recipes.html
-.. _Contribute: CONTRIBUTING.md
+.. _recipes: http://gpiozero.readthedocs.io/en/latest/recipes.html
+.. _contribute: http://gpiozero.readthedocs.io/en/latest/contributing.html
 .. _Ben Nuttall: https://github.com/bennuttall
 .. _Dave Jones: https://github.com/waveform80
 .. _Martin O'Hanlon: https://github.com/martinohanlon

README.rst

@@ -11,8 +11,9 @@ X-Python3-Version: >= 3.2
 Package: python-gpiozero
 Architecture: all
 Section: python
-Depends: ${misc:Depends}, ${python:Depends}, python-rpi.gpio
-Suggests: python-spidev, python-gpiozero-docs
+Depends: ${misc:Depends}, ${python:Depends}
+Recommends: python-rpi.gpio, python-spidev
+Suggests: python-gpiozero-docs
 Description: Simple API for controlling devices attached to the GPIO pins.
  gpiozero builds on RPi.GPIO to provide a set of classes designed to simplify
  interaction with devices connected to the GPIO pins, from simple buttons and
@@ -24,8 +25,9 @@ Description: Simple API for controlling devices attached to the GPIO pins.
 Package: python3-gpiozero
 Architecture: all
 Section: python
-Depends: ${misc:Depends}, ${python3:Depends}, python3-rpi.gpio
-Suggests: python3-spidev, python-gpiozero-docs
+Depends: ${misc:Depends}, ${python3:Depends}
+Recommends: python3-rpi.gpio, python3-spidev
+Suggests: python-gpiozero-docs
 Description: Simple API for controlling devices attached to the GPIO pins.
  gpiozero builds on RPi.GPIO to provide a set of classes designed to simplify
  interaction with devices connected to the GPIO pins, from simple buttons and

debian/control

@@ -29,13 +29,27 @@ LEDBarGraph
     :inherited-members:
     :members:
 
+ButtonBoard
+===========
+
+.. autoclass:: ButtonBoard(\*pins, pull_up=True, bounce_time=None, hold_time=1, hold_repeat=False, \*\*named_pins)
+    :inherited-members:
+    :members:
+
 TrafficLights
 =============
 
 .. autoclass:: TrafficLights
     :inherited-members:
     :members:
 
+LedBorg
+=======
+
+.. autoclass:: LedBorg
+    :inherited-members:
+    :members:
+
 PiLITEr
 =======
 
@@ -106,6 +120,13 @@ Energenie
     :inherited-members:
     :members:
 
+SnowPi
+======
+
+.. autoclass:: SnowPi
+    :inherited-members:
+    :members:
+
 Base Classes
 ============
 

docs/api_boards.rst

@@ -17,7 +17,7 @@ Button
 ======
 
 .. autoclass:: Button(pin, pull_up=True, bounce_time=None)
-    :members: wait_for_press, wait_for_release, pin, is_pressed, pull_up, when_pressed, when_released
+    :members: wait_for_press, wait_for_release, pin, is_pressed, is_held, hold_time, held_time, hold_repeat, pull_up, when_pressed, when_released, when_held
 
 
 Line Sensor (TRCT5000)

docs/api_input.rst

@@ -25,6 +25,11 @@ PingServer
 
 .. autoclass:: PingServer
 
+CPUTemperature
+==============
+
+.. autoclass:: CPUTemperature
+
 Base Classes
 ============
 

docs/api_other.rst

@@ -23,13 +23,13 @@ PWMLED
 ======
 
 .. autoclass:: PWMLED(pin, active_high=True, initial_value=0, frequency=100)
-    :members: on, off, toggle, blink, pin, is_lit, value
+    :members: on, off, toggle, blink, pulse, pin, is_lit, value
 
 RGBLED
 ======
 
-.. autoclass:: RGBLED(red, green, blue, active_high=True, initial_value=(0, 0, 0))
-    :members: on, off, toggle, blink, red, green, blue, is_lit, color
+.. autoclass:: RGBLED(red, green, blue, active_high=True, initial_value=(0, 0, 0), pwm=True)
+    :members: on, off, toggle, blink, pulse, red, green, blue, is_lit, color
 
 Buzzer
 ======
@@ -40,9 +40,23 @@ Buzzer
 Motor
 =====
 
-.. autoclass:: Motor(forward, backward)
+.. autoclass:: Motor(forward, backward, pwm=True)
     :members: forward, backward, stop
 
+Servo
+=====
+
+.. autoclass:: Servo(pin, initial_value=0, min_pulse_width=1/1000, max_pulse_width=2/1000, frame_width=20/1000)
+    :inherited-members:
+    :members:
+
+AngularServo
+============
+
+.. autoclass:: AngularServo(pin, initial_angle=0, min_angle=-90, max_angle=90, min_pulse_width=1/1000, max_pulse_width=2/1000, frame_width=20/1000)
+    :inherited-members:
+    :members:
+
 Base Classes
 ============
 

docs/api_output.rst

@@ -25,34 +25,38 @@ integer number instead, it uses one of the following classes to provide the
 4. :class:`gpiozero.pins.native.NativePin`
 
 You can change the default pin implementation by over-writing the
-``DefaultPin`` global in the ``devices`` module like so::
+``pin_factory`` global in the ``devices`` module like so::
 
     from gpiozero.pins.native import NativePin
     import gpiozero.devices
     # Force the default pin implementation to be NativePin
-    gpiozero.devices.DefaultPin = NativePin
+    gpiozero.devices.pin_factory = NativePin
 
     from gpiozero import LED
 
     # This will now use NativePin instead of RPiGPIOPin
     led = LED(16)
 
-Alternatively, instead of passing an integer to the device constructor, you
-can pass a :class:`Pin` object itself::
+``pin_factory`` is a concrete descendent of the abstract :class:`Pin` class.
+The descendent may take additional parameters in its constructor provided they
+are optional; GPIO Zero will expect to be able to construct instances with
+nothing more than an integer pin number.
 
-    from gpiozero.pins.native import NativePin
-    from gpiozero import LED
+However, the descendent may take default information from additional sources.
+For example, to default to creating pins with
+:class:`gpiozero.pins.pigpiod.PiGPIOPin` on a remote pi called ``remote-pi``
+you can set the :envvar:`PIGPIO_ADDR` environment variable when running your
+script::
 
-    led = LED(NativePin(16))
+    $ PIGPIO_ADDR=remote-pi python my_script.py
 
-This is particularly useful with implementations that can take extra parameters
-such as :class:`~gpiozero.pins.pigpiod.PiGPIOPin` which can address pins on
-remote machines::
+It is worth noting that instead of passing an integer to device constructors,
+you can pass an object derived from :class:`Pin` itself::
 
-    from gpiozero.pins.pigpiod import PiGPIOPin
+    from gpiozero.pins.native import NativePin
     from gpiozero import LED
 
-    led = LED(PiGPIOPin(16, host='my_other_pi'))
+    led = LED(NativePin(16))
 
 In future, this separation of pins and devices should also permit the library
 to utilize pins that are part of IO extender chips. For example::
@@ -110,6 +114,13 @@ Abstract Pin
     :members:
 
 
+Local Pin
+=========
+
+.. autoclass:: LocalPin
+    :members:
+
+
 Utilities
 =========