Skip to content

Latest commit

 

History

History
148 lines (112 loc) · 6.91 KB

PlatformIO.md

File metadata and controls

148 lines (112 loc) · 6.91 KB

PlatformIO

PlatformIO is an open source ecosystem for embedded development. It has a built-in library manager and is Arduino compatible. It supports most operating systems; Windows, MacOS, Linux 32 and 64-bit; ARM and X86.
And best of all, MiniCore is supported!

MiniCore + PlatformIO

At the moment it is not possible to burn the bootloader or set fuses using PlatformIO. You will still have to use Arduino IDE for this. However, PlatformIO really shows its stength when working on large projects, often with a lot of dependencies. I've made a simple platformio.ini template you can use when creating a project for a MiniCore compatible device. The most common functionality is available through this template. For more information about the build option, check out PlatformIO's Project Configuration File Doc page.

; PlatformIO Project Configuration File for MiniCore
; https://github.com/MCUdude/MiniCore/
;
;   Build options: build flags, source filter
;   Upload options: custom upload port, speed, and extra flags
;   Library options: dependencies, extra library storages
;   Advanced options: extra scripting
;
; Please visit documentation for the other options
; https://github.com/MCUdude/MiniCore/blob/master/PlatformIO.md
; https://docs.platformio.org/page/projectconf.html


; ENVIRONMENT SETTINGS
[env:MiniCore]
platform = atmelavr
framework = arduino

; TARGET SETTINGS
; PlatformIO requires the board parameter. Must match your actual hardware
board = ATmega328P
; Clock frequency in [Hz]
board_build.f_cpu = 16000000L

; BUILD OPTIONS
; Comment out to enable LTO (this line unflags it)
build_unflags = -flto
; Extra build flags
build_flags = 

; UPLOAD SETTINGS
; Upload serial port is automatically detected by default. Override by uncommenting the line below
;upload_port = /dev/cu.usbserial*
; Upload baud rate
board_upload.speed = 115200

; Upload using programmer
;upload_protocol = usbasp
; Aditional upload flags
;upload_flags = -Pusb

; SERIAL MONITOR OPTIONS
; Monitor and upload port is the same by default
;monitor_port = 
; Serial monitor baud rate
monitor_speed = 9600

board

PlatformIO requires the board parameter to be present. The table below shows what board name should be used for each target

Target Board name
ATmega328PB ATmega328PB
ATmega328P
ATmega328PA		 ATmega328P
ATmega328 ATmega328
ATmega168PB ATmega168PB
ATmega168P
ATmega168PA		 ATmega168P
ATmega168
ATmega168A		 ATmega168
ATmega88PB ATmega88PB
ATmega88P
ATmega88PA		 ATmega88P
ATmega88
ATmega88A		 ATmega88
ATmega48PB ATmega48PB
ATmega48P
ATmega48PA		 ATmega48P
ATmega48
ATmega48A		 ATmega48
ATmega8
ATmega8A		 ATmega8

board_build.f_cpu

Holds the main clock frequency in [Hz]. Note that the clock frequency and upload baud rate will have to match if uploading using a serial bootloader.
Below is a table with the default clocks and baud rates for MiniCore:

Clock speed Oscillator board_build.f_cpu board_upload.speed
20 MHz External 20000000L 115200
18.432 MHz External 18432000L 115200
16 MHz External 16000000L 115200
12 MHz External 12000000L 57600
8 MHz External 8000000L 57600
8 MHz Internal 8000000L 38400
1 MHz Internal 1000000L 9600

build_unflags

This parameter is used to unflag. Since LTO is enabled by default in PlatformIO we may disable it by unflagging -flto.

build_flags

This parameter is used to set compiler flags. This is useful if you want to for instance want to chage the serial RX or TX buffer. Here's a list of the current available core files flags:

Flag Default size Description
-DSERIAL_RX_BUFFER_SIZE=128 64 bytes Sets the serial RX buffer to 128 bytes
-DSERIAL_TX_BUFFER_SIZE=128 64 bytes Sets the serial TX buffer to 128 bytes
-DTWI_BUFFER_SIZE=64 32 bytes Sets the TWI (i2c) buffer to 64 bytes
-DTWI1_BUFFER_SIZE=64 32 bytes Sets the TWI1 (i2c) buffer to 64 bytes (ATmega328PB only)

Example: build_flags = -DSERIAL_RX_BUFFER_SIZE=128 -DSERIAL_TX_BUFFER_SIZE=128

upload_port

Holds the serial port used for uploading. PlatformIO automatically detects the serial port. However, if you want to override this you can uncomment upload_port. Use /dev/[port] on Unix compatible systems, and use COMx on Windows.

board_upload.speed

Upload baudrate. See board_build.f_cpu for more details.

upload_protocol

Used when using a programmer rather than using a USB to serial adapter.
Supports all Avrdude compatible programmers such as usbasp, usbtiny and stk500v1.

upload_flags

Used to pass extra flags to Avrdude when uploading using a programmer.
Typical parameters are -PUSB, -B[clock divider] and -b[baudrate]

monitor_port

PlatformIO detects serial ports automatically. However, if you want to override this you can uncomment monitor_port. Use /dev/[port] on Unix compatible systems, and use COMx on Windows.

monitor_speed

Sets the serial monitor baud rate. Defaults to 9600 if not defined.