Extend SerialPort

[sebastianbergt]

Description
Adding software flow control parameter xonoff to SerialPort, since otherwise I could not get my current board to run with labgrid.

Checklist

• Documentation for the feature
• Tests for the feature
• The arguments and description in doc/configuration.rst have been updated

A library feature which other developers can use:

• PR has been tested (with an Orin Linux Board)
• Man pages have been regenerated

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 55.8%. Comparing base (02fa1ef) to head (ee3c5d1).
Report is 8 commits behind head on master.

✅ All tests successful. No failed tests found.

Additional details and impacted files

@@           Coverage Diff            @@
##           master   #1601     +/-   ##
========================================
- Coverage    55.8%   55.8%   -0.1%     
========================================
  Files         170     170             
  Lines       13377   13382      +5     
========================================
+ Hits         7469    7471      +2     
- Misses       5908    5911      +3     

Flag	Coverage Δ
3.10	55.8% <100.0%> (-0.1%)	⬇️
3.11	55.8% <100.0%> (-0.1%)	⬇️
3.12	55.8% <100.0%> (-0.1%)	⬇️
3.13	55.7% <100.0%> (-0.1%)	⬇️
3.9	55.8% <100.0%> (-0.1%)	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[Emantor]

Changes look good, usage.rst needs to be updated.

[sebastianbergt]

@Emantor thank you for the quick review and comment :)

Changes look good, usage.rst needs to be updated.

I am happy to update usage.rst where you see fit, but it seems to me it shall have the most simple examples to keep first time users on the right path.

[Emantor]

@Emantor thank you for the quick review and comment :)

Changes look good, usage.rst needs to be updated.

I am happy to update usage.rst where you see fit, but it seems to me it shall have the most simple examples to keep first time users on the right path.

I meant the CI failure which complains about an argument mismatch.

[sebastianbergt]

@Emantor when testing xonoff with the exporter, I am running into issues:

Could you give me a hint how to fix this, please?

add resource example_group/example_device: USBSerialPort/OrderedDict([('match', OrderedDict([('ID_VENDOR', 'FTDI'), ('ID_USB_MODEL', 'FT232R_USB_UART')])), ('speed', 115200), ('xonoff', True)])
Traceback (most recent call last):
  File "/home/labgrid/labgrid-venv/bin/labgrid-exporter", line 8, in <module>
    sys.exit(main())
  File "/home/labgrid/labgrid-venv/lib/python3.10/site-packages/labgrid/remote/exporter.py", line 1109, in main
    asyncio.run(amain(config), debug=bool(args.debug))
  File "/usr/lib/python3.10/asyncio/runners.py", line 44, in run
    return loop.run_until_complete(main)
  File "/usr/lib/python3.10/asyncio/base_events.py", line 649, in run_until_complete
    return future.result()
  File "/home/labgrid/labgrid-venv/lib/python3.10/site-packages/labgrid/remote/exporter.py", line 1032, in amain
    await exporter.run()
  File "/home/labgrid/labgrid-venv/lib/python3.10/site-packages/labgrid/remote/exporter.py", line 844, in run
    await self.add_resource(group_name, resource_name, cls, params)
  File "/home/labgrid/labgrid-venv/lib/python3.10/site-packages/labgrid/remote/exporter.py", line 1003, in add_resource
    res = group[resource_name] = export_cls(
  File "<attrs generated init labgrid.remote.exporter.SerialPortExport>", line 8, in __init__
  File "/home/labgrid/labgrid-venv/lib/python3.10/site-packages/labgrid/remote/exporter.py", line 200, in __attrs_post_init__
    self.local = USBSerialPort(target=None, name=None, **self.local_params)
TypeError: USBSerialPort.__init__() got an unexpected keyword argument 'xonoff'
Exception ignored in: <function SerialPortExport.__del__ at 0x7ec7decc1c60>

[Emantor]

Is the labgrid inside of your venv running with this PR? It looks like the USBSerialPort does not know the keyword argument.

[sebastianbergt]

Is the labgrid inside of your venv running with this PR? It looks like the USBSerialPort does not know the keyword argument.

Yes, I installed it from my branch like so:
pip install git+https://github.com/sebastianbergt/labgrid@feat/software-flow-control

EDIT: Found a mistake I made installing. Will try that way:

[Emantor]

Note that you can also install into a local venv via pip install -e . inside the labgrid repository, should be under development setup in the documentation.

[sebastianbergt]

Just changed the installation to venv, git clone ... and pip install.

Apparently it has the correct file, but the exporter keeps failing nevertheless, if I use the xonoff attribute :(

(labgrid-venv) labgrid@testpc:~$ cat labgrid-venv/lib/python3.10/site-packages/labgrid/resource/base.py
import attr

from ..factory import target_factory
from .common import Resource


@attr.s(eq=False)
class SerialPort(Resource):
    """The basic SerialPort describes port and speed

    Args:
        port (str): port to connect to
        speed (int): speed of the port, defaults to 115200
        xonxoff (bool): software flow control, defaults to False (=off)"""
    port = attr.ib(default=None)
    speed = attr.ib(default=115200, validator=attr.validators.instance_of(int))
    xonxoff = attr.ib(default=False, validator=attr.validators.instance_of(bool))

[sebastianbergt]

Turned out to be a hard to spot typo xonoff vs xonxoff. So problem solved.