init

Author: vascop

MIT-license.txt

@@ -0,0 +1,19 @@
+Copyright (c) 2009-2010 Akash Manohar J <[email protected]>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

README.md

@@ -0,0 +1,68 @@
+# Python Arduino Prototyping API v2
+
+This is a project based on the original [Python Arduino Prototyping API](https://github.com/HashNuke/Python-Arduino-Prototyping-API).
+I started a fork and after a while the whole thing was getting too different to make a pull request so I just put it here.
+The old project had wierd things going on to handle the communication, where I rely on parseInt() to do the work for me.
+There were also problems with analogWrite(), which is working in this version. 
+
+Major changes:
+- .pde is completely redone
+- Small changes in the arduino.py file
+- Added examples
+
+Here follows the original README:
+
+> &copy; 2009-2010 Akash Manohar J <[email protected]>
+> under the MIT License
+
+The Python Arduino Prototyping API helps you to quickly prototype Arduino programs,
+without having to repeatedly load the program to the Arduino board.
+
+#### Setup:
+
+1. Load prototype.pde onto your Arduino dev board.
+2. Import the arduino lib in your python script.
+
+
+## Methods
+
+*Arduino.output(list_of_output_pins)* - set the output pins
+
+**Digital I/O**
+
+1. *Arduino.setHigh(pin_number)*
+2. *Arduino.setLow(pin_number)*
+3. *Arduino.getState(pin_number)*
+4. *Arduino.getState()* - returns true if pin state is high, else it returns false.
+
+**Analog I/O**
+
+1. *Arduino.analogRead(pin_number)* - returns the analog value
+2. *Arduino.analogWrite(pin_number, value)* - sets the analog value
+
+**Misc**
+
+1.) *Arduino.turnOff()* - sets all the pins to low state
+
+2.) *Arduino.close()* - closes serial connection. Using this makes sure that you won't have to disconnect & reconnect the Arduino again to recover the serial port.
+
+## Usage example
+
+        from arduino import Arduino
+        import time
+
+        b = Arduino('/dev/ttyUSB0')
+        pin = 9
+
+        #declare output pins as a list/tuple
+        b.output([pin])
+
+        for xrange(10):
+            b.setHigh(pin)
+            time.sleep(1)
+            print b.getState(pin)
+            b.setLow(pin)
+            print b.getState(pin)
+            time.sleep(1)
+
+        b.close()

arduino/__init__.py

@@ -0,0 +1,4 @@
+#!/usr/bin/env python
+
+from arduino import *
+

arduino/arduino.py

@@ -0,0 +1,71 @@
+#!/usr/bin/env python
+
+import serial
+
+class Arduino(object):
+
+    __OUTPUT_PINS = -1
+
+    def __init__(self, port, baudrate=115200):
+        self.serial = serial.Serial(port, baudrate)
+
+    def __str__(self):
+        return "Arduino is on port %s at %d baudrate" %(self.serial.port, self.serial.baudrate)
+
+    def output(self, pinArray):
+        self.__sendData(len(pinArray))
+
+        if(isinstance(pinArray, list) or isinstance(pinArray, tuple)):
+            self.__OUTPUT_PINS = pinArray
+            for each_pin in pinArray:
+                self.__sendData(each_pin)
+        return True
+
+    def setLow(self, pin):
+        self.__sendData('0')
+        self.__sendData(pin)
+        return True
+
+    def setHigh(self, pin):
+        self.__sendData('1')
+        self.__sendData(pin)
+        return True
+
+    def getState(self, pin):
+        self.__sendData('2')
+        self.__sendData(pin)
+        return self.__formatPinState(self.__getData()[0])
+
+    def analogWrite(self, pin, value):
+        self.__sendData('3')
+        self.__sendData(pin)
+        self.__sendData(value)
+        return True
+
+    def analogRead(self, pin):
+        self.__sendData('4')
+        self.__sendData(pin)
+        return self.__getData()
+
+    def turnOff(self):
+        for each_pin in self.__OUTPUT_PINS:
+            self.setLow(each_pin)
+        return True
+
+    def __sendData(self, serial_data):
+        while(self.__getData()[0] != "w"):
+            pass
+        self.serial.write(str(serial_data))
+
+    def __getData(self):
+        return self.serial.readline().rstrip('\n')
+
+    def __formatPinState(self, pinValue):
+        if pinValue == '1':
+            return True
+        else:
+            return False
+
+    def close(self):
+        self.serial.close()
+        return True

prototype.pde

@@ -0,0 +1,38 @@
+void setup() {
+    Serial.begin(115200);
+    Serial.setTimeout(5);
+
+    int cmd = readData();
+    for (int i = 0; i < cmd; i++) {
+        pinMode(readData(), OUTPUT);
+    }
+}
+
+void loop() {
+    switch (readData()) {
+        case 0 :
+            //set digital low
+            digitalWrite(readData(), LOW); break;
+        case 1 :
+            //set digital high
+            digitalWrite(readData(), HIGH); break;
+        case 2 :
+            //get digital value
+            Serial.println(digitalRead(readData())); break;
+        case 3 :
+            // set analog value
+            analogWrite(readData(), readData()); break;
+        case 4 :
+            //read analog value
+            Serial.println(analogRead(readData()));
+    }
+}
+
+char readData() {
+    Serial.println("w");
+    while(1) {
+        if(Serial.available() > 0) {
+            return Serial.parseInt();
+        }
+    }
+}

sample_analogread.py

@@ -0,0 +1,12 @@
+from arduino import Arduino
+import time
+
+b = Arduino('/dev/ttyUSB0')
+pin = 1
+
+b.output([])
+
+while (True):
+    val = b.analogRead(pin)
+    print val
+    time.sleep(0.5)

sample_analogwrite.py

@@ -0,0 +1,22 @@
+from arduino import Arduino
+import time
+
+b = Arduino('/dev/ttyUSB0')
+pin = 9
+
+#declare output pins as a list/tuple
+b.output([pin])
+
+brightness = 0
+fadeAmount = 3
+
+b.output([pin])
+
+while (True):
+    b.analogWrite(pin, brightness)
+    time.sleep(0.05)
+    print b.analogRead(pin)
+    brightness = brightness + fadeAmount
+
+    if (brightness == 0 or brightness == 255):
+        fadeAmount = -fadeAmount

sample_blink.py

@@ -0,0 +1,20 @@
+from arduino import Arduino
+import time
+
+b = Arduino('/dev/ttyUSB0')
+pin = 9
+
+#declare output pins as a list/tuple
+b.output([pin])
+
+
+for xrange(10):
+    b.setHigh(pin)
+    time.sleep(1)
+    print b.getState(pin)
+    b.setLow(pin)
+    print b.getState(pin)
+    time.sleep(1)
+
+b.close()
+