Difference between revisions of "PlatformIO"

From Stanford SSI Wiki
Jump to navigation Jump to search
 
(6 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{guide| authors=John Dean ({{slack-user|johndean}})}}
+
{{guide| authors=John Dean ({{slack-user|display-name=John Dean}})}}
  
 
==Background==
 
==Background==
Line 5: Line 5:
 
[http://platformio.org/ PlatformIO] is an open source Integrated Development Environment (IDE) for programming microcontrollers (like arduino) and embedded systems. For our purposes, we mainly use it to write software for the [https://www.pjrc.com/store/teensy32.html Teensy 3.2 Microcontoller]. In the past, we previously had used the easy to set up [https://www.arduino.cc/en/Guide/Environment Arduino IDE], however it has many drawbacks and lacks many of the features of a full IDE.
 
[http://platformio.org/ PlatformIO] is an open source Integrated Development Environment (IDE) for programming microcontrollers (like arduino) and embedded systems. For our purposes, we mainly use it to write software for the [https://www.pjrc.com/store/teensy32.html Teensy 3.2 Microcontoller]. In the past, we previously had used the easy to set up [https://www.arduino.cc/en/Guide/Environment Arduino IDE], however it has many drawbacks and lacks many of the features of a full IDE.
  
==Instalation==
+
==Installation==
  
 
To install the PlatformIO IDE, follow the installation steps on [http://docs.platformio.org/en/latest/ide/atom.html#installation the PlatformIO website]
 
To install the PlatformIO IDE, follow the installation steps on [http://docs.platformio.org/en/latest/ide/atom.html#installation the PlatformIO website]
Line 11: Line 11:
 
There are a fair number of steps to follow if you do not have any of the software that PlatformIO incorporates, but it should be fairly straightforward.
 
There are a fair number of steps to follow if you do not have any of the software that PlatformIO incorporates, but it should be fairly straightforward.
  
'''OSX Users:''' due to a a problem with the program that loads your compiled code to the teensy on OSX, you will need to used a custom executable file in place of the original.
+
'''OS X Users:''' due to a a problem with the program that loads your compiled code to the teensy on OS X, you will need to used a custom executable file in place of the original.
 
''there will be more added here later''
 
''there will be more added here later''
  
 
==Usage Guide==
 
==Usage Guide==
  
=Starting a new project=
+
To get started in PlatformIO, follow the [http://docs.platformio.org/en/latest/ide/atom.html#quick-start PlatformIO Quickstart tutorial]
  
To start a new project, select <code> PlatformIO &rarr; Initialize or Update PlatformIO Project </code> from the top bar. From this menu, simple select the board that you are programming for (Usually will be Teensy 3.2), navigate to the directory that you want to generate the project in. You should create a new directory that is the name of your project, as you want nothing but the project's contents to be in the directory that you are working in.
+
===Library Dependencies===
  
=Project Setup=
+
If you used the Ardiuno IDE, you will be used to having an folder on your computers where you install libraries. If you downloaded a project from the internet that needed a bunch of new libraries, you would have to install all of them manually. Thankfully, with PlatformIO, you no longer have to worry about this. Dependencies for libraries are added to the <code>platformio.ini</code> file with a github link, so that they are automatically downloaded if you do not already have them on your computer.
  
 +
For information on exactly how to set it up, follow [http://docs.platformio.org/en/latest/librarymanager/index.html?highlight=libraries this guide]
  
 
+
[[Category:Raccoonworks]]
 
+
[[Category:Getting started]]
=Library Dependencies=
 
 
 
If you used the Ardiuno IDE, you will be used to having an folder on your computers where you install libraries. If you downloaded a project from the internet that needed a bunch of new libraries, you would have to install all of them manually. Thankfully, with PlatformIO, you no longer have to worry about this.
 

Latest revision as of 03:32, 1 March 2021

Journey.jpg

This is a guide

Welcome! This article is intended to guide you through an SSI process. While its authors have made efforts to make it useful, if you have questions, please ask the authors on Slack. They will be able to both help you and improve this resource for future SSI-ers.

This article was written by John Dean (SlackLogo.png@John Dean ).

Background

PlatformIO is an open source Integrated Development Environment (IDE) for programming microcontrollers (like arduino) and embedded systems. For our purposes, we mainly use it to write software for the Teensy 3.2 Microcontoller. In the past, we previously had used the easy to set up Arduino IDE, however it has many drawbacks and lacks many of the features of a full IDE.

Installation

To install the PlatformIO IDE, follow the installation steps on the PlatformIO website

There are a fair number of steps to follow if you do not have any of the software that PlatformIO incorporates, but it should be fairly straightforward.

OS X Users: due to a a problem with the program that loads your compiled code to the teensy on OS X, you will need to used a custom executable file in place of the original. there will be more added here later

Usage Guide

To get started in PlatformIO, follow the PlatformIO Quickstart tutorial

Library Dependencies

If you used the Ardiuno IDE, you will be used to having an folder on your computers where you install libraries. If you downloaded a project from the internet that needed a bunch of new libraries, you would have to install all of them manually. Thankfully, with PlatformIO, you no longer have to worry about this. Dependencies for libraries are added to the platformio.ini file with a github link, so that they are automatically downloaded if you do not already have them on your computer.

For information on exactly how to set it up, follow this guide