Removed "application-specific" code

EAGrahamJr · Sep 24, 2023 · c59044d · c59044d
1 parent 8834482
commit c59044d
Show file tree

Hide file tree

Showing 96 changed files with 3,093 additions and 8,058 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,9 @@
 # Changelog
 
+## v 0.2.0 - 9/24/2023
+
+- Removed "application-specific" code: this makes this library _all_ about devices and interacting with them.
+
 ## v 0.1.5 - 9/23/2023
 
 - Mostly working around the MQTT client to add resiliency
@@ -87,9 +91,9 @@ These changes include those made on the robotics project prior to splitting.
 - Code re-use.
 - Re-set read delay.
 - Combining a servo, the range-finder, and OLED display.
-- Alternate contructor just from an image.
+- Alternate contsructor just from an image.
 - Fix formatting/tests, etc.
-- Allow direct useage of drive ports (e.g. solenoids)
+- Allow direct usage of drive ports (e.g. solenoids)
 - Tweak bus, run gauge stuff faster
 - Steppers added via `diozero` branch.
 - Add another operator for PixelBuf
@@ -98,7 +102,7 @@ These changes include those made on the robotics project prior to splitting.
 - Duplicate code.
 - Close some things when closed.
 - Not implemented on Pi Hat?
-- Collapse the Hat and SeeSaw codes (since the Hat is just pinouts)
+- Collapse the Hat and SeeSaw codes (since the Hat is just pin-outs)
 - Added blocking I/O for the CRICKIT.
 - Might help if it compiled...
 - Fix **ALL** the formatting, language, and other garbage.
@@ -120,7 +124,7 @@ These changes include those made on the robotics project prior to splitting.
 - SSD working!!!!!
 - Merge branch 'main' into oled
 - Fix threading issues and throw around some coroutine stuff
-- Remove uplidate test and ensure property is set
+- Remove update test and ensure property is set
 - Finish moving to full factory stuff.
 - Helpers to get "real" devices.
 - Split out "device factory" and add tests
@@ -136,7 +140,7 @@ These changes include those made on the robotics project prior to splitting.
 - Test maybe?
 - May or may not be working due to possibly non-functional display.
 - Lint gathering, etc.
-- Finish off the prox/light sensor
+- Finish off the proximity/light sensor
 - Almost done with sensor
 - First Qwiic device - light and proximity sensor
 - Initial stepper work is actually stepping
@@ -148,7 +152,7 @@ These changes include those made on the robotics project prior to splitting.
 - Clean up after LCD issues fixed.
 - Back to having fun: Kotlin LCD and a progress bar
 - LCD stuff
-- A kind of port for a specific 2x16 LCD display.
+- A kind of port for a specific 2x16 LCD.
 - Adding basic action and tweaking convenience.
 - Shift-register using 4-digit 8-segment
 - Shift register and 8-segment display
@@ -159,7 +163,7 @@ These changes include those made on the robotics project prior to splitting.
 - Tweaks to ADS7830, motor lesson.
 - Lessons on ADC and some clean up.
 - Turning this into something resembling a real project.
-- RGB LED and a different pinout picture.
-- A debounced button with Java construtor checks
+- RGB LED and a different pin-out picture.
+- A debounced button with Java constructor checks
 - Notes and first extensions.
 - Set up project
diff --git a/build.gradle.kts b/build.gradle.kts
@@ -19,15 +19,12 @@ repositories {
 
 val DIOZERO_VER = "1.4.0"
 group = "crackers.kobots"
-version = "0.1.5"
+version = "0.2.0"
 
 dependencies {
     api("org.slf4j:slf4j-api:2.0.5")
     api("com.diozero:diozero-core:$DIOZERO_VER")
 
-    // for remote control
-    compileOnly("org.eclipse.paho:org.eclipse.paho.mqttv5.client:1.2.5")
-
     // for adhoc testing
     testImplementation("com.diozero:diozero-provider-remote:$DIOZERO_VER")
     testImplementation("com.diozero:diozero-provider-mock:$DIOZERO_VER")

diff --git a/docs/allclasses.html b/docs/allclasses.html
@@ -65,17 +65,7 @@ <h1 class="bar">All Classes</h1>
 
             <li><a href=crackers/kobots/devices/sensors/VL6180X.html>VL6180X</a></li>
 
-            <li><a href=crackers/kobots/mqtt/KobotsMQTT.html>KobotsMQTT</a></li>
-
-            <li><a href=crackers/kobots/utilities/SimpleAverageMeasurement.html>SimpleAverageMeasurement</a></li>
-
-            <li><a href=crackers/kobots/utilities/KobotSleep.html>KobotSleep</a></li>
-
-            <li><a href=crackers/kobots/utilities/PointerGauge.html>PointerGauge</a></li>
-
             <li><a href=crackers/kobots/utilities/BitsAndBytesKt.html>BitsAndBytesKt</a></li>
-
-            <li><a href=crackers/kobots/utilities/CommonKt.html>CommonKt</a></li>
         </ul>
 </main>
 </body>

diff --git a/docs/crackers/kobots/devices/AnodeRgbPwmLed.html b/docs/crackers/kobots/devices/AnodeRgbPwmLed.html
@@ -1,7 +1,7 @@
 <!DOCTYPE HTML>
 <!-- NewPage -->
 <html lang="en"><head>
-    <title>AnodeRgbPwmLed 0.1.5 API </title>
+    <title>AnodeRgbPwmLed 0.2.0 API </title>
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
     <meta name="dc.created" content="2020-03-25">
     <link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">

diff --git a/docs/crackers/kobots/devices/DSLKt.html b/docs/crackers/kobots/devices/DSLKt.html
@@ -1,7 +1,7 @@
 <!DOCTYPE HTML>
 <!-- NewPage -->
 <html lang="en"><head>
-    <title>DSLKt 0.1.5 API </title>
+    <title>DSLKt 0.2.0 API </title>
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
     <meta name="dc.created" content="2020-03-25">
     <link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">

diff --git a/docs/crackers/kobots/devices/DebouncedButton.html b/docs/crackers/kobots/devices/DebouncedButton.html
@@ -1,7 +1,7 @@
 <!DOCTYPE HTML>
 <!-- NewPage -->
 <html lang="en"><head>
-    <title>DebouncedButton 0.1.5 API </title>
+    <title>DebouncedButton 0.2.0 API </title>
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
     <meta name="dc.created" content="2020-03-25">
     <link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">

diff --git a/docs/crackers/kobots/devices/DeviceUtilsKt.html b/docs/crackers/kobots/devices/DeviceUtilsKt.html
@@ -1,7 +1,7 @@
 <!DOCTYPE HTML>
 <!-- NewPage -->
 <html lang="en"><head>
-    <title>DeviceUtilsKt 0.1.5 API </title>
+    <title>DeviceUtilsKt 0.2.0 API </title>
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
     <meta name="dc.created" content="2020-03-25">
     <link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">

diff --git a/docs/crackers/kobots/devices/I2CSubRegister.html b/docs/crackers/kobots/devices/I2CSubRegister.html
@@ -1,7 +1,7 @@
 <!DOCTYPE HTML>
 <!-- NewPage -->
 <html lang="en"><head>
-    <title>I2CSubRegister 0.1.5 API </title>
+    <title>I2CSubRegister 0.2.0 API </title>
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
     <meta name="dc.created" content="2020-03-25">
     <link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">

diff --git a/docs/crackers/kobots/devices/I2CUtilsKt.html b/docs/crackers/kobots/devices/I2CUtilsKt.html
@@ -1,7 +1,7 @@
 <!DOCTYPE HTML>
 <!-- NewPage -->
 <html lang="en"><head>
-    <title>I2CUtilsKt 0.1.5 API </title>
+    <title>I2CUtilsKt 0.2.0 API </title>
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
     <meta name="dc.created" content="2020-03-25">
     <link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">

diff --git a/docs/crackers/kobots/devices/Quadruple.html b/docs/crackers/kobots/devices/Quadruple.html
@@ -1,7 +1,7 @@
 <!DOCTYPE HTML>
 <!-- NewPage -->
 <html lang="en"><head>
-    <title>Quadruple 0.1.5 API </title>
+    <title>Quadruple 0.2.0 API </title>
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
     <meta name="dc.created" content="2020-03-25">
     <link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">

diff --git a/docs/crackers/kobots/devices/display/GrayOled.DisplayType.html b/docs/crackers/kobots/devices/display/GrayOled.DisplayType.html
@@ -1,7 +1,7 @@
 <!DOCTYPE HTML>
 <!-- NewPage -->
 <html lang="en"><head>
-    <title>DisplayType 0.1.5 API </title>
+    <title>DisplayType 0.2.0 API </title>
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
     <meta name="dc.created" content="2020-03-25">
     <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
@@ -180,13 +180,13 @@ <h3>Field Summary</h3>
 
                                         <tr class="rowColor">
                                             <td class="colFirst"><code>private final <a href=https://docs.oracle.com/javase/8/docs/api/java/lang/String.html>String</a></code></td>
-                                            <th class="colSecond" scope="row"><code><a href=../../utilities/PointerGauge.Shape.html#name>name</a></code></th>
+                                            <th class="colSecond" scope="row"><code><a href=../sensors/VL6180X.Companion.Errors.html#name>name</a></code></th>
                                             <td class="colLast"></td>
                                         </tr>
 
                                         <tr class="altColor">
                                             <td class="colFirst"><code>private final <a href=https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html>Integer</a></code></td>
-                                            <th class="colSecond" scope="row"><code><a href=../../utilities/PointerGauge.Shape.html#ordinal>ordinal</a></code></th>
+                                            <th class="colSecond" scope="row"><code><a href=../sensors/VL6180X.Companion.Errors.html#ordinal>ordinal</a></code></th>
                                             <td class="colLast"></td>
                                         </tr>
 

diff --git a/docs/crackers/kobots/devices/display/GrayOled.html b/docs/crackers/kobots/devices/display/GrayOled.html
@@ -1,7 +1,7 @@
 <!DOCTYPE HTML>
 <!-- NewPage -->
 <html lang="en"><head>
-    <title>GrayOled 0.1.5 API </title>
+    <title>GrayOled 0.2.0 API </title>
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
     <meta name="dc.created" content="2020-03-25">
     <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">

diff --git a/docs/crackers/kobots/devices/display/LcdProgressBar.html b/docs/crackers/kobots/devices/display/LcdProgressBar.html
@@ -1,7 +1,7 @@
 <!DOCTYPE HTML>
 <!-- NewPage -->
 <html lang="en"><head>
-    <title>LcdProgressBar 0.1.5 API </title>
+    <title>LcdProgressBar 0.2.0 API </title>
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
     <meta name="dc.created" content="2020-03-25">
     <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">

diff --git a/docs/crackers/kobots/devices/display/SSD1327.Companion.html b/docs/crackers/kobots/devices/display/SSD1327.Companion.html
@@ -1,7 +1,7 @@
 <!DOCTYPE HTML>
 <!-- NewPage -->
 <html lang="en"><head>
-    <title>Companion 0.1.5 API </title>
+    <title>Companion 0.2.0 API </title>
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
     <meta name="dc.created" content="2020-03-25">
     <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">

diff --git a/docs/crackers/kobots/devices/display/SSD1327.html b/docs/crackers/kobots/devices/display/SSD1327.html
@@ -1,7 +1,7 @@
 <!DOCTYPE HTML>
 <!-- NewPage -->
 <html lang="en"><head>
-    <title>SSD1327 0.1.5 API </title>
+    <title>SSD1327 0.2.0 API </title>
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
     <meta name="dc.created" content="2020-03-25">
     <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">

diff --git a/docs/crackers/kobots/devices/expander/ADS7830.html b/docs/crackers/kobots/devices/expander/ADS7830.html
@@ -1,7 +1,7 @@
 <!DOCTYPE HTML>
 <!-- NewPage -->
 <html lang="en"><head>
-    <title>ADS7830 0.1.5 API </title>
+    <title>ADS7830 0.2.0 API </title>
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
     <meta name="dc.created" content="2020-03-25">
     <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">

diff --git a/docs/crackers/kobots/devices/expander/CRICKITHat.html b/docs/crackers/kobots/devices/expander/CRICKITHat.html
@@ -1,7 +1,7 @@
 <!DOCTYPE HTML>
 <!-- NewPage -->
 <html lang="en"><head>
-    <title>CRICKITHat 0.1.5 API </title>
+    <title>CRICKITHat 0.2.0 API </title>
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
     <meta name="dc.created" content="2020-03-25">
     <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">

diff --git a/docs/crackers/kobots/devices/io/GamepadQT.GamepadButtons.html b/docs/crackers/kobots/devices/io/GamepadQT.GamepadButtons.html
@@ -1,7 +1,7 @@
 <!DOCTYPE HTML>
 <!-- NewPage -->
 <html lang="en"><head>
-    <title>GamepadButtons 0.1.5 API </title>
+    <title>GamepadButtons 0.2.0 API </title>
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
     <meta name="dc.created" content="2020-03-25">
     <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">

diff --git a/docs/crackers/kobots/devices/io/GamepadQT.html b/docs/crackers/kobots/devices/io/GamepadQT.html
@@ -1,7 +1,7 @@
 <!DOCTYPE HTML>
 <!-- NewPage -->
 <html lang="en"><head>
-    <title>GamepadQT 0.1.5 API </title>
+    <title>GamepadQT 0.2.0 API </title>
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
     <meta name="dc.created" content="2020-03-25">
     <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">

diff --git a/docs/crackers/kobots/devices/io/NeoKey.Companion.html b/docs/crackers/kobots/devices/io/NeoKey.Companion.html
@@ -1,7 +1,7 @@
 <!DOCTYPE HTML>
 <!-- NewPage -->
 <html lang="en"><head>
-    <title>Companion 0.1.5 API </title>
+    <title>Companion 0.2.0 API </title>
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
     <meta name="dc.created" content="2020-03-25">
     <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">

diff --git a/docs/crackers/kobots/devices/io/NeoKey.html b/docs/crackers/kobots/devices/io/NeoKey.html
@@ -1,7 +1,7 @@
 <!DOCTYPE HTML>
 <!-- NewPage -->
 <html lang="en"><head>
-    <title>NeoKey 0.1.5 API </title>
+    <title>NeoKey 0.2.0 API </title>
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
     <meta name="dc.created" content="2020-03-25">
     <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">

diff --git a/docs/crackers/kobots/devices/lighting/IS31FL3731.html b/docs/crackers/kobots/devices/lighting/IS31FL3731.html
@@ -1,7 +1,7 @@
 <!DOCTYPE HTML>
 <!-- NewPage -->
 <html lang="en"><head>
-    <title>IS31FL3731 0.1.5 API </title>
+    <title>IS31FL3731 0.2.0 API </title>
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
     <meta name="dc.created" content="2020-03-25">
     <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">

diff --git a/docs/crackers/kobots/devices/lighting/NeoPixel.html b/docs/crackers/kobots/devices/lighting/NeoPixel.html
@@ -1,7 +1,7 @@
 <!DOCTYPE HTML>
 <!-- NewPage -->
 <html lang="en"><head>
-    <title>NeoPixel 0.1.5 API </title>
+    <title>NeoPixel 0.2.0 API </title>
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
     <meta name="dc.created" content="2020-03-25">
     <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">

diff --git a/docs/crackers/kobots/devices/lighting/PimoroniLEDShim.Companion.html b/docs/crackers/kobots/devices/lighting/PimoroniLEDShim.Companion.html
@@ -1,7 +1,7 @@
 <!DOCTYPE HTML>
 <!-- NewPage -->
 <html lang="en"><head>
-    <title>Companion 0.1.5 API </title>
+    <title>Companion 0.2.0 API </title>
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
     <meta name="dc.created" content="2020-03-25">
     <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">

diff --git a/docs/crackers/kobots/devices/lighting/PimoroniLEDShim.html b/docs/crackers/kobots/devices/lighting/PimoroniLEDShim.html
@@ -1,7 +1,7 @@
 <!DOCTYPE HTML>
 <!-- NewPage -->
 <html lang="en"><head>
-    <title>PimoroniLEDShim 0.1.5 API </title>
+    <title>PimoroniLEDShim 0.2.0 API </title>
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
     <meta name="dc.created" content="2020-03-25">
     <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">

diff --git a/docs/crackers/kobots/devices/lighting/PixelBuf.Companion.html b/docs/crackers/kobots/devices/lighting/PixelBuf.Companion.html
@@ -1,7 +1,7 @@
 <!DOCTYPE HTML>
 <!-- NewPage -->
 <html lang="en"><head>
-    <title>Companion 0.1.5 API </title>
+    <title>Companion 0.2.0 API </title>
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
     <meta name="dc.created" content="2020-03-25">
     <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">

diff --git a/docs/crackers/kobots/devices/lighting/PixelBuf.html b/docs/crackers/kobots/devices/lighting/PixelBuf.html
@@ -1,7 +1,7 @@
 <!DOCTYPE HTML>
 <!-- NewPage -->
 <html lang="en"><head>
-    <title>PixelBuf 0.1.5 API </title>
+    <title>PixelBuf 0.2.0 API </title>
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
     <meta name="dc.created" content="2020-03-25">
     <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">

diff --git a/docs/crackers/kobots/devices/lighting/WS2811.PixelColor.html b/docs/crackers/kobots/devices/lighting/WS2811.PixelColor.html
@@ -1,7 +1,7 @@
 <!DOCTYPE HTML>
 <!-- NewPage -->
 <html lang="en"><head>
-    <title>PixelColor 0.1.5 API </title>
+    <title>PixelColor 0.2.0 API </title>
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
     <meta name="dc.created" content="2020-03-25">
     <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">

diff --git a/docs/crackers/kobots/devices/lighting/WS2811.html b/docs/crackers/kobots/devices/lighting/WS2811.html
@@ -1,7 +1,7 @@
 <!DOCTYPE HTML>
 <!-- NewPage -->
 <html lang="en"><head>
-    <title>WS2811 0.1.5 API </title>
+    <title>WS2811 0.2.0 API </title>
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
     <meta name="dc.created" content="2020-03-25">
     <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">

diff --git a/docs/crackers/kobots/devices/microcontroller/AdafruitSeeSaw.Companion.DeviceType.html b/docs/crackers/kobots/devices/microcontroller/AdafruitSeeSaw.Companion.DeviceType.html
@@ -1,7 +1,7 @@
 <!DOCTYPE HTML>
 <!-- NewPage -->
 <html lang="en"><head>
-    <title>DeviceType 0.1.5 API </title>
+    <title>DeviceType 0.2.0 API </title>
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
     <meta name="dc.created" content="2020-03-25">
     <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
@@ -180,13 +180,13 @@ <h3>Field Summary</h3>
 
                                         <tr class="rowColor">
                                             <td class="colFirst"><code>private final <a href=https://docs.oracle.com/javase/8/docs/api/java/lang/String.html>String</a></code></td>
-                                            <th class="colSecond" scope="row"><code><a href=../../utilities/PointerGauge.Shape.html#name>name</a></code></th>
+                                            <th class="colSecond" scope="row"><code><a href=../sensors/VL6180X.Companion.Errors.html#name>name</a></code></th>
                                             <td class="colLast"></td>
                                         </tr>
 
                                         <tr class="altColor">
                                             <td class="colFirst"><code>private final <a href=https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html>Integer</a></code></td>
-                                            <th class="colSecond" scope="row"><code><a href=../../utilities/PointerGauge.Shape.html#ordinal>ordinal</a></code></th>
+                                            <th class="colSecond" scope="row"><code><a href=../sensors/VL6180X.Companion.Errors.html#ordinal>ordinal</a></code></th>
                                             <td class="colLast"></td>
                                         </tr>