https://github.com/firmata/firmata-builder

A utility to generate an Arduino file from a selection of Firmata features.
https://github.com/firmata/firmata-builder

Last synced: 4 days ago
JSON representation

A utility to generate an Arduino file from a selection of Firmata features.

• Host: GitHub
• URL: https://github.com/firmata/firmata-builder
• Owner: firmata
• License: mit
• Created: 2015-01-03T06:13:48.000Z (almost 10 years ago)
• Default Branch: master
• Last Pushed: 2023-08-27T07:41:55.000Z (about 1 year ago)
• Last Synced: 2024-11-07T13:42:05.893Z (7 days ago)
• Language: JavaScript
• Size: 125 KB
• Stars: 25
• Watchers: 13
• Forks: 8
• Open Issues: 8
• Metadata Files:
  • Readme: README.md
  • License: LICENSE-MIT

Awesome Lists containing this project

README

        
Firmata Builder

===

[![Gitter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/firmata/firmata-builder?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)

A module to generate an Arduino sketch (.ino) file from a selection of Firmata features. It is currently used by [firmatabuilder.com](http://firmatabuilder.com). However, because it is modular it could also be wraped to create a cli utility or even used in an IDE.

To use:

1. Install [ConfigurableFirmata](https://github.com/firmata/ConfigurableFirmata)

2. Install [Node.js](http://nodejs.org)

3. Install from source or install the firmata-builder npm module

    **source code:**

    ```bash

    $ git clone [email protected]:firmata/firmata-builder.git && cd firmata-builder

    $ npm install

    ```

    **npm package:**

    ```bash

    $ npm install firmata-builder

    ```

4. Navigate to the `examples` directory and run one of the following command:

    ```bash

    $ node demo.js

    ```

    ```bash

    $ node demo-wifi.js

    ```

    ```bash

    $ node demo-ethernet.js

    ```

    ```bash

    $ node demo-ble.js

    ```

    The first command above will generate a file named *ConfiguredFirmata.ino* and the second will generate a file named *ConfiguredFirmataWiFi.ino* in the same directory, etc. These examples also demonstrate the format of the object to be passed into the `build` method.

5. Open ConfiguredFirmata.ino in the Arduino IDE and accept the prompt to move ConfiguredFirmata.ino into a ConfiguredFirmata sketch folder.

6. Compile and upload ConfiguredFirmata for your particular Arduino board.

Goals

===

Firmata Builder opens the door to offer a larger selection of features than can be offered with the all-in-one [StandardFirmata](https://github.com/firmata/arduino/blob/master/examples/StandardFirmata/StandardFirmata.ino) approach. You can include as many or as few features as your application needs (within the constraints of the board you are using). It is also possible to wrap existing Arduino libraries to use them as Firmata features. See [FirmataEncoder](https://github.com/firmata/FirmataEncoder) for an example. This makes it much easier to mix custom features with standard features (digital and analog I/O, I2C, etc).

Contributing

===

I'm looking for contributers, especially in figuring out how to make what is currently builder.js and features.js something that can scale well to support contributed Firmata features. If you want to get involved, [contact me](https://github.com/soundanalogous) and/or [join the gitter](https://gitter.im/firmata/firmata-builder?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge).