adafruit / adafruit_circuitpython_tfmini Goto Github PK

There are missing type annotations for some functions in this library.

The typing module does not exist on CircuitPython devices so the import needs to be wrapped in try/except to catch the error for missing import. There is an example of how that is done here:

try:
    from typing import List, Tuple
except ImportError:
    pass

Once imported the typing annotations for the argument type(s), and return type(s) can be added to the function signature. Here is an example of a function that has had this done already:

def wrap_text_to_pixels(
    string: str, max_width: int, font=None, indent0: str = "", indent1: str = ""
) -> List[str]:

If you are new to Git or Github we have a guide about contributing to our projects here: https://learn.adafruit.com/contribute-to-circuitpython-with-git-and-github

There is also a guide that covers our CI utilities and how to run them locally to ensure they will pass in Github Actions here: https://learn.adafruit.com/creating-and-sharing-a-circuitpython-library/check-your-code In particular the pages: Sharing docs on ReadTheDocs and Check your code with pre-commit contain the tools to install and commands to run locally to run the checks.

If you are attempting to resolve this issue and need help, you can post a comment on this issue and tag both @FoamyGuy and @kattni or reach out to us on Discord: https://adafru.it/discord in the #circuitpython-dev channel.

The following locations are reported by mypy to be missing type annotations:

• adafruit_tfmini.py:48
• adafruit_tfmini.py:100
• adafruit_tfmini.py:105

I'm trying to connect a TFMini to a Feather S2 (with an Ethernet hat if relevant). I'm using busio, with code roughly in-line with the example in the readthedocs.

When processing the mode setting line, the tfmini library successfully sends _STARTCONFIG, but fails to fully receive _STARTREPLY. Specifically, everything works on the first boot from power-off, but after resetting the S2 by saving an updated code.py it will only read the first 3-6 bytes of _STARTREPLY (the number varies with each reset). Powering down the tfmini alone for ~10s appears to sometimes reset things back to a working state.

I assumed it might be a timing issue and tried modifying the library to continue reading until hitting the timeout (which I raised to ~10s), but self._uart.read(1) continued to return None.

I flailed around a bit, among other things putting the line tfmini.mode = adafruit_tfmini.MODE_SHORT in a loop, catching the RuntimeException and trying again. Then I noticed that the next call to _set_config would read off the remaining header bytes (before the 0x42 start byte from the next header). There seems to be some sort of buffering going on, but I can't tell if it's coming from the device or the uart library though. Apologies if this issue belongs on the main circuitpython tracker.