https://github.com/reelyactive/barnowl-test

A simple way to evaluate barnowl regardless of whether or not you have access to reelyActive technology
https://github.com/reelyactive/barnowl-test

Last synced: 8 months ago
JSON representation

A simple way to evaluate barnowl regardless of whether or not you have access to reelyActive technology

• Host: GitHub
• URL: https://github.com/reelyactive/barnowl-test
• Owner: reelyactive
• License: mit
• Created: 2014-05-19T16:27:43.000Z (about 12 years ago)
• Default Branch: master
• Last Pushed: 2014-10-08T21:32:26.000Z (over 11 years ago)
• Last Synced: 2025-07-05T02:04:44.249Z (12 months ago)
• Language: JavaScript
• Size: 162 KB
• Stars: 1
• Watchers: 13
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

          
barnowl-test

============

The easiest way to get started with barnowl!

--------------------------------------------

[barnowl is a Node.js package](https://www.npmjs.org/package/barnowl) that identifies and locates all the advertising wireless devices within a [Smart Space](http://context.reelyactive.com).  barnowl-test is a simple way to evaluate barnowl regardless of whether or not you have access to [reelyActive technology](http://context.reelyactive.com/technology.html).

But what will it do?

--------------------

barnowl-test will serve up a webpage that lets you see all of the wireless devices detected in a space.  It will also output to the console the real-time stream of detected wireless transmissions.  Don't have reelyActive hardware?  No worries, by default barnowl-test will simulate the presence of hardware!

Install and run

---------------

    > $ git clone https://github.com/reelyactive/barnowl-test.git barnowl-test

    > $ cd barnowl-test

    > $ npm install

    > $ node barnowl-test

If you're unfamiliar with the first step, simply copy barnowl-test.js and package.json to a local folder and then complete the remaining steps.

Is it working?

--------------

Do you see lines like the following being output to the console?  _Good!_

    {

     "identifier": {

      "type": "EUI-64",

      "value": "001bc5094b00b1e5",

      "flags": {

       "transmissionCount": 0

      }

     },

     "timestamp": "2014-09-01T01:23:45.678Z",

     "radioDecodings": [

      {

       "rssi": 128,

       "identifier": {

        "type": "EUI-64",

        "value": "001bc50940800000"

       }

      }

     ]

    }

Point your browser to http://127.0.0.1:3000 - does it display a table like this?  _Good!_

![screenshot](http://reelyactive.com/images/barnowl-test-screenshot.png)

What you're seeing are simulated wireless device transmissions that include an identifier, a timestamp, the strongest signal strength (RSSI) and the identifier of the decoding device.

Moving beyond the default

-------------------------

If you have reelyActive hardware, tweak the code in the Hardware Configuration section at the bottom of barnowl-test.js.

Don't like how the HTML table looks with our CSS code?  Make your own CSS!

Beyond the barn

---------------

We hope that barnowl-test provides a solid perch from which to experiment and build.  We'd love to hear about your projects: [keep in touch with reelyActive via social media or e-mail](http://context.reelyactive.com/contact.html).

License

-------

MIT License

Copyright (c) 2014 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.