Skip to content
This repository has been archived by the owner on Dec 9, 2023. It is now read-only.
/ pyfirmata Public archive
forked from 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.

License

Notifications You must be signed in to change notification settings

mrmolybdaen/pyfirmata

 
 

Repository files navigation

pyFirmata

Warning

This project just recreated ale-novo's fix for use of pullup modes of digital inputs by copying an existing installation and merging it into a fork of the original pyFirmata repo. The project is not under development. Thanks to https://github.com/tino/pyFirmata tino! Thanks to https://github.com/ale-novo/ ale-novo!

Your work is awesome!

Note

I will do a C based rewrite at some time which will then be available for Raspberry Pi and amd64.

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.

Test & coverage status:

.. ![https://travis-ci.org/tino/pyFirmata.png?branch=master!](target: https://travis-ci.org/tino/pyFirmata)

.. https://coveralls.io/repos/github/tino/pyFirmata/badge.svg?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

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:

About

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.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Python 100.0%