exosite-fleet

Exosite fleet management API wrapper

Usage no npm install needed!

<script type="module">
  import exositeFleet from 'https://cdn.skypack.dev/exosite-fleet';
</script>

README

Exosite Fleet API

Javascript library for Exosite's fleet management APIs, currently in beta.

Usage

Add library and dependencies to your HTML. The library is dependent on Auth0 (for tokens). The jQuery dependency is expected to be dropped.

<head>
    <script src="//code.jquery.com/jquery-1.11.3.min.js"></script>
    <script src="http://cdn.auth0.com/w2/auth0-4.js"></script>
    <script>
      authProvider.init({
        domain: 'exositeapp.auth0.com',
        clientID: 'dcnod3KP9Hn40y0VWbmKLVRODQ9I12xv'
      });
    </script>
    <script src="https://rawgit.com/dweaver/exosite-fleet/master/exosite-fleet.js"></script>
</head>

Use the library by requiring it:

<script>
var fleet = require('exosite-fleet');
var exo = new fleet('API TOKEN');
exo.queryDevices({domain: "cloudy.exosite.com"}, ["model","name","sn"]).then(function(devices) {
  console.log(devices);
});
</script>

For a working example, look here: https://github.com/dweaver/exosite-fleet-example

Build for distribution

To build, do this:

$ npm build && cd src && browserify Exosite.js -t babelify -r ./Exosite:exosite-fleet -o ../exosite-fleet.js && cd ..
$ uglifyjs exosite-fleet.js -o exosite-fleet.min.js

For debugging, you may want to copy it into a different project:

$ npm build && cd src && browserify Exosite.js -t babelify -r ./Exosite:exosite-fleet -o ../exosite-fleet.js && cd .. && cp ./exosite-fleet.js ../fleet/scripts/exosite-fleet.js

To distribute, update version number in package.json and bower.json. Then do this:

$ git tag <version, e.g. 0.1.0>
$ git push origin <version, e.g. 0.1.0>
$ npm publish