platformio settings¶
Manage PlatformIO settings
Contents
platformio settings get¶
Description¶
Note
- The
Yes
value is equal to:True
,Y
,1
and is not case sensitive. - You can override these settings using Environment variables.
Get/List existing settings
Settings¶
enable_telemetry
¶
Default: | Yes |
---|---|
Values: | Yes/No |
Share minimal diagnostics and usage information to help us make PlatformIO better:
- PlatformIO errors/exceptions
- The name of used platforms, boards, frameworks (for example, “espressif”, “arduino”, “uno”, etc.)
- The name of commands (for example, “run”, “lib list”, etc.)
- The type of IDE (for example, “atom”, “eclipse”, etc.)
This gives us a sense of what parts of the PlatformIO is most important.
The source code of telemetry service is open source. You can make sure that we DO NOT share PRIVATE information or source code of your project. All information shares anonymously.
Thanks a lot that keep this setting enabled.
force_verbose
¶
Default: | No |
---|---|
Values: | Yes/No |
Force verbose output when processing environments. This setting overrides
projects_dir
¶
Default: | ~/Documents/PlatformIO/Projects |
---|---|
Values: | Path to folder |
Default location for PlatformIO projects (PIO Home)
Examples¶
- List all settings and theirs current values
> platformio settings get
Name Value [Default] Description
------------------------------------------------------------------------------------------
auto_update_libraries No Automatically update libraries (Yes/No)
auto_update_platforms No Automatically update platforms (Yes/No)
check_libraries_interval 7 Check for the library updates interval (days)
check_platformio_interval 3 Check for the new PlatformIO interval (days)
check_platforms_interval 7 Check for the platform updates interval (days)
enable_cache Yes Enable caching for API requests and Library Manager
strict_ssl No Strict SSL for PlatformIO Services
enable_telemetry Yes Telemetry service?#enable-telemetry> (Yes/No)
force_verbose No Force verbose output when processing environments
projects_dir ~/Documents/PlatformIO/Projects Default location for PlatformIO projects (PIO Home)
- Show specified setting
$ platformio settings get auto_update_platforms
Name Value [Default] Description
------------------------------------------------------------------------------------------
auto_update_platforms Yes Automatically update platforms (Yes/No)
platformio settings set¶
Description¶
Set new value for the setting
Examples¶
Change to check for the new PlatformIO each day
$ platformio settings set check_platformio_interval 1
The new value for the setting has been set!
Name Value [Default] Description
------------------------------------------------------------------------------------------
check_platformio_interval 1 [3] Check for the new PlatformIO interval (days)
platformio settings reset¶
Description¶
Reset settings to default
Examples¶
$ platformio settings reset
The settings have been reset!
Name Value [Default] Description
------------------------------------------------------------------------------------------
auto_update_libraries No Automatically update libraries (Yes/No)
auto_update_platforms No Automatically update platforms (Yes/No)
check_libraries_interval 7 Check for the library updates interval (days)
check_platformio_interval 3 Check for the new PlatformIO interval (days)
check_platforms_interval 7 Check for the platform updates interval (days)
enable_cache Yes Enable caching for API requests and Library Manager
strict_ssl No Enable SSL for PlatformIO Services
enable_telemetry Yes Telemetry service?#enable-telemetry> (Yes/No)
force_verbose No Force verbose output when processing environments
projects_dir ~/Documents/PlatformIO/Projects Default location for PlatformIO projects (PIO Home)