smartspaces

Smart Spaces put Things in context

Smart Spaces understand the context of what’s happening in real time by detecting and locating the people and objects that are present. The smartspaces package serves up webpages that display, in a human-friendly way, who and what is present in a Smart Space. Read our quickyActive and Make a Smart Space tutorials, and learn more at: context.reelyactive.com

In the scheme of Things (pun intended)

smartspaces provides a layer on top of our other npmjs package, hlc-server, which acts as a convenience wrapper around our barnowl, barnacles, barterer and chickadee npmjs packages. Our json-silo npmjs package can also be used to host the data consumed by smartspaces.

Visit smartspac.es for a live demo, for example smartspac.es/example-mascots:

Installation

npm install smartspaces

Hello Smart Spaces

var smartspaces = require('smartspaces');
var app = new smartspaces();

Then browse to http://localhost:3000/manage to configure the smart spaces. The default password is admin.

If you're running an instance of hlc-server on http://localhost:3001, you can quickly test the configuration: create a place called test with API root http://localhost:3001/contextat/directory/ Alternatively, if you're running an instance of json-silo on http://localhost:3002, use API root http://localhost:3002/contextat/directory/

Then browse to http://localhost:3000/test and you should see a Barn Owl. The landing page http://localhost:3000 provides visitors with a pull-down of all the places and a brief description of the platform.

Options

The following options are supported when instantiating smartspaces (those shown are the defaults):

{
  httpPort: 3000,
  authPass: "admin",
  siloUrl: "http://localhost:3002",
  unlistedPlaces: false
}

What's next?

This is an active work in progress. Expect regular changes and updates, as well as improved documentation!

License

MIT License

Copyright (c) 2014-2015 reelyActive

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.