Skip to content

Move CLI to commander #13

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Nov 11, 2015
Merged

Move CLI to commander #13

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
ccfe9a3
Move CLI to commander
derekwheee Nov 11, 2015
1c0b09d
Fix install description
derekwheee Nov 11, 2015
e1fb296
Remove errant console.log
derekwheee Nov 11, 2015
06258fa
Move interchange, cleanup CLI, updated README
derekwheee Nov 11, 2015
08c4a7f
Rename optional --firmata param
derekwheee Nov 11, 2015
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
46 changes: 23 additions & 23 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,11 @@
![](https://img.shields.io/david/ajfisher/nodebots-interchange.svg)
![](https://img.shields.io/github/issues/ajfisher/nodebots-interchange.svg)

Provides a mechanism to use custom backpacks and firmatas in your nodebots easily
Provides a mechanism to use custom backpacks and firmatas in your nodebots easily
and without needing to use arduino or compile firmwares and all their dependencies.

Want to use a ping sensor on your nodebot or play around with neopixels? Plug in
your arduino or backpack, install the relevant firmware with interchange and
your arduino or backpack, install the relevant firmware with interchange and
start building that nodebot.

It's as easy as:
Expand All @@ -25,7 +25,7 @@ like npm for your backpacks.
Interchange provides the following:

* A specification for how backpack devices should behave
* An installation method for backpack firmware onto target boards to make
* An installation method for backpack firmware onto target boards to make
backpack firmware selection and installation easy.
* A method of updating select parts of the firmware if required without recompilation.
* An ability to install Standard or Custom Firmatas to a board.
Expand All @@ -34,17 +34,17 @@ backpack firmware selection and installation easy.
## Installation

It is recommended to install nodebots-interchange locally so different versions
can coexist as part of projects. If you do this, make sure the node modules
can coexist as part of projects. If you do this, make sure the node modules
.bin directory is on your path, like this:

```
export PATH=./node_modules/.bin:$PATH
```

After that just install locally using npm
After that just install locally using npm

```
npm install ajfisher/nodesbots-interchange
npm install ajfisher/nodebots-interchange
```

Or alternatively
Expand All @@ -69,11 +69,11 @@ section below.
In general:

```
interchange install <firmware> -p <port> -a <board_type> -i <I2C_address> [--firmata]
interchange install <firmware> -p <port> -a <board_type> -i <I2C_address> [--firmata [name]]
```

Where `<firmware>` is the name of the firmware you would like to flash to the board,
`<port>` is the name of the serial port you want to use, `<board_type>` is the
`<port>` is the name of the serial port you want to use, `<board_type>` is the
specific type of board you would like to use and `<I2C_address>` is an optional
parameter allowing you to change the default address of the I2C device.

Expand Down Expand Up @@ -106,7 +106,7 @@ are firmata capable or not.
interchange list
```

Get a list of all the available serial devices you can see (use the --verbose
Get a list of all the available serial devices you can see (use the --verbose
switch if you want to get much more detail about the devices.

```
Expand All @@ -121,7 +121,7 @@ interchange install hc-sr04 -a nano -p /dev/tty.wchserial1410
```

Install the HC-SR04 backpack firmware to an arduino nano on port /dev/tty.wchserial1410
however change the default I2C address to 0x65 instead. (Ensure configuration
however change the default I2C address to 0x65 instead. (Ensure configuration
mode on the arduino is set).

```
Expand All @@ -130,7 +130,7 @@ interchange install hc-sr04 -a nano -p /dev/tty.wchserial1410 -i 0x65

Install StandardFirmata on an arduino Uno at port /dev/tty.usbmodem1230

```
```
interchange install StandardFirmata -a uno -p /dev/tty.usbmodem1230
```

Expand All @@ -140,7 +140,7 @@ Install the HC-SR04 custom firmata on an arduino Uno at port /dev/tty.usbmodem12
interchange install hc-sr04 -a uno -p /dev/tty.usbmodem1230 --firmata
```

Install a custom firmata (in this case for the mbot) onto an arduino from a git
Install a custom firmata (in this case for the mbot) onto an arduino from a git
repository and not from the interchange directory (good for testing in development) on port
/dev/tty.wchserial1560

Expand All @@ -149,14 +149,14 @@ interchange install git+https://github.com/Makeblock-official/mbot_nodebots -p /
```

Install a named custom firmata (in this case the mbot Bluetooth firmata) onto
an arduino from git repo on port /dev/tty.wchserial1560 - note the use of
`--firmata=[name]` here.
an arduino from git repo on port /dev/tty.wchserial1560 - note the use of
`--firmata [name]` here.

```
interchange install git+https://github.com/Makeblock-official/mbot_nodebots -p /dev/tty.wchserial1560 -a uno --firmata=bluetooth
interchange install git+https://github.com/Makeblock-official/mbot_nodebots -p /dev/tty.wchserial1560 -a uno --firmata bluetooth
```

Read the details of a backpack firmware on /dev/tty.usbmodem1130 to see what
Read the details of a backpack firmware on /dev/tty.usbmodem1130 to see what
is on it.

```
Expand All @@ -179,29 +179,29 @@ Additional documentation: https://docs.google.com/document/d/1j6Jce2MUSA-V-I9iO6
# Acknowledgements

Interchange was born of an idea that came out of RobotsConf 2014 that started
with a discussion about how to incorporate NeoPixel support into
[Firmata](https://github.com/firmata/arduino) and
with a discussion about how to incorporate NeoPixel support into
[Firmata](https://github.com/firmata/arduino) and
[Johnny-Five](https://github.com/rwaldron/johnny-five). Adding custom additions
to firmata created numerous problems, not just with the bloat that it would
cause in firmata but additionally the support requirements it would impose on
cause in firmata but additionally the support requirements it would impose on
other IO Plugins as any custom instructions would then need to be supported as well.

The end solution was to instead create a custom NodeBots "board", in the
style of a "BackPack" (as used by AdaFruit & others in the hardware space) that
would act as a bridge between "dumb" devices such as ultrasonic sensors,
neopixels and touch screens that would then expose these components as I2C
neopixels and touch screens that would then expose these components as I2C
devices. In this way, any nodebots capable board that can talk I2C (just about
all of them) would be able to work with these components, not just those running
firmata.

As the project has developed, it was determined that being able to use it to
As the project has developed, it was determined that being able to use it to
eliminate the need for Arduino for beginners was also useful and would use the
same mechanism.
same mechanism.

This project would not have seen light were it not for the following people:

* Rick Waldron - believing this was a good approach and supporting the exploration
of the idea to augment Johnny Five.
* Suz Hinton - for the excellent avrgirl which provided considerable heavy lifting on the
* Suz Hinton - for the excellent avrgirl which provided considerable heavy lifting on the
flashing side of things.
* Andy Gelme, Luis Montes - for pushing me on backpacks and keep me moving.
37 changes: 37 additions & 0 deletions bin/cli.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
#! /usr/bin/env node

var program = require('commander');
var version = require('../package.json').version;
var Interchange = require('../lib/interchange');
var interchange = new Interchange();

program
.version(version);

program.command("list")
.description("Lists all of the available firmwares")
.alias("l")
.action(interchange.list_devices.bind(interchange));

program.command("ports")
.description("Lists all of the attached boards and their ports")
.alias("p")
.option("-v, --verbose", "List with additional information")
.action(interchange.list_ports.bind(interchange));

program.command("read")
.description("Read firmware info from port")
.alias("r")
.option("-p, --port", "Serial port board is attached to")
.action(interchange.get_firmware_info.bind(interchange));

program.command("install [firmware]")
.description("Install specified firmware to board")
.alias("i")
.option("-a, --board <board>", "Type of board/AVR")
.option("-p, --port <port>", "Serial port board is attached to")
.option("-f, --firmata [firmata]", "Install firmata version of firmware")
.option("-i, --address <address>", "Specify I2C address, eg 0x67")
.action(interchange.install_firmware.bind(interchange));

program.parse(process.argv);
Loading