A set of java programs to automatically generate arduino library header (.h), body (.cpp), keywords (.txt), and example sketch (.ino) from a working Arduino (.ino) sketch.
For users who want to create libraries from the Arduino IDE, the project can be integrated so it works like this (press control+space or go to sketch menu--> Generate Arduino Class):
This is an automatic verion of the tutorial here
- Install the tools to compile the Arduino application yourself
- Copy the ClassGeneratorInterface class from src/processing/app into Arduino/app/src/processing/app
- Copy ArduinoClassGenerator Folder in src/cc to Arduino/src/cc
- Note:My RunArduino.bat file copies the folders from this github repo into the Arduino project and runs it for Windows
For users who want to create class files independent of other software, you will be able to do this:
- Click on Runme.jar, which will allow the user to enter the name of the class to generate and the file path it is in.
- When you click on the body, the editable files are displayed.
- Note: I deleted the code used to generate the .jar file on May 31, 2019 to focus on the Arduino IDE integration.
I haven't found any tool that generates Arduino Libraries. Probably the closest is Sloeber, a great IDE providing autocomplete, automatic library includes, and other professional features.
That is why I created a ArduinoClassGenerator, a tool which converts Arduino Sketches into Arduino libraries. While working on my project, I have found that the best workflow for me to create arduino libraries is to write a .ino sketch with the behavior I want, and then sort out that code into the .h, .cpp, example file, and keywords file manually or with a template.
However, I realized that much of this work can be done for me, so I created a java class which reads the Morse.ino or other sketch, and parses it (MorseParsed) into a format containing the essential information, like variable type, name, value, and comments.
Then, my Java program generates a cpp (Morse.cpp), .h (Morse.h), keywords (MorseKeywords.txt), and example file (MorseExampleFile.ino). It can do this because all of the information is contained in the parsed file. This means that instead of copy pasting variable names from a header to body file, the computer does the busywork. In addition, the program can identify which methods should be public by whether they are called in the loop and setup methods.
This tool could save advanced programmers the time of typing out a class from a sketch, and could be used to encourage good programming practices like commenting and including a keywords file. In addition, this tool could help programmers who might not format their code for easy sharing to do so.
-
Arduino Class: header, file, example and keywords files can be generated by creating an ArduinoClassContainer object given strings containing information about the class like variables and methods.
-
Parsing tools and SketchParser class to generate those strings so the files can be created from an Arduino sketch, see MorseParsed.txt file for the format
-
Integration with Arduino IDE using ClassGeneratorInterface class with one click.
-
Allow for code variation like missing header comment, library includes, method parameters, and variables, as well as brackets on new line of method declaration vs same line
-
Generation of TODO messages for missing comments
-
Automatic sorting of class methods into private and public based on whether they appear in the sketch setup or loop methods
-
Inclusion of date in header comments
-
Generate an error message if board is being used other than user defined allowed boards like (ARDUINO_AVR_UNO)
-
Unit tests and example prompts to show usage of programs and enforce standards
Previous: (email jsmith2021@brandeis.edu if interested)
-
Ability to prompt user for formatted strings so experiences users can quickly create a class from scratch
-
Ability to prompt user for individual fields so they don't need to know anything about the formatting rules for fields to generate arduino class files
-
Interface to generate class files independent of any development environment, click on runMe.jar
-
The format used by sketchParser could allow for a simplified arduino programming language.
-
The classes generated could go into a folder structure and with additional files to publish the library to github
-
Integration with release of an IDE, probably either Sloeber or Arduino
This repository is licensed under the gnu general public license v 3.0
This is the same license as the Arduino repository
I thank Professor Pito Salas for his advice on documentation and Timothy Hebert for his support of the Zumo automation project that gave me the idea to make this project.
If there is a problem, submit an issue on github or email jsmith2021@brandeis.edu
To contribute to the project, submit a pull request on github or email same adress
Clickup Task ID:#164d8v test