1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
|
.. highlight:: sh
.. _unix-toolchain:
===========================
Unix Toolchain Quickstart
===========================
This is a tutorial for using a standard Unix toolchain (``make``,
``gcc``, etc.) with Maple. It's intended for C and C++ programmers
who want to use :ref:`libmaple` directly. If you're just beginning, we
recommend installing :ref:`Maple IDE <maple-ide-install>` instead.
If you have success on an operating system not covered here, please
post in the `forum`_ (or email us at info@leaflabs.com), so we can
update this document.
.. contents:: Contents
:local:
:depth: 2
Requirements
------------
You need a Maple board, a Mini-B USB cable, and root (or
Administrator) access to your computer. We assume you've had success
with the IDE on your machine (this is important on Windows, as this
document doesn't cover :ref:`driver installation
<maple-ide-install-windows-drivers>`).
On Linux and OS X, you need to know how to use a shell and edit your
shell startup script (.bashrc, .tcshrc, etc.). (The Windows
instructions are more detailed, since we assume many Windows users
will be newer to the Unix shell). Some experience using `GCC
<http://gcc.gnu.org/>`_ and `make
<http://www.gnu.org/software/make/>`_ is recommended, but is not
required.
Setup
-----
.. _toolchain-linux-setup:
Linux
^^^^^
1. Collect and Install Tools
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
First, you'll need some tools.
.. warning:: Due to firmware bugs in our :ref:`bootloader
<bootloader>`, you must use recent versions of ``dfu-util``, or
uploads will not work. ``dfu-util`` versions 0.6 and greater
should work.
**Debian-based distributions (Debian, Ubuntu, Mint, etc.)**:
Install mandatory and optional tools with ::
$ sudo apt-get install build-essential git-core screen dfu-util python python-serial
On *64-bit distros only*, you will also need to install some 32-bit
libraries needed by the LeafLabs-supported :ref:`ARM GCC toolchain
<arm-gcc>` with ::
# 64-bit systems only!
$ sudo apt-get install ia32-libs
You may also need to remove `brltty <http://mielke.cc/brltty/>`_
with ::
# Optional
$ sudo apt-get remove brltty
Brltty provides braille access to the console. It has been reported
to cause conflicts with Maple.
**Red Hat-based distributions (RHEL, Fedora, Centos, etc.)**:
Install mandatory and optional tools with ::
$ sudo yum install screen git python pyserial dfu-util make
On *64-bit distros only*, you will also need to install 32-bit
libraries needed by the LeafLabs-supported :ref:`ARM GCC toolchain
<arm-gcc>` with ::
# 64-bit systems only!
$ sudo yum install glibc.i686
You may also need to remove `brltty <http://mielke.cc/brltty/>`_
with one of these::
# Optional, 64-bit systems:
$ sudo yum erase brltty.x86_64
# Optional, 32-bit systems:
$ sudo yum erase brltty.i686
Brltty provides braille access to the console. It has been
reported to cause conflicts with Maple.
**Other Linux distributions**:
On other distributions, you'll need to figure this out for yourself
(please `contact`_ us if you have instructions for distros not
covered here!).
Mandatory tools:
* `Git`_ is a distributed version control system. We use it to track
our source code.
* `dfu-util`_ is a tool from the `OpenMoko`_ project. It is used to
upload programs to the Maple over USB.
* `Make <http://www.gnu.org/software/make/>`_ is used to direct
compilation.
* `Python`_ is a programming language. Our reset script, which sends
control signals to the board which cause it to to reset and enter
the :ref:`bootloader <bootloader>`, is written in Python (and
works with Python 2 or 3). Most Linux distributions these days
include Python by default.
* `PySerial`_ is a Python library for interacting with serial port
devices. It's needed by our reset script. PySerial can also be
installed with `easy_install`_.
Optional tools:
* `screen <http://www.gnu.org/s/screen/>`_ is a screen manager used
here to connect to serial port devices. (Some popular
alternatives are `Minicom
<http://alioth.debian.org/projects/minicom/>`_ and `Kermit
<http://www.kermitproject.org/>`_).
2. Fetch ``libmaple`` and Compiler Toolchain
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
First, make a Git clone of :ref:`libmaple`::
$ cd ~
$ git clone git://github.com/leaflabs/libmaple.git libmaple
Next, download the `Linux ARM GCC toolchain
<http://static.leaflabs.com/pub/codesourcery/gcc-arm-none-eabi-latest-linux32.tar.gz>`_
you'll use to build your programs. Extract the archive into a
directory named :file:`arm`. Put resulting :file:`arm/bin`
subdirectory somewhere in your ``PATH``. For example, if you have
`wget <http://www.gnu.org/software/wget/>`_ installed, you can run::
$ cd ~/libmaple
$ wget http://static.leaflabs.com/pub/codesourcery/gcc-arm-none-eabi-latest-linux32.tar.gz
$ tar xvf gcc-arm-none-eabi-latest-linux32.tar.gz
$ export PATH=$PATH:~/libmaple/arm/bin
You can check that this worked by entering ``arm-none-`` and hitting
tab to auto-complete; your shell should show a bunch of results. After
you're done, you'll probably want to update your shell startup script
so the :file:`arm/bin` directory stays in your ``PATH``.
.. _toolchain-udev:
3. Install udev Rules
~~~~~~~~~~~~~~~~~~~~~
From the libmaple directory, copy our udev rules [#fudev]_ to
``/etc/udev/rules.d``::
$ sudo cp support/scripts/45-maple.rules /etc/udev/rules.d/45-maple.rules
Then restart udev.
**Debian-based distros**:
Make sure you are in the plugdev group (e.g. by running ``$ groups``
and seeing if the output includes "plugdev"). If not, add yourself
to plugdev with ::
$ sudo usermod -a -G plugdev $USER
then log back out and log back in.
After that's done, restart udev::
$ sudo restart udev
**Red Hat-based distros**:
::
$ udevadm control --reload-rules
After restarting ``udev``, you'll need to unplug and re-plug your
Maple.
So far, so good?
~~~~~~~~~~~~~~~~
Great! Test your setup by :ref:`compiling a sample program
<toolchain-test>`.
.. _toolchain-osx-setup:
OS X
^^^^
These instructions have been tested successfully on OS X 10.6.4 and
10.8.1.
1. Collect and Install Tools
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
First, you'll need some tools. [#fpackman]_
* `XCode <http://developer.apple.com/technologies/xcode.html>`_:
Provides compilers and other basic tools of the trade. XCode was
once free of charge, but Apple has since begun charging for it. If
you'd rather not pay, you can probably get by with just a `make
<http://www.gnu.org/software/make/>`_ binary, but you're on your
own.
* `Git`_: All of our code is tracked by a distributed versioning
system called Git. A `Mac installer
<http://code.google.com/p/git-osx-installer/downloads/list?can=3>`_
is available.
* `dfu-util`_: A tool from `OpenMoko`_ that we use to upload programs
to the Maple over USB.
.. warning:: Due to firmware bugs in our :ref:`bootloader
<bootloader>`, you must use recent versions of ``dfu-util``, or
uploads will not work. ``dfu-util`` versions 0.6 and greater
should work.
If you prefer to compile from source, OpenMoko provides instructions
for `building dfu-util on OS X
<http://wiki.openmoko.org/wiki/Dfu-util#Mac>`_.
If you're in a hurry, you can use the dfu-util binary bundled with
`OpenMoko Flasher
<http://www.handheld-linux.com/wiki.php?page=OpenMoko%20Flasher>`_. To
do this, first `download OpenMoko Flasher
<http://projects.goldelico.com/p/omflasher/downloads/>`_, then move
it to your :file:`/Applications` folder (or wherever you
like). Let's say you save it as :file:`/Applications/OpenMoko
Flasher.app`. Then the ``dfu-util`` binary resides in
:file:`/Applications/OpenMoko Flasher.app/Contents/Mac OS/dfu-util`
To run it from the command line, make a symbolic link to the binary
from some place on your ``PATH``::
$ ln -s /Applications/OpenMoko\ Flasher.app/Contents/Mac\ OS/dfu-util \
/somewhere/on/your/PATH/dfu-util
.. note::
Copying the binary won't work, as it relies on dynamically linked
libraries found elsewhere in the .app bundle.
To make sure this worked, plug in your Maple, put it into
:ref:`perpetual bootloader mode
<troubleshooting-perpetual-bootloader>` (press RESET, then quickly
press and hold BUT for several seconds), and run ::
$ dfu-util -l
The output should look like this::
Found DFU: [0x1eaf:0x0003] devnum=0, cfg=0, intf=0, alt=0, name="DFU Program RAM 0x20000C00"
Found DFU: [0x1eaf:0x0003] devnum=0, cfg=0, intf=0, alt=1, name="DFU Program FLASH 0x08005000"
* `PySerial`_: our reset script (which sends control signals over the
USB-serial connection to restart and enter the bootloader) is
written in Python, and requires the PySerial library. Download and
extract the `latest version
<http://pypi.python.org/pypi/pyserial>`_, then install with ::
$ cd /path/to/pyserial-x.y
$ python setup.py build
$ sudo python setup.py install
PySerial is also available via `easy_install`_, so if you're
comfortable using that, you could alternatively install it with ::
$ easy_install pyserial
2. Fetch ``libmaple`` and Compiler Toolchain
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
First, make a `Git`_ clone of :ref:`libmaple`::
$ cd ~
$ git clone git://github.com/leaflabs/libmaple.git
Next, `download the cross-compilers
<http://static.leaflabs.com/pub/codesourcery/gcc-arm-none-eabi-latest-osx32.tar.gz>`_
you'll use to build libmaple and your own programs. (These are just
special-purpose versions of :ref:`GCC <arm-gcc>`).
Let's say you saved these into
:file:`~/Downloads/gcc-arm-none-eabi-latest-osx32.tar.gz`. Then unpack
the archive and tell the shell about its contents with::
$ cd ~/Downloads
$ tar -xvf gcc-arm-none-eabi-latest-osx32.tar.gz
$ mv arm ~/libmaple/arm
$ export PATH=$PATH:~/libmaple/arm/bin
After that's done, update your shell startup script so
:file:`~/libmaple/arm/bin` stays in your ``PATH``.
So far, so good?
~~~~~~~~~~~~~~~~
Great! Test your setup by :ref:`compiling a sample program
<toolchain-test>`.
.. _toolchain-win-setup:
Windows
^^^^^^^
These instructions have been tested successfully on Windows 7 Home
Premium.
1. Collect and Install Tools
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
First, you'll need some tools.
* `GitHub for Windows <http://windows.github.com/>`_: this is a GUI
for `Git`_, the version control system we use for :ref:`libmaple`.
If you don't have one, you need to sign up for a (free) `GitHub
account <https://github.com/signup/free>`_.
.. note:: If you use Git from the command line, you can clone
libmaple with::
$ git clone git://github.com/leaflabs/libmaple.git
If you go this route, you don't need a GitHub account.
* `Python`_: choose the **latest 2.7.x version**. (Python 3 works, but
you're on your own.)
* `PySerial`_: Choose the latest **pyserial-x.y-win32.exe version**.
2. Fetch ``libmaple`` and Compiler Toolchain
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
First, make a Git clone of the :ref:`libmaple` repository with the
following steps:
1. **Run GitHub for Windows**, and **sign in** using your GitHub
account.
2. **Visit** `libmaple's GitHub page
<https://github.com/leaflabs/libmaple/>`_, and **sign in** to
GitHub in your web browser as well.
3. **Click on the "Clone in Windows" button** on libmaple's GitHub
page, which looks like this:
.. figure:: /_static/img/github-clone-in-windows.png
Your browser may prompt you about what to do when you click the
"Clone in Windows" button. Choose the option that launches the
GitHub for Windows application.
Next, you'll need to get some cross-compilers and other tools for
building and uploading your programs:
- `Download a .zip of the latest tools
<http://static.leaflabs.com/pub/codesourcery/gcc-arm-none-eabi-latest-win32.zip>`_.
- Extract the .zip, and **move the extracted "arm" folder into the
libmaple repository's folder**.
You can open the libmaple repository folder by right-clicking
libmaple in the main GitHub for Windows screen and choosing "open in
explorer":
.. figure:: /_static/img/win7-github-open-in-explorer.png
:align: center
3. Update your PATH
~~~~~~~~~~~~~~~~~~~
You'll next need to configure your system to use the various tools
you've downloaded and installed. Do that by adding the Python and
``arm\bin`` directories to your PATH environment variable.
If you've never set environment variables before, this section
explains what to do.
**Add Python to your PATH**:
Start by navigating to the folder where Python is installed on your
system (this is probably ``C:\Python27``). Right click on the folder
address, then choose "Copy address as text":
.. figure:: /_static/img/win7-copy-python-address.png
:align: center
Next, open your environment variables window: from the Start/Windows
menu, right click on Computer, then choose Properties > Advanced
System Settings > Environment Variables. Under the "User variables
for YOUR_USERNAME", look for PATH.
- If PATH is missing from the list, click "New...".
Under "Variable Name", write PATH. Under "Variable value", paste
the Python address you just copied, and click OK. The result looks
like this:
.. figure:: /_static/img/win7-python-path.png
:align: center
- If PATH is present in the list, click on it and choose "Edit...".
Go to the end of the "Variable value:" text box, type a semicolon
(the ``;`` character), and then paste the path you just
copied. Click OK.
Test that this worked by running the Git Shell program that came with
GitHub for Windows, then running ``python`` at the command prompt. You
should get a Python interpreter that looks like this:
.. figure:: /_static/img/win7-python-prompt.png
:align: center
If that worked, then close the window.
**Add compiler toolchain to your PATH**:
Do this by adding the ``arm\bin`` directory (earlier instructions
had you move ``arm`` to the libmaple repository folder) to your PATH
environment variable in the same way you added Python.
Copy the address of the ``arm\bin`` folder by right-clicking on it
after navigating to it:
.. figure:: /_static/img/win7-copy-arm-bin-address.png
:align: center
The PATH environment variable should exist from when you added
Python to it, so make sure you choose "Edit..." from the
environment variables window. Then paste the ``arm\bin`` address you
copied after typing a semicolon. The final result will look
something like this:
.. figure:: /_static/img/win7-python-arm-bin-path.png
:align: center
Click OK.
Once that's done, **open a new Git Shell**, then type this at the
prompt, and hit return::
cd libmaple
.. warning:: You must open a new Git Shell window. If you use a shell
that's already open, then the changes to PATH you just
made won't be available, and the instructions in the next
section won't work.
So far, so good?
~~~~~~~~~~~~~~~~
Great! Go on to the next section, where you'll compile a program.
.. _toolchain-test:
Test compilation
----------------
Test that you've installed all the compilation tools correctly by
running these commands in your shell::
# Windows users:
# - Type "cs-make" instead of "make"
# - Don't type the "$", just the parts that come after
#
# Linux and OS X users:
# - First get to libmaple with $ cd libmaple
$ cp main.cpp.example main.cpp
$ make clean
$ make
If all goes well, you should see a bunch of output, then something
like this::
Final Size:
text data bss dec hex filename
13164 1704 552 15420 3c3c build/maple.elf
Hurray! You've just compiled your first program for Maple.
**Important: if you're not using Maple (Maple Mini, etc.), make sure
to read the following note before moving on**.
You can now move on to :ref:`uploading a program <toolchain-upload>`,
or take a quick detour to learn :ref:`more about the build output
<toolchain-build-info>`.
.. _toolchain-setting-board:
.. note:: This tutorial assumes you're using a Maple. If you're
compiling for another board, you'll need to set a ``BOARD``
environment variable appropriately.
To get a list of values for ``BOARD``, run ::
$ make list-boards
For example, to compile for Maple Mini:
* On OS X or Linux, run::
$ export BOARD=maple_mini
$ make
* On Windows, set a new environment variable named ``BOARD`` to
value ``maple_mini``, then open a new Git Shell, and run ``cd
libmaple`` followed by ``cs-make`` as explained above.
You can check that this worked by making sure that the final
program file is named ``build/maple_mini.elf`` instead of
``maple.elf``::
Final Size:
text data bss dec hex filename
16848 2696 704 20248 4f18 build/maple_mini.elf
Other notes for OS X and Linux:
- You can also use the following, but you'll need to write the
``BOARD=maple_mini`` part every time you call ``make`` (for
``make install``, etc.)::
$ BOARD=maple_mini make
- To make the board setting permanent, add this line to your
.bashrc::
export BOARD=maple_mini
.. warning:: You must start from a clean build after each time you
change ``BOARD`` (advanced users: or ``MEMORY_TARGET``). For
example, if you compile a program for Maple, then you want to
compile another program for Maple Mini, you must run ``$ make
clean`` **before** you compile the second program. If you do not,
you will experience strange errors.
.. _toolchain-build-info:
Notes about the ``libmaple`` build
----------------------------------
These are just some miscellaneous notes that are good to know. Feel
free to skip reading this section.
- The ``dec`` field at the end under ``Final Size:`` gives the total
program size in bytes. The ``text``, ``data``, and ``bss`` fields
respectively break down the size of the program into `code
<http://en.wikipedia.org/wiki/Code_segment>`_, `initialized data
<http://en.wikipedia.org/wiki/Data_segment>`_, and `zero-valued data
<http://en.wikipedia.org/wiki/.bss>`_.
- The long list of object files above the ``Final Size`` shows similar
information on a per-file basis. You can use it to help slim down
programs that use too much space.
- ``build/$BOARD.elf`` is the final build result (where ``BOARD`` is
``maple``, ``maple_mini``, etc. :ref:`depending on your build
<toolchain-setting-board>`).
- There are other files under ``build`` you may be interested in, like
disassembly and map files.
- If you want quicker build times, you should check out our blog post,
`Making libmaple compile faster
<http://leaflabs.com/2012/08/2549/>`_.
.. _toolchain-upload:
Upload a program
----------------
Let's blow away the little example program and upload the interactive
test session to your Maple. This will let you interact with the Maple
over a :ref:`USB serial port <usb>`.
* Linux: you need udev rules set up :ref:`as described above
<toolchain-udev>`.
* Windows: you need to :ref:`install the Maple's device drivers
<maple-ide-install-windows-drivers>`.
* OS X: everything Just Works for you. Aren't you special?
Plug in your Maple using a Mini-B USB cable, then run ::
# Window users: as usual, use cs-make instead of make.
$ cp examples/test-session.cpp main.cpp
$ make clean
$ make
$ make install
A number of things can go wrong at this stage. Simple debugging steps
include using :ref:`perpetual bootloader mode
<troubleshooting-perpetual-bootloader>`, restarting the Maple a couple
times, ``make clean``, etc. If nothing works, the `forum`_ is your
friend.
.. _toolchain-serialusb:
Communicate over USB-Serial
---------------------------
Now let's try out the interactive test session. You need to connect
to the board's serial port device file.
* Linux: this looks like :file:`/dev/ttyACM*`
* OS X: it looks like :file:`/dev/tty.usbmodem*`
* Windows: it will be :file:`COMx`, where ``x`` is some number.
Try using one of these to find out which it is::
# Linux
$ ls /dev/ttyACM*
# OS X
$ ls /dev/tty.usbmodem*
# Windows, works from libmaple directory
$ python support/scripts/win-list-com-ports.py
To open up a session on Linux or OS X, run ::
$ screen /dev/ttyXXX
(On Windows, you will need to use a separate program, such as Maple
IDE's serial console or `PuTTY
<http://www.chiark.greenend.org.uk/~sgtatham/putty/>`_.)
``screen`` will present you an empty terminal. Your board is waiting
for you to send it a command. Type ``h`` to print a list of commands;
type any command's letter to run it.
.. highlight:: none
Example output (for Maple)::
> u
Hello World!
> b
Board information
=================
* Clock speed (MHz): 72
* BOARD_LED_PIN: 13
* BOARD_BUTTON_PIN: 38
* GPIO information (BOARD_NR_GPIO_PINS = 44):
ADC pins (15): 0, 1, 2, 3, 10, 11, 12, 15, 16, 17, 18, 19, 20, 27, 28
PWM pins (15): 0, 1, 2, 3, 5, 6, 7, 8, 9, 11, 12, 14, 24, 27, 28
Used pins (7): 13, 38, 39, 40, 41, 42, 43``
.. highlight:: sh
To exit the screen session, type :kbd:`C-a k` (control-a k) on Linux,
or :kbd:`C-a C-\\` (Control-a, followed by Control-backslash) on OS X,
and type ``y`` when prompted if you're sure.
.. note::
Using ``screen`` sometimes messes up your terminal session on OS X.
If your shell starts acting funny after you exit ``screen``, you
should be able to fix it with ::
$ reset && clear
If that doesn't work, just close the Terminal window and open up a
new one.
.. _toolchain-projects:
Start your own project
----------------------
So everything worked, and you want to start your own project? Great!
There are two ways to go about it.
If your project is small, all you have to do is replace
:file:`~/libmaple/main.cpp` with your own code, and you're free to use
``make`` and ``make install`` in the same way you did when you first
:ref:`uploaded a program <toolchain-upload>`.
If you have a more complicated project, with its own Makefile and
multiple source files, or if you're using an IDE that creates its own
Makefile, you'll probably want to load libmaple from an archive (a
build-time library, not a DLL).
To create an archive, use the ``library`` Makefile target::
$ cd ~/libmaple
$ make library
This will produce a build-time library in the file
:file:`~/libmaple/build/libmaple.a`. To use it, make sure that you
link against that library, and that the libmaple sources are in your
include path.
There is also a page on `starting a project with the Unix toolchain
<http://wiki.leaflabs.com/index.php?title=Starting_A_Project_%28No_IDE%29>`_
on the `LeafLabs wiki <http://wiki.leaflabs.com>`_ that you may find
useful.
Get updates
-----------
We update libmaple fairly frequently with bugfixes and other
improvements. In order get access to these in your local copy of the
repository, you should periodically update it with::
$ cd ~/libmaple
$ git pull
We do our best to keep the master libmaple branch on GitHub free from
broken or half-finished code, so don't be too scared running the
latest and greatest. If you do, please report any bugs or regressions!
We keep releases of libmaple and the Maple IDE in lockstep, so any IDE
updates will have corresponding library updates. Our `blog
<http://leaflabs.com/blog/>`_ is the place to watch for major
releases; an `RSS feed <http://leaflabs.com/blog/feed/>`_ is
available.
You can sign up for a free `GitHub <https://github.com/plans>`_
account and `watch libmaple
<https://github.com/leaflabs/libmaple/watchers>`_ to receive
notifications about bleeding-edge development.
.. _toolchain-openocd:
(Optional) Upload/Debug with JTAG/SWD
-------------------------------------
Advanced users will wish to use a JTAG (or SWD) dongle for uploading
and debugging their programs. A big advantage to this approach is that
it lets you use `GDB
<http://www.gnu.org/software/gdb/documentation/>`_ to single-step
through your code, inspect variables, etc.
You can build your projects for JTAG or SWD upload with the ``jtag``
Makefile target. Instead of compiling with ``make``, compile with
``make jtag``. Then use your method of choice to upload the resulting
program, which will be in ``build/$BOARD.elf`` in the libmaple
directory.
.. warning:: Uploading code built with the ``jtag`` target will
overwrite the :ref:`bootloader <bootloader>`. This is a good thing
-- since you're using another upload method, this lets you use the
Flash and RAM the bootloader ordinarily reserves for itself. You
can always :ref:`reflash the bootloader <bootloader-reflashing>`
later.
While LeafLabs doesn't officially support any particular way of using
JTAG with Maple, there is a `JTAG How-To
<http://wiki.leaflabs.com/index.php?title=Maple_JTAG_How_To>`_ on the
`LeafLabs wiki <http://wiki.leaflabs.com>`_ that you may find useful.
.. _toolchain-exuberantly:
Go forth exuberantly!
---------------------
Let us know what you come up with! Mention `@leaflabs on Twitter
<http://twitter.com/#!/leaflabs>`_, post in the `forum`_, join the the
#leafblowers IRC channel on `freenode
<http://freenode.net/irc_servers.shtml>`_, whatever. We love projects!
.. _Python: http://python.org/download/
.. _PySerial: http://pyserial.sourceforge.net/
.. _OpenMoko: http://openmoko.com/
.. _Git: http://git-scm.com/
.. _dfu-util: http://wiki.openmoko.org/wiki/Dfu-util
.. _easy_install: http://packages.python.org/distribute/easy_install.html
.. rubric:: Footnotes
.. [#fudev] As a security precaution on Linux, unknown USB devices can
only be accessed by root. This udev script identifies the Maple
based on its vendor and product IDs, mounts it to
:file:`/dev/maple`, and (for Debian-based distros) grants
read/write permissions to the ``plugdev`` group.
.. [#fpackman] Some of these software packages might be available on
`MacPorts <http://www.macports.org/>`_ or `Homebrew
<http://mxcl.github.com/homebrew/>`_. The author had some bad
experiences with MacPorts a few years ago, though, and hasn't
touched a package manager on OS X since. Your mileage may vary.
|