Difference between revisions of "Userspace Arduino"

From eLinux.org
Jump to: navigation, search
 
(20 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
<div style="margin:0; margin-top:10px; margin-right:10px; border:1px solid #dfdfdf; padding:0 1em 1em 1em; background-color:#ffffcc; align:right; ">
 
<div style="margin:0; margin-top:10px; margin-right:10px; border:1px solid #dfdfdf; padding:0 1em 1em 1em; background-color:#ffffcc; align:right; ">
 +
'''GitHub page for the Userspace Arduino project:'''
 +
* [https://github.com/prpplague/Userspace-Arduino Userspace Arduino Repo]
 
'''Development Blogs for the Userspace Arduino project:'''
 
'''Development Blogs for the Userspace Arduino project:'''
 
* [http://prpplague.github.io/Energia/ Primary Blog] for work on the project  
 
* [http://prpplague.github.io/Energia/ Primary Blog] for work on the project  
Line 6: Line 8:
 
</div>
 
</div>
 
<br />
 
<br />
This page documents research on creating a userspace executable using the wiring and Processing language used with Arduino.
+
A Getting Started guide on compiling and executing "Arduino code" on embedded Linux boards.
 
<br />
 
<br />
 +
 
= Getting Started =
 
= Getting Started =
== Image ==
+
== new Debian images ==
 +
The [http://beagleboard.org/latest-images latest Debian images] for BeagleBone Black include the [https://github.com/prpplague/Userspace-Arduino Userspace Arduino libraries] and can be programmed from the Cloud9 IDE. Save the file with the extension .ino and click "Run" to build and run your sketch. To have your sketch run on bootup, drag it into the "autorun" folder.
 +
 
 +
== old-style ==
 +
Unlike the "standard" way of developing for the Arduino boards, we only have the [https://github.com/prpplague/Userspace-Arduino libraries] ready at the moment (The IDE is still under development). In short, you'll have to use your own editor for writing code.
 +
<br />Currently there are 2 methods to compile and execute Arduino code on the BeagleBone Black.
 +
# [[#native | Native compilation]]
 +
# [[#cross | Cross compilation]]
 +
 
 +
==<span id="native">Native Compilation</span>==
 +
You won't have to install any toolchain.
 +
<p> Connect to your BeagleBone Black using ssh. Make sure that you have internet access on your BBB.</p>
 +
===Clone repo===
 +
* Clone the repo from the GitHub project page
 +
git clone http://github.com/prpplague/Userspace-Arduino.git
  
=== Beaglebone Black ===
+
=== Running a demo ===
 +
Running Blink LED program:
 +
<pre>
 +
cd Userspace-Arduino/arduino-makefile/examples/BlinkUserspace
 +
make
 +
</pre>
 +
* A binary BlinkUserspace.elf should be created in a directory build-userspace
 +
cd build-userspace
 +
./BlinkUserspace.elf
 +
* You will now see USR LED 1 blinking at one second intervals. Press Ctrl-C to break from the loop.
  
The examples have been tested to work on production images later than [https://s3.amazonaws.com/angstrom/demo/beaglebone/BBB-eMMC-flasher-2013.06.20.img.xz 2013.06.20]. You will need a 4 GB (or greater) microSD card for flashing the Beaglebone Black, a process which may take well over 45 minutes. It is documented on the [http://circuitco.com/support/index.php?title=Updating_The_Software CircuitCo wiki]. If you are unsure which image is currently loaded on the Beaglebone Black, check it at [http://www.crashcourse.ca/wiki/index.php/Examining_your_BBB_install_version http://www.crashcourse.ca/wiki/index.php/Examining_your_BBB_install_version].
+
==<span id="cross">Cross Compilation</span>==
== Toolchain ==
+
===Install toolchain===
<br />
+
*You will need the Angstrom cross compilation toolchain for the BeagleBone Black.
=== BeagleBone Black ===
+
*Run the following commands on your host machine (i.e. laptop/PC)
 
<pre>
 
<pre>
 
~$ wget http://www.angstrom-distribution.org/toolchains/angstrom-2011.03-x86_64-linux-armv7a-linux-gnueabi-toolchain.tar.bz2
 
~$ wget http://www.angstrom-distribution.org/toolchains/angstrom-2011.03-x86_64-linux-armv7a-linux-gnueabi-toolchain.tar.bz2
~$ sudo tar -C / -xzf angstrom-2011.03-x86_64-linux-armv7a-linux-gnueabi-toolchain.tar.bz2
+
~$ sudo tar -C / -xjf angstrom-2011.03-x86_64-linux-armv7a-linux-gnueabi-toolchain.tar.bz2
 
~$ export PATH=/usr/local/angstrom/arm/bin:$PATH
 
~$ export PATH=/usr/local/angstrom/arm/bin:$PATH
 
~$ export CROSS_COMPILE=arm-angstrom-linux-gnueabi-
 
~$ export CROSS_COMPILE=arm-angstrom-linux-gnueabi-
 
</pre>  
 
</pre>  
 
<br />
 
<br />
 +
Links to 64 and 32 bit versions of Angstrom toolchain.
 
* [http://www.angstrom-distribution.org/toolchains/angstrom-2011.03-x86_64-linux-armv7a-linux-gnueabi-toolchain.tar.bz2 x86_64-linux-armv7a-linux-gnueabi-toolchain]
 
* [http://www.angstrom-distribution.org/toolchains/angstrom-2011.03-x86_64-linux-armv7a-linux-gnueabi-toolchain.tar.bz2 x86_64-linux-armv7a-linux-gnueabi-toolchain]
 
* [http://www.angstrom-distribution.org/toolchains/angstrom-2011.03-i686-linux-armv7a-linux-gnueabi-toolchain.tar.bz2 i686-linux-armv7a-linux-gnueabi-toolchain]
 
* [http://www.angstrom-distribution.org/toolchains/angstrom-2011.03-i686-linux-armv7a-linux-gnueabi-toolchain.tar.bz2 i686-linux-armv7a-linux-gnueabi-toolchain]
 
<br />
 
<br />
=== MinnowBoard ===
+
===Clone repo===
* todo
 
<br />
 
=== Raspberry Pi ===
 
* todo
 
<br />
 
<br />
 
== Cloning ==
 
 
* Clone the repo from https://github.com/prpplague/Userspace-Arduino
 
* Clone the repo from https://github.com/prpplague/Userspace-Arduino
 
  git clone https://github.com/prpplague/Userspace-Arduino.git
 
  git clone https://github.com/prpplague/Userspace-Arduino.git
 
<br />
 
<br />
== Running a demo ==
+
===Running a demo ===
 
<br>
 
<br>
 
Running Blink LED program:
 
Running Blink LED program:
Line 46: Line 66:
 
</pre>
 
</pre>
 
* A binary BlinkUserspace.elf should be created in a directory build-userspace
 
* A binary BlinkUserspace.elf should be created in a directory build-userspace
* [https://github.com/prpplague/Userspace-Arduino/blob/master/utility/send_exec.sh send-exec] is an upload and execute script, which is integrated with the Arduino-Userspace repository. It uses the scp protocol to copy binaries to the Beaglebone Black over USB/ethernet and execute it. You can find it in the utility folder.
+
* To upload the created binary file, do  
* To use it, simply do  
 
 
<pre>
 
<pre>
 
make upload  
 
make upload  
Line 68: Line 87:
 
Here after, you won't be prompted for a password from this machine
 
Here after, you won't be prompted for a password from this machine
 
<br />
 
<br />
 +
 +
= Examples =
 +
 +
Each of these examples have their own detailed wiki pages:
 +
 +
* [[Userspace_Arduino:BlinkUserspace|BlinkUserspace]]
 +
* [[Userspace Arduino:BlinkWithoutDelay|Blink Without Delay]]
 +
* [[Userspace Arduino:AnalogReadSerial|AnalogReadSerial]]
  
 
= Boards Supported =
 
= Boards Supported =
Line 220: Line 247:
 
* will use [[RPi_Gertboard]] for initial development
 
* will use [[RPi_Gertboard]] for initial development
 
<br />
 
<br />
= Transfer Options =
+
*[[Userspace_Arduino:To Do]]
<br />
+
*[[Userspace_Arduino:Libraries]]
== Netcat ==
 
* GNU Netcat networking tool http://netcat.sourceforge.net/
 
* Can create a  connection using nc -w 1 192.168.7.2 1114 < new.zip on the server (in this case the machine running the Energia IDE), and nc -lp 1114 > n.zip on the Beaglebone. 1114 is a random port number which has to be the same on client as well as server side.
 
* Some issue with sending .bin files directly. Mostly it was with how the file ends, not sure. So need to zip the file.
 
* Requires no authentication
 
* A script will be needed to listen on a particular port on the BBB for any incoming connections which will receive, unzip and execute the code.
 
<br />
 
== ssh/sftp ==
 
* Needs ssh and sftp installed
 
* Need to configure keys initially. Works without user authentication after that
 
* Code to upload and execute binary here : https://github.com/anujdeshpande/send_exec
 
<br />
 
== Emulating the Arduino bootloader  ==
 
* The Arduino Bootloader uses a protocol similar to STK500v1 (over UART, though)
 
* One way to program (copy) the binaries would be to emulate the protocol on the bone over USB gadget and use AVRDude on the IDE side
 
* However this would be cumbersome, since the protocol was designed to write bytes to flash memory, not copy files.
 
* Energia uses mspdebug to flash the MSP430 using a serialized version of JTAG called Spy-Bi-Wire (SBW).
 
* File transfer protocols over serial like XMODEM and ZMODEM could be explored for an easier and more compatible option to Upload the binaries.
 
* Install the lrzsz package on both the host (PC) and the client (Beaglebone):
 
apt-get install lrzsz
 
* Connect the Beaglebone via USB and determine the port (for e.g. /dev/ttyUSB1). Once the OS is booted up, start the transfer:
 
sz -vv -b filename.bin < /dev/ttyUSB1 > /dev/ttyUSB1
 
<br />
 
== HTTP post ==
 
* Send executable over port 80
 
* On BBB, listen for any uploads and execute them
 
<br />
 
= Action List and Issues  =
 
* The Arduino 1.5 IDE has better support for arbitrary architectures than the Energia fork of Arduino. This could help since the architecture specific stuff has been moved to config files. Further investigation is needed. Should the Userspace implementation forked directly out of the Arduino IDE or should the current implementation continue?
 
* For development beyond the GSOC period, an option to get this upstream needs to be considered.
 
* The BBB needs a separate FTDI cable for serial ports. However, a /dev/ttyACM port is available over USB. It can be used for uploading via the normal bootloader way. After the upload, it can be used for serial read/write to the host (PC).
 
* A single protocol to tackle uploading via USB and ethernet and may not be feasible. Networking over USB is pretty unreliable and tough for newbies to get working. For ethernet upload, several of the above options can be considered. For USB, a simple bootloader emulator will do.
 
<br />
 
 
<br />
 
<br />
 
[[Category:Arduino]]
 
[[Category:Arduino]]
Line 260: Line 254:
 
[[Category: MinnowBoard]]
 
[[Category: MinnowBoard]]
 
[[Category: BeagleBoard]]
 
[[Category: BeagleBoard]]
 +
[[Category: Userspace_Arduino]]

Latest revision as of 23:16, 18 June 2014

GitHub page for the Userspace Arduino project:

Development Blogs for the Userspace Arduino project:


A Getting Started guide on compiling and executing "Arduino code" on embedded Linux boards.

Getting Started

new Debian images

The latest Debian images for BeagleBone Black include the Userspace Arduino libraries and can be programmed from the Cloud9 IDE. Save the file with the extension .ino and click "Run" to build and run your sketch. To have your sketch run on bootup, drag it into the "autorun" folder.

old-style

Unlike the "standard" way of developing for the Arduino boards, we only have the libraries ready at the moment (The IDE is still under development). In short, you'll have to use your own editor for writing code.
Currently there are 2 methods to compile and execute Arduino code on the BeagleBone Black.

  1. Native compilation
  2. Cross compilation

Native Compilation

You won't have to install any toolchain.

Connect to your BeagleBone Black using ssh. Make sure that you have internet access on your BBB.

Clone repo

  • Clone the repo from the GitHub project page
git clone http://github.com/prpplague/Userspace-Arduino.git

Running a demo

Running Blink LED program:

cd Userspace-Arduino/arduino-makefile/examples/BlinkUserspace
make
  • A binary BlinkUserspace.elf should be created in a directory build-userspace
cd build-userspace
./BlinkUserspace.elf
  • You will now see USR LED 1 blinking at one second intervals. Press Ctrl-C to break from the loop.

Cross Compilation

Install toolchain

  • You will need the Angstrom cross compilation toolchain for the BeagleBone Black.
  • Run the following commands on your host machine (i.e. laptop/PC)
~$ wget http://www.angstrom-distribution.org/toolchains/angstrom-2011.03-x86_64-linux-armv7a-linux-gnueabi-toolchain.tar.bz2
~$ sudo tar -C / -xjf angstrom-2011.03-x86_64-linux-armv7a-linux-gnueabi-toolchain.tar.bz2
~$ export PATH=/usr/local/angstrom/arm/bin:$PATH
~$ export CROSS_COMPILE=arm-angstrom-linux-gnueabi-


Links to 64 and 32 bit versions of Angstrom toolchain.


Clone repo

git clone https://github.com/prpplague/Userspace-Arduino.git


Running a demo


Running Blink LED program:

cd Userspace-Arduino/arduino-makefile/examples/BlinkUserspace
make
  • A binary BlinkUserspace.elf should be created in a directory build-userspace
  • To upload the created binary file, do
make upload 

Setup SSH keys (optional)

  • If you want to avoid a password prompt, you can set up the ssh keys for the Beaglebone Black:
cd ~/.ssh
ssh-keygen -t dsa #set a password or you can leave it blank
ssh-copy-id -i ~/.ssh/id_dsa.pub root@$192.168.7.2 # replace id_dsa.pub by your public key file if some other name is given
ssh root@192.168.7.2 # login and enter password once

Here after, you won't be prompted for a password from this machine

Examples

Each of these examples have their own detailed wiki pages:

Boards Supported


Beaglebone Black

Initial development is being done with the Beaglebone Black and the Bacon Cape

  • if you have your Beaglebone Black loaded with a firmware image older that 07.11.2013, you will need copy the Bacon Cape dtbo file on to your beaglebone black
~# scp ~/Downloads/BB-BONE-BACONE-00A0.dtbo root@192.168.7.2:/lib/firmware/BB-BONE-BACONE-00A0.dtbo
Arduino Pin BBB Header Pin Function Alternate Function
0 P9_11 UART (RXD)
1 P9_13 UART (TXD)
2 P9_15 GPIO
3 P9_14 PWM
4 P9_12 GPIO
5 P9_16 PWM
6 P9_42 PWM
7 P8_19 GPIO PWM
8 P9_19 I2C (SCL)
9 P9_20 I2C (SDA)
10 P9_17 GPIO SPI_CS0
11 P9_18 GPIO SPI_MOSI
12 P9_21 SPI_MISO
13 P9_22 GPIO SCK
14 USR LED 0 LED
15 USR LED 1 LED
16 USR LED 2 LED
17 USR LED 3 LED
18 P9_33 AIN4
19 P9_35 AIN6
20 P9_36 AIN5
21 P9_37 AIN2
22 P9_38 AIN3
23 P9_39 AIN0
24 P9_40 AIN1


MinnowBoard

  • Initial support started
  • Need Lure accessory board for testing


Raspberry Pi