You are here

Installation

Downloading Jaluino

As a first step, you'll need to download latest Jaluino archive. You can retrieve it from Jaluino Google Code download section. Actual installation is rather easy: just unzip the archive.

Figure 1. Typical Jaluino archive content

Beside usual licenses and readme files, you'll find every content related to Jaluino mainboard and shields, in order for you to manufacture them, and refer to schematics and diagrams as needed. bin contains jalv2 compiler binaries (for each platform) and several wrapper scripts, or helpers, that hopefully simplify every day tasks. lib and samples contains jalv2 libraries (mostly based on jallib) and jaluino samples, ready to compile and program. bootloaders is where you'll soon choose the program (HEX file) to upload to your Jaluino board. doc is the first place you should search when looking for a specific Jaluino information, and ide contains JaluinoIDE and other several related plugins you can install in order to setup a fully functional programming environment. Other locations are rarely used for every day usage.

Note: you can also get Jaluino from sources, accessing Google Code SVN repository. This can be useful when you want to access lastest librairies and others related tools. Content looks the same, there are few differences regarding libraries and documentation though. All in all, you should get your feet on the ground easily. Retrieving Jaluino from SVN can be done following instructions detailed in this page: http://code.google.com/p/jaluino/source/checkout.
Note: third party programs are located into 3rdparty directory, under their own licenses. Jaluino licenses obviously don't apply to them.

Installing Jaluino IDE dependencies

Jaluino project comes with an IDE, an Integrated Development Environment. This IDE, JaluinoIDE, is here to help you, by providing default commands to compile and upload your programs. It also provides features like a code browser, code completion, calltips, ... It can be used as a generic Jalv2 IDE.

  1. JaluinoIDE is based on Editra, and it's actually an Editra plugin. Editra is a cross-platform IDE, running under Windows, OSX and Linux. First download Editra, and follow guidelines regarding OS used, described on this page: http://editra.org/installation_guide. Windows installer is a binary distribution containing every Editra's dependencies, like wxPython. Under Linux, running Editra may require you to install wxPython, but nowadays, it is becoming more and more popular, it wouldn't be surprising you wouldn't have to.
    Important: JaluinoIDE requires at least Editra 0.5.51. Don't use a older version, it just won't work !
  2. Several scripts used by JaluinoIDE are based on python. It's now time to install python. Go to http://python.org, and download python1.

    • for Windows users, download python 2.5
    • for others, download either python 2.5 or 2.6
  3. You'll sure need to access Jaluino through a serial link, either with a programmer or a bootloader. You need to install pyserial, available from http://pyserial.sourceforge.net/. Windows users need to install pyserial for python 2.5, others will choose version following installed python version.

Installing Jaluino IDE

Once dependencies are installed, you can safely install Jaluino IDE. JaluinoIDE will be installed and deployed in several Editra's directories, so Editra can detect it and enable it. Since Editra is cross-platform, you can use it under Windows, OSX and Linux.

  1. As a first step, if not already done, run Editra once, so default directories will be created
    • Windows: click on Editra icon
    • Linux: type Editra in a terminal
    • OSX: probably click on Editra icon2

    You should get a window like this:

    Figure 2. Editra IDE

  2. Now close Editra, and go back to Jaluino directory. Run installation script:
    • Windows: double-click on install.py file
    • Linux: type python install.py within Jaluino directory
    • OSX: double-click on install.py
    Figure 3. Installation script opens a terminal and talks a little about it does

    Installation script copied several files to Editra, like plugins and configuration files. It also detect several parameters specific to your system, like where Jaluino has been unzipped, Editra installed, path to your python installation, etc... Should you change a parameter you can safely run this script again.

  3. Now open Editra again. So far nothing has happened, go to the Tools, open Plugin Manager and Enable Jaluino IDE plugin.
    Figure 4. Editra's Plugin Manager lists all available plugins, including JaluinoIDE previously installed
  4. Close Plugin Manager window, and restart Editra as stated. I swear this is the last time :). You should now see a Jaluino menu entry. Content is grayed, this is normal as we did not open a jalv2 file yet.
    Figure 5. "Jaluino" menu entry, JaluinoIDE plugin is correctly installed !

  5. Now go to View, Shelf and enable Jaluino shelf. This opens a window on the bottom part of Editra. This is where you'll mostly operate when compiling and uploading program.
    Figure 6. JaluinoIDE shelf. Compilation and upload output will be displayed in this window.

  6. As a final check, open jaluino_medium_blink.jal sample, which can be found in samples directory. Select "Jaluino without bootloader" in Compile's dropdown list and click on Compile icon on the right. Check there's no error in output window.
    Figure 7. Compiling our first sample


Configuring JaluinoIDE

JaluinoIDE requires you to specify information about serial link. Click on "Settings" icon (top left of Jaluino shelf) or navigate to "Jaluino" => "Settings" menu, then click on "Serial/USB" tab.

Figure 8. Serial configuration tab

Specify which port you'll use to program Jaluino, either with TinyBootloader or a programmer. You can also enter your own port on the text box. This is useful for Linux users for instance, when using a USB-to-serial adapter. In this case, you'd typically enter "/dev/ttyUSB0".

Also specify which baudrate is used. Usually 115200 when using default Jaluino files.

Congratulations ! You've just installed a fully functional Jaluino development environment3. It's now time to have fun with Jaluino board.

1 Editra for Windows, when installed from binaries (most of the time), is using python 2.5. Installing another version, like python 2.6, is possible, but installation procedure gets more complicated, particularly when installing dependency like pyserial.
2 I don't have access to an OSX box around there, so I'm not able to to test. If you're a lucky OSX owner, please report so this documentation will be completed as needed.
3 Jaluino comes with JaluinoIDE, where environment is automatically configured, as much as possible. Of course, you're free to use any other IDE, like JalEdit (http://jal.sunish.net/jaledit). Or even no IDE at all, if you're a commandline guy. If so, please report and share how you configured it, so this document can grow and let users choose different alternatives. That said, Jaluino documentation is based on JaluinoIDE, some functionalities may not be available in other IDEs.