Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tino/pyFirmata
Python interface for the Firmata (http://firmata.org/) protocol. It is compliant with Firmata 2.1. Any help with updating to 2.2 is welcome. The Capability Query is implemented, but the Pin State Query feature not yet.
https://github.com/tino/pyFirmata
Last synced: 3 months ago
JSON representation
Python interface for the Firmata (http://firmata.org/) protocol. It is compliant with Firmata 2.1. Any help with updating to 2.2 is welcome. The Capability Query is implemented, but the Pin State Query feature not yet.
- Host: GitHub
- URL: https://github.com/tino/pyFirmata
- Owner: tino
- License: mit
- Created: 2012-08-09T15:31:33.000Z (over 12 years ago)
- Default Branch: master
- Last Pushed: 2024-06-06T10:40:30.000Z (5 months ago)
- Last Synced: 2024-07-31T11:24:21.230Z (3 months ago)
- Language: Python
- Homepage:
- Size: 158 KB
- Stars: 573
- Watchers: 41
- Forks: 192
- Open Issues: 65
-
Metadata Files:
- Readme: README.rst
- Changelog: CHANGES.rst
- License: LICENSE
Awesome Lists containing this project
- Awesome-arduino - pyFirmata - Python interface for the Firmata protocol (Libraries)
- awesome-arduino - pyFirmata - Python interface for the Firmata protocol (Libraries)
README
=========
pyFirmata
=========
pyFirmata is a Python interface for the `Firmata`_ protocol. It is fully
compatible with Firmata 2.1, and has some functionality of version 2.2. It runs
on Python 2.7, 3.6 and 3.7.
.. _Firmata: http://firmata.org
Test & coverage status:
.. image:: https://travis-ci.org/tino/pyFirmata.png?branch=master
:target: https://travis-ci.org/tino/pyFirmata
.. image:: https://coveralls.io/repos/github/tino/pyFirmata/badge.svg?branch=master
:target: https://coveralls.io/github/tino/pyFirmata?branch=master
Installation
============
The preferred way to install is with pip_::
pip install pyfirmata
You can also install from source with ``python setup.py install``. You will
need to have `setuptools`_ installed::
git clone https://github.com/tino/pyFirmata
cd pyFirmata
python setup.py install
.. _pip: http://www.pip-installer.org/en/latest/
.. _setuptools: https://pypi.python.org/pypi/setuptools
Usage
=====
Basic usage::
>>> from pyfirmata import Arduino, util
>>> board = Arduino('/dev/tty.usbserial-A6008rIF')
>>> board.digital[13].write(1)
To use analog ports, it is probably handy to start an iterator thread.
Otherwise the board will keep sending data to your serial, until it overflows::
>>> it = util.Iterator(board)
>>> it.start()
>>> board.analog[0].enable_reporting()
>>> board.analog[0].read()
0.661440304938
If you use a pin more often, it can be worth it to use the ``get_pin`` method
of the board. It let's you specify what pin you need by a string, composed of
'a' or 'd' (depending on wether you need an analog or digital pin), the pin
number, and the mode ('i' for input, 'o' for output, 'p' for pwm). All
seperated by ``:``. Eg. ``a:0:i`` for analog 0 as input or ``d:3:p`` for
digital pin 3 as pwm.::
>>> analog_0 = board.get_pin('a:0:i')
>>> analog_0.read()
0.661440304938
>>> pin3 = board.get_pin('d:3:p')
>>> pin3.write(0.6)
Board layout
============
If you want to use a board with a different layout than the standard Arduino
or the Arduino Mega (for which there exist the shortcut classes
``pyfirmata.Arduino`` and ``pyfirmata.ArduinoMega``), instantiate the Board
class with a dictionary as the ``layout`` argument. This is the layout dict
for the Mega for example::
>>> mega = {
... 'digital' : tuple(x for x in range(54)),
... 'analog' : tuple(x for x in range(16)),
... 'pwm' : tuple(x for x in range(2,14)),
... 'use_ports' : True,
... 'disabled' : (0, 1, 14, 15) # Rx, Tx, Crystal
... }
Todo
====
The next things on my list are to implement the new protocol changes in
firmata:
- Pin State Query, which allows it to populate on-screen controls with an
accurate representation of the hardware's configuration
(http://firmata.org/wiki/Proposals#Pin_State_Query_.28added_in_version_2.2.29)