Giter VIP home page Giter VIP logo

python-aardvark's Introduction

Python binding for Total Phase Aardvark

BuildStatus PyPiVersion Python versions

The Total Phase Aardvark is an USB I2C/SPI host adapter.

Rationale

The manufacturer already provides an python binding. So why a new one? This is correct, but the python binding you can find in the aardvark-linux-api package is very C oriented. Eg. you need to pass arrays as method parameters, which are then modified by the binding. Instead, this binding tries to be more pythonic.

Features

  • simple interface
  • CLI tool for easy testing
  • I2C and SPI support
  • support for control signals like target power and internal I2C pullups
  • rudimental I2C slave support
  • Support for Linux, Windows and OSX

(Still) Missing Features

  • more documentation (please bear with me)
  • GPIO support

Documentation

You can find the most up to date documentation at: http://pyaardvark.rtfd.org

Requirements

You need an either a x86 or an amd64 machine. This is because the binding uses a binary-only module supplied by the manufacturer, Total Phase. Linux, Windows, and OSX is supported.

Contributing

Contributions are always welcome. You may send patches directly (eg. git send-email), do a github pull request or just file an issue.

If you are doing code changes or additions please:

  • respect the coding style (eg. PEP8),
  • provide well-formed commit message (see this blog post.)
  • add a Signed-off-by line (eg. git commit -s)

License

This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version.

This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.