From d963802d5b7a9bf47be56bfd24ed7112a0d5301b Mon Sep 17 00:00:00 2001
From: ZodiusInfuser <christopher.parrott2@gmail.com>
Date: Wed, 8 Nov 2023 22:03:24 +0000
Subject: [PATCH] Restructured lib directory

---
 examples/modules/dual_motor/single_stepper.py |  2 +-
 firmware/PIMORONI_YUKON/uf2-manifest.txt      |  3 +--
 .../{extras/player.py => devices/audio.py}    |  0
 .../lx_servos.py => devices/lx_servo.py}      | 21 ++++++++++++-------
 .../{extras => devices}/stepper.py            |  0
 lib/pimoroni_yukon/modules/audio_amp.py       |  2 +-
 6 files changed, 17 insertions(+), 11 deletions(-)
 rename lib/pimoroni_yukon/{extras/player.py => devices/audio.py} (100%)
 rename lib/pimoroni_yukon/{protocols/lx_servos.py => devices/lx_servo.py} (99%)
 rename lib/pimoroni_yukon/{extras => devices}/stepper.py (100%)

diff --git a/examples/modules/dual_motor/single_stepper.py b/examples/modules/dual_motor/single_stepper.py
index d1e5e15..aa02331 100644
--- a/examples/modules/dual_motor/single_stepper.py
+++ b/examples/modules/dual_motor/single_stepper.py
@@ -1,7 +1,7 @@
 from pimoroni_yukon import Yukon
 from pimoroni_yukon import SLOT1 as SLOT
 from pimoroni_yukon.modules import DualMotorModule
-from pimoroni_yukon.extras.stepper import OkayStepper
+from pimoroni_yukon.devices.stepper import OkayStepper
 
 """
 Drive a stepper motor from a Dual Motor Module connected to Slot1.
diff --git a/firmware/PIMORONI_YUKON/uf2-manifest.txt b/firmware/PIMORONI_YUKON/uf2-manifest.txt
index 0091892..36ca348 100644
--- a/firmware/PIMORONI_YUKON/uf2-manifest.txt
+++ b/firmware/PIMORONI_YUKON/uf2-manifest.txt
@@ -1,6 +1,5 @@
 ../*.py
 ../lib/*.py
 ../lib/pimoroni_yukon/*.py
-../lib/pimoroni_yukon/extras/*.py
+../lib/pimoroni_yukon/devices/*.py
 ../lib/pimoroni_yukon/modules/*.py
-../lib/pimoroni_yukon/protocols/*.py
\ No newline at end of file
diff --git a/lib/pimoroni_yukon/extras/player.py b/lib/pimoroni_yukon/devices/audio.py
similarity index 100%
rename from lib/pimoroni_yukon/extras/player.py
rename to lib/pimoroni_yukon/devices/audio.py
diff --git a/lib/pimoroni_yukon/protocols/lx_servos.py b/lib/pimoroni_yukon/devices/lx_servo.py
similarity index 99%
rename from lib/pimoroni_yukon/protocols/lx_servos.py
rename to lib/pimoroni_yukon/devices/lx_servo.py
index 7cc3f63..ff2025c 100644
--- a/lib/pimoroni_yukon/protocols/lx_servos.py
+++ b/lib/pimoroni_yukon/devices/lx_servo.py
@@ -10,6 +10,13 @@
 import pimoroni_yukon.logging as logging
 from ucollections import namedtuple
 
+"""
+Classes and functions for controlling LewanSoul/HiWonder
+LX servos (tested on LX-16A and LX-224HV) via Yukon's
+Serial Bus Servo module.
+"""
+
+
 Command = namedtuple("Command", ("value", "length"))
 
 # LX Servo Protocol
@@ -69,7 +76,7 @@ def checksum(buffer):
 def send(id, uart, duplexer, command, fmt="", *data):
     # Create a buffer of the correct length
     buffer = bytearray(FRAME_HEADER_LENGTH + command.length)
-    
+
     # Populate the buffer with the required header values and command data
     struct.pack_into("<BBBBB" + fmt + "B", buffer, 0,  # fmt, buffer, offset
                      FRAME_HEADER,
@@ -119,7 +126,7 @@ def handle_receive(uart):
             # Only look for header bytes
             if rx_byte == FRAME_HEADER:
                 header_count += 1
-                
+
                 # Have to header bytes been received?
                 if header_count == 2:
                     header_count = 0
@@ -133,7 +140,7 @@ def handle_receive(uart):
         # Are we inside the frame?
         if frame_started:
             rx_buffer[data_count] = rx_byte  # Add the byte to the buffer
-            
+
             # Extract the frame length from the data, exiting if it contradicts
             if data_count == 3:
                 data_length = rx_buffer[data_count]
@@ -142,7 +149,7 @@ def handle_receive(uart):
                     frame_started = False
 
             data_count += 1
-            
+
             # Have we reached the expected end of the received data?
             if data_count == data_length + 3:
                 # Does the checksum we calculate match what was received?
@@ -167,7 +174,7 @@ def receive(id, uart, duplexer, timeout, fmt=""):
     # Wait for data to start coming in
     while uart.any() == 0:
         remaining_ms = ticks_diff(end_ms, ticks_ms())
-        
+
         # Has the timeout been reached?
         if remaining_ms <= 0:
             duplexer.send_on_data()     # Switch back to send mode before throwing the error
@@ -175,12 +182,12 @@ def receive(id, uart, duplexer, timeout, fmt=""):
 
     # Handle the received data
     data_buffer = handle_receive(uart)
-    
+
     # Was valid data received?
     data = None
     if data_buffer is not None:
         data = struct.unpack("<" + fmt, data_buffer)
-        
+
         # If there is only one piece of data expected, extract it
         if len(fmt) == 1:
             data = data[0]
diff --git a/lib/pimoroni_yukon/extras/stepper.py b/lib/pimoroni_yukon/devices/stepper.py
similarity index 100%
rename from lib/pimoroni_yukon/extras/stepper.py
rename to lib/pimoroni_yukon/devices/stepper.py
diff --git a/lib/pimoroni_yukon/modules/audio_amp.py b/lib/pimoroni_yukon/modules/audio_amp.py
index 556c33d..a87eabb 100644
--- a/lib/pimoroni_yukon/modules/audio_amp.py
+++ b/lib/pimoroni_yukon/modules/audio_amp.py
@@ -7,7 +7,7 @@
 from ucollections import OrderedDict
 from .common import YukonModule, ADC_FLOAT, IO_LOW, IO_HIGH
 from pimoroni_yukon.errors import OverTemperatureError
-from pimoroni_yukon.extras.player import WavPlayer
+from pimoroni_yukon.devices.audio import WavPlayer
 
 # PAGE 0 Regs
 PAGE = 0x00             # Device Page Section 8.9.5