Repository files navigation

Snap4Arduino binds Snap! and Arduino together and is available in several flavors:

• A desktop application for GNU/Linux, MacOSX and MS Windows.
• A Chrome App for Chromebooks and any other device that can run the Chromium browser or Google Chrome.
• A web application that makes use of a special Chrome extension.
• A command line interpreter for embedded GNU/Linux machines.
• A websockets-powered version for Linino boards.
• A mobile app for Android. 💥EXPERIMENTAL! BARELY USABLE! 💥

Please check out our official website for further info:

snap4arduino.rocks

You can get the latest pre-built versions for all platforms at:

snap4arduino.rocks/#download

TheWiki holds a bunch of tutorials on different topics. You can also find acollection of examples in the official website.

To learn more aboutSnap!, take a look atits official manual and itsadditional annex chapters.

There are also a few example projectshere. To load one of them into Snap4Arduino:

1. Click on the project name:
2. Click on theRaw button:
3. Right click on the text and selectSave As (or just pressControl+S) to save the file into your computer.
4. Drag and drop the file you've just downloaded into Snap4Arduino

Of course, this project wouldn't exist without:

• Snap!
• Arduino
• nwjs.io

To build installers for Microsoft Windows OSes, we are making use ofInno Setup, ran headless underWine.

The mobile version is powered byCordova.

Before trying to build Snap4Arduino, make sure you havenode,npm,sed,git,wget,zip andunzip installed in your system.

This project is built by a single shell script that takes care of everything, but it takes for granted you have first prepared your local setup.

If you haven't, please first run theprepare script with the--all parameter:

./prepare --all

The command line parameters for theprepare script are:

Usage: ./prepare [options]    --snap              Pulls the latest Snap! version.    --nwjs              Pulls the latest nwjs.io stable version.    --desktop           Pulls all NodeJS modules needed for desktop versions.    --chromeos          Pulls all NodeJS modules needed for the ChromeOS app.    --chromium          Pulls all NodeJS modules needed for the web extension.    --cli               Pulls all NodeJS modules needed for command-line version.    --all               Does all of the above.    --inno              Attempts to install Inno Setup under Wine, required to                        build an installer for the Microsoft Windows versions.

Once your local setup is ready, you can use thebuild script as follows:

Usage: ./build [OPTIONS]    --platform=TARGET   Selects a platform. Accepts both generic platform names                        (all, mobile, desktop, desktop/gnu) and specific names                        (desktop/gnu/64). See --help=platform for details.    --run               Builds and runs Snap4Arduino for the specified architecture.                        Only for desktop GNU/Linux and Android.    --makeinstaller     Attempts to create an installer for the Microsoft Windows                        versions. Needs Inno Setup, check prepare script for info.    --rerun             Runs the last built version of Snap4Arduino, if it exists.                        Only for desktop GNU/Linux.    --keeptmp           Do not remove the temporary build directory afterwards.    --pack              Compresses the resulting files into a properly named                        package.    --deploy=URL        Tries to deploy the built version(s) to a server.                        Implicitly runs --pack.                        --username=USERNAME Specifies a username for the deploy                                            server.                        --password=PASSWD   Specifies a password for that user.

To find out which platforms are supported by the build script, just run./build --help=platform.

Usage: ./build --platform=TARGET [--run] [--deploy=URL --username=USERNAME [--dir=PATH]]Available platforms are:embedded/clidesktop/win/32desktop/win/64desktop/osx/32desktop/osx/64desktop/gnu/32desktop/gnu/64desktop/chromeosweb/chromiummobile/androidGeneric names are also accepted, such as:desktopdesktop/gnumobilethisall

See thewiki section on installing and using thecommand line version.

• node-canvas(only with--canvas flag active)
• firmata(if you need Snap4Arduino compatibility)

This repository contains only source files. The old, huge (2Gb+!) repository that contained all binaries can still be found for archaeologic purposes at:https://github.com/edutec/Snap4Arduino-old-huge

Snap4Arduino was started in 2013 as a side project in theEdutec research group fromCitilab (Cornellà, Barcelona), but was soon turned into a full fledged project when it began to gain user base and became clear that it had potential. Since then, it has been used in primary schools, high schools, universities, code clubs, artistic installations and individuals from all around the world. It has received localization contributions for 13 different languages, and projects such as Phiro (India), SmartBlock (Turkey), First Makers (Chile) or ROKIT Brick (South Korea) have based their software solutions in modified versions of Snap4Arduino. From June 2016 until August 2017 it was supported and developed at Arduino.org. Nowadays it is being independently developed by Bernat Romagosa, Joan Guillén and several contributors.

Please readCONTRIBUTING.md before sending us any pull requests. Thank you!