pd-buddy/pd-buddy-python: Python library for working with the PD Buddy Sink Serial Console Configuration Interface

Python library for working with the PD Buddy Sink Serial Console Configuration Interface

Clara Hobbs 43810cf6ba Added test_sink script To replace my old Sink testing system (GNU Screen and a text file with the commands to send to the Sink), I wrote a Python script that tests the Sink automatically. The only thing I have to do (assuming the test is successful) is press Enter a few times while watching a voltmeter's display. A basic testing script could be useful to other people, so I'm including it in this Python package. I have a vague plan to integrate this with Kaylee at some point so I don't even have to press Enter, but that will have to wait until Kaylee has menu support.		vor 7 Jahren
pdbuddy	Added test_sink script	vor 7 Jahren
test_pdbuddy	Support the new typec_virtual PDO	vor 7 Jahren
.gitignore	Initial commit	vor 7 Jahren
LICENSE	Added a simple PD Buddy Sink configuration library	vor 7 Jahren
README.rst	Added get_source_cap and PDO support	vor 7 Jahren
setup.py	Bump version number to 0.4.2	vor 7 Jahren

pd-buddy-python
===============

Python library for working with the PD Buddy Sink Serial Console
Configuration Interface

Features
--------

-  Provides a Pythonic interface to the PD Buddy Sink shell commands
-  Configuration is represented as a SinkConfig object
-  SinkConfig objects can be manipulated locally and written to the
   device with one method call
-  Allows control of whether or not the output is enabled
-  Provides a Pythonic interface for reading advertised PDOs

Examples
--------

Open the first PD Buddy Sink device and read its configuration
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

::

    >>> import pdbuddy
    >>> pdbs = pdbuddy.Sink(list(pdbuddy.Sink.get_devices())[0])
    >>> pdbs.get_cfg()
    SinkConfig(status=<SinkStatus.VALID: 2>, flags=<SinkFlags.NONE: 0>, v=5000, i=3000)
    >>> print(pdbs.get_cfg())
    status: valid
    flags: (none)
    v: 5.00 V
    i: 3.00 A

Locally manipulate a SinkConfig object
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

::

    >>> cfg = pdbs.get_cfg()
    >>> cfg = cfg._replace(v=20000, i=2250)
    >>> cfg = cfg._replace(flags=cfg.flags | pdbuddy.SinkFlags.GIVEBACK)
    >>> cfg
    SinkConfig(status=<SinkStatus.VALID: 2>, flags=<SinkFlags.GIVEBACK: 1>, v=20000, i=2250)

Write the SinkConfig object to flash
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

::

    >>> pdbs.set_tmpcfg(cfg)
    >>> pdbs.write()
    >>> pdbs.get_cfg()
    SinkConfig(status=<SinkStatus.VALID: 2>, flags=<SinkFlags.GIVEBACK: 1>, v=20000, i=2250)

Requirements
------------

-  Python 2.7, >= 3.3
-  pySerial >= 3.0
-  aenum >= 2.0 (if using Python < 3.6)

Testing
-------

To run the unit tests, run::

    $ python setup.py test

This will test the Sink class only if a PD Buddy Sink is plugged in and in
setup mode, so make sure that's the case if you're testing any changes to the
Sink class.  Also, make sure the Status LED is blinking quickly when the tests
are run, since that's the only real way to test the ``identify`` command.  Be
aware that the Sink's configuration will get clobbered by the tests.

README.rst