scrollkit 0.8.3__py3-none-any.whl

scrollkit/simulator/CIRCUITPYTHON_COMPATIBILITY.md

@@ -0,0 +1,364 @@
+# CircuitPython Compatibility Guide
+
+This document outlines the CircuitPython compatibility considerations when using PyLEDSimulator and developing code that needs to run on both desktop (simulation) and CircuitPython hardware.
+
+## Overview
+
+PyLEDSimulator implements CircuitPython's display APIs to allow desktop development and testing. However, there are important differences between standard Python and CircuitPython that developers must be aware of.
+
+## Core Compatibility Principles
+
+### 1. Module Availability
+
+CircuitPython has a limited subset of Python's standard library. Many common modules are not available or have limited functionality.
+
+#### Available in CircuitPython:
+- `os` (limited functionality)
+- `time` (limited functionality)
+- `json` (basic functionality only)
+- `re` (basic regex support)
+- `random` (limited functionality - no `shuffle()`)
+- `asyncio` (cooperative multitasking only)
+- `gc` (garbage collection)
+- `sys` (limited functionality)
+
+#### NOT Available in CircuitPython:
+- `pathlib`
+- `urllib`
+- `threading`
+- `subprocess`
+- `typing` (type hints must be removed)
+- `dataclasses`
+- `collections` (except `namedtuple`)
+- Most standard library modules
+
+### 2. Exception Handling Differences
+
+CircuitPython uses different exceptions than standard Python:
+
+```python
+# ❌ WRONG - Standard Python only
+try:
+    data = json.loads(response)
+except json.JSONDecodeError:  # Not available in CircuitPython
+    pass
+
+# ✅ CORRECT - CircuitPython compatible
+try:
+    data = json.loads(response)
+except ValueError:  # CircuitPython raises ValueError for invalid JSON
+    pass
+
+# ❌ WRONG - Standard Python only
+try:
+    with open('file.txt') as f:
+        content = f.read()
+except FileNotFoundError:  # Not available in CircuitPython
+    pass
+
+# ✅ CORRECT - CircuitPython compatible
+try:
+    with open('file.txt') as f:
+        content = f.read()
+except OSError:  # CircuitPython only has OSError
+    pass
+```
+
+### 3. String and Type Operations
+
+```python
+# ❌ WRONG - f-string debug syntax not supported
+print(f"{value=}")
+
+# ✅ CORRECT - Use regular f-strings
+print(f"value={value}")
+
+# ❌ WRONG - match/case not available
+match command:
+    case "start":
+        start()
+
+# ✅ CORRECT - Use if/elif
+if command == "start":
+    start()
+elif command == "stop":
+    stop()
+```
+
+### 4. Memory Management
+
+CircuitPython has limited memory (typically 256KB-512KB RAM):
+
+```python
+# ❌ WRONG - Loading large data structures
+data = json.loads(large_file_content)  # May cause MemoryError
+
+# ✅ CORRECT - Process data in chunks or use generators
+def process_json_lines(file_path):
+    with open(file_path) as f:
+        for line in f:
+            yield json.loads(line)
+```
+
+### 5. File Operations
+
+```python
+# ❌ WRONG - Using pathlib
+from pathlib import Path
+if Path('config.json').exists():
+    pass
+
+# ✅ CORRECT - Use os or try/except
+import os
+try:
+    os.stat('config.json')
+    file_exists = True
+except OSError:
+    file_exists = False
+```
+
+### 6. Time Operations
+
+```python
+# ❌ WRONG - time.time() not always available
+start_time = time.time()
+
+# ✅ CORRECT - Use time.monotonic()
+start_time = time.monotonic()
+```
+
+### 7. Random Module Limitations
+
+```python
+# ❌ WRONG - random.shuffle() not available
+import random
+my_list = [1, 2, 3, 4, 5]
+random.shuffle(my_list)
+
+# ✅ CORRECT - Implement simple shuffle
+import random
+
+def simple_shuffle(lst):
+    """Simple in-place shuffle for CircuitPython compatibility."""
+    for i in range(len(lst)):
+        j = random.randint(0, len(lst) - 1)
+        lst[i], lst[j] = lst[j], lst[i]
+
+my_list = [1, 2, 3, 4, 5]
+simple_shuffle(my_list)
+```
+
+### 8. Async Operations
+
+```python
+# ❌ WRONG - asyncio.run() at module level
+import asyncio
+asyncio.run(main())
+
+# ✅ CORRECT - Use asyncio properly
+import asyncio
+
+async def main():
+    # Your async code here
+    pass
+
+# At the bottom of your main file:
+if __name__ == "__main__":
+    asyncio.run(main())
+```
+
+## displayio API Changes
+
+### Display.show() Removed in CircuitPython 9.x
+
+The `.show()` method has been removed from Display objects in CircuitPython 9.x:
+
+```python
+# ❌ WRONG - Old API (CircuitPython 8.x and earlier)
+display.show(None)  # Clear display
+display.show(group)  # Show group
+
+# ✅ CORRECT - New API (CircuitPython 9.x)
+display.root_group = None  # Clear display
+display.root_group = group  # Show group
+```
+
+### MatrixPortal Pixel Access
+
+The MatrixPortal class doesn't provide direct pixel manipulation methods:
+
+```python
+# ❌ WRONG - No set_pixel/get_pixel methods
+matrixportal.set_pixel(x, y, color)
+color = matrixportal.get_pixel(x, y)
+
+# ✅ CORRECT - Use displayio.Bitmap
+bitmap = displayio.Bitmap(width, height, num_colors)
+palette = displayio.Palette(num_colors)
+palette[0] = 0x000000  # Black
+palette[1] = 0xFFFF00  # Yellow
+
+tile_grid = displayio.TileGrid(bitmap, pixel_shader=palette)
+group = displayio.Group()
+group.append(tile_grid)
+display.root_group = group
+
+# Set pixels via bitmap
+bitmap[x, y] = 1  # Set to color index 1 (yellow)
+```
+
+## PyLEDSimulator-Specific Compatibility
+
+### 1. Conditional Imports
+
+Always structure imports to support both environments:
+
+```python
+try:
+    # Try hardware imports first
+    import board
+    import displayio
+    import terminalio
+    from adafruit_display_text import label
+    HARDWARE_AVAILABLE = True
+except ImportError:
+    # Fall back to simulator
+    from pyledsimulator import displayio
+    from pyledsimulator import terminalio
+    from pyledsimulator.adafruit_display_text import label
+    HARDWARE_AVAILABLE = False
+```
+
+### 2. Display Initialization
+
+```python
+def get_display():
+    """Get display for hardware or simulator."""
+    if HARDWARE_AVAILABLE:
+        return board.DISPLAY
+    else:
+        from pyledsimulator.devices import MatrixPortalS3
+        device = MatrixPortalS3()
+        device.initialize()
+        return device.display
+```
+
+### 3. Performance Differences
+
+The simulator runs at desktop speeds, which is much faster than CircuitPython:
+
+```python
+# Add delays to simulate hardware timing
+if not HARDWARE_AVAILABLE:
+    time.sleep(0.1)  # Simulate hardware processing time
+```
+
+### 4. Memory Constraints Simulation
+
+When developing with the simulator, be mindful of hardware memory limits:
+
+```python
+# Even though desktop has more memory, design for hardware constraints
+MAX_SPRITES = 10  # Limit based on hardware capabilities
+MAX_TEXT_LENGTH = 100  # Avoid long strings
+```
+
+## Common Pitfalls and Solutions
+
+### 1. HTTP Libraries
+
+```python
+# ❌ WRONG - Using requests
+import requests
+response = requests.get(url)
+
+# ✅ CORRECT - Use adafruit_requests
+import adafruit_requests
+response = adafruit_requests.get(url)
+```
+
+### 2. JSON Handling
+
+```python
+# ❌ WRONG - Expecting specific exceptions
+try:
+    data = json.loads(text)
+except json.JSONDecodeError as e:
+    print(f"JSON error at position {e.pos}")
+
+# ✅ CORRECT - Handle generic ValueError
+try:
+    data = json.loads(text)
+except ValueError as e:
+    print(f"JSON error: {e}")
+```
+
+### 3. Type Hints
+
+```python
+# ❌ WRONG - Using type hints
+def process_data(data: dict[str, Any]) -> list[str]:
+    pass
+
+# ✅ CORRECT - Remove type hints or use comments
+def process_data(data):  # type: (dict) -> list
+    """Process data dictionary and return list of strings."""
+    pass
+```
+
+## Testing for Compatibility
+
+### 1. Linting for CircuitPython
+
+Use the project's linting tools to catch compatibility issues:
+
+```bash
+make lint-errors  # Catches undefined names and syntax errors
+```
+
+### 2. Import Testing
+
+Test imports in both environments:
+
+```python
+# test_imports.py
+def test_imports():
+    """Verify all imports work in current environment."""
+    try:
+        import json
+        import time
+        import os
+        print("✓ Core imports successful")
+    except ImportError as e:
+        print(f"✗ Import failed: {e}")
+```
+
+### 3. Memory Testing
+
+```python
+import gc
+
+def check_memory():
+    """Check available memory (CircuitPython only)."""
+    gc.collect()
+    if hasattr(gc, 'mem_free'):
+        print(f"Free memory: {gc.mem_free()} bytes")
+```
+
+## Best Practices
+
+1. **Always test on hardware**: The simulator is for development, but final testing must be on actual hardware
+2. **Use minimal dependencies**: Stick to CircuitPython built-ins when possible
+3. **Handle errors gracefully**: Assume operations can fail due to memory or hardware constraints
+4. **Keep it simple**: Complex Python features are often not available
+5. **Check CircuitPython docs**: When in doubt, consult https://docs.circuitpython.org/
+
+## Useful Resources
+
+- [CircuitPython API Reference](https://docs.circuitpython.org/en/latest/docs/library/index.html)
+- [CircuitPython vs MicroPython](https://docs.circuitpython.org/en/latest/docs/design_guide.html)
+- [Adafruit Learn Guides](https://learn.adafruit.com/category/circuitpython)
+
+## Version Compatibility
+
+PyLEDSimulator targets CircuitPython 8.x and 9.x compatibility. Features specific to newer versions should be avoided or have fallbacks.

scrollkit/simulator/LICENSE

@@ -0,0 +1,176 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS

scrollkit/simulator/README.md

@@ -0,0 +1,87 @@
+# LED Simulator
+
+A standalone Python library for simulating LED matrix displays used with CircuitPython boards. The library provides a visual representation of LED hardware using Pygame, allowing developers to test their code on desktop platforms before deploying to actual hardware.
+
+## Features
+
+- **Pixel-Perfect LED Simulation**: Realistic LED rendering with configurable pitch (2.5, 3, 4, 5, 6mm)
+- **CircuitPython API Compatibility**: Implements displayio, terminalio, and adafruit_display_text APIs
+- **Multi-Display Support**: Tile multiple displays together (up to 4x4 grid)
+- **Font Support**: BDF font loading with bundled fonts
+- **Performance Simulation**: Optional hardware performance characteristics simulation
+- **Device Emulation**: Pre-configured device profiles (MatrixPortal S3, etc.)
+
+## Installation
+
+```bash
+pip install led_simulator
+```
+
+## Quick Start
+
+```python
+from led_simulator.devices import MatrixPortalS3
+from led_simulator.displayio import Group
+from led_simulator.adafruit_display_text import Label
+from led_simulator.terminalio import FONT
+
+# Create device
+device = MatrixPortalS3()
+device.initialize()
+
+# Create text label
+text_group = Group()
+label = Label(font=FONT, text="Hello LED!")
+label.x = 0
+label.y = 15
+text_group.append(label)
+
+# Show on display
+device.display.show(text_group)
+
+# Run the simulation
+device.run()
+```
+
+## API Compatibility
+
+PyLEDSimulator aims for "sufficient API compatibility" with CircuitPython's displayio module. This means:
+- Your CircuitPython code should work with minimal or no modifications
+- The visual output closely matches real hardware
+- Some advanced features may have behavioral differences (documented below)
+
+### Known Limitations
+
+- Rendering order nuances may differ slightly from hardware
+- Memory management follows Python's model, not CircuitPython's
+- Some rotation/scaling transforms may have minor differences
+- Font rendering may have slight metric differences
+
+### CircuitPython Compatibility
+
+For detailed information about writing code that works in both the simulator and on CircuitPython hardware, see [CIRCUITPYTHON_COMPATIBILITY.md](CIRCUITPYTHON_COMPATIBILITY.md). This guide covers:
+- Module availability differences
+- Exception handling in CircuitPython
+- Memory constraints
+- Common pitfalls and solutions
+
+## Examples
+
+See the `examples/` directory for various usage examples:
+- `matrixportal_s3_example.py` - Basic MatrixPortal S3 simulation
+- `scrolling_text_example.py` - Text scrolling demonstration
+- `dual_zone_example.py` - Multi-zone display example
+- `multi_display_example.py` - Multiple display coordination
+- `rainbow_text.py` - Colorful text effects
+- `pixel_dust.py` - Particle effects simulation
+
+## License
+
+Apache License 2.0
+
+## Attribution
+
+Portions of this project are adapted from CircuitPython:
+- Copyright (c) 2016-2024 Adafruit Industries
+- Licensed under MIT License
+- See ATTRIBUTION.md for details

scrollkit/simulator/__init__.py

@@ -0,0 +1,11 @@
+# Copyright (c) 2024-2026 Michael Winslow Czeiszperger
+"""SLDK LED Matrix Simulator."""
+
+# Make simulator modules available at package level
+from . import core
+from . import devices
+from . import displayio
+from . import adafruit_display_text
+from . import terminalio
+
+__version__ = "0.8.1"

scrollkit/simulator/adafruit_bitmap_font/__init__.py

@@ -0,0 +1,5 @@
+"""Bitmap font support."""
+
+from .bitmap_font import load_font
+
+__all__ = ['load_font']