Cylon.js (http://cylonjs.com) is a JavaScript framework for robotics, physical computing, and the Internet of Things using Node.js
API plugins are separate from the Cylon.js main module, to allow for greater modularization of Cylon robots.
This repository contains the Cylon API plugin for HTTP.
For more information about Cylon, check out the repo at https://github.com/hybridgroup/cylon
$ npm install cylon cylon-api-http
With both of these modules installed, you can make your robots accessible over HTTP:
"use strict";
var Cylon = require("cylon");
Cylon.api("http", {
ssl: false // serve unsecured, over HTTP
// optional configuration here.
// for details see 'Configuration' section.
});
Cylon.robot({
name: "Maria",
connections: {
arduino: { adaptor: 'firmata', port: '/dev/ttyACM0' }
},
devices: {
led: { driver: 'led', pin: 13 }
},
work: function() {
// we'll interact with this robot through the API
}
}).start();
Once you've got a Cylon instance with the API configured and running, you can use cURL to test it out:
$ curl http://127.0.0.1:4000/api/robots/Maria
{ "robot": { "name": "Maria" /* ... */ } }
This plugin follows the CPPP-IO specification.
To get started, you can visit the /api
route in your browser to get an overview of the Cylon Master Control Program (MCP).
This provides a high level overview of your program:
$ curl http://127.0.0.1:4000/api | python -m json.tool
{
"MCP": {
"commands": [ ],
"events": [ ],
"robots": [
{
"name": "Maria",
"connections": [
{
"name": "arduino",
"adaptor": "firmata",
"details": { "port": "/dev/ttyACM0" }
}
],
"devices": [
{
"name": "led",
"commands": [ "toggle" ],
"connection": "arduino",
"details": { "pin": "13" },
"driver": "LED"
}
],
"commands": [ ],
"events": [ ]
}
]
}
}
For details on other available routes in the API and expected responses, please see the [specification document][spec].
This plugin includes a default front-end in Robeaux.
Robeaux is a simple tool to use against the HTTP API, and explore your robots visually, while also able to issue commands to robots and listen for events.
Option | Description |
---|---|
host |
What HTTP host to serve from. Defaults to 127.0.0.1 . |
port |
What HTTP port to serve on. Defaults to 3000 . |
auth |
What authorization scheme to use. e.g. { type: "basic", user: "username", pass: "password"} . Defaults to false . |
CORS |
Cross-Origin Resource Sharing option (HTTP Header: "Access-Control-Allow-Origin"). Defaults to "*". |
serveDir |
Directory to serve as static assets. Defaults to the included Robeaux installation. |
ssl |
SSL key and cert options, wrapped as an object. Set to false for an unsecured API. Defaults to included self-signed certs. |
We're busy adding documentation to cylonjs.com. Please check there as we continue to work on Cylon.js.
Thank you!
- All patches must be provided under the Apache 2.0 License
- Please use the -s option in git to "sign off" that the commit is your work and you are providing it under the Apache 2.0 License
- Submit a Github Pull Request to the appropriate branch and ideally discuss the changes with us in IRC.
- We will look at the patch, test it out, and give you feedback.
- Avoid doing minor whitespace changes, renamings, etc. along with merged content. These will be done by the maintainers from time to time but they can complicate merges and should be done seperately.
- Take care to maintain the existing coding style.
- Add unit tests for any new or changed functionality & lint and test your code using
make test
andmake lint
. - All pull requests should be "fast forward"
- If there are commits after yours use “git rebase -i <new_head_branch>”
- If you have local changes you may need to use “git stash”
- For git help see progit which is an awesome (and free) book on git
0.3.0 - Update dependencies, add newer Robeaux version
0.2.0 - Continued internals, fixes, serveDir
option
0.1.1 - Correct command issues, re-organize internals.
0.1.0 - Initial release
Copyright (c) 2014-2015 The Hybrid Group. Licensed under the Apache 2.0 license.