Skip to content

Generate more Arduino IDE library example files #29

@brtchip-gdm

Description

@brtchip-gdm

The Arduino IDE libraries are based on the code in this repository. The examples for the Arduino IDE libraries are included in the library. At the moment they are mostly customised versions of the normal example code.

There is a sketchbuild.py script that can convert a local example file into a runnable sketch. This simply builds a directory for a sketch with all the required files although a few changes are needed to make it run.

The libbuild.py script could be improved to make all the required changes to an example code so it could be included in the Adruino IDE library.

Currently this process is used in libbuild.py:

  • API header files are preprocessed to obtain the functions, constants and other information that is applicable to the API version.
  • The template files for the Arduino IDE library are filled out with the above information.
  • The template files are processed to remove unnecessary code which is not applicable to the API version. This is not nested and can only cope with a number of set conditions.
  • The example files which are based on the normal example code files are processed to exclude code that is not applicable.
  • Some of the documentation is copied from the normal example directory. This is just image files in the "docs" directory of a normal example that exactly matches the name of the Arduino IDE example at the moment.

Improvements needed:

  • The template file processing to allow nested commands (maybe use the C preprocessor and revert to IS_EVE_API for non-used code).
  • Example code to be taken as much as possible from the main example code eve_common directory. There can be at most one .ino file in the Arduino IDE library code to run the program.

Metadata

Metadata

Assignees

Labels

enhancementNew feature or request

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions