Skip to content

Latest commit

 

History

History
150 lines (92 loc) · 4.71 KB

development-instructions.rst

File metadata and controls

150 lines (92 loc) · 4.71 KB

Development Instructions

Environment Setup

  1. Pre-conditions:

  2. Create a <SKETCHBOOK>/hardware/arduino-git folder. Where <SKETCHBOOK> is the location of your Arduino sketchbook. The <SKETCHBOOK> default is OS-dependent:

    .. tabs::

   .. group-tab:: Linux

      ::

           {HOME}/Arduino

   .. group-tab:: Windows

      ::

           {DOCUMENTS}/Arduino

   .. group-tab:: MacOS

      ::

           {HOME}/Documents/Arduino

  3. Clone this repo in <SKETCHBOOK>/hardware/arduino-git:

    git clone https://github.com/Infineon/XMC-for-Arduino.git xmc

    This allows quick testing of local changes during development while keeping the released version.

  4. You can check if the correct version is installed by running:

    arduino-cli core list

    You should be able to see the arduino-git:xmc core.

  5. Update all submodule included in this project:

    git submodule update --init --recursive

    If you are not familiar with git submodules, check out Git-Tools-Submodules

  6. Start developing |:tools:|!

|:bell:| If you encounter strange behavior with Arduino IDE during development, try cleaning up the Arduino IDE's cache:

.. tabs::

   .. group-tab:: Windows

      .. code-block:: text

         %AppData%\arduino-ide

   .. group-tab:: Linux

      ::

         ~/.config/arduino-ide

   .. group-tab:: macOS

      ::

         ~/Library/Application Support/arduino-ide/

Code Check and Tests

Pre-commit Hooks

For the C/C++ code format and commit message format, we add git hooks to check it automatically.

For ease of use, we currently use pre-commit to automatically run clang-formatting to format all C/C++ code. Please install this Python package, and follow the quick start (the pre-commit configuration file is already there). You should be able to format your code automatically on git commit.

We also have workflow to for auto-checking, so please refer to code convention before committing your code.

Code Check

Warning

Code Checks are still a work in progress in this project.

If you are developing a new built-in library, please refer to libraries\CAN\Makefile.codecheck using cppcheck for static code analysis to ensure code quality.

Automated Build Checks

Currently a GitHub Action workflow is used for automatic compilation checking. Workflows are defined here.

Validation Test

To validate the XMC-for-Arduino, we utilize Unity for testing various features of the Arduino core and built-in libraries.

Tests are located in tests/arduino-core-tests and included as submodule in this project. Run git submodule update --init --recursive to update them.

If you need to run these tests locally, you'll also need to download GNU Make .

Release

Add a git tag in the format Vx.y.z (e.g. V3.3.0) to trigger the release process.

Creating and Maintaining Third Party Libraries

Basics

The Arduino IDE allows for external libraries to be added to support specific devices and functions which are not part of the core setup. For details on creating libraries see the Arduino library specification.

If you add additional libraries to this project, make sure to document them accordingly.

XMC-for-Arduino Configuration

To ensure that a library specific to one architecture or board type is only compiled when a supporting board is set up, this specification includes a setting for architecture in the library.properties file.

When creating or maintaining third party or external libraries for XMC-for-Arduino please use this setting:

architecture=xmc

If your library also supports other boards and architectures, add those in as well.