Skip to content

Commit adb0f6a

Browse files
author
Akash Xavier
committed
First commit
0 parents  commit adb0f6a

File tree

4 files changed

+315
-0
lines changed

4 files changed

+315
-0
lines changed

‎README‎

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
Python Arduino Prototyping API (version: 0.1)
2+
=====================================================
3+
4+
The Python Arduino Prototyping API helps you to quickly prototype Arduino programs without having to repeatedly load the program to the Arduino board.
5+
6+
Setup:
7+
1.) Load prototype.pde onto your Arduino dev board.
8+
2.) Import the arduino lib in your python script.
9+
10+
-----------------------------------------------------
11+
METHODS:
12+
-----------------------------------------------------
13+
14+
Arduino.output(list_of_output_pins)
15+
16+
Digital I/O functions:
17+
1.) Arduino.setHigh(pin_number)
18+
2.) Arduino.setLow(pin_number)
19+
3.) Arduino.getState(pin_number)
20+
getState() returns true if pin state is high, else it returns false.
21+
22+
Analog I/O functions:
23+
1.) Arduino.analogRead(pin_number)
24+
returns the analog value
25+
2.) Arduino.analogRead(pin_number, value)
26+
sets the analog value
27+
28+
Misc functions:
29+
1.) Arduino.turnOff()
30+
sets all the pins to low state
31+
2.) Arduino.close()
32+
closes serial connection. Using this makes sure that you won't have to disconnect & reconnect the Arduino again to recover the serial port.
33+
34+
-----------------------------------------------------
35+
USAGE EXAMPLE:
36+
-----------------------------------------------------
37+
#the blink program
38+
39+
#import the lib
40+
from arduino import Arduino
41+
42+
import time
43+
44+
#specify the port as an ardument
45+
my_board = Arduino('/dev/ttyUSB1')
46+
47+
#declare output pins as a list/tuple
48+
my_board.output([11,12,13])
49+
50+
#perform operations
51+
i=0
52+
while(i<10):
53+
my_board.setHigh(13)
54+
time.sleep(1)
55+
my_board.setLow(13)
56+
i+=1

‎arduino/__init__.py‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
#!/usr/bin/env python
2+
3+
"""
4+
Arduino API Library is an API layer to quickly prototype ideas using the Arduino.
5+
Copyright (C) 2009 Akash Xavier <akashmanohar@gmail.com>
6+
7+
This program is free software: you can redistribute it and/or modify
8+
it under the terms of the GNU General Public License as published by
9+
the Free Software Foundation, either version 3 of the License, or
10+
(at your option) any later version.
11+
12+
This program is distributed in the hope that it will be useful,
13+
but WITHOUT ANY WARRANTY; without even the implied warranty of
14+
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15+
GNU General Public License for more details.
16+
17+
You should have received a copy of the GNU General Public License
18+
along with this program. If not, see <http://www.gnu.org/licenses/>.
19+
"""
20+
21+
VERSION = '0.5'
22+
23+
from arduino import *
24+

‎arduino/arduino.py‎

Lines changed: 104 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,104 @@
1+
#!/usr/bin/env python
2+
3+
"""
4+
Arduino API Library is an API layer to quickly prototype ideas using the Arduino.
5+
Copyright (C) 2009 Akash Xavier <akashmanohar@gmail.com>
6+
7+
This program is free software: you can redistribute it and/or modify
8+
it under the terms of the GNU General Public License as published by
9+
the Free Software Foundation, either version 3 of the License, or
10+
(at your option) any later version.
11+
12+
This program is distributed in the hope that it will be useful,
13+
but WITHOUT ANY WARRANTY; without even the implied warranty of
14+
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15+
GNU General Public License for more details.
16+
17+
You should have received a copy of the GNU General Public License
18+
along with this program. If not, see <http://www.gnu.org/licenses/>.
19+
"""
20+
21+
import serial, time
22+
23+
class Arduino:
24+
25+
__OUTPUT_PINS = -1
26+
27+
def __init__(self, port, baudrate=115200):
28+
self.serial = serial.Serial(port, baudrate)
29+
30+
def __str__(self):
31+
return "Arduino is on port %s at %d baudrate" %(self.serial.port, self.serial.baudrate)
32+
33+
def output(self, pinArray):
34+
self.__sendData(len(pinArray))
35+
36+
if(isinstance(pinArray, list) or isinstance(pinArray, tuple)):
37+
self.__OUTPUT_PINS = pinArray
38+
for each_pin in pinArray:
39+
self.__sendPin(each_pin)
40+
return True
41+
42+
def setLow(self, pin):
43+
self.__sendData('0')
44+
self.__sendPin(pin)
45+
return True
46+
47+
def setHigh(self, pin):
48+
self.__sendData('1')
49+
self.__sendPin(pin)
50+
return True
51+
52+
def getState(self, pin):
53+
self.__sendData('2')
54+
self.__sendPin(pin)
55+
return self.__formatPinState(self.__getData())
56+
57+
def analogWrite(self, pin, value):
58+
self.__sendData('3')
59+
hex_value = hex(value)[2:]
60+
if(len(hex_value)==1):
61+
self.__sendData('0')
62+
else:
63+
self.__sendData(hex_value[0])
64+
self.__sendData(hex_value[1])
65+
return True
66+
67+
def analogRead(self, pin, value):
68+
self.__sendData('4')
69+
return self.__getData()
70+
71+
def turnOff(self):
72+
for each_pin in self.__OUTPUT_PINS:
73+
self.setLow(each_pin)
74+
return True
75+
76+
def __sendPin(self, pin):
77+
pin_in_char = chr(pin+48)
78+
self.__sendData(pin_in_char)
79+
80+
def __sendData(self, serial_data):
81+
while(self.__getData()!="what"):
82+
pass
83+
self.serial.write(str(serial_data))
84+
85+
def __getData(self):
86+
return self.serial.readline().replace("\r\n","")
87+
88+
def __formatPinState(self, pinValue):
89+
if pinValue=='1':
90+
return True
91+
else:
92+
return False
93+
94+
def close(self):
95+
self.serial.close()
96+
return True
97+
98+
"""
99+
def __del__(self):
100+
#close serial connection once program ends
101+
#this fixes the problem of port getting locked or unrecoverable in some linux systems
102+
self.serial.close()
103+
"""
104+

‎prototype.pde‎

Lines changed: 131 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,131 @@
1+
// variable to store the data from the serial port
2+
int cmd = 0;
3+
4+
// command arguments
5+
int cmd_arg[2];
6+
7+
8+
void setup() {
9+
// connect to the serial port
10+
Serial.begin(115200);
11+
// confirm ready state
12+
13+
while(Serial.available()<1)
14+
{
15+
// get number of output pins and convert to int
16+
cmd = int(readData()) - 48;
17+
for(int i=0; i<cmd; i++)
18+
{
19+
cmd_arg[0] = int(readData()) - 48;
20+
pinMode(cmd_arg[0], OUTPUT);
21+
}
22+
break;
23+
}
24+
}
25+
26+
void loop()
27+
{
28+
29+
askCmd();
30+
31+
if(Serial.available()>0)
32+
{
33+
cmd = int(Serial.read()) - 48;
34+
35+
if(cmd==0) //set digital low
36+
{
37+
cmd_arg[0] = int(readData()) - 48;
38+
digitalWrite(cmd_arg[0],LOW);
39+
}
40+
41+
if(cmd==1) //set digital high
42+
{
43+
cmd_arg[0] = int(readData()) - 48;
44+
digitalWrite(cmd_arg[0],HIGH);
45+
}
46+
47+
if(cmd==2) //get digital value
48+
{
49+
cmd_arg[0] = int(readData()) - 48;
50+
cmd_arg[0] = digitalRead(cmd_arg[0]);
51+
Serial.println(cmd_arg[0]);
52+
}
53+
54+
if(cmd==3) // set analog value
55+
{
56+
Serial.println("I'm in the right place");
57+
cmd_arg[0] = int(readData()) - 48;
58+
cmd_arg[1] = readHexValue();
59+
analogWrite(cmd_arg[0],cmd_arg[1]);
60+
}
61+
62+
if(cmd==4) //read analog value
63+
{
64+
cmd_arg[0] = int(readData()) - 48;
65+
cmd_arg[0] = analogRead(cmd_arg[0]);
66+
Serial.println(cmd_arg[0]);
67+
}
68+
}
69+
}
70+
71+
char readData()
72+
{
73+
askData();
74+
75+
while(1)
76+
{
77+
if(Serial.available()>0)
78+
{
79+
return Serial.read();
80+
}
81+
}
82+
}
83+
84+
85+
//read hex value from serial and convert to integer
86+
int readHexValue()
87+
{
88+
int strval[2];
89+
int converted_str;
90+
91+
while(1)
92+
{
93+
if(Serial.available()>0)
94+
{
95+
strval[0] = convert_hex_to_int(Serial.read());
96+
break;
97+
}
98+
}
99+
100+
askData();
101+
102+
while(1)
103+
{
104+
if(Serial.available()>0)
105+
{
106+
strval[1] = convert_hex_to_int(Serial.read());
107+
break;
108+
}
109+
}
110+
111+
converted_str = (strval[0]*16) + strval[1];
112+
return converted_str;
113+
}
114+
115+
int convert_hex_to_int(char c)
116+
{
117+
return (c <= '9') ? c-'0' : c-'a'+10;
118+
}
119+
120+
void askData()
121+
{
122+
Serial.println("what");
123+
}
124+
125+
void askCmd()
126+
{
127+
askData();
128+
while(Serial.available()<=0)
129+
{}
130+
}
131+

0 commit comments

Comments
 (0)