cylon-api-socketio
Advanced tools
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 make everything more modular and at the same time make Cylon.js lighter.
This repository contains the Cylon API plugin for Socket.io
For more information about Cylon, check out the repo at https://github.com/hybridgroup/cylon
$ npm install cylon cylon-api-socketio
Make sure you have Cylon.js installed, then we can add Socket.io support to cylon programs as follows:
'use strict';
var Cylon = require('cylon');
Cylon.robot({
name: 'rosie',
connections: {
arduino: { adaptor: 'firmata', port: '/dev/ttyACM0' }
},
devices: {
led: { driver: 'led', pin: 13 }
},
work: function() {
// for this example with sockets
// we are going to be interacting
// with the robot using the code in
// ./**-client.html
}
});
// ensure you install the API plugin first:
// $ npm install cylon-api-socket-io
Cylon.api('socketio',
{
host: '0.0.0.0',
port: '3000'
});
Cylon.start();
Once you have added the api to your Cylon.js code, and your robots are up and running, you can connect to them using Socket.io using the following code:
<!doctype html>
<html>
<meta charset="utf-8">
<head>
<title>Simple Device Example</title>
<style>
* { margin: 0; padding: 0; box-sizing: border-box; }
body { font: 13px Helvetica, Arial; }
form { background: #000; padding: 3px; position: fixed; bottom: 0; width: 100%; }
form input { border: 0; padding: 10px; width: 90%; margin-right: .5%; }
form button { width: 9%; background: rgb(130, 224, 255); border: none; padding: 10px; }
#messages { list-style-type: none; margin: 0; padding: 0; }
#messages li { padding: 5px 10px; }
#messages li:nth-child(odd) { background: #eee; }
</style>
</head>
<script src="https://cdn.socket.io/socket.io-1.2.0.js"></script>
<script src="http://code.jquery.com/jquery-1.11.1.js"></script>
<script type="text/javascript">
var device;
window.onload = function() {
console.log('Setting up socket connections:');
// We use the robot nsp (namespace) to connect to one of the devices
// in this case the led we added in our cylon robot code
device = io('http://127.0.0.1:3000/api/robots/rosie/devices/led');
setInterval(function() {
// There are two ways to send commands to a device,
// The first one (we preffer this one) is by emitting
// an event using the name of the command for the event,
// and passing the params as regular function args.
// eg. device.emit('angle', 180[, param2, param3, ...]);
device.emit('toggle');
/*
// In the second one you emit a 'command' event and
// pass the command specifics inside an object.
device.emit(
'command',
{
name: 'angle',
args: [180, 'arg2', 'arg3']
}
);'
*/
}, 1000);
device.on('message', function(payload) {
console.log('On Device');
console.log(' Event:', payload.event);
console.log(' Data:', payload.data);
$('#messages').append($('<li>').text('On Device:'));
$('#messages').append($('<li>').text(' Event:' + payload.event.toString()));
if (!!payload.data) {
$('#messages').append($('<li>').text(' Data:' + payload.data.toString()));
}
$('#messages').append($('<hr />'));
});
msg = 'You have been subscribed to Cylon sockets:' + device.nsp;
$('#messages').append($('<li>').text(msg));
};
</script>
<body>
<ul id="messages"></ul>
</body>
</html>
We're busy adding documentation to cylonjs.com. Please check there as we continue to work on Cylon.js.
Thank you!
For our contribution guidelines, please go to https://github.com/hybridgroup/cylon/blob/master/CONTRIBUTING.md.
For the release history, please go to https://github.com/hybridgroup/cylon-api-socketio/blob/master/RELEASES.md.
Copyright (c) 2014-2015 The Hybrid Group. Licensed under the Apache 2.0 license.
FAQs
Socket.io API add-on module for Cylon.JS
We found that cylon-api-socketio demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 4 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Socket CEO Feross Aboukhadijeh joins Software Engineering Daily to discuss modern software supply chain attacks and rising AI-driven security risks.
Security News
GitHub has revoked npm classic tokens for publishing; maintainers must migrate, but OpenJS warns OIDC trusted publishing still has risky gaps for critical projects.
Security News
Rust’s crates.io team is advancing an RFC to add a Security tab that surfaces RustSec vulnerability and unsoundness advisories directly on crate pages.