https://github.com/ebu/radiotag.js

RadioTag client library
https://github.com/ebu/radiotag.js

Last synced: 3 months ago
JSON representation

RadioTag client library

• Host: GitHub
• URL: https://github.com/ebu/radiotag.js
• Owner: ebu
• License: bsd-3-clause
• Created: 2014-06-27T15:26:35.000Z (about 10 years ago)
• Default Branch: master
• Last Pushed: 2015-09-09T08:19:34.000Z (almost 9 years ago)
• Last Synced: 2024-04-12T05:09:40.509Z (3 months ago)
• Language: JavaScript
• Homepage:
• Size: 632 KB
• Stars: 5
• Watchers: 18
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: ChangeLog
  • License: LICENSE

Lists

• awesome-broadcasting - RadioTag.js - RadioTag client library in JavaScript. (Hybrid Radio)
• awesome-broadcasting - RadioTag.js - RadioTag client library in JavaScript. (Hybrid Radio)

README

        
radiotag.js

===========

[![Build Status](https://travis-ci.org/ebu/radiotag.js.svg?branch=master)](https://travis-ci.org/ebu/radiotag.js)

This project contains a JavaScript implementation of a RadioTAG client.

More information on RadioTAG: [RadioDNS.org](http://radiodns.org)

RadioTAG is based on [EBU-CPA](http://tech.ebu.ch/cpa)

(EBU Cross-Platform Authentication) in order to authenticate tags.

A JavaScript library is available here: [cpa.js](https://github.com/ebu/cpa.js)

## Usage

### Installation with Bower

[Bower](https://github.com/bower/bower) is a package manager for the web.

> bower install radiotag.js

### RequireJS

You can use [RequireJS](http://requirejs.org/) in order to include the radiotag.js library.

> HTML:

    

> js/main.js

    require.config({

      baseUrl: 'js',

      paths: {

        'radiotag': '../bower_components/radiotag.js/dist/radiotag.min'

      }

    });

    require(['radiotag'], function(radiotag) {

      radiotag.getAuthProvider('http://tag.ebu.io/',

        function(err, authProvider) {

          console.log(err, authProvider.apBaseUrl, authProvider.modes);

        });

    });

### Stand-alone

You can use the radiotag.js library directly in the HTML page:

    

The `radiotag` object is used to expose the library:

    

       radiotag.getAuthProvider('http://tag.ebu.io/',

         function(err, authProvider) {

           console.log(err, authProvider.apBaseUrl, authProvider.modes);

         });

    

### Node.js

Install the radiotag.js package using NPM:

    npm install radiotag.js

Use `require` to access within Node.js:

    var radiotag = require('radiotag.js');

    radiotag.getAuthProvider('http://tag.ebu.io/',

     function(err, authProviderBaseUrl, modes) {

       console.log(err, authProviderBaseUrl, modes);

     });

## Development

### Build

> npm install

> bower install

> grunt

## Related Projects

Cross-Platform Authentication JavaScript Library:

* [CPA.js](https://github.com/ebu/cpa.js)

This library has been developed alongside the EBU CPA Client Reference Implementation.

* [CPA Client](https://github.com/ebu/cpa-client)

## Contributors

* [Michael Barroco](https://github.com/barroco) (EBU)

* [Chris Needham](https://github.com/chrisn) (BBC)

* [Thomas Parisot](https://github.com/oncletom) (BBC)

* [Andrew Nicolaou](https://github.com/andrewn) (BBC)

* [Andy Buckingham](https://github.com/andybee) (Togglebit)

## Copyright & License

Copyright (c) 2014-2015, EBU-UER Technology & Innovation

The code is under BSD (3-Clause) License. (see LICENSE.txt)