espzero 0.0.1__tar.gz → 0.0.3__tar.gz

{espzero-0.0.1 → espzero-0.0.3}/PKG-INFO

@@ -1,9 +1,10 @@
 Metadata-Version: 2.4
 Name: espzero
-Version: 0.0.1
+Version: 0.0.3
 Summary: Educational tool for physical computing and ESP32/ESP8266 development.
 Author-email: Neo Neopia-uz <neopia.uz@gmail.com>
 Project-URL: Homepage, https://github.com/roboticsware/espzero
+Project-URL: Documentation, https://espzero.readthedocs.io
 Project-URL: Bug Tracker, https://github.com/roboticsware/espzero/issues
 Classifier: Programming Language :: Python :: 3
 Classifier: License :: OSI Approved :: MIT License
@@ -13,6 +14,10 @@ Description-Content-Type: text/markdown
 
 # espzero
 
+[![PyPI version](https://badge.fury.io/py/espzero.svg)](https://badge.fury.io/py/espzero)
+[![Documentation Status](https://readthedocs.org/projects/espzero/badge/?version=latest)](https://espzero.readthedocs.io/)
+[![License](https://img.shields.io/github/license/roboticsware/espzero)](https://github.com/roboticsware/espzero/blob/main/LICENSE)
+
 > A single MicroPython library that ports [picozero](https://github.com/raspberrypilearning/picozero) to the ESP32 family (WROOM, S3, C3, and more).  
 > **"One codebase, many boards"** — hardware differences are absorbed by the Board Profile system.
 
@@ -20,10 +25,20 @@ Description-Content-Type: text/markdown
 
 ## Installation
 
-Copy the `espzero/` directory to the root of your ESP32 filesystem using Mu Editor, Thonny, or `mpremote`:
+### For your ESP32 board (Recommended)
+Use `mpremote` to install directly from PyPI to your board:
 
+```bash
+mpremote mip install espzero
 ```
-mpremote cp -r espzero/ :espzero/
+
+Or manually copy the `espzero/` directory to your board's root.
+
+### For your PC (Development)
+To get autocomplete and linting in your IDE:
+
+```bash
+pip install espzero
 ```
 
 ---

{espzero-0.0.1 → espzero-0.0.3}/README.md

@@ -1,5 +1,9 @@
 # espzero
 
+[![PyPI version](https://badge.fury.io/py/espzero.svg)](https://badge.fury.io/py/espzero)
+[![Documentation Status](https://readthedocs.org/projects/espzero/badge/?version=latest)](https://espzero.readthedocs.io/)
+[![License](https://img.shields.io/github/license/roboticsware/espzero)](https://github.com/roboticsware/espzero/blob/main/LICENSE)
+
 > A single MicroPython library that ports [picozero](https://github.com/raspberrypilearning/picozero) to the ESP32 family (WROOM, S3, C3, and more).  
 > **"One codebase, many boards"** — hardware differences are absorbed by the Board Profile system.
 
@@ -7,10 +11,20 @@
 
 ## Installation
 
-Copy the `espzero/` directory to the root of your ESP32 filesystem using Mu Editor, Thonny, or `mpremote`:
+### For your ESP32 board (Recommended)
+Use `mpremote` to install directly from PyPI to your board:
 
+```bash
+mpremote mip install espzero
 ```
-mpremote cp -r espzero/ :espzero/
+
+Or manually copy the `espzero/` directory to your board's root.
+
+### For your PC (Development)
+To get autocomplete and linting in your IDE:
+
+```bash
+pip install espzero
 ```
 
 ---

espzero-0.0.3/__init__.py

@@ -0,0 +1,153 @@
+# This file is part of espzero, automatically synced from
+# https://github.com/roboticsware/espzero at revision 24cae2bc1c028458052675181e95f2a08fdf7481.
+# Do not edit this file directly — run update_user_libs.py espzero instead.
+
+"""
+espzero/__init__.py
+Public entry point for the espzero library — an ESP32 port of picozero.
+
+Quick start::
+
+    import espzero
+    espzero.begin()               # initialise board (auto-detect)
+
+    from espzero import esp_led   # built-in LED, ready after begin()
+    from time import sleep
+
+    while True:
+        esp_led.on()
+        sleep(1)
+        esp_led.off()
+        sleep(1)
+
+Specify a board explicitly::
+
+    espzero.begin("esp32_devkit_v1")  # override auto-detection
+
+Import other components after begin()::
+
+    from espzero import LED, Button, Servo, WiFi
+
+The board profile system abstracts hardware differences (pin aliases,
+ADC attenuation, strapping pins, NeoPixel vs GPIO LEDs, etc.) so that
+user code remains identical across supported boards.
+"""
+
+from . import _hal
+
+# ── Board → profile class mapping ─────────────────────────────
+# Key   : user-facing board name (passed to begin())
+# Value : (module_name, class_name) for lazy import
+_PROFILE_MAP = {
+    "esp32_devkit_v1":    ("profiles.esp32_boards", "ESP32DevKitV1"),
+    "esp32_s3_devkit":    ("profiles.esp32_boards", "ESP32S3DevKit"),
+    "esp32_c3_mini":      ("profiles.esp32_boards", "ESP32C3Mini"),
+    "m5stack_atom":       ("profiles.esp32_boards", "M5StackAtom"),
+    "wemos_d1_mini32":    ("profiles.esp32_boards", "WemosD1Mini32"),
+    "esp8266_lolin_v3":   ("profiles.esp32_boards", "ESP8266LolinV3"),
+    "esp32_38pin_nodemcu":("profiles.esp32_boards", "ESP32_38Pin_NodeMCU"),
+}
+
+# ── Internal state for convenience objects ─────────────────────
+_esp_led         = None   # Built-in LED (DigitalLED or NeoPixelLED)
+_esp_temp_sensor = None   # Built-in temperature sensor
+
+# Module-level __getattr__ (MicroPython 1.18+) for lazy loading.
+# This prevents NoneType errors if user imports before calling begin().
+def __getattr__(name):
+    if name == "esp_led":
+        if _esp_led is None:
+            raise RuntimeError(
+                "[espzero] ERROR: 'esp_led' is not initialized. "
+                "You must call espzero.begin() first."
+            )
+        return _esp_led
+    if name == "esp_temp_sensor":
+        if _esp_temp_sensor is None:
+            raise RuntimeError(
+                "[espzero] ERROR: 'esp_temp_sensor' is not initialized. "
+                "You must call espzero.begin() first."
+            )
+        return _esp_temp_sensor
+    raise AttributeError("module 'espzero' has no attribute '{}'".format(name))
+
+
+def begin(board="auto"):
+    """
+    Initialise the board profile.  Must be called before any espzero class.
+
+    :param board:
+        - ``"auto"``          – detect from ``sys.implementation._machine``
+        - A board name string – e.g. ``"esp32_devkit_v1"``
+        - A ``BoardProfile`` instance – for custom boards
+
+    Raises ``ValueError`` for unknown board name strings.
+    """
+    global _esp_led, _esp_temp_sensor
+
+    from .profiles._base import BoardProfile
+
+    if isinstance(board, BoardProfile):
+        _hal._profile = board
+
+    elif board == "auto":
+        from .profiles.auto import detect
+        begin(detect())
+        return
+
+    else:
+        if board not in _PROFILE_MAP:
+            raise ValueError(
+                "[espzero] Unknown board: '{}'. "
+                "Available boards: {}".format(board, list(_PROFILE_MAP.keys()))
+            )
+        mod_name, cls_name = _PROFILE_MAP[board]
+        # Dynamically import the profile module within the package
+        full_mod_name = __name__ + "." + mod_name
+        mod = __import__(full_mod_name, None, None, [cls_name])
+        _hal._profile = getattr(mod, cls_name)()
+
+    print("[espzero] Board: {} ({})".format(
+        _hal._profile.NAME, _hal._profile.CHIP))
+
+    # Initialise built-in LED — branch on LED type declared in the profile
+    from ._core import NeoPixelLED, LED as _LED
+    try:
+        p = _hal._profile
+        if p.INTERNAL_LED_TYPE == "neopixel":
+            _esp_led = NeoPixelLED(p.resolve_pin("internal"))
+        else:
+            _esp_led = _LED("internal",
+                            pwm=False,
+                            active_high=p.INTERNAL_LED_ACTIVE_HIGH)
+    except Exception as e:
+        print("[espzero] LED Init Error:", e)
+        _esp_led = None
+
+    # Initialise built-in temperature sensor
+    try:
+        from ._core import ESPTemperatureSensor
+        _esp_temp_sensor = ESPTemperatureSensor()
+    except Exception as e:
+        print("[espzero] TempSensor Init Error:", e)
+        _esp_temp_sensor = None
+
+
+# ── Re-export public API ───────────────────────────────────────
+from ._core import (
+    LED, DigitalLED, PWMLED, NeoPixelLED,
+    Buzzer, PWMBuzzer, Speaker,
+    RGBLED,
+    Servo,
+    Motor, Robot, Rover, Stepper,
+    Button, Switch, MotionSensor, TouchSensor,
+    Potentiometer, Pot,
+    TemperatureSensor, TempSensor, Thermistor,
+    DistanceSensor,
+    ESPTemperatureSensor,
+    DigitalOutputDevice, PWMOutputDevice,
+    DigitalInputDevice, AnalogInputDevice,
+    I2cLcd, GpioLcd,
+)
+from ._wifi  import WiFi
+from ._touch import CapTouch