Skip to content

Commit 4835ec2

Browse files
committed
Clarifications
1 parent cf8a22f commit 4835ec2

1 file changed

Lines changed: 49 additions & 42 deletions

File tree

README.md

Lines changed: 49 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@
44

55
**Use Arduino as a replacement for Energia** to develop on Texas Instruments LaunchPad products.
66

7-
The [Arduino Boards Manager][69] makes it possible to load other processor families besides the original AVR-based Arduino boards. This repo contains instructions and relevant files for loading processor cores for Texas Instruments LaunchPad products in the MSP430, MSP432, and Tiva families. This allows development for TI LaunchPads using the Arduino [IDE][80] or [CLI][81] instead of the [Energia IDE][1].
7+
[Energia][1] was originally created in 2012 as a fork from Arduino specifically to support Texas Instruments LaunchPads. However, it is [no longer maintained][73]. The last version was released in 2019.
88

9-
Energia was originally developed in 2012 as a fork from Arduino specifically to support Texas Instruments LaunchPads. Unfortunately, it is [no longer maintained][73], with the last version released in 2019. The good news is that the processor cores used by Energia are compatible with Arduino.
9+
Fortunately, **Texas Instruments processor cores can be loaded into Arduino** using the [Arduino Boards Manager][69]. I created this repo to maintain the Energia MSP430, MSP432, and Tiva cores so that they can continue to be used with Arduino.
1010

1111
## Loading a LaunchPad Board into Arduino IDE
1212

@@ -28,37 +28,36 @@ Energia was originally developed in 2012 as a fork from Arduino specifically to
2828
2929
## Energia Application Libraries and Examples
3030
31-
The Energia IDE includes several libraries and examples at the application level of the IDE instead of in the platform cores. This means that if you use the Arduino IDE/CLI and install an MSP or Tiva core, you don't end up getting every library and example sketch that you would when using the Energia IDE. Most of the libraries and examples included with the Energia application are either readily available with Arduino or are obsolete. However, some are particular to the platforms supported by Energia and are not directly available with Arduino, so I have published standalone libraries to allow them to be loaded into Arduino.
31+
Energia includes several libraries and example sketches at the application level of the IDE instead of in the platform cores. This means that if you install an MSP or Tiva core into Arduino, you don't end up getting every library and example sketch that you would when using the Energia IDE.
3232
33-
Stand-alone repositories for Energia libraries:
33+
Most of the libraries and examples included with the Energia application are either readily available with Arduino or are obsolete. However, some are particular to the platforms supported by Energia and are not directly available with Arduino. I have published standalone libraries to allow them to be loaded into Arduino.
3434
35-
- [LCD_SharpBoosterPack_SPI][25]
36-
- [OneMsTaskTimer][26]
35+
These libraries are included in the Arduino Library Manager registry, so they can easily be installed from the `Sketch->Include Library->Manage Libraries...` menu. Note that some of the library names needed to be shortened to meet the registry name length recommendation.
3736
38-
Energia example sketches packaged into libraries so that they can be loaded into the Arduino IDE:
39-
40-
- [Energia-EducationalBP_MKII][27]
41-
- [Energia-MultiTasking][28]
42-
43-
The above four libraries are included in the Arduino Library Manager registry, so they can easily be installed from the `Sketch->Include Library->Manage Libraries...` menu.
37+
| Repository | Name in Arduino Library Manager | Notes |
38+
| -------------------------------- | ------------------------------- | --------------------------------------- |
39+
| [LCD_SharpBoosterPack_SPI][25] | LCD_SharpBP_SPI | Energia application library |
40+
| [OneMsTaskTimer][26] | OneMsTaskTimer | Energia application library |
41+
| [Energia-EducationalBP_MKII][27] | Energia-EBP_MKII | Example sketches packaged into library |
42+
| [Energia-MultiTasking][28] | Energia-MultiTas | Example sketches packaged into library |
4443
4544
## Installing LaunchPad Drivers
4645
47-
Depending on your host machine and the specific board you are programming, you probably need to install drivers and/or configuration files in order to communicate with the LaunchPad. If you see a message along the lines of "Error connecting to the target", then a missing driver or configuration file is likely the cause.
46+
Depending on your host machine and the specific board you are programming, you may need to install drivers and/or configuration files in order to communicate with the LaunchPad. If you see a message along the lines of "Error connecting to the target", then a missing driver or configuration file is likely the cause.
4847
4948
### MacOS
5049
51-
No drivers should be needed for MSP432, Tiva, or the newer MSP430 LaunchPads (including the MSP430G2ET).
50+
No drivers should be needed for MSP432, Tiva, or the newer MSP430 LaunchPads (including the [MSP430G2ET][210]).
5251
53-
The old MSP430G2 (non-ET) LaunchPads work without drivers when using version 0.25 of the `mspdebug` tool included with the msp430 v1.1.0 and msp430gcc9 v3.0.0 cores. Versions of `mspdebug` included with older versions of the MSP430 cores required separate drivers to be installed.
52+
The [old MSP430G2][211] (non-ET) LaunchPads work without drivers when using version 0.25 of the `mspdebug` tool, which is included with the msp430 v1.1.0 and msp430gcc9 v3.0.0 cores. Versions of `mspdebug` included with older MSP430 cores required separate drivers to be installed.
5453
5554
### Windows
5655
5756
On Windows, the drivers can be installed using either of the methods below:
5857
5958
1. Install [Code Composer Studio IDE][89] from Texas Instruments.
6059
61-
Code Compuser Studio is a free professional-level IDE for Texas Instruments processors. It is fully supported and regularly updated by Texas Instruments. However, it is a large download (> 1 GB), and installs many more packages than are needed if you are just using the Arduino IDE. You are essentially installing a full IDE that you won't be using, just to get the drivers.
60+
Code Composer Studio is a free professional-level IDE for Texas Instruments processors. It is fully supported and regularly updated by Texas Instruments. However, it is a large download (> 1 GB), and installs many more packages than are needed if you are just using the Arduino IDE. You are essentially installing a full IDE that you won't be using, just to get the drivers.
6261
6362
Even with this in mind, **I use this method to install the drivers**, because this way I know they are up-to-date and supported.
6463
@@ -99,7 +98,7 @@ GCC 9.3 fully supports C++11 and C++14 by default. GCC9.3 is the last MSP430 GCC
9998
10099
Having two distinct platform cores allows you to have both compilers installed so that you can easily switch between them. Code which was originally compiled with GCC 4.6 may run into some compatibility issues when compiled with GCC 9.3, as outlined in this [migration README][203].
101100
102-
If you install both platforms, be sure to select the correct platform core and board from the Tools->Board menu.
101+
If you install both platforms, be sure to select the correct platform core and board from the `Tools->Board` menu.
103102
104103
Note that the MSP432 and Tiva platforms install GCC 8.3, which fully support C++11 and C++14 by default.
105104
@@ -293,8 +292,8 @@ The tools are specific to the board package platform and version.
293292

294293
| Board Version | Compiler | dslite | mspdebug | ino2cpp |
295294
| -------------- | -------- | ------ | -------- | ------- |
296-
| MSP430 3.0.0 | msp430-elf-gcc 9.3.1.11 | 12.8.0.3352 | 0.24 | N/A |
297-
| MSP430 1.1.0 | msp430-gcc 4.6.6 | 12.8.0.3522 | 0.24 | N/A |
295+
| MSP430 3.0.0 | msp430-elf-gcc 9.3.1.11 | 12.8.0.3352 | 0.25 | N/A |
296+
| MSP430 1.1.0 | msp430-gcc 4.6.6 | 12.8.0.3522 | 0.25 | N/A |
298297
| MSP430 1.0.7 | msp430-gcc 4.6.6 | 9.3.0.1863 | 0.24 | N/A |
299298
| MSP430 1.0.6 | msp430-gcc 4.6.6 | 9.2.0.1793 | 0.24 | N/A |
300299
| MSP430 1.0.5 | msp430-gcc 4.6.6 | 8.2.0.1400 | 0.24 | N/A |
@@ -307,23 +306,26 @@ The tools are specific to the board package platform and version.
307306
| Tiva 1.0.4 | arm-none-eabi-gcc 8.3.1-20190703 | 9.3.0.1863 | N/A | N/A |
308307
| Tiva 1.0.3 | arm-none-eabi-gcc 6.3.1-20170620 | 7.2.0.2096 | N/A | N/A |
309308

310-
| Tool Download Links | | | |
311-
| :------------------------------- | ------------ | ----------- | ----------- |
312-
| msp430-gcc 4.6.6 | [Wndows][30] | [MacOS][31] | [Linux][32] |
313-
| msp430-elf-gcc 9.2.0.50 | [Wndows][55] | [MacOS][56] | [Linux][57] |
314-
| msp430-elf-gcc 8.3.0.16 | [Wndows][58] | [MacOS][59] | [Linux][60] |
315-
| msp430-elf-gcc 9.3.1.1 | [Wndows][204]| [MacOS][205]| [Linux][206]|
316-
| arm-none-eabi-gcc 8.3.1-20190703 | [Wndows][33] | [MacOS][34] | [Linux][35] |
317-
| arm-none-eabi-gcc 6.3.1-20170620 | [Wndows][36] | [MacOS][37] | [Linux][38] |
318-
| dslite 12.8.0.3522 | [Wndows][96] | [MacOS][97] | [Linux][98] |
319-
| dslite 9.3.0.1863 | [Wndows][39] | [MacOS][40] | [Linux][41] |
320-
| dslite 9.2.0.1793 | [Wndows][42] | [MacOS][43] | [Linux][44] |
321-
| dslite 8.2.0.1400 | [Wndows][45] | [MacOS][46] | [Linux][47] |
322-
| dslite 7.2.0.2096 | [Wndows][48] | [MacOS][49] | [Linux][50] |
323-
| mspdebug 0.24 | [Wndows][51] | [MacOS][52] | [Linux][53] |
324-
| ino2cpp 1.0.4 | [Wndows][54] | [MacOS][54] | [Linux][54] |
325-
| ino2cpp 1.0.6 | [Wndows][64] | [MacOS][64] | [Linux][64] |
326-
| ino2cpp 1.0.7 | [Wndows][76] | [MacOS][77] | [Linux][78] |
309+
| Tool Download Links | | | |
310+
| :------------------------------- | ------------ | ------------ | ----------- |
311+
| msp430-gcc 4.6.6 | [Wndows][30] | [MacOS][31] | [Linux][32] |
312+
| msp430-elf-gcc 8.3.0.16 | [Wndows][58] | [MacOS][59] | [Linux][60] |
313+
| msp430-elf-gcc 9.2.0.50 | [Wndows][55] | [MacOS][56] | [Linux][57] |
314+
| msp430-elf-gcc 9.3.1.1 | [Wndows][204]| [MacOS][205] | [Linux][206]|
315+
| arm-none-eabi-gcc 8.3.1-20190703 | [Wndows][33] | [MacOS][34] | [Linux][35] |
316+
| arm-none-eabi-gcc 6.3.1-20170620 | [Wndows][36] | [MacOS][37] | [Linux][38] |
317+
| dslite 12.8.0.3522 | [Wndows][96] | [MacOS][97] | [Linux][98] |
318+
| dslite 9.3.0.1863 | [Wndows][39] | [MacOS][40] | [Linux][41] |
319+
| dslite 9.2.0.1793 | [Wndows][42] | [MacOS][43] | [Linux][44] |
320+
| dslite 8.2.0.1400 | [Wndows][45] | [MacOS][46] | [Linux][47] |
321+
| dslite 7.2.0.2096 | [Wndows][48] | [MacOS][49] | [Linux][50] |
322+
| mspdebug 0.24 | [Wndows][51] | [MacOS][52] | [Linux][53] |
323+
| mspdebug 0.25 (see Note below) | [Wndows][51] | [MacOS][213] | [Linux][53] |
324+
| ino2cpp 1.0.4 | [Wndows][54] | [MacOS][54] | [Linux][54] |
325+
| ino2cpp 1.0.6 | [Wndows][64] | [MacOS][64] | [Linux][64] |
326+
| ino2cpp 1.0.7 | [Wndows][76] | [MacOS][77] | [Linux][78] |
327+
328+
Note that mspdebug 0.25 was only created for MacOS; the Linux and Windows download links point to version 0.24.
327329

328330
##### Additional Board Package Files
329331

@@ -357,16 +359,16 @@ The files in the [`actions`][15] directory contain examples for [arduino-compile
357359

358360
- Energia IDE [application][1] and source code [repo][2]
359361
- Website [source pages repo][93] for energia.nu
360-
- Energia MSP430 core [repo][3]
362+
- Energia MSP430 platform core [repo][3]
361363
- Information on [migrating from GCC 4.6 to GCC 9.3][203]
362364
- GCC [release history][gcc-releases]
363365
- GCC [standards support][gcc-standards]
364-
- Energia MSP432 core [repo][67]
365-
- Energia Tiva C core [repo][4]
366+
- Texas Instruments [MSP430 GCC compiler][212]
367+
- Energia MSP432 platform core [repo][67]
368+
- Energia Tiva C platform core [repo][4]
366369
- Arduino instructions for [installing cores][5]
367370
- GitHub documentation for managing GitHub Actions [workflows][22]
368371
- Compile Arduino Sketches GitHub [action][20]
369-
- Unofficial list of Arduino 3rd Party [Board Manager URLs][68]
370372
- Updated MSP432 [board package repo][74] created by [ndroid][75]
371373
- [Galaxia multi-tasking library][83] created by [Rei Vilo][84]
372374
- Info on using Arduino cores with [PlatformIO][86]: [here][87] and [here][88]
@@ -387,6 +389,7 @@ The files in the [`actions`][15] directory contain examples for [arduino-compile
387389
- STM32 board manager URL:
388390
- <https://github.com/stm32duino/BoardManagerFiles/raw/main/package_stmicroelectronics_index.json>
389391
- Note that many of the devices in this package require [additional options][72] as part of the FQBN, for example: `STMicroelectronics:stm32:GenF1:pnum=BLUEPILL_F103C8`
392+
- Unofficial list of Arduino 3rd Party [Board Manager URLs][68]
390393
391394
## License
392395
@@ -473,8 +476,6 @@ See the file [`LICENSE.txt`][101] in this repository.
473476
[77]: https://s3.amazonaws.com/energiaUS/tools/macosx/ino2cpp-1.0.7-x86_64-apple-darwin.tar.bz2
474477
[78]: https://s3.amazonaws.com/energiaUS/tools/linux64/ino2cpp-1.0.7-x86_64-pc-linux-gnu.tar.bz2
475478
[79]: https://github.com/ndroid/msp432-core/tree/main#change-log
476-
[80]: https://www.arduino.cc/en/software
477-
[81]: https://arduino.github.io/arduino-cli/
478479
[82]: https://www.ti.com/tool/TI-RTOS-MCU
479480
[83]: https://github.com/rei-vilo/Galaxia_Library
480481
[84]: https://github.com/rei-vilo/
@@ -507,6 +508,10 @@ See the file [`LICENSE.txt`][101] in this repository.
507508
[207]: https://github.com/dlbeer/mspdebug
508509
[208]: https://brew.sh
509510
[209]: https://github.com/dlbeer/mspdebug/releases/tag/v0.25
511+
[210]: https://www.ti.com/tool/MSP-EXP430G2ET
512+
[211]: https://embeddedcomputing.weebly.com/launchpad-msp430g2.html
513+
[212]: https://www.ti.com/tool/MSP430-GCC-OPENSOURCE
514+
[213]: https://github.com/Andy4495/TI_Platform_Cores_For_Arduino/releases/download/v1.3.0/mspdebug-0.25-x86_64-apple-darwin.tar.bz2
510515
[908]: https://forum.43oh.com/topic/13361-add-msp432-support-to-arduino/
511516
[911]: https://forum.43oh.com/topic/31134-error-compiling-for-board-msp-exp430f5529lp/
512517
[970]: https://www.microsoft.com/openjdk
@@ -515,6 +520,8 @@ See the file [`LICENSE.txt`][101] in this repository.
515520
[//]: # ([200]: https://github.com/Andy4495/TI_Platform_Cores_For_Arduino)
516521
[//]: # ([62]: https://github.com/arduino/arduino-builder/blob/master/README.md)
517522
[//]: # ([9]: https://energia.nu/packages/package_energia_index.json)
523+
[//]: # ([80]: https://www.arduino.cc/en/software)
524+
[//]: # ([81]: https://arduino.github.io/arduino-cli/)
518525
519526
[//]: # (This is a way to hack a comment in Markdown. This will not be displayed when rendered.)
520527
[//]: # (The board download links from energia.nu are not consistently working. Previous link for board msp432r 5.29.0 was: http://energia.nu/downloads/download_core.php?file=msp432r-5.29.0.tar.bz2 )

0 commit comments

Comments
 (0)