- Notifications
You must be signed in to change notification settings - Fork3
Cylon.js API plugin for Socket.io
License
hybridgroup/cylon-api-socketio
Folders and files
| Name | Name | Last commit message | Last commit date | |
|---|---|---|---|---|
Repository files navigation
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 modularand at the same time make Cylon.js lighter.
This repository contains the Cylon API plugin forSocket.io
For more information about Cylon, check out the repo athttps://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 cylonprograms as follows:
'use strict';varCylon=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-ioCylon.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><metacharset="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%; }forminput {border:0;padding:10px;width:90%;margin-right:.5%; }formbutton {width:9%;background:rgb(130,224,255);border: none;padding:10px; }#messages {list-style-type: none;margin:0;padding:0; }#messagesli {padding:5px10px; }#messagesli:nth-child(odd) {background:#eee; }</style></head><scriptsrc="https://cdn.socket.io/socket.io-1.2.0.js"></script><scriptsrc="http://code.jquery.com/jquery-1.11.1.js"></script><scripttype="text/javascript">vardevice;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 codedevice=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><ulid="messages"></ul></body></html>
We're busy adding documentation tocylonjs.com. Please check there as we continue to work on Cylon.js.
Thank you!
For our contribution guidelines, please go tohttps://github.com/hybridgroup/cylon/blob/master/CONTRIBUTING.md.
For the release history, please go tohttps://github.com/hybridgroup/cylon-api-socketio/blob/master/RELEASES.md.
Copyright (c) 2014-2015 The Hybrid Group. Licensed under the Apache 2.0 license.
About
Cylon.js API plugin for Socket.io