Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/fulminati/sketches

🤖 Sketches #1 Arduino command-line toolkit
https://github.com/fulminati/sketches

arduino command-line-tool developer-tools sketch

Last synced: 23 days ago
JSON representation

🤖 Sketches #1 Arduino command-line toolkit

Awesome Lists containing this project

README

        

# Sketches

Sketches is a command-line tool inspired by package manager like NPM.
If you are fascinated by the **package.json** then you will love **Sketches.yml**.

## Get Started

Install the Sketches via NPM
```bash
$ npm install -g sketches
```
or
```bash
$ sudo npm install -g sketches --unsafe-perm=true --allow-root
```

- See more on [Install NodeJS and NPM](https://github.com/fulminati/sketches/wiki/install-nodejs-and-npm)

### Create project from scratch

Create your first project
```bash
$ sketches init ArduinoProject
$ cd ArduinoProject
```
- See more on [Project management](https://github.com/fulminati/sketches/wiki/project-management)

### Configure your project

Each Sketches project can be configured via the 'Sketches.yml' file

```yml
name:
version: 0.0.1
sketches:
MyArduinoProject:
board: uno
port: COM3
```

- See more on [Sketches.yml reference](https://github.com/fulminati/Sketches/wiki/Reference:-sketches.yml)

### Verify operation

Verify source code of current project
```bash
$ Sketches verify
```

### Upload operation

Upload binary into arduino board
```bash
$ Sketches upload
```

## Roadmap

| Command | Progress | Features |
|---------------|:--------:|----------|
| apply-filters | 10% | |
| create-sketch | 10% | |
| flash | 10% | |
| init | 10% | |
| install | 10% | |
| ls | 10% | |
| monitor | 10% | |
| rename-sketch | 10% | |
| sandbox | 10% | |
| upload | 10% | |
| verify | 10% | |

## See more
- [Install Boards and Libraries](https://github.com/fulminati/Sketches/wiki/Install-boards-and-libraries)

## References
- https://github.com/arduino/Arduino/blob/ide-1.5.x/build/shared/manpage.adoc
- https://h3ron.com/post/programmare-lesp8266-ovvero-arduino-con-il-wifi-a-meno-di-2/
- https://cassiopeia.hk/rgb-wifi/
- https://www.anginf.de/?p=600
- https://github.com/doleron/esp8266-1-channel-relay-board-with-mqtt