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 af836b08d0 Made SinkConfig a collections.namedtuple Since it's a class used for little more than storage, with no interesting non-magic instance methods, it makes sense for SinkConfig to be a namedtuple. The rest of its code was mostly just boilerplate, after all. What remains makes it do everything we need with only slight changes to its behavior (most notably, SinkConfig must be instantiated with all its arguments now).		преди 7 години
pdbuddy	Made SinkConfig a collections.namedtuple	преди 7 години
test_pdbuddy	Made SinkConfig a collections.namedtuple	преди 7 години
.gitignore	Initial commit	преди 7 години
LICENSE	Added a simple PD Buddy Sink configuration library	преди 7 години
README.rst	Update version number	преди 7 години
setup.py	Bump version number to 0.2.1	преди 7 години

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.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