/EmbeddedHelperBetaTest

Beta test of Embedded helper Software, a Brandeis University SPARK Startup

Primary LanguageJava

Embedded Helper Beta Test

Tweet Slack

Price GitHub package version

Extension to the Arduino IDE that automatically generates Arduino Classes.

Embedded Helper Website (Web Demo Coming Soon) »

Quick start

  1. Download Arduino IDE. This is software commonly used to program Arduino and other similar chips

    Download Link

  2. Download Latest Release of this Project In the form of two .jar files

    Download Link

  3. Add Jar Files to Arduino tools folder. How to install the EmbeddedHelper Extension

In your Arduino installation folder (usually in Program Files (x86)/Arduino or Documents), create a folder called EmbeddedHelper in the tools folder, then another folder in EmbeddedHelper called tool; the folders should look like Arduino/tools/Embeddedhelper/tool/. Copy the downloaded files from step 2 into the final tool folder

The result will look similar to this (On Windows 10): Image of folder structure

  1. Launch Arduino IDE Start using EmbeddedHelper

Launch Arduino IDE, and the Embedded Helper tool will show up in the Tools menu as Generate Class Showing installed extension Now launch the Arduino Software, and the Embedded Helper tool will show up in the Tools menu as `Generate Class

Showing installed extension

And please fill out our beta test feedback form to share your thoughts!

Examples

​ Please see the Examples folder for example Arduino Sketches to convert to libraries

Special Features

The tool also includes special features designed to make writing Arduino libraries more efficient

Input author, organization, and supported boards

  • Type Author, Organization, and Boards Supported in this format in your sketch header comment

  • Timer Example Header Comment

  • And the relevant fields will be added to your generated library.properties file

  • Timer Library Properties

  • and the header comment will be reformatted in your generated header, body, and example files

  • Timer Example Header Comment

  • If you specified supported boards, your library will only compile if those boards are used, see the generated .cpp file and .h file

  • Generate class using the Timer example in the examples folder to see these features demonstrated!

    Publishing Library to Arduino Library Manager

    This tool makes it easy to publish your library to the Arduino Library Manager

    1. Make sure your library compiles
    2. Delete the .development folder, this allows you to modify the example file while writing the library but is not allowed in a library submission
    3. Update the fields in the library.properties file with a sentence describing the library and other relevant fields
    4. Create a github repository for your library
    5. "Tag it and push the tag (or create a release if you web hosting offers a way to do it, for example with GitHub "releases")
    6. Open an issue on Arduino's GitHub, specifying the URL of the repository from where to download your library. If you have multiple libraries to submit you are welcome to do them all in a single issue." From Library Manager FAQ