alpaca-stubs 0.1.0__tar.gz

alpaca_stubs-0.1.0/PKG-INFO

@@ -0,0 +1,7 @@
+Metadata-Version: 2.4
+Name: alpaca-stubs
+Version: 0.1.0
+Summary: Libraries for ALPACA 2.0 - NB2420 Electronic Instrumentation
+License-Expression: CC-BY-4.0
+Requires-Python: >=3.14
+Description-Content-Type: text/markdown

alpaca_stubs-0.1.0/alpaca_stubs.egg-info/PKG-INFO

@@ -0,0 +1,7 @@
+Metadata-Version: 2.4
+Name: alpaca-stubs
+Version: 0.1.0
+Summary: Libraries for ALPACA 2.0 - NB2420 Electronic Instrumentation
+License-Expression: CC-BY-4.0
+Requires-Python: >=3.14
+Description-Content-Type: text/markdown

alpaca_stubs-0.1.0/alpaca_stubs.egg-info/SOURCES.txt

@@ -0,0 +1,12 @@
+pyproject.toml
+alpaca_stubs.egg-info/PKG-INFO
+alpaca_stubs.egg-info/SOURCES.txt
+alpaca_stubs.egg-info/dependency_links.txt
+alpaca_stubs.egg-info/top_level.txt
+command/__init__.pyi
+dac/__init__.pyi
+dac/driver.pyi
+helper/__init__.pyi
+link/__init__.pyi
+utime/__init__.pyi
+version/__init__.pyi

alpaca_stubs-0.1.0/alpaca_stubs.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

alpaca_stubs-0.1.0/alpaca_stubs.egg-info/top_level.txt

@@ -0,0 +1,6 @@
+command
+dac
+helper
+link
+utime
+version

alpaca_stubs-0.1.0/command/__init__.pyi

@@ -0,0 +1,15 @@
+from _typeshed import Incomplete
+
+PING: Incomplete
+LCD_PUTSTR: Incomplete
+SET_PIN: Incomplete
+AWG_R2R_LOAD: Incomplete
+AWG_R2R_START: Incomplete
+AWG_R2R_STOP: Incomplete
+AWG_R2R_OFFSET: Incomplete
+COMMANDS: Incomplete
+
+def pack_args(fmt, values):
+    """Encode a tuple/list of values per a format string into bytes."""
+def unpack_args(fmt, buf):
+    """Decode bytes per a format string into a list of values."""

alpaca_stubs-0.1.0/dac/__init__.pyi

@@ -0,0 +1,31 @@
+import _thread
+import micropython
+import types
+from _typeshed import Incomplete
+from collections.abc import Callable as Callable
+from dac.driver import MCP4922 as MCP4922
+from machine import Pin as Pin, SPI as SPI
+from typing import Literal
+from utime import sleep_us as sleep_us, ticks_ms as ticks_ms
+
+driver: Incomplete
+
+class DAC:
+    channel: Literal[0, 1]
+    gain: Literal[1, 2]
+    v_ref: Incomplete
+    def __init__(self, channel: Literal['A', 'B'], v_ref: Literal[3000, 2048] = 3000, gain: Literal[1, 2] = 1) -> None: ...
+    def write(self, val: float): ...
+    def generate(self, generator: Callable[[float], float], frequency_hz: int, N: int = 100): ...
+
+class DACWorker:
+    sample_period_us: Incomplete
+    awg_table: Incomplete
+    stop_flag_lock: Incomplete
+    def __init__(self, sample_period_us: int, awg_table: memoryview) -> None: ...
+    done: Incomplete
+    def __enter__(self): ...
+    def __exit__(self, exc_type: type[BaseException] | None, exc: BaseException | None, tb: types.TracebackType | None) -> None: ...
+    @micropython.native
+    @staticmethod
+    def worker(sample_period_us: int, awg_table: memoryview, stop_flag_lock: _thread.LockType, done_lock: _thread.LockType, spi: SPI, cs: Pin, ldac: Pin): ...

alpaca_stubs-0.1.0/dac/driver.pyi

@@ -0,0 +1,36 @@
+import micropython
+from _typeshed import Incomplete
+from typing import Literal
+
+DAC_12_BIT_LIMIT: Incomplete
+
+class MCP4922:
+    """
+    MCP4922 is a Digital to Analog Converter
+
+    It operates over SP and has two channels.
+
+    The 16-bit data is sent over TX (MOSI) Pin and 4-bit is reserved
+    for config (see MCP4922.write). The data for indiviual channels
+    is kept in the input register.
+
+    Setting LDAC to low moves inputs from input register to output
+    register, which allows both channels to be operated simeltanously.
+  """
+    spi: Incomplete
+    cs: Incomplete
+    ldac: Incomplete
+    def __init__(self) -> None: ...
+    @micropython.native
+    def write(self, value: int, channel: Literal[0, 1] = 0, buffered: bool = False, gain: Literal[1, 2] = 1) -> bool:
+        """Write a 12-bit value to DAC
+    :param channel: 0 for DAC A, 1 for DAC B.
+    :param value: Integer from 0 to 4095.
+    :param buffered: True to use VREF buffer, False for unbuffered.
+    :param gain: 1x or 2x output gain
+
+    :returns: whether the data was actually sent to DAC
+    """
+    @micropython.native
+    def push(self) -> None:
+        """Move input register to output"""

alpaca_stubs-0.1.0/helper/__init__.pyi

@@ -0,0 +1,18 @@
+from _typeshed import Incomplete
+
+link: Incomplete
+
+def ping(): ...
+def set_screen_text(text_up: str = '', text_down: str = ''): ...
+def awg_r2r(samples, sample_rate_hz):
+    """Play a waveform on the Helper's R-2R ladder DAC (GPIO0-9).
+
+    samples: iterable of 10-bit codes (0-1023, values are masked), looped
+    forever. sample_rate_hz: requested playback rate; returns the actual
+    rate achieved, which is lower if the requested rate is too fast.
+    """
+def awg_r2r_stop():
+    """Stop the AWG and drive the ladder to 0."""
+def awg_r2r_offset(magnitude, negative: bool = False):
+    """Set the analog offset stage: magnitude 0.0-1.0 (PWM duty on
+    OFFSET_PWM), negative selects the sign via OFFSET_POL."""

alpaca_stubs-0.1.0/link/__init__.pyi

@@ -0,0 +1,21 @@
+import micropython
+from _typeshed import Incomplete
+
+OK: Incomplete
+ERR: Incomplete
+
+class Link:
+    uart: Incomplete
+    timeout_ms: Incomplete
+    handlers: Incomplete
+    event_loop: Incomplete
+    event_times: Incomplete
+    def __init__(self, uart, timeout_ms: int = 1000) -> None: ...
+    @micropython.native
+    def call(self, opcode, *args):
+        """Send a request and block for the reply. Returns the decoded
+        result or raises RuntimeError on an ERR reply."""
+    def register(self, opcode): ...
+    def event(self, func): ...
+    @micropython.native
+    def serve(self) -> None: ...

alpaca_stubs-0.1.0/pyproject.toml

@@ -0,0 +1,22 @@
+[project]
+name = "alpaca-stubs"
+version = "0.1.0"
+description = "Libraries for ALPACA 2.0 - NB2420 Electronic Instrumentation"
+readme = "README.md"
+requires-python = ">=3.14"
+license = "CC-BY-4.0"
+
+[build-system]
+requires = [ "setuptools>=61",]
+build-backend = "setuptools.build_meta"
+
+[tool.setuptools]
+packages = [ "dac", "version", "link", "helper", "command", "utime",]
+
+[tool.setuptools.package-data]
+dac = [ "*.pyi",]
+version = [ "*.pyi",]
+link = [ "*.pyi",]
+helper = [ "*.pyi",]
+command = [ "*.pyi",]
+utime = [ "*.pyi",]

alpaca_stubs-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

alpaca_stubs-0.1.0/utime/__init__.pyi

@@ -0,0 +1,11 @@
+from typing import Any
+
+def sleep(seconds: float) -> None: ...
+def sleep_ms(ms: int) -> None: ...
+def sleep_us(us: int) -> None: ...
+
+# Include any other native time elements you use so they don't break
+def ticks_ms() -> int: ...
+def ticks_diff(ticks1: int, ticks2: int) -> int: ...
+def ticks_add(ticks1: int, ticks2: int) -> int: ...
+def ticks_us() -> int: ...

alpaca_stubs-0.1.0/version/__init__.pyi

@@ -0,0 +1 @@
+ALPACA_FW_VER: str