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 722782b0b0 Handle str(SinkConfig()) gracefully It would've crashed before, but now it returns "No configuration" like the command shell does.		vor 7 Jahren
pdbuddy	Handle str(SinkConfig()) gracefully	vor 7 Jahren
.gitignore	Initial commit	vor 7 Jahren
LICENSE	Added a simple PD Buddy Sink configuration library	vor 7 Jahren
README.rst	Convert README to reStructuredText	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

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, flags=SinkFlags.NONE, 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.v = 20000
    >>> cfg.i = 2250
    >>> cfg.flags |= pdbuddy.SinkFlags.GIVEBACK
    >>> cfg
    SinkConfig(status=SinkStatus.VALID, flags=SinkFlags.GIVEBACK, v=20000, i=2250)

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

::

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

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

-  Python >= 3.6
-  pySerial >= 3.0

README.rst