npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

cylon-api-http

v0.4.1

Published

HTTP API add-on module for Cylon.JS

Downloads

23

Readme

Cylon.js API plugin for HTTP

Cylon.js (http://cylonjs.com) is a JavaScript framework for robotics, physical computing, and the Internet of Things (IoT).

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

Build Status Code Climate Test Coverage

How To Install

$ npm install cylon cylon-api-http

How To Use

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();

How To Connect

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" /* ... */ } }

Routes

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].

Robeaux

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.

Configuration

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.

Documentation

We're busy adding documentation to cylonjs.com. Please check there as we continue to work on Cylon.js.

Thank you!

Contributing

For our contribution guidelines, please go to https://github.com/hybridgroup/cylon/blob/master/CONTRIBUTING.md.

Release History

For the release history, please go to https://github.com/hybridgroup/cylon-api-http/blob/master/RELEASES.md.

License

Copyright (c) 2014-2016 The Hybrid Group. Licensed under the Apache 2.0 license.