view release on metacpan or  search on metacpan

script/arduino_builder  view on Meta::CPAN

=item C<--skip I<step>>

=item C<--force I<step>>

=item C<--only I<step>>

=item C<--stack-trace-on-error>, C<--stack>

=item C<--target-port I<port>>, C<--port>

=item C<--force-port I<protocol:port>>

=back

=head1 CONFIGURATION FILE SYNTAX

The syntax of the configuration file used by this tool is the same as those used
to describe Arduino I<platforms>. You can read about it
L<here|https://arduino.github.io/arduino-cli/0.32/platform-specification/#configuration-files-format>.

Informally, the format is a UTF-8 text file, where empty lines and lines
starting with C<#> are ignored (but note that you can’t have end-of-line
comments on non-comment lines). Other lines have an C<key=value> syntax where
keys can contain letters, numbers and C<.>, C<_>, and C<-> characters and values
can contain anything. Values can be expressed with other values by putting their
key in brackets. For examples:

    value.name=text with {other.value}

=head1 CONFIGURATION FILES

When you start C<arduino_builder> it will read a set of configuration files.
Once a key is defined by a given file it will not be overriden by other files
defining the same key. So the most specific configuration should be loaded
first.

The following files are read in that order when they exist (any of these files
is allowed to be missing):

=over 4

=item - I<Command line options>. These are not actually configuration files but
options passed with the C<--config> or C<--menu> command line switches will take
precedance over any other configuration files that will be read afterward.

=item - F<arduino_builder.local> file in the project directory.

=item - F<arduino_builder.config> file in the project directory.

=item - F<boards.local.txt> file in the platform package directory.

=item - F<boards.txt> file in the platform package directory.

This file and the previous ones are treated specially: once they are read,
configuration properties are filtered to keep only thoses prefixed by the name
of the board specified by the C<builder.package.board> configuration (that is
expected to be present in the F<arduino_builder.config> file). And that prefix
is removed from the configuration keys.

After that step, the L</"Menu Resolution"> happens and the resulting
configuration values will override those read in the F<boards.local.txt> and
F<boards.txt> files (but not those read in previous files).

=item - F<platform.local.txt> file in the platform package directory.

=item - F<platform.txt> file in the platform package directory.

=item - F<programmers.local.txt> file in the platform package directory.

=item - F<programmers.txt.txt> file in the platform package directory.

=back

=head1 CONFIGURATION VALUES

Note that all paths set in configuration values must be absolute path (they will
not be interpreted as relative path to the config file for example). However you
can make these paths be relative by using another configuration value to provide
the absolute part. For example:

  builder.default_build_dir={builder.project_dir}/_build

In the list below, the configuration names followed by an asterisk C<*> are
those that should usually be in F<arduino_builder.local> file rather than in the
F<arduino_builder.config> one.

=over 4

=item C<builder.project_name>

=item C<builder.package.name>

=item C<builder.package.path>*

=item C<builder.package.arch>

=item C<builder.package.board>

=item C<builder.arduino.install_dir>

=item C<builder.default_build_dir>

=item C<builder.source.path>

=item C<builder.source.is_recursive>

=item C<builder.menu.XXX>

=item C<builder.library.XXX>

=item C<builder.parallelize>*

=item C<builder.config.append.XXX>

=item C<builder.upload.port>*

The port to use to upload and/or monitor the board. The passed value should be
the label of a port found by the B<monitor> command (typically the name of the
serial port to use). You can run C<arduino_builder monitor -l debug> to see
which ports are found by the command.