Merge branch 'drop-python-2'

gpiozero · Mar 18, 2021 · 2a6bd4c · 2a6bd4c
2 parents 598d837 + a266d2c
commit 2a6bd4c
Show file tree

Hide file tree

Showing 55 changed files with 743 additions and 1,816 deletions.
diff --git a/Makefile b/Makefile
@@ -73,7 +73,7 @@ develop:
 	$(PIP) install -e .[doc,test]
 
 test:
-	$(PYTEST) tests
+	$(PYTEST) tests -v
 
 clean:
 	rm -fr dist/ build/ .pytest_cache/ .mypy_cache/ $(NAME).egg-info/ tags .coverage

diff --git a/docs/api_boards.rst b/docs/api_boards.rst
@@ -38,28 +38,28 @@ named after. All classes in this section are concrete (not abstract).
 LEDBoard
 --------
 
-.. autoclass:: LEDBoard(*pins, pwm=False, active_high=True, initial_value=False, pin_factory=None, **named_pins)
+.. autoclass:: LEDBoard
     :members: on, off, blink, pulse, toggle
 
 
 LEDBarGraph
 -----------
 
-.. autoclass:: LEDBarGraph(*pins, pwm=False, active_high=True, initial_value=0, pin_factory=None)
+.. autoclass:: LEDBarGraph
     :members: value, source, values, lit_count
 
 
 LEDCharDisplay
 --------------
 
-.. autoclass:: LEDCharDisplay(*pins, dp=None, font=None, pwm=False, active_high=True, initial_value=' ', pin_factory=None)
+.. autoclass:: LEDCharDisplay
     :members: value, font
 
 
 LEDMultiCharDisplay
 -------------------
 
-.. autoclass:: LEDMultiCharDisplay(char, *pins, active_high=True, initial_value=None, pin_factory=None)
+.. autoclass:: LEDMultiCharDisplay
     :members: value, plex_delay
 
 
@@ -72,168 +72,168 @@ LEDCharFont
 ButtonBoard
 -----------
 
-.. autoclass:: ButtonBoard(*pins, pull_up=True, active_state=None, bounce_time=None, hold_time=1, hold_repeat=False, pin_factory=None, **named_pins)
+.. autoclass:: ButtonBoard
     :members: wait_for_press, wait_for_release, is_pressed, pressed_time, when_pressed, when_released, value
 
 
 TrafficLights
 -------------
 
-.. autoclass:: TrafficLights(red, amber, green, *, yellow=None, pwm=False, initial_value=False, pin_factory=None)
+.. autoclass:: TrafficLights
     :members:
 
 
 TrafficLightsBuzzer
 -------------------
 
-.. autoclass:: TrafficLightsBuzzer(lights, buzzer, button, *, pin_factory=None)
+.. autoclass:: TrafficLightsBuzzer
     :members:
 
 
 PiHutXmasTree
 -------------
 
-.. autoclass:: PiHutXmasTree(*, pwm=False, initial_value=False, pin_factory=None)
+.. autoclass:: PiHutXmasTree
     :members:
 
 
 LedBorg
 -------
 
-.. autoclass:: LedBorg(*, pwm=True, initial_value=(0, 0, 0), pin_factory=None)
+.. autoclass:: LedBorg
     :members:
 
 
 PiLiter
 -------
 
-.. autoclass:: PiLiter(*, pwm=False, initial_value=False, pin_factory=None)
+.. autoclass:: PiLiter
     :members:
 
 
 PiLiterBarGraph
 ---------------
 
-.. autoclass:: PiLiterBarGraph(*, pwm=False, initial_value=False, pin_factory=None)
+.. autoclass:: PiLiterBarGraph
     :members:
 
 
 PiTraffic
 ---------
 
-.. autoclass:: PiTraffic(*, pwm=False, initial_value=False, pin_factory=None)
+.. autoclass:: PiTraffic
     :members:
 
 
 PiStop
 ------
 
-.. autoclass:: PiStop(location, *, pwm=False, initial_value=False, pin_factory=None)
+.. autoclass:: PiStop
     :members:
 
 
 FishDish
 --------
 
-.. autoclass:: FishDish(*, pwm=False, pin_factory=None)
+.. autoclass:: FishDish
     :members:
 
 
 TrafficHat
 ----------
 
-.. autoclass:: TrafficHat(*, pwm=False, pin_factory=None)
+.. autoclass:: TrafficHat
     :members:
 
 
 TrafficpHat
 -----------
 
-.. autoclass:: TrafficpHat(*, pwm=False, pin_factory=None)
+.. autoclass:: TrafficpHat
     :members:
 
 
 JamHat
 ------
 
-.. autoclass:: JamHat(*, pwm=False, pin_factory=None)
+.. autoclass:: JamHat
     :members:
 
 
 Pibrella
 --------
 
-.. autoclass:: Pibrella(*, pwm=False, pin_factory=None)
+.. autoclass:: Pibrella
     :members:
 
 
 Robot
 -----
 
-.. autoclass:: Robot(left, right, *, pwm=True, pin_factory=None)
+.. autoclass:: Robot
     :members:
 
 
 PhaseEnableRobot
 ----------------
 
-.. autoclass:: PhaseEnableRobot(left, right, *, pwm=True, pin_factory=None)
+.. autoclass:: PhaseEnableRobot
     :members:
 
 
 RyanteckRobot
 -------------
 
-.. autoclass:: RyanteckRobot(*, pwm=True, pin_factory=None)
+.. autoclass:: RyanteckRobot
     :members:
 
 
 CamJamKitRobot
 --------------
 
-.. autoclass:: CamJamKitRobot(*, pwm=True, pin_factory=None)
+.. autoclass:: CamJamKitRobot
     :members:
 
 
 PololuDRV8835Robot
 ------------------
 
-.. autoclass:: PololuDRV8835Robot(*, pwm=True, pin_factory=None)
+.. autoclass:: PololuDRV8835Robot
     :members:
 
 
 Energenie
 ---------
 
-.. autoclass:: Energenie(socket, *, initial_value=False, pin_factory=None)
+.. autoclass:: Energenie
     :members: on, off, socket, value
 
 
 StatusZero
 ----------
 
-.. autoclass:: StatusZero(*labels, pwm=False, active_high=True, initial_value=False, pin_factory=None)
+.. autoclass:: StatusZero
     :members:
 
 
 StatusBoard
 -----------
 
-.. autoclass:: StatusBoard(*labels, pwm=False, active_high=True, initial_value=False, pin_factory=None)
+.. autoclass:: StatusBoard
     :members:
 
 
 SnowPi
 ------
 
-.. autoclass:: SnowPi(*, pwm=False, initial_value=False, pin_factory=None)
+.. autoclass:: SnowPi
     :members:
 
 
 PumpkinPi
 ---------
 
-.. autoclass:: PumpkinPi(*, pwm=False, initial_value=False, pin_factory=None)
+.. autoclass:: PumpkinPi
     :members:
 
 
@@ -258,19 +258,19 @@ to construct classes for their own devices.
 LEDCollection
 -------------
 
-.. autoclass:: LEDCollection(*pins, pwm=False, active_high=True, initial_value=False, pin_factory=None, **named_pins)
+.. autoclass:: LEDCollection
     :members:
 
 
 CompositeOutputDevice
 ---------------------
 
-.. autoclass:: CompositeOutputDevice(*args, _order=None, pin_factory=None, **kwargs)
+.. autoclass:: CompositeOutputDevice
     :members:
 
 
 CompositeDevice
 ---------------
 
-.. autoclass:: CompositeDevice(*args, _order=None, pin_factory=None, **kwargs)
+.. autoclass:: CompositeDevice
     :members:
diff --git a/docs/api_generic.rst b/docs/api_generic.rst
@@ -42,7 +42,7 @@ are represented in purple, while abstract classes are shaded lighter):
 Device
 ======
 
-.. autoclass:: Device(*, pin_factory=None)
+.. autoclass:: Device
     :members: close, closed, value, is_active, pin_factory
 
 

diff --git a/docs/api_input.rst b/docs/api_input.rst
@@ -31,42 +31,42 @@ represent. All classes in this section are concrete (not abstract).
 Button
 ------
 
-.. autoclass:: Button(pin, *, pull_up=True, active_state=None, bounce_time=None, hold_time=1, hold_repeat=False, pin_factory=None)
+.. autoclass:: Button
     :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, value
 
 
 LineSensor (TRCT5000)
 ---------------------
 
-.. autoclass:: LineSensor(pin, *, queue_len=5, sample_rate=100, threshold=0.5, partial=False, pin_factory=None)
+.. autoclass:: LineSensor
     :members: wait_for_line, wait_for_no_line, pin, line_detected, when_line, when_no_line, value
 
 
 MotionSensor (D-SUN PIR)
 ------------------------
 
-.. autoclass:: MotionSensor(pin, *, queue_len=1, sample_rate=10, threshold=0.5, partial=False, pin_factory=None)
+.. autoclass:: MotionSensor
     :members: wait_for_motion, wait_for_no_motion, pin, motion_detected, when_motion, when_no_motion, value
 
 
 LightSensor (LDR)
 -----------------
 
-.. autoclass:: LightSensor(pin, *, queue_len=5, charge_time_limit=0.01, threshold=0.1, partial=False, pin_factory=None)
+.. autoclass:: LightSensor
     :members: wait_for_light, wait_for_dark, pin, light_detected, when_light, when_dark, value
 
 
 DistanceSensor (HC-SR04)
 ------------------------
 
-.. autoclass:: DistanceSensor(echo, trigger, *, queue_len=30, max_distance=1, threshold_distance=0.3, partial=False, pin_factory=None)
+.. autoclass:: DistanceSensor
     :members: wait_for_in_range, wait_for_out_of_range, trigger, echo, when_in_range, when_out_of_range, max_distance, distance, threshold_distance, value
 
 
 RotaryEncoder
 -------------
 
-.. autoclass:: RotaryEncoder(a, b, *, bounce_time=None, max_steps=16, threshold_steps=(0, 0), wrap=False, pin_factory=None)
+.. autoclass:: RotaryEncoder
     :members: wait_for_rotate, wait_for_rotate_clockwise, wait_for_rotate_counter_clockwise, when_rotated, when_rotated_clockwise, when_rotated_counter_clockwise, steps, value, max_steps, threshold_steps, wrap
 
 
@@ -87,26 +87,26 @@ to construct classes for their own devices.
 DigitalInputDevice
 ------------------
 
-.. autoclass:: DigitalInputDevice(pin, *, pull_up=False, active_state=None, bounce_time=None, pin_factory=None)
+.. autoclass:: DigitalInputDevice
     :members: wait_for_active, wait_for_inactive, when_activated, when_deactivated, active_time, inactive_time, value
 
 
 SmoothedInputDevice
 -------------------
 
-.. autoclass:: SmoothedInputDevice(pin, *, pull_up=False, active_state=None, threshold=0.5, queue_len=5, sample_wait=0.0, partial=False, pin_factory=None)
+.. autoclass:: SmoothedInputDevice
     :members: is_active, value, threshold, partial, queue_len
 
 
 InputDevice
 -----------
 
-.. autoclass:: InputDevice(pin, *, pull_up=False, active_state=None, pin_factory=None)
+.. autoclass:: InputDevice
     :members: pull_up, is_active, value
 
 
 GPIODevice
 ----------
 
-.. autoclass:: GPIODevice(pin, pin_factory=None)
+.. autoclass:: GPIODevice
     :members: