1024-0 User Guide: Difference between revisions

From Phidgets Support
m (Mparadis moved page 1024 User Guide to 1024-0 User Guide without leaving a redirect)
 
(28 intermediate revisions by 3 users not shown)
Line 1: Line 1:
__NOINDEX__
__NOTOC__
<metadesc>You can read and write to RFID tags up to 6cm away with the Phidget RFID read/write.  Supports EM4100 series, ASCII and ISO11785 FDX-B protocols.</metadesc>
[[Category:UserGuide]]
[[Category:UserGuide]]
{{UserguideTOC|1024.jpg|1024}}
==Part 1: Setup==
==Getting Started==
<div class="phd-deck-sequence">
{{PT1_1024_CHOOSE}}
{{PT1_1024_WIN}}{{PT1_1024_MAC}}{{PT1_1024_LNX}}
</div>


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


===Connecting the Pieces===
===Phidget Control Panel===
{{UGbox|
You can use the [[Phidget Control Panel]] to explore your device's functionality.
Connect the PhidgetRFID board to the computer using the USB
cable.
|[[File:1024_0_Connecting_The_Hardware.jpg|400px|link=]]
||}}


===Testing Using Windows 2000 / XP / Vista / 7===
1. After opening the Phidget Control Panel you will find the following channels:


{{UGwin}}
[[Image:1024_Panel.jpg|link=|center]]


===Running Phidgets Sample Program===
2. Double click on a channel to open an example program.
{{UGC-Start}}


{{UGwin2|'''PhidgetRFID-Full'''}}
{{UGC-Entry|Digital Output | Switchable 5V output (max current 400mA)
|
In your Control Panel, double click on "Digital Output":
[[Image:1024-DigitalOutput.jpg|800px|center|link=]]}}


{{UGbox|
{{UGC-Entry|LED Driver | Switchable 5V output (max current 16mA)
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:1024_0_Control_Panel_Screen.jpg|400px|link=]]
|
|
# Double Click on '''Phidget RFID Read-Write''' in the Phidget Control Panel to bring up RFID-full and check that the box labelled Attached contains the word True.
In your Control Panel, double click on "LED Driver":
# Click on the Antenna Enabled box to enable the antenna.
[[Image:1024-DigitalOutput.jpg|800px|center|link=]]}}
# Click on the LED Enabled box to turn the on-board LED on or off.
# The Output 0 box controls the +5V digital output and the Output 1 box controls the external LED digital output.
# When the Keyboard Output is Enabled, the identification string will be written at the cursor point in an application running in active window on the PC (such as a word document, for example).
# 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 a tag is read, its protocol is displayed here.
# Type the tag string here when writing to a writeable tag. You must use the proper string length and characters according to your chosen protocol.
# When writing, choose your protocol from this drop-down list. For more information on supported protocols, see the [[#Tag_Types|Tag Types]] section.
# When checked, this box will permanently write to a tag. '''Once a tag is written with the lock on, it can not be re-written.'''
# Once you've selected the protocol and string, press this button to write to the tag currently within range.
|[[File:1024_0_RFID_Screen.jpg|400px|link=]]
}}


===Testing Using Mac OS X===
{{UGC-Entry|Onboard LED | Turn on green LED beside USB connector
|
In your Control Panel, double click on "Onboard LED":
[[Image:1024-OnboardLED.jpg|800px|center|link=]]}}


{{UGmac|Phidget RFID|RFID-full}}
{{UGC-Entry|RFID Reader/Writer| Read or write data from an RFID tag
|
In your Control Panel, double click on "RFID Reader/Writer":
[[Image:1024-RFID.jpg|800px|center|link=]]}}


===Using Linux===
{{UGC-End}}


{{UGlinux}}
{{UG-Part3}}


===Using Windows Mobile / CE 5.0 / CE 6.0===
== Part 4: Other Resources ==


{{UGce}}
{{UGC-Start}}
 
{{UGC-Entry|RFID Guide|
==Technical Details==
|
 
View our [[RFID Guide]] for an in-depth look at Phidget RFID systems.
===Tag Types===
 
We support read-only tags that have been programmed with a supported protocol, as well as T5577 type tags for writing.
 
====T5577====
 
T5577 tags can be written with any of the supported protocols. Fresh T5577 tags that have never been programmed may show up as an EM4100 tag, or may not show up at all, depending on how the factory programmed them. After writing, they will always show up as the written tag. We also support a lock function which prevents a tag from ever being re-written.
 
===Protocols===
 
A protocol is a way of encoding data on an RFID tag. This is not the same as the tag type. For example, we support the T5577 tag type, which can be programmed with any of the protocols which we support. We also support read-only tags which have been programmed in any of these protocols.
 
We support reading and writing in 3 protocols with the 1024:
 
====EM4100====
EM4100 (also known as EM4102) is the protocol that all previous PhidgetRFID readers have supported. Therefore, if you want to use the 1024 to write to writable tags to be read with previous versions of the PhidgetRFID, you need to write them in this protocol first. This protocol encodes 40 bits of arbitrary data. Read-only tags that are factory programmed with this protocol are supposed to be unique.
 
Phidgets represents this protocol as a 10-digit hex string (include leading 0's) ie. "0087f3bc91". This is the format to use for writing new tags, and to expect from the tag events.
 
====ISO11785 FDX-B====
ISO11785 defines tags used for animal ID. If you have a pet cat / dog, chances are fairly high that they have one of these tags implanted. FDX-B refers to the way that the ISO11785 data is encoded on the RFID tag, and is the industry-standard encoding scheme.
 
This tag consists of a 10-bit country code and a 38-bit unique ID.
 
The country code is [http://en.wikipedia.org/wiki/ISO_3166-1_numeric ISO 3166]. The '999' code is set aside for testing.
 
The unique ID is 38-bit unsigned, so that's a range of 0 - 274,877,906,943.
 
Phidgets represents this protocol as a 15-digit decimal number string - concatenated 3-digit country code and 12-digit id. ie. "999000000000123" would represent the testing country code and an id of 123. please note that the 12-digit id part cannot exceed the 38-bit maximum integer value of 274,877,906,943.
 
Note that Animal tags with a valid country code are supposed to be unique. Of course, with the 1024 you can freely copy an existing Animal Tag.
 
====PhidgetsTAG====
The PhidgetsTAG protocol is an internal protocol only supported by the PhidgetRFID 1024.
 
This protocol allows storing an ASCII string, up to 24 characters. ie. "I am a Phidgets Tag!"
 
The ASCII data must be 7-bit, so no extended ASCII support, but standard text is all supported (as well as control codes).
 
===Controlled Outputs===
[[image:Rfid_relay.png|thumb|310px|link=|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.
 
{| style="border:1px solid darkgray;" cellpadding="7px;"
|+'''1024 Outputs'''
|-style="background: #d1d1d1" align=center
!Output || Function || Connection
|-
|style="background: #f0f0f0" align=center| 0
|style="background: #f0f0f0" align=center| +5VDC Source
|style="background: #f0f0f0" align=center| Terminal Block
|-
|style="background: #f0f0f0" align=center| 1
|style="background: #f0f0f0" align=center| External LED Drive
|style="background: #f0f0f0" align=center| Terminal Block
|-
|style="background: #f0f0f0" align=center| LED
|style="background: #f0f0f0" align=center| Internal LED Drive
|style="background: #f0f0f0" align=center| Internal Only
|-
|style="background: #f0f0f0" align=center| RF Enable
|style="background: #f0f0f0" align=center| RF Antenna Enable
|style="background: #f0f0f0" align=center| Internal Only
|}
 
<br clear=all>
 
===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 1024 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]].
 
==API==
{{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|int LastTagProtocol () [get]
|Returns the protocol of the last tag read. This method will only return a valid protocol 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.
}}
 
{{UGapi|void Write(string tag, int protocol, boolean lock)() [get]
|Writes new data to a tag, using the specified protocol. Lock will lock the tag from further writes. See above for string formats according to protocol.
}}
 
===Events===
{{UGapi|OnOutputChange(int OutputIndex, bool State) [event]
|An event issued when an output has changed.
}}
}}
{{UGC-Firmware}}
{{UGC-Entry|FCC Compliance|
|


{{UGapi|OnTag(string tagString, int protocol) [event]
{{1024-FCC-Table|1024_0|SUT1024-0}}
|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:''' in some languages this event is called Tag2
 
'''Note:''' it is very important not to block in this event, or you will receive extra attach / detach events.
}}
 
{{UGapi|OnTagLost(string tagString, int protocol) [event]
|An event issued when a tag is removed from the reader.
'''Note:''' in some languages this event is called TagLost2
}}
 
==Compliance==
{|
|rowspan="3"|[[File:Fcc-logo.png|caption|95px]]
|<font size=4>'''Phidgets Inc'''</font size>
|-
|<font size=4>'''1024_0'''</font size>
|-
|<font size=4>'''FCC ID: SUT1024-0'''</font size>
|}


:This device complies with Part 15 of the FCC Rules. Operation is subject to the following two conditions:
:This device complies with Part 15 of the FCC Rules. Operation is subject to the following two conditions:
Line 219: Line 74:


:This unit was tested with shielded cables on the peripheral devices. Shielded cables must be used with the unit to ensure compliance.
:This unit was tested with shielded cables on the peripheral devices. Shielded cables must be used with the unit to ensure compliance.
 
}}
==Product History==
{{UGC-End}}
{{UGhist}}
{{UGrow|    |0|100|Product Release}}

Latest revision as of 19:00, 16 September 2024


Part 1: Setup

PhidgetRFID - Select OS

PhidgetRFID

Welcome to the PhidgetRFID Read-Write User Guide! To get started, make sure you have the following hardware on hand:

  • PhidgetRFID Read-Write (1024)
  • USB cable or a VINT Hub Phidget and a Phidget Cable
  • RFID tag
  • Computer

Click on the blue arrow below to continue.

Select your Operating System:

Windows

MacOS

Linux

«
»

PhidgetRFID - Windows

Step 1: Install Phidgets Library

Step 2: Connect Devices

Step 3: Verify Connection

Step 1: Install Phidgets Library

Before you begin using your Phidgets, you will need to install the Phidget Library.

1. Download the installer for your system:

● 32-bit Installer Download

● 64-bit Installer Download

If you're unsure which one you should get, press ⊞ WIN + Pause/Break:

Before installing our libraries, be sure to read our Software License.

Step 1: Install Phidgets Library

2. Open the download. If it asks you for permission, select Run

Step 1: Install Phidgets Library

3a. Select Next

Step 1: Install Phidgets Library

3b. Read the Licence Agreement. Select Next.

Step 1: Install Phidgets Library

3c. Choose Installation Location. Select Next.

Step 1: Install Phidgets Library

3d. Confirm Install

Step 1: Install Phidgets Library

3e. Wait for Installation to complete. This should only take a few moments.

Step 1: Install Phidgets Library

3f. Installation Complete. Close installation Window.

Step 2: Connect Devices

● Connect USB Cable to your computer and PhidgetRFID

Step 3: Verify Connection

1. Open the Phidgets Control Panel:

If your Control Panel does not open, look in your taskbar. Double click the Phidget Icon.

Step 3: Verify Connection

2. If connected, your Phidgets will appear in the Phidget Control Panel.

Done!

If you're able to see and interact with your devices in the Phidget Control Panel, you're done with the Setup part of this guide.

Scroll down to Part 2: Using Your Phidget for the next step.


For more help installing in Windows (e.g. manual install, using a VM, etc.), visit this page:

● Windows Advanced Information

«
»

PhidgetRFID - MacOS

Step 1: Install Phidgets Library

Step 2: Connect Devices

Step 3: Verify Connection

Step 1: Install Phidgets Library

Before you begin using your Phidgets, you will need to install the Phidget Library.

1. Download the installer for your system:

● OS X 10.11+: Installer Download

● Mac OS X 10.7 - OS X 10.10: Installer Download

● Mac OS X 10.5 - OS X 10.6: Installer Download


Before installing our libraries, be sure to read our Software License.

Step 1: Install Phidgets Library

2. Open the download and double click on Phidgets.pkg

Step 1: Install Phidgets Library

3a. Select Continue

Step 1: Install Phidgets Library

3b. Read and continue. Read the License and click Agree.

Step 1: Install Phidgets Library

3c. Here, you have the option to select the installation location. Select Install to continue.

Step 1: Install Phidgets Library

3d. MacOS may ask for permission to install. Enter your username and password and Install Software.

Step 1: Install Phidgets Library

3e. Wait for Installation to complete. This should only take a few moments.

Step 1: Install Phidgets Library

3f. You may see a message that the extension has been blocked. Select Open Security Preferences.

Step 1: Install Phidgets Library

3g. Beside the message for Phidgets Inc, Click Allow.

Step 1: Install Phidgets Library

3h. Installation Complete, Click Close.

Step 1: Install Phidgets Library

3i. To delete the installer, click Move to Trash.

Step 2: Connect Devices

● Connect USB Cable to your computer and PhidgetRFID

Step 3: Verify Connection

1. Open the Phidgets Control Panel:

Step 3: Verify Connection

2. If connected, your Phidgets will appear in the Phidget Control Panel.

Done!

If you're able to see and interact with your devices in the Phidget Control Panel, you're done with the Setup part of this guide.

Scroll down to Part 2: Using Your Phidget for the next step.


For more info installing in MacOS (e.g. developer tools, driver extension, etc.), visit this page:

● MacOS Advanced Information

«
»

PhidgetRFID - Linux

Step 1: Install Phidgets Library

Step 2: Connect Devices

Step 3: Verify Connection

Step 1: Install Phidgets Library

1. First, you need to install the libusb-1.0 development libraries. For example, in Debian based distributions:

apt-get install libusb-1.0-0-dev


You’ll also need a C compiler and builder, if you don’t already have one installed.

apt-get install gcc
apt-get install make

Step 1: Install Phidgets Library

2. Next, download and unpack the Phidgets library:

● libphidget22

Step 1: Install Phidgets Library

3. Use the following commands in the location you unpacked to install the library:

./configure
make
sudo make install

Step 1: Install Phidgets Library

4. (Optional) You can also download and unpack the following optional packages:

● phidget22networkserver - Phidget Network Server, which enables the use of Phidgets over your network

● phidget22admin - Admin tool to track who is connected to your Phidgets when using the network server

● libphidget22extra - Required for phidget22networkserver and phidget22admin

● libphidget22java - The Java libraries for Phidget22


For installation instructions for these packages, see the README file included with each one.

Step 2: Connect Devices

● Connect USB Cable to your computer and PhidgetRFID

Step 3: Verify Connection

1. The easiest way to verify that your libraries are working properly is to compile and run an example program. Download and unpack this C example that will detect any Phidget:

● HelloWorld C Example

Step 3: Verify Connection

2. Next, open the terminal in the location where you unpacked the example. Compile and run using:

gcc HelloWorld.c -o HelloWorld -lphidget22
sudo ./HelloWorld

ou should receive a “Hello” line for each Phidget channel that is discovered:

I don’t see any Phidgets show up in the HelloWorld example

You need to run it with sudo in order to be able to access USB devices. In order to use Phidgets without sudo, you need to set your udev rules. See the Advanced Information page on the final slide of this guide for details.

Done!

If you're able to see your devices in the Hello World example, you're done with the Setup part of this guide.

Scroll down to Part 2: Using Your Phidget for the next step.


For more info installing in Linux (e.g. Udev rules, old versions, etc.), visit this page:

● Linux Advanced Information

«
»

Part 2: Using Your Phidget

Phidget Control Panel

You can use the Phidget Control Panel to explore your device's functionality.

1. After opening the Phidget Control Panel you will find the following channels:

1024 Panel.jpg

2. Double click on a channel to open an example program.

Expand All
Digital Output Switchable 5V output (max current 400mA)

In your Control Panel, double click on "Digital Output":

1024-DigitalOutput.jpg
LED Driver Switchable 5V output (max current 16mA)

In your Control Panel, double click on "LED Driver":

1024-DigitalOutput.jpg
Onboard LED Turn on green LED beside USB connector

In your Control Panel, double click on "Onboard LED":

1024-OnboardLED.jpg
RFID Reader/Writer Read or write data from an RFID tag

In your Control Panel, double click on "RFID Reader/Writer":

1024-RFID.jpg

Part 3: Create your Program

Part 4: Other Resources

Expand All
RFID Guide

View our RFID Guide for an in-depth look at Phidget RFID systems.

Upgrading or Downgrading Device Firmware

Firmware Upgrade

MacOS users can upgrade device firmware by double-clicking the device row in the Phidget Control Panel.

Linux users can upgrade via the phidget22admin tool (see included readme for instructions).

Windows users can upgrade the firmware for this device using the Phidget Control Panel as shown below.

ControlpanelFWup.jpg

Firmware Downgrade

Firmware upgrades include important bug fixes and performance improvements, but there are some situations where you may want to revert to an old version of the firmware (for instance, when an application you're using is compiled using an older version of phidget22 that doesn't recognize the new firmware).

MacOS and Linux users can downgrade using the phidget22admin tool in the terminal (see included readme for instructions).

Windows users can downgrade directly from the Phidget Control Panel if they have driver version 1.9.20220112 or newer:

ControlpanelFWdown.jpg

Firmware Version Numbering Schema

Phidgets device firmware is represented by a 3-digit number. For firmware patch notes, see the device history section on the Specifications tab on your device's product page.

FWversion.jpg

  • If the digit in the 'ones' spot changes, it means there have been bug fixes or optimizations. Sometimes these changes can drastically improve the performance of the device, so you should still upgrade whenever possible. These upgrades are backwards compatible, meaning you can still use this Phidget on a computer that has Phidget22 drivers from before this firmware upgrade was released.
  • If the digit in the 'tens' spot changes, it means some features were added (e.g. new API commands or events). These upgrades are also backwards compatible, in the sense that computers running old Phidget22 drivers will still be able to use the device, but they will not be able to use any of the new features this version added.
  • If the digit in the 'hundreds' spot changes, it means a major change has occurred (e.g. a complete rewrite of the firmware or moving to a new architecture). These changes are not backwards compatible, so if you try to use the upgraded board on a computer with old Phidget22 drivers, it will show up as unsupported in the Control Panel and any applications build using the old libraries won't recognize it either. Sometimes, when a Phidget has a new hardware revision (e.g. 1018_2 -> 1018_3), the firmware version's hundreds digit will change because entirely new firmware was needed (usually because a change in the processor). In this case, older hardware revisions won't be able to be upgraded to the higher version number and instead continue to get bug fixes within the same major revision.
FCC Compliance


caption Phidgets Inc
1024_0
FCC ID: SUT1024-0
This device complies with Part 15 of the FCC Rules. Operation is subject to the following two conditions:
(1) This device may not cause harmful interference, and
(2) This device must accept any interference received, including interference that may cause undesired operation.
Note: The manufacturer is not responsible for any radio or TV interference caused by unauthorized modifications to this equipment. Such modifications could void the user’s authority to operate the equipment.
The user is cautioned that any changes or modifications not expressly approved by the party responsible for compliance could void the user’s authority to operate the equipment.
This equipment has been tested and found to comply with the limits for a Class B digital device, pursuant to part 15 of the FCC Rules. These limits are designed to provide reasonable protection against harmful interference in a residential installation. This equipment generates, uses and can radiate radio frequency energy and, if not installed and used in accordance with the instructions, may cause harmful interference to radio communications. However, there is no guarantee that interference will not occur in a particular installation. If this equipment does cause harmful interference to radio or television reception, which can be determined by turning the equipment off and on, the user is encouraged to try to correct the interference by one or more of the following measures:
• Reorient or relocate the receiving antenna.
• Increase the separation between the equipment and receiver.
• Connect the equipment into an outlet on a circuit different from that to which the receiver is connected.
• Consult the dealer or an experienced radio/TV technician for help.
This unit was tested with shielded cables on the peripheral devices. Shielded cables must be used with the unit to ensure compliance.
Retrieved from "https://www.phidgets.com/docs/index.php?title=1024-0_User_Guide&oldid=34561"