Skip to content
Browse files

Merge branch 'fixes-bs' into gh-pages

  • Loading branch information...
2 parents d6154a4 + 1005127 commit f6cd2004ee2f744c80766b48e959bf3605db1ec7 @barberdt barberdt committed Feb 10, 2012
Showing with 4,514 additions and 1,007 deletions.
  1. +115 −8 applications.html
  2. +128 −5 bugstats.html
  3. +449 −42 configuration_api.html
  4. +122 −14 contact.html
  5. +135 −25 documentation.html
  6. +14 −1 googleeed5e812cc5b4fc5.html
  7. +379 −68 hardware.html
  8. +129 −18 http_response_codes.html
  9. +203 −28 index.html
  10. +93 −8 libraries.html
  11. +373 −77 participation_api.html
  12. +213 −58 restful_api_keys.html
  13. +335 −117 restful_invitations.html
  14. +417 −155 restful_resources.html
  15. +538 −206 restful_swarms.html
  16. +144 −15 swarmgame.html
  17. +114 −12 swarmlight.html
  18. +249 −21 tools.html
  19. +364 −129 tutorial.html
View
123 applications.html
@@ -1,8 +1,115 @@
-<!DOCTYPE html><html lang="en"><head><title>BUGswarm Developers</title><link rel="stylesheet" href="bootstrap/bootstrap.css"><link rel="stylesheet" href="css/this.css"><link rel="stylesheet" href="js/google-code-prettify/prettify.css"><script src="http://code.jquery.com/jquery-1.5.2.js"></script><script src="js/google-code-prettify/prettify.js"></script><script src="js/application.js"></script><script src="js/google-analytics.js"></script></head><body><!-- NAVIGATION--><div class="topbar"><div class="topbar-inner"><div class="container"><h3><a id="banner" href="index.html"><img src="images/bs_logo.png"></a></h3><ul class="nav"><li class="dropdown nav-dropdown"><a href="documentation.html" class="dropdown-toggle">Documentation</a><ul class="dropdown-menu"><li><a href="configuration_api.html">Configuration</a></li><li><a href="participation_api.html">Participation</a></li></ul></li><li><a href="tools.html">Tools</a></li><li><a href="libraries.html">Libraries</a></li><li><a href="tutorial.html">Tutorial</a></li><li><a href="applications.html">Applications</a></li><li><a href="hardware.html">Hardware</a></li><li><a href="contact.html">Contact</a></li></ul></div></div></div><!-- CONTAINER--><div class="container"><div class="page-header"><a href="index.html">Home</a> &rarr;
-Applications
-</div><!-- Header--><h1>Applications</h1><p>Below are some of the applications people have built using BUGswarm. If you've created something you feel is worthy of display,
-<a href="mailto:list@buglabs.net">share it with us!</a></p><!-- BUGstats--><h2><a href="https://gist.github.com/6f3593466869402988a4">BUGstats</a></h2><div class="row"><div class="span3 columns"><a href="bugstats.html"><img src="images/bugstats.png" height="100" class="app-image"></a></div><div class="span13 columns"><p>An application for monitoring hardware statistics on your BUG. Makes use of BUGswarm's
-<a href="https://github.com/buglabs/bugswarm-api/tree/master/javascript">JavaScript library</a> and Python.
-</p></div></div><div class="page-header"></div><!-- HNTR--><h2><a href="https://gist.github.com/1265034">HNTR</a></h2><div class="row"><div class="span3 columns"><a href="https://gist.github.com/1265034"><img src="images/hntr.jpg" height="100" class="app-image"></a></div><div class="span13 columns"><p>A shared shopping list for the oncoming winter. Makes use of BUGswarm's
-<a href="https://github.com/buglabs/bugswarm-api/tree/master/javascript">JavaScript library</a>.
-</p></div></div><div class="page-header"></div></div></body></html>
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
+
+<html lang="en">
+<head>
+ <meta name="generator" content=
+ "HTML Tidy for Linux (vers 25 March 2009), see www.w3.org">
+
+ <title>BUGswarm Developers</title>
+ <link rel="stylesheet" href="bootstrap/bootstrap.css" type=
+ "text/css">
+ <link rel="stylesheet" href="css/this.css" type="text/css">
+ <link rel="stylesheet" href=
+ "js/google-code-prettify/prettify.css" type="text/css">
+ <script src="http://code.jquery.com/jquery-1.5.2.js" type=
+ "text/javascript">
+</script>
+ <script src="js/google-code-prettify/prettify.js" type=
+ "text/javascript">
+</script>
+ <script src="js/application.js" type="text/javascript">
+</script>
+ <script src="js/google-analytics.js" type="text/javascript">
+</script>
+</head>
+
+<body>
+ <!-- NAVIGATION-->
+
+ <div class="topbar">
+ <div class="topbar-inner">
+ <div class="container">
+ <h3><a id="banner" href="index.html" name=
+ "banner"><img src="images/bs_logo.png"></a></h3>
+
+ <ul class="nav">
+ <li class="dropdown nav-dropdown">
+ <a href="documentation.html" class=
+ "dropdown-toggle">Documentation</a>
+
+ <ul class="dropdown-menu">
+ <li><a href=
+ "configuration_api.html">Configuration</a></li>
+
+ <li><a href=
+ "participation_api.html">Participation</a></li>
+ </ul>
+ </li>
+
+ <li><a href="tools.html">Tools</a></li>
+
+ <li><a href="libraries.html">Libraries</a></li>
+
+ <li><a href="tutorial.html">Tutorial</a></li>
+
+ <li><a href="applications.html">Applications</a></li>
+
+ <li><a href="hardware.html">Hardware</a></li>
+
+ <li><a href="contact.html">Contact</a></li>
+ </ul>
+ </div>
+ </div>
+ </div><!-- CONTAINER-->
+
+ <div class="container">
+ <div class="page-header">
+ <a href="index.html">Home</a> &rarr; Applications
+ </div><!-- Header-->
+
+ <h1>Applications</h1>
+
+ <p>Below are some of the applications people have built using
+ BUGswarm. If you've created something you feel is worthy of
+ display, <a href="mailto:list@buglabs.net">share it with
+ us!</a></p><!-- BUGstats-->
+
+ <h2><a href=
+ "https://gist.github.com/6f3593466869402988a4">BUGstats</a></h2>
+
+ <div class="row">
+ <div class="span3 columns">
+ <a href="bugstats.html"><img src="images/bugstats.png"
+ height="100" class="app-image"></a>
+ </div>
+
+ <div class="span13 columns">
+ <p>An application for monitoring hardware statistics on
+ your BUG. Makes use of BUGswarm's <a href=
+ "https://github.com/buglabs/bugswarm-api/tree/master/javascript">
+ JavaScript library</a> and Python.</p>
+ </div>
+ </div>
+
+ <div class="page-header"></div><!-- HNTR-->
+
+ <h2><a href="https://gist.github.com/1265034">HNTR</a></h2>
+
+ <div class="row">
+ <div class="span3 columns">
+ <a href="https://gist.github.com/1265034"><img src=
+ "images/hntr.jpg" height="100" class="app-image"></a>
+ </div>
+
+ <div class="span13 columns">
+ <p>A shared shopping list for the oncoming winter. Makes
+ use of BUGswarm's <a href=
+ "https://github.com/buglabs/bugswarm-api/tree/master/javascript">
+ JavaScript library</a>.</p>
+ </div>
+ </div>
+
+ <div class="page-header"></div>
+ </div>
+</body>
+</html>
View
133 bugstats.html
@@ -1,5 +1,128 @@
-<!DOCTYPE html><html lang="en"><head><script src="http://cdn.buglabs.net/swarm/swarm-v0.3.2.js"></script><script src="http://maps.googleapis.com/maps/api/js?sensor=false"></script><title>BUGstats</title><link rel="stylesheet" href="bootstrap/bootstrap.css"><link rel="stylesheet" href="css/this.css"><link rel="stylesheet" href="js/google-code-prettify/prettify.css"><script src="http://code.jquery.com/jquery-1.5.2.js"></script><script src="js/google-code-prettify/prettify.js"></script><script src="js/application.js"></script><script src="js/google-analytics.js"></script><script src="js/bugstats.js" type="text/javascript"></script><link rel="stylesheet" href="css/bugstats.css"></head><body onload="mapInitialize()"><!-- CONTENT--><div class="container"><div id="header"><!-- Header--><h1>BUGstats</h1><p>Using
-<a href="http://developer.bugswarm.net">BUGswarm</a>, an M2M cloud messaging platform built by
-<a href="http://buglabs.net">Bug Labs</a>, this application allows you to monitor the vital
-statistics of each BUG in your swarm.
-</p></div><div id="swarm-overview"><h1>Swarm Overview</h1><div id="swarm-info"></div><div class="page-header"></div><h3 id="aggregate-head">Averages:</h3><div id="aggregate-stats"><div class="row"><div class="span-smallstats"><h4>User % </h4><ul class="unstyled"><li id="aggregate-usr" class="aggregate-data">Pending</li></ul></div><div class="span-smallstats"><h4>Nice %</h4><ul class="unstyled"><li id="aggregate-nice" class="aggregate-data">Pending</li></ul></div><div class="span-smallstats"><h4>System %</h4><ul class="unstyled"><li id="aggregate-sys" class="aggregate-data">Pending</li></ul></div><div class="span-datetime"><h4>Datetime</h4><ul class="unstyled"><li id="aggregate-datetime" class="aggregate-data">Pending</li></ul></div></div></div></div><div id="divider"><div class="page-header"></div></div><div id="resources"><h1>Members</h1><div id="controls"><input disabled="disabled" id="get-immediate-stats" type="button" value="Update All" onclick="javascript: getImmediateStats()" class="btn danger disabled"><br><br><div class="page-header"></div></div><div id="resources-list"></div></div><div id="map"><h1>Locations</h1><div id="map-canvas"></div></div><br></div></body></html>
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
+
+<html lang="en">
+<head>
+ <meta name="generator" content=
+ "HTML Tidy for Linux (vers 25 March 2009), see www.w3.org">
+ <script src="http://cdn.buglabs.net/swarm/swarm-v0.3.2.js" type=
+ "text/javascript">
+</script>
+ <script src="http://maps.googleapis.com/maps/api/js?sensor=false"
+ type="text/javascript">
+</script>
+
+ <title>BUGstats</title>
+ <link rel="stylesheet" href="bootstrap/bootstrap.css" type=
+ "text/css">
+ <link rel="stylesheet" href="css/this.css" type="text/css">
+ <link rel="stylesheet" href=
+ "js/google-code-prettify/prettify.css" type="text/css">
+ <script src="http://code.jquery.com/jquery-1.5.2.js" type=
+ "text/javascript">
+</script>
+ <script src="js/google-code-prettify/prettify.js" type=
+ "text/javascript">
+</script>
+ <script src="js/application.js" type="text/javascript">
+</script>
+ <script src="js/google-analytics.js" type="text/javascript">
+</script>
+ <script src="js/bugstats.js" type="text/javascript">
+</script>
+ <link rel="stylesheet" href="css/bugstats.css" type="text/css">
+</head>
+
+<body onload="mapInitialize()">
+ <!-- CONTENT-->
+
+ <div class="container">
+ <div id="header">
+ <!-- Header-->
+
+ <h1>BUGstats</h1>
+
+ <p>Using <a href=
+ "http://developer.bugswarm.net">BUGswarm</a>, an M2M cloud
+ messaging platform built by <a href="http://buglabs.net">Bug
+ Labs</a>, this application allows you to monitor the vital
+ statistics of each BUG in your swarm.</p>
+ </div>
+
+ <div id="swarm-overview">
+ <h1>Swarm Overview</h1>
+
+ <div id="swarm-info"></div>
+
+ <div class="page-header"></div>
+
+ <h3 id="aggregate-head">Averages:</h3>
+
+ <div id="aggregate-stats">
+ <div class="row">
+ <div class="span-smallstats">
+ <h4>User %</h4>
+
+ <ul class="unstyled">
+ <li id="aggregate-usr" class="aggregate-data">
+ Pending</li>
+ </ul>
+ </div>
+
+ <div class="span-smallstats">
+ <h4>Nice %</h4>
+
+ <ul class="unstyled">
+ <li id="aggregate-nice" class="aggregate-data">
+ Pending</li>
+ </ul>
+ </div>
+
+ <div class="span-smallstats">
+ <h4>System %</h4>
+
+ <ul class="unstyled">
+ <li id="aggregate-sys" class="aggregate-data">
+ Pending</li>
+ </ul>
+ </div>
+
+ <div class="span-datetime">
+ <h4>Datetime</h4>
+
+ <ul class="unstyled">
+ <li id="aggregate-datetime" class="aggregate-data">
+ Pending</li>
+ </ul>
+ </div>
+ </div>
+ </div>
+ </div>
+
+ <div id="divider">
+ <div class="page-header"></div>
+ </div>
+
+ <div id="resources">
+ <h1>Members</h1>
+
+ <div id="controls">
+ <input disabled="disabled" id="get-immediate-stats" type=
+ "button" value="Update All" onclick=
+ "javascript: getImmediateStats()" class=
+ "btn danger disabled"><br>
+ <br>
+
+ <div class="page-header"></div>
+ </div>
+
+ <div id="resources-list"></div>
+ </div>
+
+ <div id="map">
+ <h1>Locations</h1>
+
+ <div id="map-canvas"></div>
+ </div><br>
+ </div>
+</body>
+</html>
View
491 configuration_api.html
@@ -1,42 +1,449 @@
-<!DOCTYPE html><html lang="en"><head><title>BUGswarm Developers</title><link rel="stylesheet" href="bootstrap/bootstrap.css"><link rel="stylesheet" href="css/this.css"><link rel="stylesheet" href="js/google-code-prettify/prettify.css"><script src="http://code.jquery.com/jquery-1.5.2.js"></script><script src="js/google-code-prettify/prettify.js"></script><script src="js/application.js"></script><script src="js/google-analytics.js"></script></head><body><!-- NAVIGATION--><div class="topbar"><div class="topbar-inner"><div class="container"><h3><a id="banner" href="index.html"><img src="images/bs_logo.png"></a></h3><ul class="nav"><li class="dropdown nav-dropdown"><a href="documentation.html" class="dropdown-toggle">Documentation</a><ul class="dropdown-menu"><li><a href="configuration_api.html">Configuration</a></li><li><a href="participation_api.html">Participation</a></li></ul></li><li><a href="tools.html">Tools</a></li><li><a href="libraries.html">Libraries</a></li><li><a href="tutorial.html">Tutorial</a></li><li><a href="applications.html">Applications</a></li><li><a href="hardware.html">Hardware</a></li><li><a href="contact.html">Contact</a></li></ul></div></div></div><!-- CONTAINER--><div class="container"><!-- Path--><div class="page-header"><a href="index.html">Home</a> &rarr;
-<a href="documentation.html">Documentation</a> &rarr;
-Configuration API
-</div><!-- Jump to dropdown--><div class="topbar-inner jump-bar"><div class="nav jump-nav"><div class="dropdown jump-dropdown"><a href="documentation.html" class="jump-header dropdown-toggle">Jump to</a><ul class="dropdown-menu jump-menu"><li><a href="#api-keys">API Keys</a></li><li><a href="#resources">Resources</a></li><li><a href="#swarms">Swarms</a></li><li><a href="#invitations">Invitations</a></li></ul></div></div></div><!-- Header--><h1>Configuration API</h1><p>Configure swarms and their resources through the use of our RESTful API. Manage the social aspect of swarm
-by sending and responding to invitations. Be sure to check out the
-<a href="tools.html">Tools</a> page for quick and easy ways to get started, including
-<a href="http://github.com/bugswarm-tools">BUGswarm Tools</a>, a simple set of python scripts that wraps up both the Configuration and Participation APIs.
-</p><!-- API Keys--><h3><a id="api-keys" href="restful_api_keys.html">API Keys</a></h3><p>Used as credentials and passed as headers when making HTTP requests.
-</p><div class="row"><div class="span6 columns"><h5>Method</h5></div><div class="span6 columns"><h5>Description</h5></div></div><div class="page-header"></div><!-- create--><div class="row"><div class="span6 columns"><a href="restful_api_keys.html#create">Create (POST)</a></div><div class="span10 columns"><p>Create your participation key, configuration key, or both at once.
-</p></div></div><div class="page-header"></div><!-- list--><div class="row"><div class="span6 columns"><a href="restful_api_keys.html#list">List (GET)</a></div><div class="span10 columns"><p>Retrieve both of your API keys or just one based on type.
-</p></div></div><div class="page-header"></div><!-- Resources--><h3><a id="resources" href="restful_resources.html">Resources</a></h3><p>Used to produce and consume data in the swarms they are members of.
-</p><div class="row"><div class="span6 columns"><h5>Method</h5></div><div class="span6 columns"><h5>Description</h5></div></div><div class="page-header"></div><!-- create--><div class="row"><div class="span6 columns"><a href="restful_resources.html#create">Create (POST)</a></div><div class="span10 columns"><p>Create a resource. POST a JSON file containing information about the resource to be
-created.
-</p></div></div><div class="page-header"></div><!-- update--><div class="row"><div class="span6 columns"><a href="restful_resources.html#update">Update (PUT)</a></div><div class="span10 columns"><p>Update an already existing resource. PUT a JSON file containing the information
-to update.
-</p></div></div><div class="page-header"></div><!-- destroy--><div class="row"><div class="span6 columns"><a href="restful_resources.html#destroy">Destroy (DELETE)</a></div><div class="span10 columns"><p>Destroy a resource. Remove a resource from your user account.
-</p></div></div><div class="page-header"></div><!-- list--><div class="row"><div class="span6 columns"><a href="restful_resources.html#list">List (GET)</a></div><div class="span10 columns"><p>List all of the resources in your user account.
-</p></div></div><div class="page-header"></div><!-- get info--><div class="row"><div class="span6 columns"><a href="restful_resources.html#get-info">Get Info (GET)</a></div><div class="span10 columns"><p>Get a given resource's information.
-</p></div></div><div class="page-header"></div><!-- list swarms--><div class="row"><div class="span6 columns"><a href="restful_resources.html#list-swarms">List Swarms (GET)</a></div><div class="span10 columns"><p>List the swarms that a given resource is a member of.
-</p></div></div><div class="page-header"></div><!-- Swarms--><h3><a id="swarms" href="restful_swarms.html">Swarms</a></h3><p>Used to group together resources and allow them to share data with each other.
-</p><div class="row"><div class="span6 columns"><h5>Method</h5></div><div class="span6 columns"><h5>Description</h5></div></div><div class="page-header"></div><!-- create--><div class="row"><div class="span6 columns"><a href="restful_swarms.html#create">Create (POST)</a></div><div class="span10 columns"><p>Create a swarm. POST a JSON file containing information about the swarm to be
-created.
-</p></div></div><div class="page-header"></div><!-- update--><div class="row"><div class="span6 columns"><a href="restful_swarms.html#update">Update (PUT)</a></div><div class="span10 columns"><p>Update an already existing swarm. PUT a JSON file containing the information to
-update.
-</p></div></div><div class="page-header"></div><!-- destroy--><div class="row"><div class="span6 columns"><a href="restful_swarms.html#destroy">Destroy (DELETE)</a></div><div class="span10 columns"><p>Destroy a swarm. Remove a swarm from your user account.
-</p></div></div><div class="page-header"></div><!-- list--><div class="row"><div class="span6 columns"><a href="restful_swarms.html#list">List (GET)</a></div><div class="span10 columns"><p>List all of the swarms in your user account.
-</p></div></div><div class="page-header"></div><!-- get info--><div class="row"><div class="span6 columns"><a href="restful_swarms.html#get-info">Get Info (GET)</a></div><div class="span10 columns"><p>Get a given swarm's information, including it's member resources.
-</p></div></div><div class="page-header"></div><!-- add resource--><div class="row"><div class="span6 columns"><a href="restful_swarms.html#add-resource">Add Resource (POST)</a></div><div class="span10 columns"><p>Add a resource to a swarm. POST a JSON file containing the swarm-relevant information
-regarding the resource to be added.
-</p></div></div><div class="page-header"></div><!-- remove resource--><div class="row"><div class="span6 columns"><a href="restful_swarms.html#remove-resource">Remove Resource (DELETE)</a></div><div class="span10 columns"><p>Remove a resource from a swarm. POST a JSON file containing swarm-relevant information
-regarding the resource to remove.
-</p></div></div><div class="page-header"></div><!-- list resources--><div class="row"><div class="span6 columns"><a href="restful_swarms.html#list-resources">List Resources (GET)</a></div><div class="span10 columns"><p>List a given swarm's member resources. Users may choose to list only producing resources,
-only consuming resourcs, or all resources at once.
-</p></div></div><div class="page-header"></div><!-- Invitations--><h3><a id="invitations" href="restful_invitations.html">Invitations</a></h3><p>Expose BUGswarm's unique social presence by inviting another user's resources to join your swarms
-and share in the production and consumption of data. Accept invitations from other users to join
-their swarms as well.
-</p><div class="row"><div class="span6 columns"><h5>Method</h5></div><div class="span6 columns"><h5>Description</h5></div></div><div class="page-header"></div><!-- send--><div class="row"><div class="span6 columns"><a href="restful_invitations.html#send">Send (POST)</a></div><div class="span10 columns"><p>Send an invitation to another user's resource to join your swarm.
-</p></div></div><div class="page-header"></div><!-- respond--><div class="row"><div class="span6 columns"><a href="restful_invitations.html#respond">Respond (PUT)</a></div><div class="span10 columns"><p>Respond to received invitations by either accepting or rejecting them.
-</p></div></div><div class="page-header"></div><!-- list sent--><div class="row"><div class="span6 columns"><a href="restful_invitations.html#list-sent">List Sent (GET)</a></div><div class="span10 columns"><p>List all the invitations sent from your user account for resources to join a given swarm.
-</p></div></div><div class="page-header"></div><!-- list received--><div class="row"><div class="span6 columns"><a href="restful_invitations.html#list-received">List Received (GET)</a></div><div class="span10 columns"><p>List the invitations received by your user account from other users. List all invitations or only those
-sent to specific resources.
-</p></div></div><div class="page-header"></div></div></body></html>
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
+
+<html lang="en">
+<head>
+ <meta name="generator" content=
+ "HTML Tidy for Linux (vers 25 March 2009), see www.w3.org">
+
+ <title>BUGswarm Developers</title>
+ <link rel="stylesheet" href="bootstrap/bootstrap.css" type=
+ "text/css">
+ <link rel="stylesheet" href="css/this.css" type="text/css">
+ <link rel="stylesheet" href=
+ "js/google-code-prettify/prettify.css" type="text/css">
+ <script src="http://code.jquery.com/jquery-1.5.2.js" type=
+ "text/javascript">
+</script>
+ <script src="js/google-code-prettify/prettify.js" type=
+ "text/javascript">
+</script>
+ <script src="js/application.js" type="text/javascript">
+</script>
+ <script src="js/google-analytics.js" type="text/javascript">
+</script>
+</head>
+
+<body>
+ <!-- NAVIGATION-->
+
+ <div class="topbar">
+ <div class="topbar-inner">
+ <div class="container">
+ <h3><a id="banner" href="index.html" name=
+ "banner"><img src="images/bs_logo.png"></a></h3>
+
+ <ul class="nav">
+ <li class="dropdown nav-dropdown">
+ <a href="documentation.html" class=
+ "dropdown-toggle">Documentation</a>
+
+ <ul class="dropdown-menu">
+ <li><a href=
+ "configuration_api.html">Configuration</a></li>
+
+ <li><a href=
+ "participation_api.html">Participation</a></li>
+ </ul>
+ </li>
+
+ <li><a href="tools.html">Tools</a></li>
+
+ <li><a href="libraries.html">Libraries</a></li>
+
+ <li><a href="tutorial.html">Tutorial</a></li>
+
+ <li><a href="applications.html">Applications</a></li>
+
+ <li><a href="hardware.html">Hardware</a></li>
+
+ <li><a href="contact.html">Contact</a></li>
+ </ul>
+ </div>
+ </div>
+ </div><!-- CONTAINER-->
+
+ <div class="container">
+ <!-- Path-->
+
+ <div class="page-header">
+ <a href="index.html">Home</a> &rarr; <a href=
+ "documentation.html">Documentation</a> &rarr; Configuration
+ API
+ </div><!-- Jump to dropdown-->
+
+ <div class="topbar-inner jump-bar">
+ <div class="nav jump-nav">
+ <div class="dropdown jump-dropdown">
+ <a href="documentation.html" class=
+ "jump-header dropdown-toggle">Jump to</a>
+
+ <ul class="dropdown-menu jump-menu">
+ <li><a href="#api-keys">API Keys</a></li>
+
+ <li><a href="#resources">Resources</a></li>
+
+ <li><a href="#swarms">Swarms</a></li>
+
+ <li><a href="#invitations">Invitations</a></li>
+ </ul>
+ </div>
+ </div>
+ </div><!-- Header-->
+
+ <h1>Configuration API</h1>
+
+ <p>Configure swarms and their resources through the use of our
+ RESTful API. Manage the social aspect of swarm by sending and
+ responding to invitations. Be sure to check out the <a href=
+ "tools.html">Tools</a> page for quick and easy ways to get
+ started, including <a href=
+ "http://github.com/bugswarm-tools">BUGswarm Tools</a>, a simple
+ set of python scripts that wraps up both the Configuration and
+ Participation APIs.</p><!-- API Keys-->
+
+ <h3><a id="api-keys" href="restful_api_keys.html" name=
+ "api-keys">API Keys</a></h3>
+
+ <p>Used as credentials and passed as headers when making HTTP
+ requests.</p>
+
+ <div class="row">
+ <div class="span6 columns">
+ <h5>Method</h5>
+ </div>
+
+ <div class="span6 columns">
+ <h5>Description</h5>
+ </div>
+ </div>
+
+ <div class="page-header"></div><!-- create-->
+
+ <div class="row">
+ <div class="span6 columns">
+ <a href="restful_api_keys.html#create">Create (POST)</a>
+ </div>
+
+ <div class="span10 columns">
+ <p>Create your participation key, configuration key, or
+ both at once.</p>
+ </div>
+ </div>
+
+ <div class="page-header"></div><!-- list-->
+
+ <div class="row">
+ <div class="span6 columns">
+ <a href="restful_api_keys.html#list">List (GET)</a>
+ </div>
+
+ <div class="span10 columns">
+ <p>Retrieve both of your API keys or just one based on
+ type.</p>
+ </div>
+ </div>
+
+ <div class="page-header"></div><!-- Resources-->
+
+ <h3><a id="resources" href="restful_resources.html" name=
+ "resources">Resources</a></h3>
+
+ <p>Used to produce and consume data in the swarms they are
+ members of.</p>
+
+ <div class="row">
+ <div class="span6 columns">
+ <h5>Method</h5>
+ </div>
+
+ <div class="span6 columns">
+ <h5>Description</h5>
+ </div>
+ </div>
+
+ <div class="page-header"></div><!-- create-->
+
+ <div class="row">
+ <div class="span6 columns">
+ <a href="restful_resources.html#create">Create (POST)</a>
+ </div>
+
+ <div class="span10 columns">
+ <p>Create a resource. POST a JSON file containing
+ information about the resource to be created.</p>
+ </div>
+ </div>
+
+ <div class="page-header"></div><!-- update-->
+
+ <div class="row">
+ <div class="span6 columns">
+ <a href="restful_resources.html#update">Update (PUT)</a>
+ </div>
+
+ <div class="span10 columns">
+ <p>Update an already existing resource. PUT a JSON file
+ containing the information to update.</p>
+ </div>
+ </div>
+
+ <div class="page-header"></div><!-- destroy-->
+
+ <div class="row">
+ <div class="span6 columns">
+ <a href="restful_resources.html#destroy">Destroy
+ (DELETE)</a>
+ </div>
+
+ <div class="span10 columns">
+ <p>Destroy a resource. Remove a resource from your user
+ account.</p>
+ </div>
+ </div>
+
+ <div class="page-header"></div><!-- list-->
+
+ <div class="row">
+ <div class="span6 columns">
+ <a href="restful_resources.html#list">List (GET)</a>
+ </div>
+
+ <div class="span10 columns">
+ <p>List all of the resources in your user account.</p>
+ </div>
+ </div>
+
+ <div class="page-header"></div><!-- get info-->
+
+ <div class="row">
+ <div class="span6 columns">
+ <a href="restful_resources.html#get-info">Get Info
+ (GET)</a>
+ </div>
+
+ <div class="span10 columns">
+ <p>Get a given resource's information.</p>
+ </div>
+ </div>
+
+ <div class="page-header"></div><!-- list swarms-->
+
+ <div class="row">
+ <div class="span6 columns">
+ <a href="restful_resources.html#list-swarms">List Swarms
+ (GET)</a>
+ </div>
+
+ <div class="span10 columns">
+ <p>List the swarms that a given resource is a member
+ of.</p>
+ </div>
+ </div>
+
+ <div class="page-header"></div><!-- Swarms-->
+
+ <h3><a id="swarms" href="restful_swarms.html" name=
+ "swarms">Swarms</a></h3>
+
+ <p>Used to group together resources and allow them to share
+ data with each other.</p>
+
+ <div class="row">
+ <div class="span6 columns">
+ <h5>Method</h5>
+ </div>
+
+ <div class="span6 columns">
+ <h5>Description</h5>
+ </div>
+ </div>
+
+ <div class="page-header"></div><!-- create-->
+
+ <div class="row">
+ <div class="span6 columns">
+ <a href="restful_swarms.html#create">Create (POST)</a>
+ </div>
+
+ <div class="span10 columns">
+ <p>Create a swarm. POST a JSON file containing information
+ about the swarm to be created.</p>
+ </div>
+ </div>
+
+ <div class="page-header"></div><!-- update-->
+
+ <div class="row">
+ <div class="span6 columns">
+ <a href="restful_swarms.html#update">Update (PUT)</a>
+ </div>
+
+ <div class="span10 columns">
+ <p>Update an already existing swarm. PUT a JSON file
+ containing the information to update.</p>
+ </div>
+ </div>
+
+ <div class="page-header"></div><!-- destroy-->
+
+ <div class="row">
+ <div class="span6 columns">
+ <a href="restful_swarms.html#destroy">Destroy (DELETE)</a>
+ </div>
+
+ <div class="span10 columns">
+ <p>Destroy a swarm. Remove a swarm from your user
+ account.</p>
+ </div>
+ </div>
+
+ <div class="page-header"></div><!-- list-->
+
+ <div class="row">
+ <div class="span6 columns">
+ <a href="restful_swarms.html#list">List (GET)</a>
+ </div>
+
+ <div class="span10 columns">
+ <p>List all of the swarms in your user account.</p>
+ </div>
+ </div>
+
+ <div class="page-header"></div><!-- get info-->
+
+ <div class="row">
+ <div class="span6 columns">
+ <a href="restful_swarms.html#get-info">Get Info (GET)</a>
+ </div>
+
+ <div class="span10 columns">
+ <p>Get a given swarm's information, including it's member
+ resources.</p>
+ </div>
+ </div>
+
+ <div class="page-header"></div><!-- add resource-->
+
+ <div class="row">
+ <div class="span6 columns">
+ <a href="restful_swarms.html#add-resource">Add Resource
+ (POST)</a>
+ </div>
+
+ <div class="span10 columns">
+ <p>Add a resource to a swarm. POST a JSON file containing
+ the swarm-relevant information regarding the resource to be
+ added.</p>
+ </div>
+ </div>
+
+ <div class="page-header"></div><!-- remove resource-->
+
+ <div class="row">
+ <div class="span6 columns">
+ <a href="restful_swarms.html#remove-resource">Remove
+ Resource (DELETE)</a>
+ </div>
+
+ <div class="span10 columns">
+ <p>Remove a resource from a swarm. POST a JSON file
+ containing swarm-relevant information regarding the
+ resource to remove.</p>
+ </div>
+ </div>
+
+ <div class="page-header"></div><!-- list resources-->
+
+ <div class="row">
+ <div class="span6 columns">
+ <a href="restful_swarms.html#list-resources">List Resources
+ (GET)</a>
+ </div>
+
+ <div class="span10 columns">
+ <p>List a given swarm's member resources. Users may choose
+ to list only producing resources, only consuming resourcs,
+ or all resources at once.</p>
+ </div>
+ </div>
+
+ <div class="page-header"></div><!-- Invitations-->
+
+ <h3><a id="invitations" href="restful_invitations.html" name=
+ "invitations">Invitations</a></h3>
+
+ <p>Expose BUGswarm's unique social presence by inviting another
+ user's resources to join your swarms and share in the
+ production and consumption of data. Accept invitations from
+ other users to join their swarms as well.</p>
+
+ <div class="row">
+ <div class="span6 columns">
+ <h5>Method</h5>
+ </div>
+
+ <div class="span6 columns">
+ <h5>Description</h5>
+ </div>
+ </div>
+
+ <div class="page-header"></div><!-- send-->
+
+ <div class="row">
+ <div class="span6 columns">
+ <a href="restful_invitations.html#send">Send (POST)</a>
+ </div>
+
+ <div class="span10 columns">
+ <p>Send an invitation to another user's resource to join
+ your swarm.</p>
+ </div>
+ </div>
+
+ <div class="page-header"></div><!-- respond-->
+
+ <div class="row">
+ <div class="span6 columns">
+ <a href="restful_invitations.html#respond">Respond
+ (PUT)</a>
+ </div>
+
+ <div class="span10 columns">
+ <p>Respond to received invitations by either accepting or
+ rejecting them.</p>
+ </div>
+ </div>
+
+ <div class="page-header"></div><!-- list sent-->
+
+ <div class="row">
+ <div class="span6 columns">
+ <a href="restful_invitations.html#list-sent">List Sent
+ (GET)</a>
+ </div>
+
+ <div class="span10 columns">
+ <p>List all the invitations sent from your user account for
+ resources to join a given swarm.</p>
+ </div>
+ </div>
+
+ <div class="page-header"></div><!-- list received-->
+
+ <div class="row">
+ <div class="span6 columns">
+ <a href="restful_invitations.html#list-received">List
+ Received (GET)</a>
+ </div>
+
+ <div class="span10 columns">
+ <p>List the invitations received by your user account from
+ other users. List all invitations or only those sent to
+ specific resources.</p>
+ </div>
+ </div>
+
+ <div class="page-header"></div>
+ </div>
+</body>
+</html>
View
136 contact.html
@@ -1,14 +1,122 @@
-<!DOCTYPE html><html lang="en"><head><title>BUGswarm Developers</title><link rel="stylesheet" href="bootstrap/bootstrap.css"><link rel="stylesheet" href="css/this.css"><link rel="stylesheet" href="js/google-code-prettify/prettify.css"><script src="http://code.jquery.com/jquery-1.5.2.js"></script><script src="js/google-code-prettify/prettify.js"></script><script src="js/application.js"></script><script src="js/google-analytics.js"></script></head><body><div class="topbar"><div class="topbar-inner"><div class="container"><h3><a id="banner" href="index.html"><img src="images/bs_logo.png"></a></h3><ul class="nav"><li class="dropdown nav-dropdown"><a href="documentation.html" class="dropdown-toggle">Documentation</a><ul class="dropdown-menu"><li><a href="configuration_api.html">Configuration</a></li><li><a href="participation_api.html">Participation</a></li></ul></li><li><a href="tools.html">Tools</a></li><li><a href="libraries.html">Libraries</a></li><li><a href="tutorial.html">Tutorial</a></li><li><a href="applications.html">Applications</a></li><li><a href="hardware.html">Hardware</a></li><li><a href="contact.html">Contact</a></li></ul></div></div></div><!-- CONTAINER--><div class="container"><!-- Path--><div class="page-header"><a href="index.html">Home</a> &rarr;
-Contact
-</div><!-- Header--><h1>Contact</h1><div class="row"><div class="span-one-third"><h2><a href="irc://irc.freenode.net/bugswarm">Chat</a></h2><p>Feel free to drop in the
-<a href="irc://irc.freenode.net/bugswarm">#bugswarm</a> IRC channel on
-<a href="irc.freenode.net">Freenode</a> to chat with the BUGswarm development team.
-</p></div><div class="span-one-third"><h2><a href="http://twitter.com/bugswarm">Twitter</a></h2><p>Tweet
-<a href="http://twitter.com/bugswarm">@bugswarm</a> and let us know what you're thinking.
-</p></div><div class="span-one-third"><h2><a href="http://community.buglabs.net/blog">Blog</a></h2><p>Read up on what's new with BUGswarm by visiting our
-<a href="http://community.buglabs.net/blog">blog</a>.
-</p></div></div><div class="page-header"></div><div class="row"><div class="span-one-third"><h2><a href="http://github.com/buglabs">GitHub</a></h2><p>Find us at the
-<a href="http://github.com/buglabs">Bug Labs github page</a> to check out BUGswarm-related projects and contribute.
-</p></div><div class="span-one-third"><h2><a href="http://github.com/buglabs/bugswarm-api/issues">Report Bugs</a></h2><p>Found a bug in BUGswarm? Help us out and submit an issue
-<a href="http://github.com/buglabs/bugswarm-api/issues">here</a>.
-</p></div></div></div></body></html>
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
+
+<html lang="en">
+<head>
+ <meta name="generator" content=
+ "HTML Tidy for Linux (vers 25 March 2009), see www.w3.org">
+
+ <title>BUGswarm Developers</title>
+ <link rel="stylesheet" href="bootstrap/bootstrap.css" type=
+ "text/css">
+ <link rel="stylesheet" href="css/this.css" type="text/css">
+ <link rel="stylesheet" href=
+ "js/google-code-prettify/prettify.css" type="text/css">
+ <script src="http://code.jquery.com/jquery-1.5.2.js" type=
+ "text/javascript">
+</script>
+ <script src="js/google-code-prettify/prettify.js" type=
+ "text/javascript">
+</script>
+ <script src="js/application.js" type="text/javascript">
+</script>
+ <script src="js/google-analytics.js" type="text/javascript">
+</script>
+</head>
+
+<body>
+ <div class="topbar">
+ <div class="topbar-inner">
+ <div class="container">
+ <h3><a id="banner" href="index.html" name=
+ "banner"><img src="images/bs_logo.png"></a></h3>
+
+ <ul class="nav">
+ <li class="dropdown nav-dropdown">
+ <a href="documentation.html" class=
+ "dropdown-toggle">Documentation</a>
+
+ <ul class="dropdown-menu">
+ <li><a href=
+ "configuration_api.html">Configuration</a></li>
+
+ <li><a href=
+ "participation_api.html">Participation</a></li>
+ </ul>
+ </li>
+
+ <li><a href="tools.html">Tools</a></li>
+
+ <li><a href="libraries.html">Libraries</a></li>
+
+ <li><a href="tutorial.html">Tutorial</a></li>
+
+ <li><a href="applications.html">Applications</a></li>
+
+ <li><a href="hardware.html">Hardware</a></li>
+
+ <li><a href="contact.html">Contact</a></li>
+ </ul>
+ </div>
+ </div>
+ </div><!-- CONTAINER-->
+
+ <div class="container">
+ <!-- Path-->
+
+ <div class="page-header">
+ <a href="index.html">Home</a> &rarr; Contact
+ </div><!-- Header-->
+
+ <h1>Contact</h1>
+
+ <div class="row">
+ <div class="span-one-third">
+ <h2><a href="irc://irc.freenode.net/bugswarm">Chat</a></h2>
+
+ <p>Feel free to drop in the <a href=
+ "irc://irc.freenode.net/bugswarm">#bugswarm</a> IRC channel
+ on <a href="irc.freenode.net">Freenode</a> to chat with the
+ BUGswarm development team.</p>
+ </div>
+
+ <div class="span-one-third">
+ <h2><a href="http://twitter.com/bugswarm">Twitter</a></h2>
+
+ <p>Tweet <a href=
+ "http://twitter.com/bugswarm">@bugswarm</a> and let us know
+ what you're thinking.</p>
+ </div>
+
+ <div class="span-one-third">
+ <h2><a href=
+ "http://community.buglabs.net/blog">Blog</a></h2>
+
+ <p>Read up on what's new with BUGswarm by visiting our
+ <a href="http://community.buglabs.net/blog">blog</a>.</p>
+ </div>
+ </div>
+
+ <div class="page-header"></div>
+
+ <div class="row">
+ <div class="span-one-third">
+ <h2><a href="http://github.com/buglabs">GitHub</a></h2>
+
+ <p>Find us at the <a href="http://github.com/buglabs">Bug
+ Labs github page</a> to check out BUGswarm-related projects
+ and contribute.</p>
+ </div>
+
+ <div class="span-one-third">
+ <h2><a href=
+ "http://github.com/buglabs/bugswarm-api/issues">Report
+ Bugs</a></h2>
+
+ <p>Found a bug in BUGswarm? Help us out and submit an issue
+ <a href=
+ "http://github.com/buglabs/bugswarm-api/issues">here</a>.</p>
+ </div>
+ </div>
+ </div>
+</body>
+</html>
View
160 documentation.html
@@ -1,25 +1,135 @@
-<!DOCTYPE html><html lang="en"><head><title>BUGswarm Developers</title><link rel="stylesheet" href="bootstrap/bootstrap.css"><link rel="stylesheet" href="css/this.css"><link rel="stylesheet" href="js/google-code-prettify/prettify.css"><script src="http://code.jquery.com/jquery-1.5.2.js"></script><script src="js/google-code-prettify/prettify.js"></script><script src="js/application.js"></script><script src="js/google-analytics.js"></script></head><body><!-- NAVIGATION--><div class="topbar"><div class="topbar-inner"><div class="container"><h3><a id="banner" href="index.html"><img src="images/bs_logo.png"></a></h3><ul class="nav"><li class="dropdown nav-dropdown"><a href="documentation.html" class="dropdown-toggle">Documentation</a><ul class="dropdown-menu"><li><a href="configuration_api.html">Configuration</a></li><li><a href="participation_api.html">Participation</a></li></ul></li><li><a href="tools.html">Tools</a></li><li><a href="libraries.html">Libraries</a></li><li><a href="tutorial.html">Tutorial</a></li><li><a href="applications.html">Applications</a></li><li><a href="hardware.html">Hardware</a></li><li><a href="contact.html">Contact</a></li></ul></div></div></div><!-- CONTENT--><div class="container"><!-- Path--><div class="page-header"><a href="index.html">Home</a> &rarr;
- Documentation
-</div><!-- Header--><h1>Documentation</h1><div class="page-header"><h2>API</h2><p>The BUGswarm API can be broken down into two primary actions, configuration and participation.
-Configuration includes the creation, updating, and destruction of swarms and their resources
-in addition to inviting other users' resources into your swarms and accepting or rejecting pending invitations.
-Participation includes producing and consuming data within one or many swarms.
-</p><!-- Descriptions--><div class="row"><div class="span8"><h3><a href="configuration_api.html">Configuration</a><small> Establish swarms, resources, and invitations
-</small></h3><p>BUGswarm uses a RESTful (Representational State Transfer) API to configure swarms
-and their resources. Use it to create and destroy swarms and resources, add and remove resources to and from swarms,
-and generate API keys. In addition to these
-methods, the Configuration API also takes care of the social aspect of BUGswarm, sending invitations to other users'
-resources to join your swarms as well as accepting and rejecting pending invitations.
-To make development easier, the Configuration API has been wrapped up in
-<a href="http://github.com/buglabs/bugswarm-tools">BUGswarm Tools</a>, a set of python scripts used to make the development process simple and easy.
-</p></div><div class="span8"><h3><a href="participation_api.html">Participation</a><small> Produce and consume data
-</small></h3><p>BUGswarm makes use of an HTTP streaming API to allow resources to connect to and participate in the swarms they are members of.
-Because the Participation API uses streaming, after connecting a resource to a swarm,
-the connection remains open while bidirectional HTTP requests are processed.
-To make development easier, the Participation API has also been wrapped up in
-<a href="http://github.com/buglabs/bugswarm-tools">BUGswarm Tools</a> . Use the `consume.py` and `produce.py` scripts for use the Participation API from the command line.
-</p></div></div><div class="page-header"></div><!-- Tools and Libraries--><h2>Tools and Libraries</h2><p>In order to make the BUGswarm development process as easy and friendly as possible, we have developed a set
-of tools and libraries to help you get started even faster. Visit the
-<a href="tools.html">Tools</a> and
-<a href="libraries.html">Libraries</a> pages to learn more.
-</p></div></div></body></html>
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
+
+<html lang="en">
+<head>
+ <meta name="generator" content=
+ "HTML Tidy for Linux (vers 25 March 2009), see www.w3.org">
+
+ <title>BUGswarm Developers</title>
+ <link rel="stylesheet" href="bootstrap/bootstrap.css" type=
+ "text/css">
+ <link rel="stylesheet" href="css/this.css" type="text/css">
+ <link rel="stylesheet" href=
+ "js/google-code-prettify/prettify.css" type="text/css">
+ <script src="http://code.jquery.com/jquery-1.5.2.js" type=
+ "text/javascript">
+</script>
+ <script src="js/google-code-prettify/prettify.js" type=
+ "text/javascript">
+</script>
+ <script src="js/application.js" type="text/javascript">
+</script>
+ <script src="js/google-analytics.js" type="text/javascript">
+</script>
+</head>
+
+<body>
+ <!-- NAVIGATION-->
+
+ <div class="topbar">
+ <div class="topbar-inner">
+ <div class="container">
+ <h3><a id="banner" href="index.html" name=
+ "banner"><img src="images/bs_logo.png"></a></h3>
+
+ <ul class="nav">
+ <li class="dropdown nav-dropdown">
+ <a href="documentation.html" class=
+ "dropdown-toggle">Documentation</a>
+
+ <ul class="dropdown-menu">
+ <li><a href=
+ "configuration_api.html">Configuration</a></li>
+
+ <li><a href=
+ "participation_api.html">Participation</a></li>
+ </ul>
+ </li>
+
+ <li><a href="tools.html">Tools</a></li>
+
+ <li><a href="libraries.html">Libraries</a></li>
+
+ <li><a href="tutorial.html">Tutorial</a></li>
+
+ <li><a href="applications.html">Applications</a></li>
+
+ <li><a href="hardware.html">Hardware</a></li>
+
+ <li><a href="contact.html">Contact</a></li>
+ </ul>
+ </div>
+ </div>
+ </div><!-- CONTENT-->
+
+ <div class="container">
+ <!-- Path-->
+
+ <div class="page-header">
+ <a href="index.html">Home</a> &rarr; Documentation
+ </div><!-- Header-->
+
+ <h1>Documentation</h1>
+
+ <div class="page-header">
+ <h2>API</h2>
+
+ <p>The BUGswarm API can be broken down into two primary
+ actions, configuration and participation. Configuration
+ includes the creation, updating, and destruction of swarms
+ and their resources in addition to inviting other users'
+ resources into your swarms and accepting or rejecting pending
+ invitations. Participation includes producing and consuming
+ data within one or many swarms.</p><!-- Descriptions-->
+
+ <div class="row">
+ <div class="span8">
+ <h3><a href="configuration_api.html">Configuration</a>
+ <small>Establish swarms, resources, and
+ invitations</small></h3>
+
+ <p>BUGswarm uses a RESTful (Representational State
+ Transfer) API to configure swarms and their resources.
+ Use it to create and destroy swarms and resources, add
+ and remove resources to and from swarms, and generate API
+ keys. In addition to these methods, the Configuration API
+ also takes care of the social aspect of BUGswarm, sending
+ invitations to other users' resources to join your swarms
+ as well as accepting and rejecting pending invitations.
+ To make development easier, the Configuration API has
+ been wrapped up in <a href=
+ "http://github.com/buglabs/bugswarm-tools">BUGswarm
+ Tools</a>, a set of python scripts used to make the
+ development process simple and easy.</p>
+ </div>
+
+ <div class="span8">
+ <h3><a href="participation_api.html">Participation</a>
+ <small>Produce and consume data</small></h3>
+
+ <p>BUGswarm makes use of an HTTP streaming API to allow
+ resources to connect to and participate in the swarms
+ they are members of. Because the Participation API uses
+ streaming, after connecting a resource to a swarm, the
+ connection remains open while bidirectional HTTP requests
+ are processed. To make development easier, the
+ Participation API has also been wrapped up in <a href=
+ "http://github.com/buglabs/bugswarm-tools">BUGswarm
+ Tools</a> . Use the `consume.py` and `produce.py` scripts
+ for use the Participation API from the command line.</p>
+ </div>
+ </div>
+
+ <div class="page-header"></div><!-- Tools and Libraries-->
+
+ <h2>Tools and Libraries</h2>
+
+ <p>In order to make the BUGswarm development process as easy
+ and friendly as possible, we have developed a set of tools
+ and libraries to help you get started even faster. Visit the
+ <a href="tools.html">Tools</a> and <a href=
+ "libraries.html">Libraries</a> pages to learn more.</p>
+ </div>
+ </div>
+</body>
+</html>
View
15 googleeed5e812cc5b4fc5.html
@@ -1 +1,14 @@
-google-site-verification: googleeed5e812cc5b4fc5.html
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 3.2//EN">
+
+<html>
+<head>
+ <meta name="generator" content=
+ "HTML Tidy for Linux (vers 25 March 2009), see www.w3.org">
+
+ <title></title>
+</head>
+
+<body>
+ google-site-verification: googleeed5e812cc5b4fc5.html
+</body>
+</html>
View
447 hardware.html
@@ -1,97 +1,408 @@
-<!DOCTYPE html><html lang="en"><head><title>BUGswarm Developers</title><link rel="stylesheet" href="bootstrap/bootstrap.css"><link rel="stylesheet" href="css/this.css"><link rel="stylesheet" href="js/google-code-prettify/prettify.css"><script src="http://code.jquery.com/jquery-1.5.2.js"></script><script src="js/google-code-prettify/prettify.js"></script><script src="js/application.js"></script><script src="js/google-analytics.js"></script></head><body><!-- NAVIGATION--><div class="topbar"><div class="topbar-inner"><div class="container"><h3><a id="banner" href="index.html"><img src="images/bs_logo.png"></a></h3><ul class="nav"><li class="dropdown nav-dropdown"><a href="documentation.html" class="dropdown-toggle">Documentation</a><ul class="dropdown-menu"><li><a href="configuration_api.html">Configuration</a></li><li><a href="participation_api.html">Participation</a></li></ul></li><li><a href="tools.html">Tools</a></li><li><a href="libraries.html">Libraries</a></li><li><a href="tutorial.html">Tutorial</a></li><li><a href="applications.html">Applications</a></li><li><a href="hardware.html">Hardware</a></li><li><a href="contact.html">Contact</a></li></ul></div></div></div><!-- CONTAINER--><div class="container"><div class="page-header"><a href="index.html">Home</a> &rarr;
- Hardware
-</div><!-- Header--><h1>Connectors</h1><p>While you can certainly use any of our
-<a href="libraries.html">libraries</a> to develop applications for the embedded devices of your choosing, we also provide you with a series of hands-off device connectors
-that make it easy to get your device up and running on BUGswarm without having to write any embedded code.
-</p><br><h1>How they work:</h1><p>A connector is a client-side, device-specific application that allows you to quickly get your embedded devices connected to and participating on BUGswarm.
-With a minimal amount of configuration and zero embedded code to write, you can have your devices producing and consuming in a matter of minutes. In order to achieve this
-simplicity and ease, connectors follow a specific messaging contract with all applications that may be interested in the data that connectors produce. For instance, the
-<a href="http://bugswarm.net">BUGswarm Management UI</a> is a web application used to create and configure swarms and resources. Additionally, the UI allows for communication with devices exhibiting the connector contract and producing
-Location and Acceleration feeds. For an example of how this communication between connectors and connector-interested applications such as the Management UI, check out our JavaScript-based
-<a href="http://buglabs.github.com/web-connector">Web Connector</a>. Simply input your participation API key, the ID of the resource you wish to use as your web-connector device, and the ID of the swarm it is a member of and click 'Connect'.
-You should then be able to view that resource in the Management UI and observe that the Location and Acceleration services are now available. Keep in mind that if you are not using one of
-the supported devices listed in the web-connector, you may not receive valid data.
-</p><br><h1>Contract:</h1><br><div class="page-header"><h2>Events</h2></div><div class="row"><div class="span8 columns"><h4>Connector connects to a swarm:</h4></div><div class="span8 columns"><ol><li>Send a <strong>private</strong> Capabilities message to each swarm member based on
-the swarm presence available messages received.
-</li></ol></div></div><div class="page-header"></div><div class="row"><div class="span8 columns"><h4>Connector disconnects from a swarm:</h4></div><div class="span8 columns"><ol><li>Cancel any active feed responses associated with that swarm.
-</li></ol></div></div><div class="page-header"></div><div class="row"><div class="span8 columns"><h4>Connector has a new feed:</h4></div><div class="span8 columns"><ol><li>Send a <strong>private</strong> `Capabilities` message to each swarm member based on
-the swarm presence available messages received.
-</li></ol></div></div><div class="page-header"></div><div class="row"><div class="span8 columns"><h4>Connector loses a feed:</h4></div><div class="span8 columns"><ol><li>Send a <strong>private</strong> `Capabilities` message to each swarm member based on
-the swarm presence available messages received.
-</li><li>Cancel any active feed responses associated with the swarms it is a member of for that feed.
-</li></ol></div></div><div class="page-header"></div><div class="row"><div class="span8 columns"><h4>Member joins the swarm:</h4></div><div class="span8 columns"><ol><li>Send a <strong>private</strong> `Capabilities` message to the new member.
-</li></ol></div></div><div class="page-header"></div><div class="row"><div class="span8 columns"><h4>Member leaves the swarm:</h4></div><div class="span8 columns"><ol><li>Cancel any active feed responses to that member.
-</li></ol></div></div><div class="page-header"></div><div class="row"><div class="span8 columns"><h4>Member requests a feed:</h4></div><div class="span8 columns"><ol><li>Parse the feed request.
-</li><li>Send a <strong>private</strong> feed response for that feed to the requesting member with the desired response parameters.
-</li></ol></div></div><div class="page-header"></div><br><br><div class="page-header"><h2>Messages</h2></div><div class="row"><div class="span-one-third columns"><h4>Capabilities:</h4><p>When a connector connects to a swarm, it sends the capabilities message privately to all members of that swarm. Additionally, once already
-connected, the connector sends a private capabilities message to each new member that connects to that swarm. The capabilities message
-contains relevant information regarding what the connected device is capable of producing. Currently, the capabilities message is simply
-a wrapper around the <code>feeds</code> message, but may contain more information in the future.
-</p></div><div class="span-one-third columns"><h5>Format:</h5><pre class="prettyprint language-javascript">{
- &quot;capabilities&quot;: {
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
+
+<html lang="en">
+<head>
+ <meta name="generator" content=
+ "HTML Tidy for Linux (vers 25 March 2009), see www.w3.org">
+
+ <title>BUGswarm Developers</title>
+ <link rel="stylesheet" href="bootstrap/bootstrap.css" type=
+ "text/css">
+ <link rel="stylesheet" href="css/this.css" type="text/css">
+ <link rel="stylesheet" href=
+ "js/google-code-prettify/prettify.css" type="text/css">
+ <script src="http://code.jquery.com/jquery-1.5.2.js" type=
+ "text/javascript">
+</script>
+ <script src="js/google-code-prettify/prettify.js" type=
+ "text/javascript">
+</script>
+ <script src="js/application.js" type="text/javascript">
+</script>
+ <script src="js/google-analytics.js" type="text/javascript">
+</script>
+</head>
+
+<body>
+ <!-- NAVIGATION-->
+
+ <div class="topbar">
+ <div class="topbar-inner">
+ <div class="container">
+ <h3><a id="banner" href="index.html" name=
+ "banner"><img src="images/bs_logo.png"></a></h3>
+
+ <ul class="nav">
+ <li class="dropdown nav-dropdown">
+ <a href="documentation.html" class=
+ "dropdown-toggle">Documentation</a>
+
+ <ul class="dropdown-menu">
+ <li><a href=
+ "configuration_api.html">Configuration</a></li>
+
+ <li><a href=
+ "participation_api.html">Participation</a></li>
+ </ul>
+ </li>
+
+ <li><a href="tools.html">Tools</a></li>
+
+ <li><a href="libraries.html">Libraries</a></li>
+
+ <li><a href="tutorial.html">Tutorial</a></li>
+
+ <li><a href="applications.html">Applications</a></li>
+
+ <li><a href="hardware.html">Hardware</a></li>
+
+ <li><a href="contact.html">Contact</a></li>
+ </ul>
+ </div>
+ </div>
+ </div><!-- CONTAINER-->
+
+ <div class="container">
+ <div class="page-header">
+ <a href="index.html">Home</a> &rarr; Hardware
+ </div><!-- Header-->
+
+ <h1>Connectors</h1>
+
+ <p>While you can certainly use any of our <a href=
+ "libraries.html">libraries</a> to develop applications for the
+ embedded devices of your choosing, we also provide you with a
+ series of hands-off device connectors that make it easy to get
+ your device up and running on BUGswarm without having to write
+ any embedded code.</p><br>
+
+ <h1>How they work:</h1>
+
+ <p>A connector is a client-side, device-specific application
+ that allows you to quickly get your embedded devices connected
+ to and participating on BUGswarm. With a minimal amount of
+ configuration and zero embedded code to write, you can have
+ your devices producing and consuming in a matter of minutes. In
+ order to achieve this simplicity and ease, connectors follow a
+ specific messaging contract with all applications that may be
+ interested in the data that connectors produce. For instance,
+ the <a href="http://bugswarm.net">BUGswarm Management UI</a> is
+ a web application used to create and configure swarms and
+ resources. Additionally, the UI allows for communication with
+ devices exhibiting the connector contract and producing
+ Location and Acceleration feeds. For an example of how this
+ communication between connectors and connector-interested
+ applications such as the Management UI, check out our
+ JavaScript-based <a href=
+ "http://buglabs.github.com/web-connector">Web Connector</a>.
+ Simply input your participation API key, the ID of the resource
+ you wish to use as your web-connector device, and the ID of the
+ swarm it is a member of and click 'Connect'. You should then be
+ able to view that resource in the Management UI and observe
+ that the Location and Acceleration services are now available.
+ Keep in mind that if you are not using one of the supported
+ devices listed in the web-connector, you may not receive valid
+ data.</p><br>
+
+ <h1>Contract:</h1><br>
+
+ <div class="page-header">
+ <h2>Events</h2>
+ </div>
+
+ <div class="row">
+ <div class="span8 columns">
+ <h4>Connector connects to a swarm:</h4>
+ </div>
+
+ <div class="span8 columns">
+ <ol>
+ <li>Send a <strong>private</strong> Capabilities message
+ to each swarm member based on the swarm presence
+ available messages received.</li>
+ </ol>
+ </div>
+ </div>
+
+ <div class="page-header"></div>
+
+ <div class="row">
+ <div class="span8 columns">
+ <h4>Connector disconnects from a swarm:</h4>
+ </div>
+
+ <div class="span8 columns">
+ <ol>
+ <li>Cancel any active feed responses associated with that
+ swarm.</li>
+ </ol>
+ </div>
+ </div>
+
+ <div class="page-header"></div>
+
+ <div class="row">
+ <div class="span8 columns">
+ <h4>Connector has a new feed:</h4>
+ </div>
+
+ <div class="span8 columns">
+ <ol>
+ <li>Send a <strong>private</strong> `Capabilities`
+ message to each swarm member based on the swarm presence
+ available messages received.</li>
+ </ol>
+ </div>
+ </div>
+
+ <div class="page-header"></div>
+
+ <div class="row">
+ <div class="span8 columns">
+ <h4>Connector loses a feed:</h4>
+ </div>
+
+ <div class="span8 columns">
+ <ol>
+ <li>Send a <strong>private</strong> `Capabilities`
+ message to each swarm member based on the swarm presence
+ available messages received.</li>
+
+ <li>Cancel any active feed responses associated with the
+ swarms it is a member of for that feed.</li>
+ </ol>
+ </div>
+ </div>
+
+ <div class="page-header"></div>
+
+ <div class="row">
+ <div class="span8 columns">
+ <h4>Member joins the swarm:</h4>
+ </div>
+
+ <div class="span8 columns">
+ <ol>
+ <li>Send a <strong>private</strong> `Capabilities`
+ message to the new member.</li>
+ </ol>
+ </div>
+ </div>
+
+ <div class="page-header"></div>
+
+ <div class="row">
+ <div class="span8 columns">
+ <h4>Member leaves the swarm:</h4>
+ </div>
+
+ <div class="span8 columns">
+ <ol>
+ <li>Cancel any active feed responses to that member.</li>
+ </ol>
+ </div>
+ </div>
+
+ <div class="page-header"></div>
+
+ <div class="row">
+ <div class="span8 columns">
+ <h4>Member requests a feed:</h4>
+ </div>
+
+ <div class="span8 columns">
+ <ol>
+ <li>Parse the feed request.</li>
+
+ <li>Send a <strong>private</strong> feed response for
+ that feed to the requesting member with the desired
+ response parameters.</li>
+ </ol>
+ </div>
+ </div>
+
+ <div class="page-header"></div><br>
+ <br>
+
+ <div class="page-header">
+ <h2>Messages</h2>
+ </div>
+
+ <div class="row">
+ <div class="span-one-third columns">
+ <h4>Capabilities:</h4>
+
+ <p>When a connector connects to a swarm, it sends the
+ capabilities message privately to all members of that
+ swarm. Additionally, once already connected, the connector
+ sends a private capabilities message to each new member
+ that connects to that swarm. The capabilities message
+ contains relevant information regarding what the connected
+ device is capable of producing. Currently, the capabilities
+ message is simply a wrapper around the <code>feeds</code>
+ message, but may contain more information in the
+ future.</p>
+ </div>
+
+ <div class="span-one-third columns">
+ <h5>Format:</h5>
+ <pre class="prettyprint language-javascript">
+{
+ "capabilities": {
&lt;feeds message&gt;
}
}
-</pre></div><div class="span-one-third columns"><h5>Example:</h5><pre class="prettyprint language-javascript">{
- &quot;capabilities&quot; {
- &quot;feeds&quot;: [
- &quot;Location&quot;,
- &quot;Acceleration&quot;
+</pre>
+ </div>
+
+ <div class="span-one-third columns">
+ <h5>Example:</h5>
+ <pre class="prettyprint language-javascript">
+{
+ "capabilities" {
+ "feeds": [
+ "Location",
+ "Acceleration"
]
}
}
-</pre></div></div><div class="page-header"></div><div class="row"><div class="span-one-third columns"><h4>Feeds:</h4><p>The feeds message is sent as part of the <code>capabilities</code> message and contains an array of the services that the connected devices provides. Example services
-are <code>Location</code> and <code>Acceleration</code>.
-</p></div><div class="span-one-third columns"><h5>Format:</h5><pre class="prettyprint language-javascript">{
- &quot;feeds&quot;: [
+</pre>
+ </div>
+ </div>
+
+ <div class="page-header"></div>
+
+ <div class="row">
+ <div class="span-one-third columns">
+ <h4>Feeds:</h4>
+
+ <p>The feeds message is sent as part of the
+ <code>capabilities</code> message and contains an array of
+ the services that the connected devices provides. Example
+ services are <code>Location</code> and
+ <code>Acceleration</code>.</p>
+ </div>
+
+ <div class="span-one-third columns">
+ <h5>Format:</h5>
+ <pre class="prettyprint language-javascript">
+{
+ "feeds": [
&lt;feed name 1&gt;,
&lt;feed name 2&gt;
]
}
-</pre></div><div class="span-one-third columns"><h5>Example:</h5><pre class="prettyprint language-javascript">{
- &quot;feeds&quot;: [
+</pre>
+ </div>
+
+ <div class="span-one-third columns">
+ <h5>Example:</h5>
+ <pre class="prettyprint language-javascript">
+{
+ "feeds": [
Location,
Acceleration
]
}
-</pre></div></div><div class="page-header"></div><div class="row"><div class="span-one-third columns"><h4>Feed Request:</h4><p>The feed request message is sent to a connector from applications or devices that are interested in that connector. The <code>capabilities</code> message
-that is privately sent to them by the connector lets them know what kind of feeds are available. In addition to which feed to request, the <code>type</code>
-field must be given. The <code>params</code> field is optional. If no parameters are given, the connector will respond with a single feed response message
-for the desired feed. Possible parameters are <code>frequency</code>, which determines the interval frequency for the connector to send feed responses, and
-<code>status</code> which may be set to <code>off</code> to tell the connector to stop sending feed responses for that feed.
-</p></div><div class="span-one-third columns"><h5>Format:</h5><pre class="prettyprint language-javascript">{
- &quot;type&quot;: &lt;type&gt;,
- &quot;feed&quot;: &lt;feed name&gt;,
- &quot;params&quot;: {
+</pre>
+ </div>
+ </div>
+
+ <div class="page-header"></div>
+
+ <div class="row">
+ <div class="span-one-third columns">
+ <h4>Feed Request:</h4>
+
+ <p>The feed request message is sent to a connector from
+ applications or devices that are interested in that
+ connector. The <code>capabilities</code> message that is
+ privately sent to them by the connector lets them know what
+ kind of feeds are available. In addition to which feed to
+ request, the <code>type</code> field must be given. The
+ <code>params</code> field is optional. If no parameters are
+ given, the connector will respond with a single feed
+ response message for the desired feed. Possible parameters
+ are <code>frequency</code>, which determines the interval
+ frequency for the connector to send feed responses, and
+ <code>status</code> which may be set to <code>off</code> to
+ tell the connector to stop sending feed responses for that
+ feed.</p>
+ </div>
+
+ <div class="span-one-third columns">
+ <h5>Format:</h5>
+ <pre class="prettyprint language-javascript">
+{
+ "type": &lt;type&gt;,
+ "feed": &lt;feed name&gt;,
+ "params": {
&lt;param 1&gt;: &lt;value 1&gt;,
&lt;param 2&gt;: &lt;value 2&gt;
}
}
-</pre></div><div class="span-one-third columns"><h5>Example:</h5><pre class="prettyprint language-javascript">{
- &quot;type&quot;: &quot;get&quot;,
- &quot;feed&quot;: &quot;Location&quot;,
- &quot;params&quot;: {
- &quot;frequency&quot;: 60 #seconds
+</pre>
+ </div>
+
+ <div class="span-one-third columns">
+ <h5>Example:</h5>
+ <pre class="prettyprint language-javascript">
+{
+ "type": "get",
+ "feed": "Location",
+ "params": {
+ "frequency": 60 #seconds
}
}
-</pre></div></div><div class="page-header"></div><div class="row"><div class="span-one-third columns"><h4>Feed Response:</h4><p>The feed response message is send from the connector to a device or application that has sent a feed request to it. It is sent on an interval at the frequency
-that is given in the feed request or just once if no frequency is given. It contains the name of the feed that is being send and a feed object containing key:value
-pairs of data.
-</p></div><div class="span-one-third columns"><h5>Format:</h5><pre class="prettyprint language-javascript">{
- &quot;name&quot;: &lt;feed name&gt;,
- &quot;feed&quot;: {
+</pre>
+ </div>
+ </div>
+
+ <div class="page-header"></div>
+
+ <div class="row">
+ <div class="span-one-third columns">
+ <h4>Feed Response:</h4>
+
+ <p>The feed response message is send from the connector to
+ a device or application that has sent a feed request to it.
+ It is sent on an interval at the frequency that is given in
+ the feed request or just once if no frequency is given. It
+ contains the name of the feed that is being send and a feed
+ object containing key:value pairs of data.</p>
+ </div>
+
+ <div class="span-one-third columns">
+ <h5>Format:</h5>
+ <pre class="prettyprint language-javascript">
+{
+ "name": &lt;feed name&gt;,
+ "feed": {
&lt;key 1&gt;: &lt;value 1&gt;,
&lt;key 2&gt;: &lt;value 2&gt;
}
}
-</pre></div><div class="span-one-third columns"><h5>Example:</h5><pre class="prettyprint language-javascript">{
- &quot;name&quot;: &quot;Location&quot;,
- &quot;feed&quot;: {
- &quot;Latitude&quot;: &quot;-40.4545&quot;,
- &quot;Longitude&quot;: &quot;72.482899&quot;
+</pre>
+ </div>
+
+ <div class="span-one-third columns">
+ <h5>Example:</h5>
+ <pre class="prettyprint language-javascript">
+{
+ "name": "Location",
+ "feed": {
+ "Latitude": "-40.4545",
+ "Longitude": "72.482899"
}
}
-</pre></div></div><div class="page-header"></div></div></body></html>
+</pre>
+ </div>
+ </div>
+
+ <div class="page-header"></div>
+ </div>
+</body>
+</html>
View
147 http_response_codes.html
@@ -1,18 +1,129 @@
-<!DOCTYPE html><html lang="en"><head><title>BUGswarm Developers</title><link rel="stylesheet" href="bootstrap/bootstrap.css"><link rel="stylesheet" href="css/this.css"><link rel="stylesheet" href="js/google-code-prettify/prettify.css"><script src="http://code.jquery.com/jquery-1.5.2.js"></script><script src="js/google-code-prettify/prettify.js"></script><script src="js/application.js"></script><script src="js/google-analytics.js"></script></head><body><!-- NAVIGATION--><div class="topbar"><div class="topbar-inner"><div class="container"><h3><a id="banner" href="index.html"><img src="images/bs_logo.png"></a></h3><ul class="nav"><li class="dropdown nav-dropdown"><a href="documentation.html" class="dropdown-toggle">Documentation</a><ul class="dropdown-menu"><li><a href="configuration_api.html">Configuration</a></li><li><a href="participation_api.html">Participation</a></li></ul></li><li><a href="tools.html">Tools</a></li><li><a href="libraries.html">Libraries</a></li><li><a href="tutorial.html">Tutorial</a></li><li><a href="applications.html">Applications</a></li><li><a href="hardware.html">Hardware</a></li><li><a href="contact.html">Contact</a></li></ul></div></div></div><!-- CONTENT--><div class="container"><!-- Path--><div class="page-header"><a href="index.html">Home</a> &rarr;
-<a href="api_documentation.html">API Documentation</a> &rarr;
-<a href="configuration_api.html">Configuration</a> &rarr;
-HTTP Response Codes
-</div><!-- Header--><h1>HTTP Response Codes</h1><p>A list of HTTP response codes that may be returned when using the BUGswarm API and their associated meanings.
-</p><div class="page-header"><h2>Codes</h2></div><ul class="unstyled"><li><strong>200:</strong> Request was received and handled without error. The server will return information based on the request.
-</li><li><strong>201:</strong> The entity was succesfully created.
-</li><li><strong>204:</strong> Request was received and handled without error. No information will be returned by the server.
-</li><li><strong>400:</strong> Bad request. There was something wrong with the specified data. It may have been an unrecognizable format
-or missing a field. The platform will provide a descriptive message with the application error code for easier
-debugging.
-</li><li><strong>401:</strong> Unauthorized. You may not have specified the HTTP header containing your API key.
-</li><li><strong>403:</strong> Forbidden. The resource may exist, but you do not have access to it due to application-level constraints.
-</li><li><strong>404:</strong> Not found. Either the specified URL does not exist in the server or the entity itself does not exist in the database.
-</li><li><strong>409:</strong> Conflict. There was a conflict with the request.
-</li><li><strong>500:</strong> Internal error. Something went wrong with the server. If you receive this error response, please notify the BUGswarm development team.
-</li></ul><div class="page-header"><h2>Format</h2></div><pre class="prettyprint language-javascript">[{code: 'xxx', description: 'foo'}, {code: 'yyy', description: 'bar'}]
-</pre></div></body></html>
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
+
+<html lang="en">
+<head>
+ <meta name="generator" content=
+ "HTML Tidy for Linux (vers 25 March 2009), see www.w3.org">
+
+ <title>BUGswarm Developers</title>
+ <link rel="stylesheet" href="bootstrap/bootstrap.css" type=
+ "text/css">
+ <link rel="stylesheet" href="css/this.css" type="text/css">
+ <link rel="stylesheet" href=
+ "js/google-code-prettify/prettify.css" type="text/css">
+ <script src="http://code.jquery.com/jquery-1.5.2.js" type=
+ "text/javascript">
+</script>
+ <script src="js/google-code-prettify/prettify.js" type=
+ "text/javascript">
+</script>
+ <script src="js/application.js" type="text/javascript">
+</script>
+ <script src="js/google-analytics.js" type="text/javascript">
+</script>
+</head>
+
+<body>
+ <!-- NAVIGATION-->
+
+ <div class="topbar">
+ <div class="topbar-inner">
+ <div class="container">
+ <h3><a id="banner" href="index.html" name=
+ "banner"><img src="images/bs_logo.png"></a></h3>
+
+ <ul class="nav">
+ <li class="dropdown nav-dropdown">
+ <a href="documentation.html" class=
+ "dropdown-toggle">Documentation</a>
+
+ <ul class="dropdown-menu">
+ <li><a href=
+ "configuration_api.html">Configuration</a></li>
+
+ <li><a href=
+ "participation_api.html">Participation</a></li>
+ </ul>
+ </li>
+
+ <li><a href="tools.html">Tools</a></li>
+
+ <li><a href="libraries.html">Libraries</a></li>
+
+ <li><a href="tutorial.html">Tutorial</a></li>
+
+ <li><a href="applications.html">Applications</a></li>
+
+ <li><a href="hardware.html">Hardware</a></li>
+
+ <li><a href="contact.html">Contact</a></li>
+ </ul>
+ </div>
+ </div>
+ </div><!-- CONTENT-->
+
+ <div class="container">
+ <!-- Path-->
+
+ <div class="page-header">
+ <a href="index.html">Home</a> &rarr; <a href=
+ "api_documentation.html">API Documentation</a> &rarr;
+ <a href="configuration_api.html">Configuration</a> &rarr;
+ HTTP Response Codes
+ </div><!-- Header-->
+
+ <h1>HTTP Response Codes</h1>
+
+ <p>A list of HTTP response codes that may be returned when
+ using the BUGswarm API and their associated meanings.</p>
+
+ <div class="page-header">
+ <h2>Codes</h2>
+ </div>
+
+ <ul class="unstyled">
+ <li><strong>200:</strong> Request was received and handled
+ without error. The server will return information based on
+ the request.</li>
+
+ <li><strong>201:</strong> The entity was succesfully
+ created.</li>
+
+ <li><strong>204:</strong> Request was received and handled
+ without error. No information will be returned by the
+ server.</li>
+
+ <li><strong>400:</strong> Bad request. There was something
+ wrong with the specified data. It may have been an
+ unrecognizable format or missing a field. The platform will
+ provide a descriptive message with the application error code
+ for easier debugging.</li>
+
+ <li><strong>401:</strong> Unauthorized. You may not have
+ specified the HTTP header containing your API key.</li>
+
+ <li><strong>403:</strong> Forbidden. The resource may exist,
+ but you do not have access to it due to application-level
+ constraints.</li>
+
+ <li><strong>404:</strong> Not found. Either the specified URL
+ does not exist in the server or the entity itself does not
+ exist in the database.</li>
+
+ <li><strong>409:</strong> Conflict. There was a conflict with
+ the request.</li>
+
+ <li><strong>500:</strong> Internal error. Something went
+ wrong with the server. If you receive this error response,
+ please notify the BUGswarm development team.</li>
+ </ul>
+
+ <div class="page-header">
+ <h2>Format</h2>
+ </div>
+ <pre class="prettyprint language-javascript">
+[{code: 'xxx', description: 'foo'}, {code: 'yyy', description: 'bar'}]
+</pre>
+ </div>
+</body>
+</html>
View
231 index.html
@@ -1,28 +1,203 @@
-<!DOCTYPE html><html lang="en"><head><title>BUGswarm Developers</title><link rel="stylesheet" href="bootstrap/bootstrap.css"><link rel="stylesheet" href="css/this.css"><link rel="stylesheet" href="js/google-code-prettify/prettify.css"><script src="http://code.jquery.com/jquery-1.5.2.js"></script><script src="js/google-code-prettify/prettify.js"></script><script src="js/application.js"></script><script src="js/google-analytics.js"></script></head><body><!-- NAVIGATION--><div class="topbar"><div class="topbar-inner"><div class="container"><h3><a id="banner" href="index.html"><img src="images/bs_logo.png"></a></h3><ul class="nav"><li class="dropdown nav-dropdown"><a href="documentation.html" class="dropdown-toggle">Documentation</a><ul class="dropdown-menu"><li><a href="configuration_api.html">Configuration</a></li><li><a href="participation_api.html">Participation</a></li></ul></li><li><a href="tools.html">Tools</a></li><li><a href="libraries.html">Libraries</a></li><li><a href="tutorial.html">Tutorial</a></li><li><a href="applications.html">Applications</a></li><li><a href="hardware.html">Hardware</a></li><li><a href="contact.html">Contact</a></li></ul></div></div></div><!-- MASTHEAD--><div class="masthead"><div class="container"><div class="row"><div class="span10 columns"><h1>Welcome to BUGswarm</h1><p id="tagline">Acquire data from and control embedded devices using JavaScript or plain old HTTP.
-</p></div><div class="span6 columns"><img id="cubes" src="images/bs_cubes.png" alt=""></div></div></div></div><!-- CONTENT--><div class="container"><!-- Features--><div class="row"><div class="span-one-third"><h3 class="sub-header">Group Resources</h3><p>Combine multiple resources together to create a swarm.
-Once a member of a swarm, a resource can communicate and share data with other resources in that swarm.
-</p></div><div class="span-one-third"><h3 class="sub-header">Control Access</h3><p>Control the level of access a resource has to a swarm.
-Grant a resource permission to produce data, consume data, or do both.
-</p></div><div class="span-one-third"><h3 class="sub-header">Share With Others</h3><p>Invite another user's resources into your swarms and accept invitations to place your resources
-in somebody else's swarms. Share your data easily and securely.
-</p></div></div><div class="page-header"></div><!-- System--><h2>System
-<small>Swarms of resources</small></h2><div class="row"><div class="span8"><h3 class="sub-header">Resources</h3><p>A resource is an application or device that is configured to produce or
-consume data over BUGswarm. A resource may be a physical device, such as a
-smartphone, BUG, or Arduino, as well as a web or mobile application. Anything than
-can communicate through HTTP can be configured to join a swarm and being producing and
-consuming data.
-</p></div><div class="span8"><h3 class="sub-header">Swarms</h3><p>A swarm is a collection of resources. Once a swarm is created, users may configure it
-to allow their own resources to participate as well as invite another user's resources to become members.
-The owner of the swarm may control what level of access (production, consumption, or both) each resource in the swarm has.
-</p></div></div><div class="page-header"></div><!-- Getting Started--><h2>Getting Started
-<small>Quick and simple</small></h2><div class="row"><div class="span-one-third"><h3 class="sub-header">1. Sign Up</h3><p>Sign up below for the developer preview. Once you receive your invitation, create a Bug Labs account and use the
-<a href="tools.html">API Key Management Tool</a> to list your given API keys or create new ones.
-</p></div><div class="span-one-third"><h3 class="sub-header">2. Create Resources and Swarms</h3><p>Use the RESTful
-<a href="configuration_api.html">Configuration API</a> to create resources and swarms. Add resources to swarms
-as producers, consumers, or both.
-</p></div><div class="span-one-third"><h3 class="sub-header">3. Produce and Consume Data</h3><p>Use the
-<a href="participation_api.html">Participation API</a> to connect resources to the swarms they are members of
-and begin producing and consuming data.
-</p></div></div><div class="page-header"></div><!-- Developer Preview--><h2>Developer Preview
-<small>Happening now!</small></h2><p>Sign up below to apply for an invitation to the BUGswarm developer preview.
-</p><form id="mc-embedded-subscribe-form" action="http://bugswarm.us2.list-manage.com/subscribe/post?u=876a1af227de66fbb5520a055&amp;id=5e569d1e96" method="post" name="mc-embedded-subscribe-form" class="validate actions"><fieldset><div class="clearfix"><label for="mce-EMAIL"><strong>Email</strong></label><div class="input"><input id="mce-EMAIL" type="email" name="EMAIL" placeholder="email address" required="required" class="xlarge email"></div></div><div class="clearfix"><div class="input"><input id="mc-embedded-subscribe" type="submit" value="Sign Me Up!" class="btn danger"></div></div></fieldset></form></div></body></html>
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
+
+<html lang="en">
+<head>
+ <meta name="generator" content=
+ "HTML Tidy for Linux (vers 25 March 2009), see www.w3.org">
+
+ <title>BUGswarm Developers</title>
+ <link rel="stylesheet" href="bootstrap/bootstrap.css" type=
+ "text/css">
+ <link rel="stylesheet" href="css/this.css" type="text/css">
+ <link rel="stylesheet" href=
+ "js/google-code-prettify/prettify.css" type="text/css">
+ <script src="http://code.jquery.com/jquery-1.5.2.js" type=
+ "text/javascript">
+</script>
+ <script src="js/google-code-prettify/prettify.js" type=
+ "text/javascript">
+</script>
+ <script src="js/application.js" type="text/javascript">
+</script>
+ <script src="js/google-analytics.js" type="text/javascript">
+</script>
+</head>
+
+<body>
+ <!-- NAVIGATION-->
+
+ <div class="topbar">
+ <div class="topbar-inner">
+ <div class="container">
+ <h3><a id="banner" href="index.html" name=
+ "banner"><img src="images/bs_logo.png"></a></h3>
+
+ <ul class="nav">
+ <li class="dropdown nav-dropdown">
+ <a href="documentation.html" class=
+ "dropdown-toggle">Documentation</a>
+
+ <ul class="dropdown-menu">
+ <li><a href=
+ "configuration_api.html">Configuration</a></li>
+
+ <li><a href=
+ "participation_api.html">Participation</a></li>
+ </ul>
+ </li>
+
+ <li><a href="tools.html">Tools</a></li>
+
+ <li><a href="libraries.html">Libraries</a></li>
+
+ <li><a href="tutorial.html">Tutorial</a></li>
+
+ <li><a href="applications.html">Applications</a></li>
+
+ <li><a href="hardware.html">Hardware</a></li>
+
+ <li><a href="contact.html">Contact</a></li>
+ </ul>
+ </div>
+ </div>
+ </div><!-- MASTHEAD-->
+
+ <div class="masthead">
+ <div class="container">
+ <div class="row">
+ <div class="span10 columns">
+ <h1>Welcome to BUGswarm</h1>
+
+ <p id="tagline">Acquire data from and control embedded
+ devices using JavaScript or plain old HTTP.</p>
+ </div>
+
+ <div class="span6 columns"><img id="cubes" src=
+ "images/bs_cubes.png" alt="" name="cubes"></div>
+ </div>
+ </div>
+ </div><!-- CONTENT-->
+
+ <div class="container">
+ <!-- Features-->
+
+ <div class="row">
+ <div class="span-one-third">
+ <h3 class="sub-header">Group Resources</h3>
+
+ <p>Combine multiple resources together to create a swarm.
+ Once a member of a swarm, a resource can communicate and
+ share data with other resources in that swarm.</p>
+ </div>
+
+ <div class="span-one-third">
+ <h3 class="sub-header">Control Access</h3>
+
+ <p>Control the level of access a resource has to a swarm.
+ Grant a resource permission to produce data, consume data,
+ or do both.</p>
+ </div>
+
+ <div class="span-one-third">
+ <h3 class="sub-header">Share With Others</h3>
+
+ <p>Invite another user's resources into your swarms and
+ accept invitations to place your resources in somebody
+ else's swarms. Share your data easily and securely.</p>
+ </div>
+ </div>
+
+ <div class="page-header"></div><!-- System-->
+
+ <h2>System <small>Swarms of resources</small></h2>
+
+ <div class="row">
+ <div class="span8">
+ <h3 class="sub-header">Resources</h3>
+
+ <p>A resource is an application or device that is
+ configured to produce or consume data over BUGswarm. A
+ resource may be a physical device, such as a smartphone,
+ BUG, or Arduino, as well as a web or mobile application.
+ Anything than can communicate through HTTP can be
+ configured to join a swarm and being producing and
+ consuming data.</p>
+ </div>
+
+ <div class="span8">
+ <h3 class="sub-header">Swarms</h3>
+
+ <p>A swarm is a collection of resources. Once a swarm is
+ created, users may configure it to allow their own
+ resources to participate as well as invite another user's
+ resources to become members. The owner of the swarm may
+ control what level of access (production, consumption, or
+ both) each resource in the swarm has.</p>
+ </div>
+ </div>
+
+ <div class="page-header"></div><!-- Getting Started-->
+
+ <h2>Getting Started <small>Quick and simple</small></h2>
+
+ <div class="row">
+ <div class="span-one-third">
+ <h3 class="sub-header">1. Sign Up</h3>
+
+ <p>Sign up below for the developer preview. Once you
+ receive your invitation, create a Bug Labs account and use
+ the <a href="tools.html">API Key Management Tool</a> to
+ list your given API keys or create new ones.</p>
+ </div>
+
+ <div class="span-one-third">
+ <h3 class="sub-header">2. Create Resources and Swarms</h3>
+
+ <p>Use the RESTful <a href=
+ "configuration_api.html">Configuration API</a> to create
+ resources and swarms. Add resources to swarms as producers,
+ consumers, or both.</p>
+ </div>
+
+ <div class="span-one-third">
+ <h3 class="sub-header">3. Produce and Consume Data</h3>
+
+ <p>Use the <a href="participation_api.html">Participation
+ API</a> to connect resources to the swarms they are members
+ of and begin producing and consuming data.</p>
+ </div>
+ </div>
+
+ <div class="page-header"></div><!-- Developer Preview-->
+
+ <h2>Developer Preview <small>Happening now!</small></h2>
+
+ <p>Sign up below to apply for an invitation to the BUGswarm
+ developer preview.</p>
+
+ <form id="mc-embedded-subscribe-form" action=
+ "http://bugswarm.us2.list-manage.com/subscribe/post?u=876a1af227de66fbb5520a055&amp;id=5e569d1e96"
+ method="post" name="mc-embedded-subscribe-form" class=
+ "validate actions">
+ <fieldset>
+ <div class="clearfix">
+ <label for="mce-EMAIL"><strong>Email</strong></label>
+
+ <div class="input">
+ <input id="mce-EMAIL" type="email" name="EMAIL"
+ placeholder="email address" required="required" class=
+ "xlarge email">
+ </div>
+ </div>
+
+ <div class="clearfix">
+ <div class="input">
+ <input id="mc-embedded-subscribe" type="submit" value=
+ "Sign Me Up!" class="btn danger">
+ </div>
+ </div>
+ </fieldset>
+ </form>
+ </div>
+</body>
+</html>
View
101 libraries.html
@@ -1,8 +1,93 @@
-<!DOCTYPE html><html lang="en"><head><title>BUGswarm Developers</title><link rel="stylesheet" href="bootstrap/bootstrap.css"><link rel="stylesheet" href="css/this.css"><link rel="stylesheet" href="js/google-code-prettify/prettify.css"><script src="http://code.jquery.com/jquery-1.5.2.js"></script><script src="js/google-code-prettify/prettify.js"></script><script src="js/application.js"></script><script src="js/google-analytics.js"></script></head><body><!-- NAVIGATION--><div class="topbar"><div class="topbar-inner"><div class="container"><h3><a id="banner" href="index.html"><img src="images/bs_logo.png"></a></h3><ul class="nav"><li class="dropdown nav-dropdown"><a href="documentation.html" class="dropdown-toggle">Documentation</a><ul class="dropdown-menu"><li><a href="configuration_api.html">Configuration</a></li><li><a href="participation_api.html">Participation</a></li></ul></li><li><a href="tools.html">Tools</a></li><li><a href="libraries.html">Libraries</a></li><li><a href="tutorial.html">Tutorial</a></li><li><a href="applications.html">Applications</a></li><li><a href="hardware.html">Hardware</a></li><li><a href="contact.html">Contact</a></li></ul></div></div></div><!-- CONTENT--><div class="container"><!-- Path--><div class="page-header"><a href="index.html">Home</a> &rarr;
-Libraries
-</div><!-- Header--><h1>Libraries</h1><p>Here you will find a set language-specific libraries built as wrappers around our APIs.
-Currently, some libraries wrap up both the
-<a href="configuration_api.html">Configuration API</a> and the
-<a href="participation_api.html">Participation API</a>, while others, the JavaScript library for instance, only wrap up the Participation API.
-</p><div class="page-header"></div><h2><a href="https://github.com/buglabs/bugswarm-api/tree/master/javascript">Javascript</a></h2><p>Easily configure your web application to produce and consume data over BUGswarm.
-</p><div class="page-header"></div></div></body></html>
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
+
+<html lang="en">
+<head>
+ <meta name="generator" content=
+ "HTML Tidy for Linux (vers 25 March 2009), see www.w3.org">
+
+ <title>BUGswarm Developers</title>
+ <link rel="stylesheet" href="bootstrap/bootstrap.css" type=
+ "text/css">
+ <link rel="stylesheet" href="css/this.css" type="text/css">
+ <link rel="stylesheet" href=
+ "js/google-code-prettify/prettify.css" type="text/css">
+ <script src="http://code.jquery.com/jquery-1.5.2.js" type=
+ "text/javascript">
+</script>
+ <script src="js/google-code-prettify/prettify.js" type=
+ "text/javascript">
+</script>
+ <script src="js/application.js" type="text/javascript">
+</script>
+ <script src="js/google-analytics.js" type="text/javascript">
+</script>
+</head>
+
+<body>
+ <!-- NAVIGATION-->
+
+ <div class="topbar">
+ <div class="topbar-inner">
+ <div class="container">
+ <h3><a id="banner" href="index.html" name=
+ "banner"><img src="images/bs_logo.png"></a></h3>
+
+ <ul class="nav">
+ <li class="dropdown nav-dropdown">
+ <a href="documentation.html" class=
+ "dropdown-toggle">Documentation</a>
+
+ <ul class="dropdown-menu">
+ <li><a href=
+ "configuration_api.html">Configuration</a></li>
+
+ <li><a href=
+ "participation_api.html">Participation</a></li>
+ </ul>
+ </li>
+
+ <li><a href="tools.html">Tools</a></li>
+
+ <li><a href="libraries.html">Libraries</a></li>
+
+ <li><a href="tutorial.html">Tutorial</a></li>
+
+ <li><a href="applications.html">Applications</a></li>
+
+ <li><a href="hardware.html">Hardware</a></li>
+
+ <li><a href="contact.html">Contact</a></li>
+ </ul>
+ </div>
+ </div>
+ </div><!-- CONTENT-->
+
+ <div class="container">
+ <!-- Path-->
+
+ <div class="page-header">
+ <a href="index.html">Home</a> &rarr; Libraries
+ </div><!-- Header-->
+
+ <h1>Libraries</h1>
+
+ <p>Here you will find a set language-specific libraries built
+ as wrappers around our APIs. Currently, some libraries wrap up
+ both the <a href="configuration_api.html">Configuration API</a>
+ and the <a href="participation_api.html">Participation API</a>,
+ while others, the JavaScript library for instance, only wrap up
+ the Participation API.</p>
+
+ <div class="page-header"></div>
+
+ <h2><a href=
+ "https://github.com/buglabs/bugswarm-api/tree/master/javascript">
+ Javascript</a></h2>
+
+ <p>Easily configure your web application to produce and consume
+ data over BUGswarm.</p>
+
+ <div class="page-header"></div>
+ </div>
+</body>
+</html>
View
450