Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Teensy Compatibility #142

Open
wants to merge 8 commits into
base: master
Choose a base branch
from
+308 −91
Open

Teensy Compatibility #142

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
6d0357f
Change: Allow infinite depth for arduino-style config import keys
Feb 15, 2015
5fe7337
Bugfix: load_arduino_style_settings now correctly imports settings va…
Feb 17, 2015
566261c
Bugfix: Added double quotes around avrdude target paths, for compatib…
Feb 17, 2015
be561ab
Bugfix: load_arduino_style_settings can now handle variable keys incl…
Feb 17, 2015
c25fcd1
Merge branch 'windows-drive-name-compatibility' into teensy-compatibi…
Feb 19, 2015
3f9d540
Added: Ability to pick between AVRDUDE and TEENSY_LOADER_CLI uploader…
Feb 19, 2015
b971c51
Bugfix: User-specified LOADER parameter now works correctly.
Feb 19, 2015
4231b90
Change: Some documentation fixed for Teensy.
Feb 20, 2015
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
65 changes: 58 additions & 7 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Features
--------

* Integrates with *Arduino SDK*
* Supports all Arduino boards.
* Supports all Arduino and Teensy boards.
* Supports Arduino type libraries
* Automatic detection of Arduino libraries.
* Generates firmware images.
Expand Down Expand Up @@ -135,9 +135,10 @@ Contents
6. `Compiler and Linker Flags`_
7. `Programmers`_
8. `Pure AVR Development`_
9. `Advanced Options`_
10. `Miscellaneous Functions`_
11. `Bundling Arduino CMake`_
9. `Teensy Development`_
10. `Advanced Options`_
11. `Miscellaneous Functions`_
12. `Bundling Arduino CMake`_

3. `Linux Environment`_

Expand Down Expand Up @@ -292,6 +293,7 @@ To create Arduino firmware in CMake you use the ``generate_arduino_firmware`` co
[LIBS lib1 lib2 ... libN]
[PORT port]
[SERIAL serial_cmd]
[LOADER loader_id]
[PROGRAMMER programmer_id]
[AFLAGS flags]
[NO_AUTOLIBS])
Expand All @@ -316,6 +318,8 @@ The options are:
+--------------------+----------------------------------------------------------------------+------------------------------------+
| **SERIAL** | Serial command for serial target (see `Serial Terminal`_) | |
+--------------------+----------------------------------------------------------------------+------------------------------------+
| **LOADER** | Uploader to transfer sketches to the board (defaults to avrdude) | |
+--------------------+----------------------------------------------------------------------+------------------------------------+
| **PROGRAMMER** | Programmer ID, enables programmer burning (see `Programmers`_). | |
+--------------------+----------------------------------------------------------------------+------------------------------------+
| **ARDLIBS** | Manual list of Arduino type libraries, common use case is when the | |
Expand Down Expand Up @@ -532,6 +536,7 @@ Most Arduino libraries have examples bundled with them. If you would like to gen
[BOARD board_id]
[PORT port]
[SERIAL serial command]
[LOADER loader_id]
[PORGRAMMER programmer_id]
[AFLAGS avrdude_flags])

Expand All @@ -551,6 +556,8 @@ The options are:
+--------------------+----------------------------------------------------------------------+------------------------------------+
| **SERIAL** | Serial command for serial target (see `Serial Terminal`_) | |
+--------------------+----------------------------------------------------------------------+------------------------------------+
| **LOADER** | Uploader to transfer sketches to the board (defaults to avrdude) | |
+--------------------+----------------------------------------------------------------------+------------------------------------+
| **PROGRAMMER** | Programmer ID, enables programmer burning (see `Programmers`_). | |
+--------------------+----------------------------------------------------------------------+------------------------------------+
| **AFLAGS** | avrdude flags for target | |
Expand Down Expand Up @@ -662,6 +669,7 @@ The `generate_avr_firmware()` command::
[LIBS lib1 lib2 ... libN]
[PORT port]
[SERIAL serial_cmd]
[LOADER loader_id]
[PROGRAMMER programmer_id]
[AFLAGS flags])

Expand All @@ -686,6 +694,8 @@ The options:
+--------------------+----------------------------------------------------------------------+------------------------------------+
| **SERIAL** | Serial command for serial target (see `Serial Terminal`_) | |
+--------------------+----------------------------------------------------------------------+------------------------------------+
| **LOADER** | Uploader to transfer sketches to the board (defaults to avrdude) | |
+--------------------+----------------------------------------------------------------------+------------------------------------+
| **PROGRAMMER** | Programmer ID, enables programmer burning (see `Programmers`_). | |
+--------------------+----------------------------------------------------------------------+------------------------------------+
| **AFLAGS** | avrdude flags for target | |
Expand Down Expand Up @@ -728,6 +738,44 @@ You can specify the options in two ways, either as the command arguments or as v

Where **${TARGET_NAME}** is the name of you target and **${OPTION_NAME}** is the name of the option.

Teensy Development
~~~~~~~~~~~~~~~~~~

When using a `PJRC Teensy`_ board instead of an Arduino, CMAKE requires some additional configuration to set all available modes.

Ensure you have installed the *Teensy SDK*, which is normally install over the top of the Arduino SDK.
If you install to another location, ensure arduino-cmake is configured to use that directory for the Arduino SDK:
``set(ARDUINO_SDK_PATH /path/to/the/teensy/sdk)``

Use the ``print_boards_list()`` command to view all available Teensy boards.
If no Teensy boards are listed, double check your Teensy SDK path settings.

Use ``print_teensy_modes(board_id)`` to list all modes that can be configured for the board.

Use ``print_teensy_modes(board_id MODE mode_id)`` to list all mode options available.

All Teensy board modes must be specified, and can be applied with the following settings:

+--------------------------+-----------------------------+
| **Name** | **Description** |
+--------------------------+-----------------------------+
| **TEENSY_CPU_F_MODE** | CPU Frequency / Speed |
+--------------------------+-----------------------------+
| **TEENSY_USB_MODE** | USB Mode (Serial, HID, etc) |
+--------------------------+-----------------------------+
| **TEENSY_KEYBOARD_MODE** | USB Keyboard Emulation |
+--------------------------+-----------------------------+

Set these option either before or after the ``project()`` setting like so::

set(TEENSY_CPU_F_MODE 16)
set(TEENSY_USB_MODE serial)
set(TEENSY_KEYBOARD_MODE en-us)

The uploader (teensy_loader_cli) will be automatically used instead of avrdude.
This can be overridden by specifying a LOADER parameter to generate_arduino_firmware:
generate_arduino_firmware(target_name LOADER avrdude)

Advanced Options
~~~~~~~~~~~~~~~~

Expand Down Expand Up @@ -774,6 +822,9 @@ When **Arduino CMake** is configured properly, these options are defined:
+---------------------------------+-----------------------------------------------------+
| **ARDUINO_SDK_VERSION_PATCH** | Patch version of the **Arduino SDK** (ex: 0) |
+---------------------------------+-----------------------------------------------------+
| **TEENSY_FOUND** | Set to True when the **Teensy SDK** is detected |
| | and configured. |
+---------------------------------+-----------------------------------------------------+


During compilation, you can enable the following environment variables.
Expand Down Expand Up @@ -1207,12 +1258,12 @@ Here are some resources you might find useful in getting started.

2. Arduino:

* `Getting Started`_ - Introduction to Arduino
* `Arduino Getting Started`_ - Introduction to Arduino
* `Playground`_ - User contributed documentation and help
* `Arduino Forums`_ - Official forums
* `Arduino Reference`_ - Official reference manual

.. _Getting Started: http://www.arduino.cc/en/Guide/HomePage
.. _Arduino Getting Started: http://www.arduino.cc/en/Guide/HomePage
.. _Playground: http://www.arduino.cc/playground/
.. _Arduino Reference: http://www.arduino.cc/en/Reference/HomePage
.. _Arduino Forums: http://www.arduino.cc/forum/
Expand All @@ -1228,4 +1279,4 @@ Here are some resources you might find useful in getting started.
.. _CMake: http://www.cmake.org/cmake/resources/software.html
.. _CMake Installer: http://www.cmake.org/cmake/resources/software.html
.. _Arduino SDK: http://www.arduino.cc/en/Main/Software

:: _PJRC Teensy: https://www.pjrc.com/teensy/
Loading