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 fe57912c2a Add unit tests for SinkConfig 100% statement coverage for the SinkConfig class, except for __repr__ which is mostly for debugging anyway.		7 år sedan
pdbuddy	Documented the parameter to SinkConfig.from_text	7 år sedan
test_pdbuddy	Add unit tests for SinkConfig	7 år sedan
.gitignore	Initial commit	7 år sedan
LICENSE	Added a simple PD Buddy Sink configuration library	7 år sedan
README.rst	Support Python 2.7	7 år sedan

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 2.7, 3.6
-  pySerial >= 3.0
-  aenum >= 2.0 (if using Python < 3.6)

README.rst