circuitpython-stubs 9.2.6__tar.gz → 9.2.8__tar.gz

{circuitpython_stubs-9.2.6/circuitpython_stubs.egg-info → circuitpython_stubs-9.2.8}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: circuitpython-stubs
-Version: 9.2.6
+Version: 9.2.8
 Summary: PEP 561 type stubs for CircuitPython
 Home-page: https://github.com/adafruit/circuitpython
 Author-email: circuitpython@adafruit.com

{circuitpython_stubs-9.2.6 → circuitpython_stubs-9.2.8}/_stage/__init__.pyi

@@ -1,7 +1,7 @@
 """C-level helpers for animation of sprites on a stage
 
-The `_stage` module contains native code to speed-up the ```stage`` Library
-<https://github.com/python-ugame/circuitpython-stage>`_."""
+The `_stage` module contains native code to speed-up the ``stage``
+`library <https://github.com/python-ugame/circuitpython-stage>`_."""
 
 from __future__ import annotations
 

{circuitpython_stubs-9.2.6 → circuitpython_stubs-9.2.8}/aesio/__init__.pyi

@@ -65,8 +65,10 @@ class AES:
         """Encrypt the buffer from ``src`` into ``dest``.
 
         For ECB mode, the buffers must be 16 bytes long.  For CBC mode, the
-        buffers must be a multiple of 16 bytes, and must be equal length.  For
-        CTR mode, there are no restrictions."""
+        buffers must be a multiple of 16 bytes, and must be equal length.
+        Any included padding must conform to the required padding style for the given mode.
+        For CTR mode, there are no restrictions.
+        """
         ...
 
     def decrypt_into(self, src: ReadableBuffer, dest: WriteableBuffer) -> None:

{circuitpython_stubs-9.2.6 → circuitpython_stubs-9.2.8}/alarm/time/__init__.pyi

@@ -21,6 +21,12 @@ class TimeAlarm:
         If the given time is already in the past, then an exception is raised.
         If the sleep happens after the given time, then it will wake immediately
         due to this time alarm.
+
+        Example::
+
+          # Deep sleep for 30 seconds.
+          time_alarm = alarm.time.TimeAlarm(monotonic_time=time.monotonic() + 30)
+          alarm.exit_and_deep_sleep_until_alarms(time_alarm)
         """
         ...
     monotonic_time: float

{circuitpython_stubs-9.2.6 → circuitpython_stubs-9.2.8}/analogbufio/__init__.pyi

@@ -46,7 +46,12 @@ class BufferedIn:
         """Create a `BufferedIn` on the given pin and given sample rate.
 
         :param ~microcontroller.Pin pin: the pin to read from
-        :param ~int sample_rate: rate: sampling frequency, in samples per second"""
+        :param ~int sample_rate: rate: sampling frequency, in samples per second
+
+        **Limitations**: On many boards with a CYW43 radio module, such as Pico W,
+        GPIO29 (often ``board.A3``) is also used to control the CYW43,
+        and is therefore not available to use as the `BufferedIn` pin.
+        """
         ...
 
     def deinit(self) -> None:

{circuitpython_stubs-9.2.6 → circuitpython_stubs-9.2.8}/analogio/__init__.pyi

@@ -87,6 +87,9 @@ class AnalogOut:
 
     **Limitations:** Not available on Nordic, RP2040, Spresense, as there is no on-chip DAC.
     On Espressif, available only on ESP32 and ESP32-S2; other chips do not have a DAC.
+    On ESP32-S2 boards, GPIO18 (DAC2) is often connected to a pull-up resistor, which causes
+    `unexpected output values in the lower part of the output range
+    <https://github.com/adafruit/circuitpython/issues/7871>`_.
 
     Example usage::
 

{circuitpython_stubs-9.2.6 → circuitpython_stubs-9.2.8}/audioio/__init__.pyi

@@ -34,11 +34,16 @@ class AudioOut:
         """Create a AudioOut object associated with the given pin(s). This allows you to
         play audio signals out on the given pin(s).
 
-        :param ~microcontroller.Pin left_channel: The pin to output the left channel to
-        :param ~microcontroller.Pin right_channel: The pin to output the right channel to
+        :param ~microcontroller.Pin left_channel: Output left channel data to this pin
+        :param ~microcontroller.Pin right_channel: Output right channel data to this pin. May be ``None``.
         :param int quiescent_value: The output value when no signal is present. Samples should start
             and end with this value to prevent audible popping.
 
+        .. note:: On ESP32 and ESP32-S2, the DAC channels are usually designated
+          as ``DAC_1`` (right stereo channel) and DAC_2 (left stereo channel).
+          These pins are sometimes labelled as ``A0`` and ``A1``, but they may be assigned
+          in either order. Check your board's pinout to verify which pin is which channel.
+
         Simple 8ksps 440 Hz sin wave::
 
           import audiocore

{circuitpython_stubs-9.2.6 → circuitpython_stubs-9.2.8}/board_definitions/42keebs_frood/__init__.pyi

@@ -54,6 +54,8 @@ D13: microcontroller.Pin  # GPIO13
 D14: microcontroller.Pin  # GPIO14
 D15: microcontroller.Pin  # GPIO15
 D16: microcontroller.Pin  # GPIO16
+D10: microcontroller.Pin  # GPIO10
+D11: microcontroller.Pin  # GPIO11
 LED: microcontroller.Pin  # GPIO17
 D17: microcontroller.Pin  # GPIO17
 VBUS_SENSE: microcontroller.Pin  # GPIO19

{circuitpython_stubs-9.2.6 → circuitpython_stubs-9.2.8}/board_definitions/adafruit_fruit_jam/__init__.pyi

@@ -32,10 +32,10 @@ D8: microcontroller.Pin  # GPIO8
 D9: microcontroller.Pin  # GPIO9
 D10: microcontroller.Pin  # GPIO10
 LED: microcontroller.Pin  # GPIO29
-BUTTON: microcontroller.Pin  # GPIO0
+BUTTON1: microcontroller.Pin  # GPIO0
 BOOT: microcontroller.Pin  # GPIO0
-BUTTON1: microcontroller.Pin  # GPIO4
-BUTTON2: microcontroller.Pin  # GPIO5
+BUTTON2: microcontroller.Pin  # GPIO4
+BUTTON3: microcontroller.Pin  # GPIO5
 SDA: microcontroller.Pin  # GPIO20
 SCL: microcontroller.Pin  # GPIO21
 SCK: microcontroller.Pin  # GPIO30

{circuitpython_stubs-9.2.6 → circuitpython_stubs-9.2.8}/board_definitions/heltec_esp32s3_wifi_lora_v3/__init__.pyi

@@ -7,7 +7,7 @@ Board stub for Heltec ESP32-S3-WIFI-LoRa-V3
  - board_id: heltec_esp32s3_wifi_lora_v3
  - NVM size: 8192
  - Included modules: _asyncio, _bleio, _eve, _pixelmap, adafruit_bus_device, adafruit_pixelbuf, aesio, alarm, analogbufio, analogio, array, atexit, audiobusio, audiocore, audiomixer, audiomp3, binascii, bitbangio, bitmapfilter, bitmaptools, board, builtins, builtins.pow3, busdisplay, busio, busio.SPI, busio.UART, canio, codeop, collections, countio, digitalio, displayio, dualbank, epaperdisplay, errno, espidf, espnow, espulp, fontio, fourwire, framebufferio, frequencyio, getpass, gifio, hashlib, i2cdisplaybus, io, ipaddress, jpegio, json, keypad, keypad.KeyMatrix, keypad.Keys, keypad.ShiftRegisterKeys, keypad_demux, keypad_demux.DemuxKeyMatrix, locale, math, max3421e, mdns, memorymap, microcontroller, msgpack, neopixel_write, nvm, onewireio, os, os.getenv, paralleldisplaybus, ps2io, pulseio, pwmio, rainbowio, random, re, rgbmatrix, rotaryio, rtc, sdcardio, sdioio, select, sharpdisplay, socketpool, socketpool.socketpool.AF_INET6, ssl, storage, struct, supervisor, synthio, sys, terminalio, tilepalettemapper, time, touchio, traceback, ulab, usb, vectorio, warnings, watchdog, wifi, zlib
- - Frozen libraries: adafruit_display_shapes, adafruit_display_text, adafruit_rfm9x
+ - Frozen libraries: adafruit_display_shapes, adafruit_display_text
 """
 
 # Imports

{circuitpython_stubs-9.2.6 → circuitpython_stubs-9.2.8}/board_definitions/waveshare_esp32_s3_geek/__init__.pyi

@@ -74,7 +74,7 @@ def I2C() -> busio.I2C:
     The object created is a singleton, and uses the default parameter values for `busio.I2C`.
     """
 
-def SD_SPI() -> busio.SPI:
+def LCD_SPI() -> busio.SPI:
     """Returns the `busio.SPI` object for the board's designated SPI bus(es).
     The object created is a singleton, and uses the default parameter values for `busio.SPI`.
     """

circuitpython_stubs-9.2.8/board_definitions/waveshare_esp32_s3_touch_lcd_2/__init__.pyi

@@ -0,0 +1,102 @@
+# SPDX-FileCopyrightText: 2024 Justin Myers
+#
+# SPDX-License-Identifier: MIT
+"""
+Board stub for Waveshare ESP32S3 Touch LCD 2
+ - port: espressif
+ - board_id: waveshare_esp32_s3_touch_lcd_2
+ - NVM size: 8192
+ - Included modules: _asyncio, _bleio, _eve, _pixelmap, adafruit_bus_device, adafruit_pixelbuf, aesio, alarm, analogbufio, analogio, array, atexit, audiobusio, audiocore, audiomixer, audiomp3, binascii, bitbangio, bitmapfilter, bitmaptools, board, builtins, builtins.pow3, busdisplay, busio, busio.SPI, busio.UART, canio, codeop, collections, countio, digitalio, displayio, dualbank, epaperdisplay, errno, espcamera, espidf, espnow, espulp, fontio, fourwire, framebufferio, frequencyio, getpass, gifio, hashlib, i2cdisplaybus, io, ipaddress, jpegio, json, keypad, keypad.KeyMatrix, keypad.Keys, keypad.ShiftRegisterKeys, keypad_demux, keypad_demux.DemuxKeyMatrix, locale, math, max3421e, mdns, memorymap, microcontroller, msgpack, neopixel_write, nvm, onewireio, os, os.getenv, paralleldisplaybus, ps2io, pulseio, pwmio, qrio, rainbowio, random, re, rgbmatrix, rotaryio, rtc, sdcardio, sdioio, select, sharpdisplay, socketpool, socketpool.socketpool.AF_INET6, ssl, storage, struct, supervisor, synthio, sys, terminalio, tilepalettemapper, time, touchio, traceback, ulab, usb, usb_cdc, usb_hid, usb_midi, vectorio, warnings, watchdog, wifi, zlib
+ - Frozen libraries: 
+"""
+
+# Imports
+import busio
+import displayio
+import microcontroller
+
+
+# Board Info:
+board_id: str
+
+
+# Pins:
+IO0: microcontroller.Pin  # GPIO0
+IO2: microcontroller.Pin  # GPIO2
+IO4: microcontroller.Pin  # GPIO4
+IO6: microcontroller.Pin  # GPIO6
+IO7: microcontroller.Pin  # GPIO7
+IO8: microcontroller.Pin  # GPIO8
+IO9: microcontroller.Pin  # GPIO9
+IO16: microcontroller.Pin  # GPIO16
+IO17: microcontroller.Pin  # GPIO17
+IO18: microcontroller.Pin  # GPIO18
+IO21: microcontroller.Pin  # GPIO21
+IO10: microcontroller.Pin  # GPIO10
+IO20: microcontroller.Pin  # GPIO20
+IO19: microcontroller.Pin  # GPIO19
+IO47: microcontroller.Pin  # GPIO47
+IO48: microcontroller.Pin  # GPIO48
+IO15: microcontroller.Pin  # GPIO15
+IO13: microcontroller.Pin  # GPIO13
+IO11: microcontroller.Pin  # GPIO11
+IO12: microcontroller.Pin  # GPIO12
+IO14: microcontroller.Pin  # GPIO14
+BOOT: microcontroller.Pin  # GPIO0
+BUTTON0: microcontroller.Pin  # GPIO0
+BATTERY: microcontroller.Pin  # GPIO5
+SCL: microcontroller.Pin  # GPIO47
+SDA: microcontroller.Pin  # GPIO48
+TOUCH_INT: microcontroller.Pin  # GPIO46
+IMU_INT: microcontroller.Pin  # GPIO3
+SCK: microcontroller.Pin  # GPIO39
+MOSI: microcontroller.Pin  # GPIO38
+MISO: microcontroller.Pin  # GPIO40
+LCD_DC: microcontroller.Pin  # GPIO42
+LCD_CS: microcontroller.Pin  # GPIO45
+LCD_RESET: microcontroller.Pin  # GPIO0
+LCD_BACKLIGHT: microcontroller.Pin  # GPIO1
+SD_CS: microcontroller.Pin  # GPIO41
+CAM_HREF: microcontroller.Pin  # GPIO4
+CAM_VSYNC: microcontroller.Pin  # GPIO6
+CAM_XCLK: microcontroller.Pin  # GPIO8
+CAM_PCLK: microcontroller.Pin  # GPIO9
+CAM_PWDN: microcontroller.Pin  # GPIO17
+CAM_D0: microcontroller.Pin  # GPIO12
+CAM_D1: microcontroller.Pin  # GPIO13
+CAM_D2: microcontroller.Pin  # GPIO15
+CAM_D3: microcontroller.Pin  # GPIO11
+CAM_D4: microcontroller.Pin  # GPIO14
+CAM_D5: microcontroller.Pin  # GPIO10
+CAM_D6: microcontroller.Pin  # GPIO7
+CAM_D7: microcontroller.Pin  # GPIO2
+TWI_CLK: microcontroller.Pin  # GPIO16
+TWI_SDA: microcontroller.Pin  # GPIO21
+RX: microcontroller.Pin  # GPIO44
+TX: microcontroller.Pin  # GPIO43
+
+
+# Members:
+def I2C() -> busio.I2C:
+    """Returns the `busio.I2C` object for the board's designated I2C bus(es).
+    The object created is a singleton, and uses the default parameter values for `busio.I2C`.
+    """
+
+def SPI() -> busio.SPI:
+    """Returns the `busio.SPI` object for the board's designated SPI bus(es).
+    The object created is a singleton, and uses the default parameter values for `busio.SPI`.
+    """
+
+def UART() -> busio.UART:
+    """Returns the `busio.UART` object for the board's designated UART bus(es).
+    The object created is a singleton, and uses the default parameter values for `busio.UART`.
+    """
+
+"""Returns the `displayio.Display` object for the board's built in display.
+The object created is a singleton, and uses the default parameter values for `displayio.Display`.
+"""
+DISPLAY: displayio.Display
+
+
+# Unmapped:
+#   none

{circuitpython_stubs-9.2.6 → circuitpython_stubs-9.2.8}/busio/__init__.pyi

@@ -75,6 +75,9 @@ class I2C:
             bit unpacking. Instead, use an existing driver or make one with
             :ref:`Register <register-module-reference>` data descriptors.
 
+        .. seealso:: This class provides an I2C controller, which controls I2C targets (peripherals).
+            To act as an I2C target, use `i2ctarget.I2CTarget`.
+
         :param ~microcontroller.Pin scl: The clock pin
         :param ~microcontroller.Pin sda: The data pin
         :param int frequency: The clock frequency in Hertz
@@ -212,7 +215,7 @@ class SPI:
     main device.  It is typically faster than :py:class:`~bitbangio.I2C` because a
     separate pin is used to select a device rather than a transmitted
     address. This class only manages three of the four SPI lines: `!clock`,
-    `!MOSI`, `!MISO`. Its up to the client to manage the appropriate
+    `!MOSI`, `!MISO`. It is up to the client to manage the appropriate
     select line, often abbreviated `!CS` or `!SS`. (This is common because
     multiple secondaries can share the `!clock`, `!MOSI` and `!MISO` lines
     and therefore the hardware.)
@@ -230,6 +233,8 @@ class SPI:
         </details>
         </p>
 
+    .. seealso:: This class acts as an SPI main (controller).
+        To act as an SPI secondary (target), use `spitarget.SPITarget`.
     """
 
     def __init__(

{circuitpython_stubs-9.2.6 → circuitpython_stubs-9.2.8/circuitpython_stubs.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: circuitpython-stubs
-Version: 9.2.6
+Version: 9.2.8
 Summary: PEP 561 type stubs for CircuitPython
 Home-page: https://github.com/adafruit/circuitpython
 Author-email: circuitpython@adafruit.com

{circuitpython_stubs-9.2.6 → circuitpython_stubs-9.2.8}/circuitpython_stubs.egg-info/SOURCES.txt

@@ -585,6 +585,7 @@ setup.py
 ./board_definitions/waveshare_esp32_s3_matrix/__init__.pyi
 ./board_definitions/waveshare_esp32_s3_pico/__init__.pyi
 ./board_definitions/waveshare_esp32_s3_tiny/__init__.pyi
+./board_definitions/waveshare_esp32_s3_touch_lcd_2/__init__.pyi
 ./board_definitions/waveshare_esp32_s3_zero/__init__.pyi
 ./board_definitions/waveshare_esp32s2_pico/__init__.pyi
 ./board_definitions/waveshare_rp2040_geek/__init__.pyi
@@ -1307,6 +1308,7 @@ board_definitions/waveshare_esp32_s3_lcd_1_28/__init__.pyi
 board_definitions/waveshare_esp32_s3_matrix/__init__.pyi
 board_definitions/waveshare_esp32_s3_pico/__init__.pyi
 board_definitions/waveshare_esp32_s3_tiny/__init__.pyi
+board_definitions/waveshare_esp32_s3_touch_lcd_2/__init__.pyi
 board_definitions/waveshare_esp32_s3_zero/__init__.pyi
 board_definitions/waveshare_esp32s2_pico/__init__.pyi
 board_definitions/waveshare_rp2040_geek/__init__.pyi

{circuitpython_stubs-9.2.6 → circuitpython_stubs-9.2.8}/epaperdisplay/__init__.pyi

@@ -18,7 +18,8 @@ class EPaperDisplay:
     is called. This is done so that CircuitPython can use the display itself.
 
     Most people should not use this class directly. Use a specific display driver instead that will
-    contain the startup and shutdown sequences at minimum."""
+    contain the startup and shutdown sequences at minimum.
+    """
 
     def __init__(
         self,
@@ -50,6 +51,7 @@ class EPaperDisplay:
         always_toggle_chip_select: bool = False,
         grayscale: bool = False,
         advanced_color_epaper: bool = False,
+        spectra6: bool = False,
         two_byte_sequence_length: bool = False,
         start_up_time: float = 0,
         address_little_endian: bool = False,
@@ -92,6 +94,7 @@ class EPaperDisplay:
         :param bool always_toggle_chip_select: When True, chip select is toggled every byte
         :param bool grayscale: When true, the color ram is the low bit of 2-bit grayscale
         :param bool advanced_color_epaper: When true, the display is a 7-color advanced color epaper (ACeP)
+        :param bool spectra6: When true, the display is a 6-color spectra6 epaper
         :param bool two_byte_sequence_length: When true, use two bytes to define sequence length
         :param float start_up_time: Time to wait after reset before sending commands
         :param bool address_little_endian: Send the least significant byte (not bit) of multi-byte addresses first. Ignored when ram is addressed with one byte

{circuitpython_stubs-9.2.6 → circuitpython_stubs-9.2.8}/fourwire/__init__.pyi

@@ -10,7 +10,11 @@ from circuitpython_typing import ReadableBuffer
 
 class FourWire:
     """Manage updating a display over SPI four wire protocol in the background while Python code runs.
-    It doesn't handle display initialization."""
+    It doesn't handle display initialization.
+
+    .. seealso:: See `busdisplay.BusDisplay` and `epaperdisplay.EPaperDisplay`
+        for how to initialize a display, given a `FourWire` bus.
+    """
 
     def __init__(
         self,

{circuitpython_stubs-9.2.6 → circuitpython_stubs-9.2.8}/i2cdisplaybus/__init__.pyi

@@ -10,7 +10,11 @@ from circuitpython_typing import ReadableBuffer
 
 class I2CDisplayBus:
     """Manage updating a display over I2C in the background while Python code runs.
-    It doesn't handle display initialization."""
+    It doesn't handle display initialization.
+
+    .. seealso:: See `busdisplay.BusDisplay` and `epaperdisplay.EPaperDisplay`
+        for how to initialize a display, given an `I2CDisplayBus`.
+    """
 
     def __init__(
         self,

{circuitpython_stubs-9.2.6 → circuitpython_stubs-9.2.8}/keypad/__init__.pyi

@@ -73,7 +73,8 @@ class EventQueue:
     ...
 
     def get(self) -> Optional[Event]:
-        """Return the next key transition event. Return ``None`` if no events are pending.
+        """Remove the next key transition event from the `EventQueue` and return it.
+        Return ``None`` if no events are pending.
 
         Note that the queue size is limited; see ``max_events`` in the constructor of
         a scanner such as `Keys` or `KeyMatrix`.
@@ -86,7 +87,7 @@ class EventQueue:
         ...
 
     def get_into(self, event: Event) -> bool:
-        """Store the next key transition event in the supplied event, if available,
+        """Remove the next key transition event from the ``EventQueue`, store it in ``event``,
         and return ``True``.
         If there are no queued events, do not touch ``event`` and return ``False``.
 

{circuitpython_stubs-9.2.6 → circuitpython_stubs-9.2.8}/paralleldisplaybus/__init__.pyi

@@ -10,7 +10,11 @@ from circuitpython_typing import ReadableBuffer
 class ParallelBus:
     """Manage updating a display over 8-bit parallel bus in the background while Python code runs. This
     protocol may be referred to as 8080-I Series Parallel Interface in datasheets. It doesn't handle
-    display initialization."""
+    display initialization.
+
+    .. seealso:: See `busdisplay.BusDisplay` and `epaperdisplay.EPaperDisplay`
+        for how to initialize a display, given a `ParallelBus`.
+    """
 
     def __init__(
         self,

{circuitpython_stubs-9.2.6 → circuitpython_stubs-9.2.8}/rotaryio/__init__.pyi

@@ -44,7 +44,13 @@ class IncrementalEncoder:
               position = enc.position
               if last_position == None or position != last_position:
                   print(position)
-              last_position = position"""
+              last_position = position
+
+        .. warning:: On RP2350 boards, any pulldowns used must be 8.2 kohms or less,
+           to overcome a hardware issue.
+           See the RP2350 warning in `digitalio` for more information.
+        """
+
         ...
 
     def deinit(self) -> None:

{circuitpython_stubs-9.2.6 → circuitpython_stubs-9.2.8}/setup.py

@@ -46,6 +46,6 @@ setup(
     package_data=package_data,
     package_dir = package_dir,
     setup_requires=["setuptools>=38.6.0"],
-    version="9.2.6",
+    version="9.2.8",
     zip_safe=False,
 )

{circuitpython_stubs-9.2.6 → circuitpython_stubs-9.2.8}/synthio/__init__.pyi

@@ -214,7 +214,7 @@ class LFO:
     An LFO's ``value`` property is computed once when it is constructed, and then
     when its associated synthesizer updates it.
 
-    This means that for instance an LFO **created** with ``offset=1`` has ```value==1``
+    This means that for instance an LFO **created** with ``offset=1`` has ``value==1``
     immediately, but **updating** the ``offset`` property alone does not
     change ``value``; it only updates through an association with an active synthesizer.
 

{circuitpython_stubs-9.2.6 → circuitpython_stubs-9.2.8}/watchdog/__init__.pyi

@@ -74,6 +74,17 @@ class WatchDogTimer:
         """Feed the watchdog timer. This must be called regularly, otherwise
         the timer will expire. Silently does nothing if the watchdog isn't active."""
         ...
+
+    def deinit(self) -> None:
+        """Stop the watchdog timer.
+
+        :raises RuntimeError: if the watchdog timer cannot be disabled on this platform.
+
+        .. note:: This is deprecated in ``9.0.0`` and will be removed in ``10.0.0``.
+            Set watchdog `mode` to `None` instead.
+
+        """
+        ...
     timeout: float
     """The maximum number of seconds that can elapse between calls
     to `feed()`. Setting the timeout will also feed the watchdog."""