mirror of
https://github.com/platformio/platformio-core.git
synced 2025-11-03 23:41:38 +01:00
152 lines
4.6 KiB
ReStructuredText
152 lines
4.6 KiB
ReStructuredText
.. Copyright 2014-2016 Ivan Kravets <me@ikravets.com>
|
|
Licensed under the Apache License, Version 2.0 (the "License");
|
|
you may not use this file except in compliance with the License.
|
|
You may obtain a copy of the License at
|
|
http://www.apache.org/licenses/LICENSE-2.0
|
|
Unless required by applicable law or agreed to in writing, software
|
|
distributed under the License is distributed on an "AS IS" BASIS,
|
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
See the License for the specific language governing permissions and
|
|
limitations under the License.
|
|
|
|
.. _envvars:
|
|
|
|
Environment variables
|
|
=====================
|
|
|
|
`Environment variables <http://en.wikipedia.org/wiki/Environment_variable>`_
|
|
are a set of dynamic named values that can affect the way running processes
|
|
will behave on a computer.
|
|
|
|
*PlatformIO* handles variables which start with ``PLATFORMIO_`` prefix. They
|
|
have the **HIGHEST PRIORITY**.
|
|
|
|
.. contents::
|
|
|
|
General
|
|
-------
|
|
|
|
PlatformIO uses *General* environment variables for the common
|
|
operations/commands.
|
|
|
|
.. envvar:: CI
|
|
|
|
PlatformIO handles ``CI`` variable which is setup by
|
|
`Continuous Integration <http://en.wikipedia.org/wiki/Continuous_integration>`_
|
|
(Travis, Circle and etc.) systems.
|
|
PlatformIO uses it to disable prompts and progress bars. In other words,
|
|
``CI=true`` automatically setup :envvar:`PLATFORMIO_SETTING_ENABLE_PROMPTS` to
|
|
``false`` and :envvar:`PLATFORMIO_DISABLE_PROGRESSBAR` to ``true``.
|
|
|
|
.. envvar:: PLATFORMIO_FORCE_COLOR
|
|
|
|
Force to output color ANSI-codes even if the output is a ``pipe`` (not a ``tty``).
|
|
The possible values are ``true`` and ``false``. Default is ``PLATFORMIO_FORCE_COLOR=false``.
|
|
|
|
.. envvar:: PLATFORMIO_DISABLE_PROGRESSBAR
|
|
|
|
Disable progress bar for package/library downloader and uploader. This is
|
|
useful when calling PlatformIO from subprocess and output is a ``pipe`` (not a ``tty``).
|
|
The possible values are ``true`` and ``false``. Default is ``PLATFORMIO_DISABLE_PROGRESSBAR=false``.
|
|
|
|
.. envvar:: PLATFORMIO_HOME_DIR
|
|
|
|
Allows to override :ref:`projectconf` option :ref:`projectconf_pio_home_dir`.
|
|
|
|
.. envvar:: PLATFORMIO_LIB_DIR
|
|
|
|
Allows to override :ref:`projectconf` option :ref:`projectconf_pio_lib_dir`.
|
|
|
|
.. envvar:: PLATFORMIO_SRC_DIR
|
|
|
|
Allows to override :ref:`projectconf` option :ref:`projectconf_pio_src_dir`.
|
|
|
|
.. envvar:: PLATFORMIO_ENVS_DIR
|
|
|
|
Allows to override :ref:`projectconf` option :ref:`projectconf_pio_envs_dir`.
|
|
|
|
.. envvar:: PLATFORMIO_DATA_DIR
|
|
|
|
Allows to override :ref:`projectconf` option :ref:`projectconf_pio_data_dir`.
|
|
|
|
|
|
Building
|
|
--------
|
|
|
|
.. envvar:: PLATFORMIO_BUILD_FLAGS
|
|
|
|
Allows to set :ref:`projectconf` option :ref:`projectconf_build_flags`.
|
|
|
|
Examples:
|
|
|
|
.. code-block:: bash
|
|
|
|
# Unix:
|
|
export PLATFORMIO_BUILD_FLAGS=-DFOO
|
|
export PLATFORMIO_BUILD_FLAGS="-DFOO -DBAR=1 -DFLOAT_VALUE=1.23457e+07"
|
|
export PLATFORMIO_BUILD_FLAGS="'-DWIFI_PASS=\"My password\"' '-DWIFI_SSID=\"My ssid name\"'"
|
|
|
|
# Windows:
|
|
SET PLATFORMIO_BUILD_FLAGS=-DFOO
|
|
SET PLATFORMIO_BUILD_FLAGS=-DFOO -DBAR=1 -DFLOAT_VALUE=1.23457e+07
|
|
SET PLATFORMIO_BUILD_FLAGS='-DWIFI_PASS="My password"' '-DWIFI_SSID="My ssid name"'
|
|
|
|
.. envvar:: PLATFORMIO_SRC_BUILD_FLAGS
|
|
|
|
Allows to set :ref:`projectconf` option :ref:`projectconf_src_build_flags`.
|
|
|
|
.. envvar:: PLATFORMIO_SRC_FILTER
|
|
|
|
Allows to set :ref:`projectconf` option :ref:`projectconf_src_filter`.
|
|
|
|
.. envvar:: PLATFORMIO_EXTRA_SCRIPT
|
|
|
|
Allows to set :ref:`projectconf` option :ref:`projectconf_extra_script`.
|
|
|
|
|
|
Uploading
|
|
---------
|
|
|
|
.. envvar:: PLATFORMIO_UPLOAD_PORT
|
|
|
|
Allows to set :ref:`projectconf` option :ref:`projectconf_upload_port`.
|
|
|
|
.. envvar:: PLATFORMIO_UPLOAD_FLAGS
|
|
|
|
Allows to set :ref:`projectconf` option :ref:`projectconf_upload_flags`.
|
|
|
|
|
|
Settings
|
|
--------
|
|
|
|
Allows to override PlatformIO settings. You can manage them via
|
|
:ref:`cmd_settings` command.
|
|
|
|
.. envvar:: PLATFORMIO_SETTING_AUTO_UPDATE_LIBRARIES
|
|
|
|
Allows to override setting :ref:`setting_auto_update_libraries`.
|
|
|
|
.. envvar:: PLATFORMIO_SETTING_AUTO_UPDATE_PLATFORMS
|
|
|
|
Allows to override setting :ref:`setting_auto_update_platforms`.
|
|
|
|
.. envvar:: PLATFORMIO_SETTING_CHECK_LIBRARIES_INTERVAL
|
|
|
|
Allows to override setting :ref:`setting_check_libraries_interval`.
|
|
|
|
.. envvar:: PLATFORMIO_SETTING_CHECK_PLATFORMIO_INTERVAL
|
|
|
|
Allows to override setting :ref:`setting_check_platformio_interval`.
|
|
|
|
.. envvar:: PLATFORMIO_SETTING_CHECK_PLATFORMS_INTERVAL
|
|
|
|
Allows to override setting :ref:`setting_check_platforms_interval`.
|
|
|
|
.. envvar:: PLATFORMIO_SETTING_ENABLE_PROMPTS
|
|
|
|
Allows to override setting :ref:`setting_enable_prompts`.
|
|
|
|
.. envvar:: PLATFORMIO_SETTING_ENABLE_TELEMETRY
|
|
|
|
Allows to override setting :ref:`setting_enable_telemetry`.
|