UC2-REST 0.2.0.24__tar.gz → 0.2.0.26__tar.gz

uc2_rest-0.2.0.26/PKG-INFO

@@ -0,0 +1,151 @@
+Metadata-Version: 2.4
+Name: UC2-REST
+Version: 0.2.0.26
+Summary: This pacage will help you to drive the ESP32-driven microscopy control modules from UC2
+Home-page: https://github.com/openUC2/UC2-REST
+Author: Benedict Diederich
+Author-email: benedictdied@gmail.com
+License: GPL v3
+Keywords: UC2REST API to control ESP32-driven microscopy control boards
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3.7
+Requires-Python: >=3.7
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: numpy
+Requires-Dist: requests
+Requires-Dist: pyserial
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: keywords
+Dynamic: license
+Dynamic: license-file
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+<p align="center">
+  <img src="https://raw.githubusercontent.com/bionanoimaging/UC2-GIT/master/IMAGES/UC2_logo_text.png" width="320" alt="UC2 logo">
+</p>
+
+# UC2‑Python Client
+
+Python interface to the **UC2 REST** micro‑controller firmware — control motors, lasers, LED matrices, galvos and more over USB‑Serial or Wi‑Fi from any Python environment.
+
+## Highlights
+
+- **Plug‑and‑play connection** via USB (`/dev/ttyUSB*`, `COM*`) or TCP (`host`, `port`).
+- **Rich device model**: every hardware block is a Python object with high‑level helpers (e.g. `motor.move_x`, `led.setPattern`, `laser.set_laser`).
+- **Asynchronous & blocking modes** for precise timing or maximum throughput.
+- **Callback hooks** to react to hardware feedback in real time.
+- **Runs everywhere**: desktop Python, headless Raspberry Pi, or in‑browser with PyScript.
+- **LGPL‑3.0‑or‑later** license – use it in academic and commercial projects.
+
+## Installation
+
+```bash
+pip install uc2rest           # latest release
+# or for the bleeding‑edge version
+pip install git+https://github.com/openUC2/UC2-REST.git#subdirectory=PYTHON
+```
+
+Dependencies (`requests`, `numpy`, `pyserial`) are resolved automatically.
+
+## Quick start
+
+```python
+import uc2rest
+
+# USB example
+esp = uc2rest.UC2Client(serialport="/dev/ttyUSB0")         # Linux / Mac OS
+# esp = uc2rest.UC2Client(serialport="COM3")               # Windows
+# Wi‑Fi example
+# esp = uc2rest.UC2Client(host="192.168.4.1", port=31950)
+
+# LED matrix: switch all pixels on at half intensity
+esp.led.setAll(True, intensity=128)
+
+# Move X axis by 1 mm (1000 steps @ 1 kHz)
+esp.motor.move_x(steps=1000, speed=1000, is_blocking=True)
+
+# Turn green laser to full power
+esp.laser.set_laser(channel="G", value=255)
+```
+
+## Supported modules (automatically attached to `UC2Client`) citeturn1file12
+
+| Object          | Purpose                               | Example method(s)                    |
+|-----------------|---------------------------------------|--------------------------------------|
+| `motor`         | X/Y/Z/θ stages                        | `move_x / move_xy`, `setup_motor`    |
+| `led`           | 8×8 RGB LED matrix                    | `setPattern`, `send_LEDMatrix_rings` |
+| `laser`         | 3‑channel RGB or IR lasers            | `set_laser`, `set_servo`             |
+| `galvo`         | Analogue DAC & 2‑axis scanner         | `set_dac`, `set_scanner_pattern`     |
+| `gripper`       | Micro‑gripper (servo)                 | `open`, `close`                      |
+| `home`          | End‑stop homing routines              | `home_x`, `home_z`                   |
+| `rotator`       | Filter wheel or Dove prism            | `move`, `set_speed`                  |
+| `objective`     | Piezo objective positioner            | `move_z`, `calibrate`                |
+| `temperature`   | NTC digital temperature sensor        | `get_temperature`                    |
+| `analog`        | Arbitrary analogue outputs            | `set_voltage`                        |
+| `digitalout`    | GPIO (TTL) outputs                    | `set_pin`, `pulse`                   |
+| `wifi`          | ESP32 network helpers                 | `scan`, `connect`                    |
+| `message`       | Generic key‑value messaging/trigger   | `register_callback`, `trigger_message` |
+
+## Design philosophy
+
+UC2 REST splits interaction into three JSON endpoints per device:
+
+```
+/*_act   → perform an action   (e.g. move)
+/*_set   → configure a device  (e.g. speed)
+/*_get   → query state         (e.g. position)
+```
+
+The Python client wraps those endpoints so you rarely deal with raw JSON.
+
+
+## Running in a browser (PyScript)
+
+```html
+<py-config>
+  packages = ["uc2rest"]
+</py-config>
+<py-script>
+  from uc2rest import UC2Client
+  esp = UC2Client(SerialManager=pyserial_manager)  # see docs
+  esp.led.setAll(True)
+</py-script>
+```
+
+## Documentation & examples
+
+* Jupyter notebook tutorial: `PYTHON/UC2_REST_Tutorial_v0.ipynb`  
+* Example scripts: `examples/` directory (motor scan, laser modulation, timelapse)  
+* Firmware sources and hardware guides: <https://github.com/openUC2>
+
+## Troubleshooting
+
+| Symptom                      | Fix |
+|------------------------------|-----|
+| `serial.serialutil.SerialException` | Check port name and permissions (`sudo adduser $USER dialout`) |
+| No JSON response / timeout   | Increase `timeout` argument; verify baud rate matches firmware |
+
+## Contributing
+
+1. Fork the repo and create a feature branch.  
+2. Follow the `pre‑commit` checks (`black`, `isort`, `flake8`).  
+3. Create pull requests against `develop`.
+
+Please open issues for bugs or feature requests.
+
+## License
+
+MIT — see `LICENSE` for details.
+
+---
+
+Made with 💚 by the OpenUC2 community.

uc2_rest-0.2.0.26/README.md

@@ -0,0 +1,120 @@
+<p align="center">
+  <img src="https://raw.githubusercontent.com/bionanoimaging/UC2-GIT/master/IMAGES/UC2_logo_text.png" width="320" alt="UC2 logo">
+</p>
+
+# UC2‑Python Client
+
+Python interface to the **UC2 REST** micro‑controller firmware — control motors, lasers, LED matrices, galvos and more over USB‑Serial or Wi‑Fi from any Python environment.
+
+## Highlights
+
+- **Plug‑and‑play connection** via USB (`/dev/ttyUSB*`, `COM*`) or TCP (`host`, `port`).
+- **Rich device model**: every hardware block is a Python object with high‑level helpers (e.g. `motor.move_x`, `led.setPattern`, `laser.set_laser`).
+- **Asynchronous & blocking modes** for precise timing or maximum throughput.
+- **Callback hooks** to react to hardware feedback in real time.
+- **Runs everywhere**: desktop Python, headless Raspberry Pi, or in‑browser with PyScript.
+- **LGPL‑3.0‑or‑later** license – use it in academic and commercial projects.
+
+## Installation
+
+```bash
+pip install uc2rest           # latest release
+# or for the bleeding‑edge version
+pip install git+https://github.com/openUC2/UC2-REST.git#subdirectory=PYTHON
+```
+
+Dependencies (`requests`, `numpy`, `pyserial`) are resolved automatically.
+
+## Quick start
+
+```python
+import uc2rest
+
+# USB example
+esp = uc2rest.UC2Client(serialport="/dev/ttyUSB0")         # Linux / Mac OS
+# esp = uc2rest.UC2Client(serialport="COM3")               # Windows
+# Wi‑Fi example
+# esp = uc2rest.UC2Client(host="192.168.4.1", port=31950)
+
+# LED matrix: switch all pixels on at half intensity
+esp.led.setAll(True, intensity=128)
+
+# Move X axis by 1 mm (1000 steps @ 1 kHz)
+esp.motor.move_x(steps=1000, speed=1000, is_blocking=True)
+
+# Turn green laser to full power
+esp.laser.set_laser(channel="G", value=255)
+```
+
+## Supported modules (automatically attached to `UC2Client`) citeturn1file12
+
+| Object          | Purpose                               | Example method(s)                    |
+|-----------------|---------------------------------------|--------------------------------------|
+| `motor`         | X/Y/Z/θ stages                        | `move_x / move_xy`, `setup_motor`    |
+| `led`           | 8×8 RGB LED matrix                    | `setPattern`, `send_LEDMatrix_rings` |
+| `laser`         | 3‑channel RGB or IR lasers            | `set_laser`, `set_servo`             |
+| `galvo`         | Analogue DAC & 2‑axis scanner         | `set_dac`, `set_scanner_pattern`     |
+| `gripper`       | Micro‑gripper (servo)                 | `open`, `close`                      |
+| `home`          | End‑stop homing routines              | `home_x`, `home_z`                   |
+| `rotator`       | Filter wheel or Dove prism            | `move`, `set_speed`                  |
+| `objective`     | Piezo objective positioner            | `move_z`, `calibrate`                |
+| `temperature`   | NTC digital temperature sensor        | `get_temperature`                    |
+| `analog`        | Arbitrary analogue outputs            | `set_voltage`                        |
+| `digitalout`    | GPIO (TTL) outputs                    | `set_pin`, `pulse`                   |
+| `wifi`          | ESP32 network helpers                 | `scan`, `connect`                    |
+| `message`       | Generic key‑value messaging/trigger   | `register_callback`, `trigger_message` |
+
+## Design philosophy
+
+UC2 REST splits interaction into three JSON endpoints per device:
+
+```
+/*_act   → perform an action   (e.g. move)
+/*_set   → configure a device  (e.g. speed)
+/*_get   → query state         (e.g. position)
+```
+
+The Python client wraps those endpoints so you rarely deal with raw JSON.
+
+
+## Running in a browser (PyScript)
+
+```html
+<py-config>
+  packages = ["uc2rest"]
+</py-config>
+<py-script>
+  from uc2rest import UC2Client
+  esp = UC2Client(SerialManager=pyserial_manager)  # see docs
+  esp.led.setAll(True)
+</py-script>
+```
+
+## Documentation & examples
+
+* Jupyter notebook tutorial: `PYTHON/UC2_REST_Tutorial_v0.ipynb`  
+* Example scripts: `examples/` directory (motor scan, laser modulation, timelapse)  
+* Firmware sources and hardware guides: <https://github.com/openUC2>
+
+## Troubleshooting
+
+| Symptom                      | Fix |
+|------------------------------|-----|
+| `serial.serialutil.SerialException` | Check port name and permissions (`sudo adduser $USER dialout`) |
+| No JSON response / timeout   | Increase `timeout` argument; verify baud rate matches firmware |
+
+## Contributing
+
+1. Fork the repo and create a feature branch.  
+2. Follow the `pre‑commit` checks (`black`, `isort`, `flake8`).  
+3. Create pull requests against `develop`.
+
+Please open issues for bugs or feature requests.
+
+## License
+
+MIT — see `LICENSE` for details.
+
+---
+
+Made with 💚 by the OpenUC2 community.

uc2_rest-0.2.0.26/UC2_REST.egg-info/PKG-INFO

@@ -0,0 +1,151 @@
+Metadata-Version: 2.4
+Name: UC2-REST
+Version: 0.2.0.26
+Summary: This pacage will help you to drive the ESP32-driven microscopy control modules from UC2
+Home-page: https://github.com/openUC2/UC2-REST
+Author: Benedict Diederich
+Author-email: benedictdied@gmail.com
+License: GPL v3
+Keywords: UC2REST API to control ESP32-driven microscopy control boards
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3.7
+Requires-Python: >=3.7
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: numpy
+Requires-Dist: requests
+Requires-Dist: pyserial
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: keywords
+Dynamic: license
+Dynamic: license-file
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+<p align="center">
+  <img src="https://raw.githubusercontent.com/bionanoimaging/UC2-GIT/master/IMAGES/UC2_logo_text.png" width="320" alt="UC2 logo">
+</p>
+
+# UC2‑Python Client
+
+Python interface to the **UC2 REST** micro‑controller firmware — control motors, lasers, LED matrices, galvos and more over USB‑Serial or Wi‑Fi from any Python environment.
+
+## Highlights
+
+- **Plug‑and‑play connection** via USB (`/dev/ttyUSB*`, `COM*`) or TCP (`host`, `port`).
+- **Rich device model**: every hardware block is a Python object with high‑level helpers (e.g. `motor.move_x`, `led.setPattern`, `laser.set_laser`).
+- **Asynchronous & blocking modes** for precise timing or maximum throughput.
+- **Callback hooks** to react to hardware feedback in real time.
+- **Runs everywhere**: desktop Python, headless Raspberry Pi, or in‑browser with PyScript.
+- **LGPL‑3.0‑or‑later** license – use it in academic and commercial projects.
+
+## Installation
+
+```bash
+pip install uc2rest           # latest release
+# or for the bleeding‑edge version
+pip install git+https://github.com/openUC2/UC2-REST.git#subdirectory=PYTHON
+```
+
+Dependencies (`requests`, `numpy`, `pyserial`) are resolved automatically.
+
+## Quick start
+
+```python
+import uc2rest
+
+# USB example
+esp = uc2rest.UC2Client(serialport="/dev/ttyUSB0")         # Linux / Mac OS
+# esp = uc2rest.UC2Client(serialport="COM3")               # Windows
+# Wi‑Fi example
+# esp = uc2rest.UC2Client(host="192.168.4.1", port=31950)
+
+# LED matrix: switch all pixels on at half intensity
+esp.led.setAll(True, intensity=128)
+
+# Move X axis by 1 mm (1000 steps @ 1 kHz)
+esp.motor.move_x(steps=1000, speed=1000, is_blocking=True)
+
+# Turn green laser to full power
+esp.laser.set_laser(channel="G", value=255)
+```
+
+## Supported modules (automatically attached to `UC2Client`) citeturn1file12
+
+| Object          | Purpose                               | Example method(s)                    |
+|-----------------|---------------------------------------|--------------------------------------|
+| `motor`         | X/Y/Z/θ stages                        | `move_x / move_xy`, `setup_motor`    |
+| `led`           | 8×8 RGB LED matrix                    | `setPattern`, `send_LEDMatrix_rings` |
+| `laser`         | 3‑channel RGB or IR lasers            | `set_laser`, `set_servo`             |
+| `galvo`         | Analogue DAC & 2‑axis scanner         | `set_dac`, `set_scanner_pattern`     |
+| `gripper`       | Micro‑gripper (servo)                 | `open`, `close`                      |
+| `home`          | End‑stop homing routines              | `home_x`, `home_z`                   |
+| `rotator`       | Filter wheel or Dove prism            | `move`, `set_speed`                  |
+| `objective`     | Piezo objective positioner            | `move_z`, `calibrate`                |
+| `temperature`   | NTC digital temperature sensor        | `get_temperature`                    |
+| `analog`        | Arbitrary analogue outputs            | `set_voltage`                        |
+| `digitalout`    | GPIO (TTL) outputs                    | `set_pin`, `pulse`                   |
+| `wifi`          | ESP32 network helpers                 | `scan`, `connect`                    |
+| `message`       | Generic key‑value messaging/trigger   | `register_callback`, `trigger_message` |
+
+## Design philosophy
+
+UC2 REST splits interaction into three JSON endpoints per device:
+
+```
+/*_act   → perform an action   (e.g. move)
+/*_set   → configure a device  (e.g. speed)
+/*_get   → query state         (e.g. position)
+```
+
+The Python client wraps those endpoints so you rarely deal with raw JSON.
+
+
+## Running in a browser (PyScript)
+
+```html
+<py-config>
+  packages = ["uc2rest"]
+</py-config>
+<py-script>
+  from uc2rest import UC2Client
+  esp = UC2Client(SerialManager=pyserial_manager)  # see docs
+  esp.led.setAll(True)
+</py-script>
+```
+
+## Documentation & examples
+
+* Jupyter notebook tutorial: `PYTHON/UC2_REST_Tutorial_v0.ipynb`  
+* Example scripts: `examples/` directory (motor scan, laser modulation, timelapse)  
+* Firmware sources and hardware guides: <https://github.com/openUC2>
+
+## Troubleshooting
+
+| Symptom                      | Fix |
+|------------------------------|-----|
+| `serial.serialutil.SerialException` | Check port name and permissions (`sudo adduser $USER dialout`) |
+| No JSON response / timeout   | Increase `timeout` argument; verify baud rate matches firmware |
+
+## Contributing
+
+1. Fork the repo and create a feature branch.  
+2. Follow the `pre‑commit` checks (`black`, `isort`, `flake8`).  
+3. Create pull requests against `develop`.
+
+Please open issues for bugs or feature requests.
+
+## License
+
+MIT — see `LICENSE` for details.
+
+---
+
+Made with 💚 by the OpenUC2 community.

{uc2_rest-0.2.0.24 → uc2_rest-0.2.0.26}/UC2_REST.egg-info/SOURCES.txt

@@ -22,7 +22,6 @@ uc2rest/gripper.py
 uc2rest/home.py
 uc2rest/laser.py
 uc2rest/ledmatrix.py
-uc2rest/ledmatrix_.py
 uc2rest/logger.py
 uc2rest/message.py
 uc2rest/modules.py

{uc2_rest-0.2.0.24 → uc2_rest-0.2.0.26}/uc2rest/__version__.py

@@ -6,7 +6,7 @@ __version__.py
 
 __title__ = 'UC2-REST'
 __description__ = 'This pacage will help you to drive the ESP32-driven microscopy control modules from UC2'
-__version__ = "v0.2.0.24"
+__version__ = "v0.2.0.26"
 __author__ = 'Benedict Diederich'
 __author_email__ = 'benedictdied@gmail.com'
 __license__ = 'GPL v3'

{uc2_rest-0.2.0.24 → uc2_rest-0.2.0.26}/uc2rest/camera.py

@@ -1,4 +1,8 @@
-from PIL import Image
+try:
+    from PIL import Image
+    IS_IMAGE = True
+except ImportError:
+    IS_IMAGE = False
 import base64
 import io
 import numpy as np

{uc2_rest-0.2.0.24 → uc2_rest-0.2.0.26}/uc2rest/mserial.py

@@ -60,10 +60,8 @@ class Serial:
         if IS_SERIAL:
             self.serialdevice= self.openDevice(port, baudrate)
         else: 
-            self.serialdevice = MockSerial(port, baudrate, timeout=timeout)
-            self.is_connected = False
-            self.manufacturer = "UC2Mock"
-            self._logger.debug("You have to ensure that the serial device is connected to the computer!")
+            ''' this is most likely happening because we work under pyoidide '''
+            self._logger.debug("You have to provide the serial interface on your own")
 
     def breakCurrentCommunication(self):
         self.resetLastCommand = True