Class Index | File Index

Classes


Class BO.custom.ID12RFIDReader

Creates an interface to an ID-12 RFID Reader. Other Innovations RFID readers will likely work but have not been tested. This object requires firmware other than StandardFirmata to be uploaded to the I/O board. See Breakout/custom_examples/rfid_example1.html and rfid_example2.html for example applications.

Defined in: ID12RFIDReader.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
BO.custom.ID12RFIDReader(board, readerId)
Innovations ID-12 RFID Reader.
Method Summary
Method Attributes Method Name and Description
 
addEventListener(type, listener)
 
dispatchEvent(type, optionalParams)
 
 
removeEventListener(type, listener)
Event Summary
Event Attributes Event Name and Description
 
The addTag event is dispatched when a new tag is read.
 
The removeTag event is dispatched when a tag is removed from the reader.
Class Detail
BO.custom.ID12RFIDReader(board, readerId)
Innovations ID-12 RFID Reader.

To use this object with standard io objects in Breakout, RFIDFirmata must be uploaded to the IOBoard rather than StandardFirmata. See custom_examples/readme.txt for insturctions.

Is is also possible to create a custom application for your IOBoard that includes the RFID reader. See IDx_Reader_Firmata_Example in the IDxRFIDReader library example files.

Parameters:
{IOBoard} board
A reference to the IOBoard instance
{Number} readerId
The ID assigned to the reader in the firmware running on the IOBoard (default = 13)
Method Detail
addEventListener(type, listener)
Parameters:
{String} type
The event type
{Function} listener
The function to be called when the event is fired

dispatchEvent(type, optionalParams)
Parameters:
{Event} type
The Event object
{Object} optionalParams
Optional parameters to assign to the event object. return {boolean} True if dispatch is successful, false if not.

hasEventListener(type)
Parameters:
{String} type
The event type return {boolean} True is listener exists for this type, false if not.

removeEventListener(type, listener)
Parameters:
{String} type
The event type
{Function} listener
The function to be called when the event is fired
Event Detail
{BO.custom.RFIDEvent.ADD_TAG} addTag
The addTag event is dispatched when a new tag is read.
This event has the following properties:
{BO.custom.ID12RFIDReader} target
A reference to the ID12RFIDReader object.
{String} tag
The RFID tag value.

{BO.custom.RFIDEvent.REMOVE_TAG} removeTag
The removeTag event is dispatched when a tag is removed from the reader.
This event has the following properties:
{BO.custom.ID12RFIDReader} target
A reference to the ID12RFIDReader object.
{String} tag
The RFID tag value.

Documentation generated by JsDoc Toolkit 2.4.0 on Mon Mar 12 2012 23:27:52 GMT-0400 (EDT)