1023 User Guide: Difference between revisions

From Phidgets Support
No edit summary
Line 1: Line 1:
[[Category:UserGuide]]
[[Category:UserGuide]]
{{UserguideTOC|1023.jpg|1023}}
==Getting Started==


===Checking the Contents===
===Required Hardware===
{{UGbox|
 
'''You should have received:'''
* A 1023 PhidgetRFID
* A PhidgetRFID
* A compatible RFID tag
* A USB Cable
* A USB Cable
|
* A computer
'''In order to test your new Phidget you will also need:'''
* A compatible RFID tag
||}}


===Connecting the Pieces===
===Connecting the Pieces===
{{UGbox|
[[Image:1023_0_Connecting_the_Hardware.jpg|300px|right|link=]]
Connect the PhidgetRFID board to the computer using the USB  
# Connect the PhidgetRFID board to the computer using a USB cable.
cable.
|[[File:1023_1_Connecting_The_Hardware.jpg|400px|link=]]
||}}


===Testing Using Windows 2000 / XP / Vista / 7===
<br clear="all">


{{UGwin}}
==Testing Using Windows==


===Running Phidgets Sample Program===
{{UGcontrolpanel|1023}}


{{UGwin2|'''PhidgetRFID-Full'''}}
{{ugRFID}}


{{UGbox|
{{ugDigitalOutput}}
Double Click on the [[File:Ph.jpg|link=]] icon to activate the Phidget Control Panel and make sure that '''Phidget RFID''' is properly attached  to your PC.
|[[File:1023_1_Control_Panel_Screen.jpg|400px|link=]]
|
#Double Click on '''Phidget RFID''' in the Phidget Control Panel to bring up RFID-full and check that the box labelled Attached contains the word True.
# Click on the Antenna Enabled box to enable the antenna.
# Click on the LED Enabled box to turn the LED on or off.
# The Output 0 box controls the +5V digital output and the Output 1 box controls the external LED digital output.
# Bring an RFID tag close to the PhidgetRFID board and check that the identification string is displayed. Make sure that the Antenna is enabled for this step.
# When the Keyboard Output is Enabled, the identification string will also be displayed at the cursor point in an application running in active window on the PC (such as a word document, for example).
|[[File:1023_1_RFID_Screen.jpg|400px|link=]]
}}


===Testing Using Mac OS X===
{{UGotheros}}
 
{{UGmac|Phidget RFID|RFID-full}}
 
===Using Linux===
 
{{UGlinux}}
 
===Using Windows Mobile / CE 5.0 / CE 6.0===
 
{{UGce}}


==Technical Details==
==Technical Details==
Line 95: Line 66:
For more information on RFID readers and tags, visit the [[RFID Primer]].
For more information on RFID readers and tags, visit the [[RFID Primer]].


==API==
{{UGnext|}}
{{UGapih}}
 
===Functions===
 
{{UGapi|int OutputCount () [get] : Constant
|Returns the number of digital outputs available on this PhidgetRFID.  These are the outputs provided by the terminal block.
}}
 
{{UGapi|bool OutputState (int OutputIndex) [get,set]
|Sets/Returns the state of an output. True indicates activated, False deactivated.  False is the default state.
}}
 
{{UGapi|bool AntennaOn() [get,set]
|Sets/Returns the state of the antenna. True turns the antenna on, False turns it off. The antenna if by default turned off, and needs to be explicitely activated before tags can be read.
}}
 
{{UGapi|bool LEDOn() [get,set]
|Sets/Returns the state of the onboard LED. True turns the LED on, False turns it off. The LED is by default turned off.
}}
 
{{UGapi|string LastTag () [get]
|Returns the last tag read. This method will only return a valid tag after a tag has been seen. This method can be used even after a tag has been removed from range of the reader.
}}
 
{{UGapi|bool TagStatus() [get]
|Returns the state of whether or not a tag is being read by the reader. True indicates that a tag is on (or near) the reader.
}}
 
===Events===
{{UGapi|OnOutputChange(int OutputIndex, bool State) [event]
|An event issued when an output has changed.
}}
 
{{UGapi|OnTag(string) [event]
|An event issued when a new tag is seen by the reader. The event is only fired one time for a new tag, so the tag has to be removed and then replaced before another OnTag event will fire.
'''Note:''' it is very important not to block in this event, or you will receive extra attach / detach events.
}}
 
{{UGapi|OnTagLost(string) [event]
|An event issued when a tag is removed from the reader.
}}


==Product History==
==Product History==

Revision as of 18:37, 29 August 2016


Required Hardware

  • A 1023 PhidgetRFID
  • A compatible RFID tag
  • A USB Cable
  • A computer

Connecting the Pieces

File:1023 0 Connecting the Hardware.jpg
  1. Connect the PhidgetRFID board to the computer using a USB cable.


Testing Using Windows

Phidget Control Panel

In order to demonstrate the functionality of the 1023, the Phidget Control Panel running on a Windows machine will be used.


The Phidget Control Panel is available for use on both macOS and Windows machines.

Windows

To open the Phidget Control Panel on Windows, find the Ph.jpg icon in the taskbar. If it is not there, open up the start menu and search for Phidget Control Panel

Windows PhidgetTaskbar.PNG

macOS

To open the Phidget Control Panel on macOS, open Finder and navigate to the Phidget Control Panel in the Applications list. Double click on the Ph.jpg icon to bring up the Phidget Control Panel.


For more information, take a look at the getting started guide for your operating system:


Linux users can follow the getting started with Linux guide and continue reading here for more information about the 1023.

First Look

After plugging the 1023 into your computer and opening the Phidget Control Panel, you will see something like this:

1023 Panel.jpg


The Phidget Control Panel will list all connected Phidgets and associated objects, as well as the following information:

  • Serial number: allows you to differentiate between similar Phidgets.
  • Channel: allows you to differentiate between similar objects on a Phidget.
  • Version number: corresponds to the firmware version your Phidget is running. If your Phidget is listed in red, your firmware is out of date. Update the firmware by double-clicking the entry.


The Phidget Control Panel can also be used to test your device. Double-clicking on an object will open an example.

RFID

Double-click on the RFID object labelled RFID Reader in order to run the example:

RFID Example.jpg


General information about the selected object will be displayed at the top of the window. You can also experiment with the following functionality:

  • Bring a compatible tag close to the 1023 and the tag's string and protocol will be displayed.
  • Toggle power to the antenna using the checkbox labelled Antenna Enabled. Toggling antenna power decreases power consumption, however, the 1023 will no longer be able to read tags.
  • Enabling the Keyboard Output Enabled checkbox will cause your computer to write a string of text whenever a tag is discovered. Park your cursor in an empty text file and try it out!


Digital Output

Double-click on a Digital Output object {{{2}}} in order to run the example: [[Image:{{{1}}}_DigitalOutput_Example.jpg|center|link=]]


General information about the selected object will be displayed at the top of the window. You can also experiment with the following functionality:

  • Toggle the state of the digital output by pressing the button.

Testing Using Mac OS X

  1. Go to the Quick Downloads section on the Mac OS X page.
  2. Download and run the Phidget OS X Installer
  3. Click on System Preferences >> Phidgets (under Other) to activate the Preference Pane
  4. Make sure your device is properly attached
  5. Double click on your device's objects in the listing to open them. The Preference Pane and examples will function very similarly to the ones described above in the Windows section.

Testing Using Linux

For a general step-by-step guide on getting Phidgets running on Linux, see the Linux page.

Using a Remote OS

We recommend testing your Phidget on a desktop OS before moving on to remote OS. Once you've tested your Phidget, you can go to the PhidgetSBC, or iOS pages to learn how to proceed.

Technical Details

Controlled Outputs

Make sure to attach a diode across the terminals of the relay if you are using output 0 on the RFID board to drive it.

The PhidgetRFID has four outputs - two of which are available to the user, and two of which are for internal control of the Phidget board only. Output 0 is a +5V source from the USB bus through a P-Channel MOSFET with less than one ohm impedance. This can be used to switch a TTL or CMOS device, or it can be used to drive a 5VDC relay such as the Aromat JS1-5V. Output 1 is an LED drive output at 5VDC with maximum 15mA of available current (250 ohm CMOS output). Both Output 0 and 1 are available in hardware at the terminal blocks on the PhidgetRFID board. If Output 0 is used to drive a relay, a fast clamping diode must be placed across the relay drive pins as shown in the diagram on the right. Not doing so can result in permanent damage to the PhidgetRFID board.

1023 Outputs
Output Function Connection
0 +5VDC Source Terminal Block
1 External LED Drive Terminal Block
LED Internal LED Drive Internal Only
RF Enable RF Antenna Enable Internal Only


Interfering Signals

If you are using multiple RFID readers, placing them too close together will cause interference when reading tags. You could work around this problem by rapidly "polling" each 1023 by turning the antenna on, checking for tags, and then turning it off in sequence. Of course, this will lengthen the amount of time it takes for your system to read a tag, since you may have to wait for the nearest reader to become active.

Object Speed

When trying to read tags, you should allow the tag to remain within detection range for at least 50ms. Tags moving through the detection area faster than this may not register at all.

Further Reading

For more information on RFID readers and tags, visit the RFID Primer.

What to do Next

  • Programming Languages - Find your preferred programming language here and learn how to write your own code with Phidgets!
  • Phidget Programming Basics - Once you have set up Phidgets to work with your programming environment, we recommend you read our page on to learn the fundamentals of programming with Phidgets.


Product History

Template:UGhist Template:UGrow2 Template:UGrow2 Template:UGrow2 Template:UGrow2 Template:UGrow2 Template:UGrow2 Template:UGrow2 Template:UGrow2 |- |style="background: #fff0f0" align=center| June 2013||style="background: #fff0f0" align=left colspan=3| Product Discontinued. Succeeded by the 1024 - PhidgetRFID Read/Write. The 1024 differs from the 1023 in its ability to write to tags with the T5577 chipset, and to read tags belonging to a number of additional protocols.

Retrieved from "https://www.phidgets.com/docs/index.php?title=1023_User_Guide&oldid=23954"