Merge pull request #928 from gpiozero/rotary

Add RotaryEncoder support
gpiozero · Mar 3, 2021 · be7f898 · be7f898
2 parents 8beee82 + 29b4316
commit be7f898
Show file tree

Hide file tree

Showing 77 changed files with 6,230 additions and 790 deletions.
diff --git a/docs/Makefile b/docs/Makefile
@@ -195,7 +195,7 @@ images/composite_device_hierarchy.dot: $(PY_SOURCES)
 		-x Motor \
 		-x PhaseEnableMotor \
 		-x Servo \
-		-o SourceMixin -o HoldMixin > $@
+		-o SourceMixin > $@
 
 images/spi_device_hierarchy.dot: $(PY_SOURCES)
 	./images/class_graph -i SPIDevice > $@
@@ -224,7 +224,7 @@ images/input_device_hierarchy.dot: $(PY_SOURCES)
 	gnuplot -e "set term pngcairo size 640,480" $< > $@
 
 %.png: %.svg
-	inkscape -e $@ $<
+	inkscape --export-dpi 150 -e $@ $<
 
 %.pdf: %.svg
 	inkscape -A $@ $<

diff --git a/docs/api_input.rst b/docs/api_input.rst
@@ -86,6 +86,13 @@ DistanceSensor (HC-SR04)
     :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)
+    :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
+
+
 Base Classes
 ============
 

diff --git a/docs/examples/color_picker.py b/docs/examples/color_picker.py
@@ -0,0 +1,30 @@
+from threading import Event
+from colorzero import Color
+from gpiozero import RotaryEncoder, RGBLED, Button
+
+rotor = RotaryEncoder(16, 20, wrap=True, max_steps=180)
+rotor.steps = -180
+led = RGBLED(22, 23, 24, active_high=False)
+btn = Button(21, pull_up=False)
+led.color = Color('#f00')
+done = Event()
+
+def change_hue():
+    # Scale the rotor steps (-180..180) to 0..1
+    hue = (rotor.steps + 180) / 360
+    led.color = Color(h=hue, s=1, v=1)
+
+def show_color():
+    print('Hue {led.color.hue.deg:.1f}° = {led.color.html}'.format(led=led))
+
+def stop_script():
+    print('Exiting')
+    done.set()
+
+print('Select a color by turning the knob')
+rotor.when_rotated = change_hue
+print('Push the button to see the HTML code for the color')
+btn.when_released = show_color
+print('Hold the button to exit')
+btn.when_held = stop_script
+done.wait()
diff --git a/docs/images/button_bb.pdf b/docs/images/button_bb.pdf
diff --git a/docs/images/button_bb.png b/docs/images/button_bb.png
diff --git a/docs/images/button_robot_bb.pdf b/docs/images/button_robot_bb.pdf
diff --git a/docs/images/button_robot_bb.png b/docs/images/button_robot_bb.png
diff --git a/docs/images/color_picker.fzz b/docs/images/color_picker.fzz
diff --git a/docs/images/color_picker_bb.pdf b/docs/images/color_picker_bb.pdf
diff --git a/docs/images/color_picker_bb.png b/docs/images/color_picker_bb.png
diff --git a/docs/images/color_picker_bb.svg b/docs/images/color_picker_bb.svg
diff --git a/docs/images/composed_devices.dot b/docs/images/composed_devices.dot
@@ -34,4 +34,6 @@ digraph classes {
     PhaseEnableMotor->PWMOutputDevice;
 
     Servo->PWMOutputDevice;
+
+    RotaryEncoder->InputDevice;
 }
diff --git a/docs/images/composed_devices.pdf b/docs/images/composed_devices.pdf
diff --git a/docs/images/composed_devices.png b/docs/images/composed_devices.png
diff --git a/docs/images/composed_devices.svg b/docs/images/composed_devices.svg
diff --git a/docs/images/composite_device_hierarchy.dot b/docs/images/composite_device_hierarchy.dot
@@ -6,7 +6,8 @@ digraph classes {
     /* Mixin classes */
     node [color="#c69ee0", fontcolor="#000000"]
 
-
+    EventsMixin;
+    HoldMixin;
 
     /* Abstract classes */
     node [color="#9ec6e0", fontcolor="#000000"]
@@ -20,11 +21,13 @@ digraph classes {
     node [color="#2980b9", fontcolor="#ffffff"];
 
     ButtonBoard->CompositeDevice;
+    ButtonBoard->HoldMixin;
     CamJamKitRobot->Robot;
     CompositeDevice->Device;
     CompositeOutputDevice->CompositeDevice;
     Energenie->Device;
     FishDish->CompositeOutputDevice;
+    HoldMixin->EventsMixin;
     JamHat->CompositeOutputDevice;
     LEDBarGraph->LEDCollection;
     LEDBoard->LEDCollection;
@@ -39,6 +42,8 @@ digraph classes {
     PololuDRV8835Robot->PhaseEnableRobot;
     PumpkinPi->LEDBoard;
     Robot->CompositeDevice;
+    RotaryEncoder->CompositeDevice;
+    RotaryEncoder->EventsMixin;
     RyanteckRobot->Robot;
     SnowPi->LEDBoard;
     StatusBoard->CompositeOutputDevice;

diff --git a/docs/images/composite_device_hierarchy.pdf b/docs/images/composite_device_hierarchy.pdf
diff --git a/docs/images/composite_device_hierarchy.png b/docs/images/composite_device_hierarchy.png
diff --git a/docs/images/composite_device_hierarchy.svg b/docs/images/composite_device_hierarchy.svg
diff --git a/docs/images/device_hierarchy.dot b/docs/images/device_hierarchy.dot
@@ -110,6 +110,8 @@ digraph classes {
     RGBLED->SourceMixin;
     Robot->CompositeDevice;
     Robot->SourceMixin;
+    RotaryEncoder->CompositeDevice;
+    RotaryEncoder->EventsMixin;
     RyanteckRobot->Robot;
     SPIDevice->Device;
     Servo->CompositeDevice;

diff --git a/docs/images/device_hierarchy.pdf b/docs/images/device_hierarchy.pdf
diff --git a/docs/images/device_hierarchy.png b/docs/images/device_hierarchy.png
diff --git a/docs/images/device_hierarchy.svg b/docs/images/device_hierarchy.svg
diff --git a/docs/images/device_pin_flowchart.pdf b/docs/images/device_pin_flowchart.pdf
diff --git a/docs/images/device_pin_flowchart.png b/docs/images/device_pin_flowchart.png
diff --git a/docs/images/distance_sensor_bb.pdf b/docs/images/distance_sensor_bb.pdf
diff --git a/docs/images/distance_sensor_bb.png b/docs/images/distance_sensor_bb.png
diff --git a/docs/images/input_device_hierarchy.pdf b/docs/images/input_device_hierarchy.pdf
diff --git a/docs/images/input_device_hierarchy.png b/docs/images/input_device_hierarchy.png
diff --git a/docs/images/input_device_hierarchy.svg b/docs/images/input_device_hierarchy.svg
diff --git a/docs/images/internal_device_hierarchy.pdf b/docs/images/internal_device_hierarchy.pdf
diff --git a/docs/images/internal_device_hierarchy.png b/docs/images/internal_device_hierarchy.png
diff --git a/docs/images/led_bb.pdf b/docs/images/led_bb.pdf
diff --git a/docs/images/led_bb.png b/docs/images/led_bb.png
diff --git a/docs/images/led_button_bb.pdf b/docs/images/led_button_bb.pdf
diff --git a/docs/images/led_button_bb.png b/docs/images/led_button_bb.png
diff --git a/docs/images/ledbargraph_bb.pdf b/docs/images/ledbargraph_bb.pdf
diff --git a/docs/images/ledbargraph_bb.png b/docs/images/ledbargraph_bb.png
diff --git a/docs/images/ledboard_bb.pdf b/docs/images/ledboard_bb.pdf
diff --git a/docs/images/ledboard_bb.png b/docs/images/ledboard_bb.png
diff --git a/docs/images/light_sensor_bb.pdf b/docs/images/light_sensor_bb.pdf
diff --git a/docs/images/light_sensor_bb.png b/docs/images/light_sensor_bb.png
diff --git a/docs/images/motion_robot_bb.pdf b/docs/images/motion_robot_bb.pdf
diff --git a/docs/images/motion_robot_bb.png b/docs/images/motion_robot_bb.png
diff --git a/docs/images/motion_sensor_bb.pdf b/docs/images/motion_sensor_bb.pdf
diff --git a/docs/images/motion_sensor_bb.png b/docs/images/motion_sensor_bb.png
diff --git a/docs/images/motor_bb.pdf b/docs/images/motor_bb.pdf
diff --git a/docs/images/motor_bb.png b/docs/images/motor_bb.png
diff --git a/docs/images/music_box_bb.pdf b/docs/images/music_box_bb.pdf
diff --git a/docs/images/music_box_bb.png b/docs/images/music_box_bb.png
diff --git a/docs/images/output_device_hierarchy.pdf b/docs/images/output_device_hierarchy.pdf
diff --git a/docs/images/output_device_hierarchy.png b/docs/images/output_device_hierarchy.png