Skip to content
This repository has been archived by the owner on Mar 28, 2020. It is now read-only.

Commit

Permalink
1.56 Changes to reset - removed delay and turn off tone.
Browse files Browse the repository at this point in the history
  • Loading branch information
MrYsLab authored and MrYsLab committed Apr 14, 2014
1 parent bfd50e2 commit 904d399
Show file tree
Hide file tree
Showing 2 changed files with 65 additions and 37 deletions.
100 changes: 64 additions & 36 deletions README.md
@@ -1,5 +1,69 @@
PyMata
======

What is PyMata ?
--------------

Harness the raw power of Standard Firmata without having to master the complexities of Standard Firmata's communication protocol. The PyMata class library is an easy to use, high performance abstraction layer for Standard Firmata. A fully documented, straight forward API is provided so that you can quickly code your application.

Epydoc generated API documentation is provided in html format. The source code is fully commented to help make extending PyMata a straight forward task.


Fully commented example applications are provided to help accelerate your development efforts.

Before using PyMata, PySerial needs to be installed. PySerial installation instructions may be found at http://pyserial.sourceforge.net/.

Two enhanced versions of the StandardFirmata sketch are included:

For support of the HC-SRO4 Sonar distance sensor, an Arduino sketch called FirmataPlus is included. This sketch adds Sonar and Tone support to the StandardFirmata command set.

1. It requires the NewPing library available here: https://code.google.com/p/arduino-new-ping/

Please read the instructions on https://code.google.com/p/arduino-new-ping/wiki/HELP_Error_Vector_7_When_Compiling to make sure you do not have compilation errors with this library.

2. The "NotSoStandard" Firmata sketch supports the CodeShield on the UNO board. It adds tone generation and rotary encoder support functionality. NOTE: currently, rotary encoder support is not available for the Arduino Leonardo. To install the libraries in Arduino for rotary encoder support, please visit these links:

http://code.google.com/p/adaencoder/

http://code.google.com/p/oopinchangeint/



Included Examples
-----------------

pymata_basics - a simple client application to communicate with an Arduino board.

pymata_i2c_write - this contains both a control layer for the Adafruit Bi-Color 8x8 LED Matrix and a demo program.

pymata_i2c_read - a demo program to read from a SparkFun TMP102 Breakout temperature device.

pymata_software_data_latch - demo program that illustrates the use of the data latching feature.

pymata_ping_config_and_read - a demo program for the Mega 2650 that configures and monitors 4 HC-SR04 modules while simultaneously controlling 8 leds. This program can be easily modified to work on a board with less pins.


When Importing Standard PyMata, Use This Import Line
---------------------------
from PyMata.pymata import PyMata




VERSION HISTORY
---------------

Version 1.56 April 14, 2014
------------
This is a bug fix release that affects the behavior of the reset command and provides some code cleanup.
Items changed:
1. All digital pins that have been initialized for Tone are sent TONE_NO_TONE to make sure that all active sounds
are terminated upon receipt of a reset command. The TONE_NO_TONE is sent to the Arduino before the reset
command is sent.
2. A 2 second delay that was invoked at the end of reset processing was removed. This provides better support for
s2a_fm ( https://github.com/MrYsLab/s2a_fm ).
3. White space was adjusted in all files and a deprecated has_key() was replaced with the "key in" construct.

Version 1.55
------------
This is a minor bug fix release that only affects Tone support. The duration field was not being populated
Expand Down Expand Up @@ -61,42 +125,6 @@ Two new features have been added.
Also, the entire package is now fully documented in HTML. Go to the documentation/html directory and open up index.html in your browser to view it.


What is PyMata ?
--------------

Harness the raw power of Standard Firmata without having to master the complexities of Standard Firmata's communication protocol. The PyMata class library is an easy to use, high performance abstraction layer for Standard Firmata. A fully documented, straight forward API is provided so that you can quickly code your application.

Epydoc generated API documentation is provided in html format. The source code is fully commented to help make extending PyMata a straight forward task.


Fully commented example applications are provided to help accelerate your development efforts.

Before using PyMata, PySerial needs to be installed. PySerial installation instructions may be found at http://pyserial.sourceforge.net/.

If you are CodeShield user, an enhanced version of Standard Firmata, called NotSoStandard Firmata is provided as part of this package. It adds tone generation and rotary support functionality. NOTE: currently, rotary encoder support is not available for the Arduino Leonardo. To install the libraries in Arduino for rotary encoder support, please visit these links:

http://code.google.com/p/adaencoder/

http://code.google.com/p/oopinchangeint/




Included Examples
-----------------

pymata_basics - a simple client application to communicate with an Arduino board

pymata_i2c_write - this contains both a control layer for the Adafruit Bi-Color 8x8 LED Matrix and a demo program

pymata_i2c_read - a demo program to read from a SparkFun TMP102 Breakout temperature device.

pymata_software_data_latch - demo program that illustrates the use of the data latching feature


Standard PyMata Import Line
---------------------------
from PyMata.pymata import PyMata



2 changes: 1 addition & 1 deletion setup.py
Expand Up @@ -5,7 +5,7 @@
setup(
name='PyMata',
packages=['PyMata'],
version='1.55',
version='1.56',
description="A Python Protocol Abstraction Library For Arduino Firmata",
author='Alan Yorinks',
author_email='MisterYsLab@gmail.com',
Expand Down

0 comments on commit 904d399

Please sign in to comment.