Merge pull request #12 from trevorwslee/develop

Develop

Author: trevorwslee

.gitignore

@@ -10,8 +10,9 @@
 /experiments/pyclock
 
 
-#/_test.py
-#/_test.ipynb
+#/_dev_test.py
+#/_dev_test.ipynb
 /.micropico
 /_my_secret.py
 
+uDumbDisplay.code-workspace

MicroPythonDumbDisplay.code-workspace

@@ -6,19 +6,23 @@ 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 work in progress, nevertheless, a large portion of DumbDisplay functionalities have been ported.
+Although the porting is work in progress, nevertheless, most of the core 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 Micro-Python, 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.
+Consequently, it might be an alternative way to prototype simple Android app driven remotely with Python 3 from desktop / laptop, say for displaying experiment result data and getting simple interaction with the user.
 
 
 Enjoy
 
 - [DumbDisplay MicroPython Library (v0.5.0)](#dumbdisplay-micropython-library-v050)
 - [Installation](#installation)
 - [Getting Started](#getting-started)
+- [Examples](#examples)
+  - [DumbDisplay `io` Object](#dumbdisplay-io-object)
+  - [Layer Feedback](#layer-feedback)
+  - [Auto-pin Layers](#auto-pin-layers)
 - [Selected Demos](#selected-demos)
 - [Thank You!](#thank-you)
 - [License](#license)
@@ -77,6 +81,10 @@ The basic Python script setup is:
      dd = DumbDisplay()
      l = LayerLedGrid(dd)
      ```
+     |[`demo_LayerLedGrid()` in `dd_demo.py`](dd_demo.py)|
+     |:--:|
+     |<img style="width: 300px; height: 300px;" src="screenshots/layer_ledgrid_2x2.png"></img>|
+
    - `LayerLcd` -- a TEXT based LCD with configurable number of lines of configurable number of characters
      <br>e.g.
      ```
@@ -85,6 +93,10 @@ The basic Python script setup is:
      dd = DumbDisplay()
      l = LayerLcd(dd)
      ```
+     |[`demo_LayerLcd()` in `dd_demo.py`](dd_demo.py)|
+     |:--:|
+     |<img style="width: 300px; height: 300px;" src="screenshots/layer_lcd.png"></img>|
+
    - `LayerGraphical` -- a graphical LCD that you can draw to, with common drawing operations
      <br>e.g.
      ```
@@ -93,6 +105,10 @@ The basic Python script setup is:
      dd = DumbDisplay()
      l = LayerGraphical(dd)
      ```
+     |[`demo_LayerGraphical()` in `dd_demo.py`](dd_demo.py)|
+     |:--:|
+     |<img style="width: 300px; height: 300px;" src="screenshots/layer_graphical.png"></img>|
+
    - `LayerSelection` -- a group / grid of TEXT based LCD mostly for showing selection choices
      <br>e.g.
      ```
@@ -101,6 +117,10 @@ The basic Python script setup is:
      dd = DumbDisplay()
      l = LayerSelection(dd)
      ```
+     |[`demo_LayerSelection()` in `dd_demo.py`](dd_demo.py)|
+     |:--:|
+     |<img style="width: 300px; height: 300px;" src="screenshots/layer_selection_1x3.png"></img>|
+
    - `Layer7SegmentRow` -- a single 7-segment digit, or a row of **n** 7-segments digits
      <br>e.g.
      ```
@@ -109,6 +129,10 @@ The basic Python script setup is:
      dd = DumbDisplay()
      l = Layer7SegmentRow(dd)
      ```
+     |[`demo_Layer7SegmentRow()` in `dd_demo.py`](dd_demo.py)|
+     |:--:|
+     |<img style="width: 300px; height: 300px;" src="screenshots/layer_7segment_3d.png"></img>|
+
    - `LayerPlotter` -- a "plotter"
      <br>e.g.
      ```
@@ -117,8 +141,25 @@ The basic Python script setup is:
      dd = DumbDisplay()
      l = LayerPlotter(dd)
      ```
+     |[`demo_LayerPlotter()` in `dd_demo.py`](dd_demo.py)|
+     |:--:|
+     |<img style="width: 300px; height: 300px;" src="screenshots/layer_plotter.png"></img>|
+
+4. if you have multiple layers, you can "auto pin" them together; otherwise, multiple layers will be stacked on top of each other
+     <br>e.g.
+     ```
+     AutoPin('V', AutoPin('H', l_ledgrid, l_lcd), AutoPin('H', l_selection, l_7segmentrow), l_graphical).pin(dd)
+     ```
+     |[`demo_AutoPin()` in `dd_demo.py`](dd_demo.py)|
+     |:--:|
+     |<img style="width: 400px; height: 400px;" src="screenshots/autopin_layers.png"></img>|
+     
+
+# Examples
 
 
+## DumbDisplay `io` Object
+
 For example (using Python networking support with `io4Inet` as `io` for the DumbDisplay object)
 ```
 from dumbdisplay.core import *
@@ -148,7 +189,10 @@ dd.writeComment("DONE")
 ```
 
 
-A simple sample that polls for feedbacks, can be like
+## Layer Feedback
+
+
+A simple sample that polls for feedback (say user pressing the layer) from a layer, can be like
 ```
 from dumbdisplay.core import *
 from dumbdisplay.io_inet import *
@@ -164,6 +208,10 @@ while True:
         l.toggle(feedback.x, feedback.y)
 ```
 
+
+## Auto-pin Layers
+
+
 A more complete simple sample that also shows "auto pin" as well, can be like
 ```
 from dumbdisplay.core import *

README.md

@@ -3,15 +3,18 @@
 import math
 
 
-from dumbdisplay.core import *
 from dumbdisplay_examples.utils import create_example_wifi_dd
 
 
+
 def run_debug():
-    #import projects.testing.main as test
     import experiments.testing.main as test
     test.runDebug()
 
+def run_debugBlepriority(ble_name: str):
+    import experiments.testing.main as test
+    test.runDebugBlePriority(ble_name)
+
 def run_doodle():
     import samples.doodle.main
 
@@ -22,34 +25,9 @@ def run_melody():
     import samples.melody.main
 
 
-def test_very_simple():
-    #import time
-    from dumbdisplay.layer_ledgrid import LayerLedGrid
-    dd = DumbDisplay()  # default io is io4Inet()
-    l = LayerLedGrid(dd, 2, 1)
-    l.offColor("green")
-    l.turnOn()
-    for _ in range(1000):
-        time.sleep(1)
-        l.toggle(0, 0)
-        l.toggle(1, 0)
-    dd.writeComment("DONE")    
-
-
-def test_plotter():
-    from dumbdisplay.layer_plotter import LayerPlotter
-    dd = DumbDisplay()  # default io is io4Inet()
-    l = LayerPlotter(dd, 300, 100)
-    l.label("X", sin="Sin")
-    for x in range(1000):
-        sin = math.sin(x)
-        l.set(x, sin=sin)
-        time.sleep(0.5)
-
-
 def test_margin():
     from dumbdisplay.layer_ledgrid import LayerLedGrid
-    dd = DumbDisplay()  # default io is io4Inet()
+    dd = create_example_wifi_dd()
     l = LayerLedGrid(dd)
     dd.backgroundColor("yellow")
     l.backgroundColor("pink")
@@ -59,7 +37,7 @@ def test_margin():
     l.margin(0.4, 0.3, 0.2, 0.1)
     while True:
         print("... ", end="")
-        dd.timeslice()
+        dd.sleep(1)
         print("...")
         if dd.isReconnecting():
             break # since haven't setup for reconnection (like with recordLayerSetupCommands) ... may as well break out of the loop
@@ -103,18 +81,27 @@ def test_find_packages():
 
 
 if __name__ == "__main__":
+    #test_LayerLedGrid(2, 2)
+    #test_LayerLcd()
+    #test_LayerGraphical()
+    #test_Layer7SegmentRow()
+    #test_LayerSelection()
+    #test_LayerPlotter()
+
+    test_AutoPin()
+
     #run_passive_blink_app()
     #run_sliding_puzzle_app()
-    run_mnist_app()
+    #run_mnist_app()
 
     #run_debug()
     #run_doodle()
     #run_graphical()
     #run_melody()
 
     #test_margin()
-    #test_very_simple()
-    #test_plotter()
+
+    #run_debugBlepriority("MyBLEDevice")
 
     #test_read_readme()
     #test_find_packages()