updated

Author: trevorwslee

README.md

@@ -6,11 +6,12 @@ to Micro-Python / Python 3 for the [DumbDisplay Android app](https://play.google
 For a video introduction, please watch the YouTube video: [Introducing DumbDisplay MicroPython Library -- 
 with ESP32, Raspberry Pi Pico, and Raspberry Pi Zero](https://www.youtube.com/watch?v=KVU26FyXs5M)
 
-Although the porting is not complete, nevertheless, a large portion of DumbDisplay functionalities have been ported.
+Although the porting is work in progress, nevertheless, a large portion of DumbDisplay functionalities have been ported.
 Hopefully, this should already be helpful for friends that develop programs for microcontroller boards in Micro-Python.
 
-As hinted previously,  even it is originally targeted for MicroPython, it should be useful with regular Python 3, like in Raspberry Pi environment
+As hinted previously, even it is originally targeted for MicroPython, it should be useful with regular Python 3, like in Raspberry Pi environment
 or even with desktop / laptop.
+As a result, it can be an alternative way to prototype Android app driven remotely with Python 3 from desktop / laptop.
 
 
 Enjoy
@@ -27,9 +28,9 @@ Enjoy
 # Installation
 
 For Micro-Python, please refer to the [above-mentioned YouTube video](https://www.youtube.com/watch?v=KVU26FyXs5M)
-for examples of using DumbDisplay MicroPython Library for microcontroller boards programming.
+for examples of using DumbDisplay MicroPython Library for microcontroller programming.
 
-If your targeted is desktop / laptop, you can install the library by cloning the repository:
+If your targeted is desktop / laptop, you can install the package like:
 ```
 pip install git+https://github.com/trevorwslee/MicroPython-DumbDisplay
 ```
@@ -44,21 +45,23 @@ pip install --upgrade --force-reinstall git+https://github.com/trevorwslee/Micro
 
 The basic script setup is:
 1. import core, for creating `DumbDisplay` object
-2. import IO mechanism, for creating IO object
+2. import IO mechanism, for creating IO object, like
+  - `io4Inet`(the default) -- Python networking support (not available for Micro-Python)
+  - `io4Wifi` -- Micro-Python WiFi support (for Raspberry Pi Pico W, ESP32, etc.)
 3. import layers, for creating layer objects
 
-For example
+For example (using Python networking support with `io4Inet` as `io` )
 ```
 from dumbdisplay.core import *
 from dumbdisplay.io_inet import *
 from dumbdisplay.layer_ledgrid import *
-dd = DumbDisplay(io4Inet())
+dd = DumbDisplay()  # default io is io4Inet()
 l = LayerLedGrid(dd)
 l.turnOn()
 ```
 
 
-A "very simple" sample that makes use of WiFi can be like
+A simple sample that explicitly makes use of WiFi `io4Wifi` as `io`, can be like
 ```
 from dumbdisplay.core import *
 from dumbdisplay.io_wifi import *
@@ -81,7 +84,7 @@ A simple sample that polls for feedbacks, can be like
 from dumbdisplay.core import *
 from dumbdisplay.io_inet import *
 from dumbdisplay.layer_ledgrid import *
-dd = DumbDisplay(io4Inet())
+dd = DumbDisplay()  # default io is io4Inet()
 l = LayerLedGrid(dd, 20, 20)
 l.enableFeedback("fa")
 l.offColor(RGB_COLOR(0xcc, 0xcc, 0xcc))
@@ -118,7 +121,7 @@ def feedback_handler(layer, type, x, y):
         _last_x = -1   
 
 
-dd = DumbDisplay(io4Inet())
+dd = DumbDisplay()  # default io is io4Inet()
 l_r = LayerLcd(dd)
 l_g = LayerLcd(dd)
 l_b = LayerLcd(dd)
@@ -134,7 +137,7 @@ l_b.enableFeedback("f", feedback_handler=feedback_handler)
 l.enableFeedback("fs:rpt50", feedback_handler=feedback_handler)
 AutoPin('V', AutoPin('H', l_r, l_g, l_b), l).pin(dd)
 while True:
-    dd.sleep(1)
+    dd.timeslice()
 ```
 
 Notes:

_test.py

@@ -27,7 +27,7 @@ def run_melody():
 def test_very_simple():
     #import time
     from dumbdisplay.layer_ledgrid import LayerLedGrid
-    dd = DumbDisplay(io4Inet())
+    dd = DumbDisplay()  # default io is io4Inet()
     l = LayerLedGrid(dd, 2, 1)
     l.offColor("green")
     l.turnOn()
@@ -40,7 +40,7 @@ def test_very_simple():
 
 def test_plotter():
     from dumbdisplay.layer_plotter import LayerPlotter
-    dd = DumbDisplay(io4Inet())
+    dd = DumbDisplay()  # default io is io4Inet()
     l = LayerPlotter(dd, 300, 100)
     l.label("X", sin="Sin")
     for x in range(1000):
@@ -51,7 +51,7 @@ def test_plotter():
 
 def test_margin():
     from dumbdisplay.layer_ledgrid import LayerLedGrid
-    dd = DumbDisplay(io4Inet())
+    dd = DumbDisplay()  # default io is io4Inet()
     l = LayerLedGrid(dd)
     dd.backgroundColor("yellow")
     l.backgroundColor("pink")
@@ -61,7 +61,7 @@ def test_margin():
     l.margin(0.4, 0.3, 0.2, 0.1)
     while True:
         print("... ", end="")
-        dd.delay(1)
+        dd.timeslice()
         print("...")
         if dd.isReconnecting():
             break # since haven't setup for reconnection (like with recordLayerSetupCommands) ... may as well break out of the loop
@@ -106,9 +106,9 @@ def test_find_packages():
     #run_graphical()
     #run_melody()
 
-    #test_margin()
+    test_margin()
     #test_very_simple()
     #test_plotter()
 
-    test_read_readme()
+    #test_read_readme()
     #test_find_packages()

dumbdisplay/_ddimpl.py

@@ -162,11 +162,15 @@ def _Connect_Threaded(io: DDInputOutput):
 
 class DumbDisplayImpl:
   def __init__(self, io: DDInputOutput):
+    if io is None:
+      # if not specific, default to DDIOInet
+      from ._ddio_inet import DDIOInet
+      io = DDIOInet()
     self._io: DDInputOutput = io
     self._connected = False
     self._compatibility = 0
     self._connected_iop: IOProxy = None
-    self._layers: dict[DDLayer] = {}
+    self._layers: dict[str, DDLayer] = {}
     self._tunnels: dict = {}
     self.last_validate_ms = 0
 
@@ -175,7 +179,7 @@ def timeslice(self):
 
   def delay(self, seconds: float = 0):
     '''
-    use sleep() instead
+    deprecated; use sleep() instead
     '''
     self.sleep_ms(seconds * 1000)
 

dumbdisplay/_ddlayer.py

@@ -47,7 +47,7 @@ def __init__(self, type, x, y):
     self.y = y
 
 class DDLayer:
-  def __init__(self, dd, layer_id):
+  def __init__(self, dd, layer_id: str):
     self.dd = dd
     self.layer_id = layer_id
     self._feedback_handler = None

dumbdisplay/_dumbdisplay.py

@@ -58,7 +58,7 @@ class DumbDisplay(DumbDisplayImpl):
   @staticmethod
   def runningWithMicropython():
     return hasattr(sys, 'implementation') and sys.implementation.name == 'micropython'
-  def __init__(self, io: DDInputOutput, reset_machine_when_failed_to_send_command: bool = False, reset_machine_if_detected_disconnect_for_s: int = None):
+  def __init__(self, io: DDInputOutput = None, reset_machine_when_failed_to_send_command: bool = False, reset_machine_if_detected_disconnect_for_s: int = None):
     super().__init__(io)
     #self.debug_led = None
     self.reset_machine_when_failed_to_send_command = reset_machine_when_failed_to_send_command

dumbdisplay_examples/utils.py

@@ -3,7 +3,7 @@
 
 def create_example_wifi_dd():
     '''
-    create example DumbDisplay with WiFi connection
+    create example DumbDisplay ... if for Micro-Python WiFi connection, assumes _my_secret.py
     '''
     if DumbDisplay.runningWithMicropython():
         # connect using WIFI:

experiments/testing/_debug.py

@@ -79,6 +79,6 @@ def loop(io: DDInputOutput):
   while True:
     dd = start(io)
     once(dd, True)
-    dd.sleep(2)
+    dd.sleep(2)  # sleep for 2 seconds before restarting
     dd.release()
 

samples/doodle/main.py

@@ -71,7 +71,7 @@ def feedback_handler(layer, type, x, y):
 
 # the main loop does nothing, but uses DumbDisplay's delay, so that DumbDisplay has a chance to do it's work
 while True:
-    dd.delay(1)
+    dd.timeslice()