SpringCard K531 - Console operation

About this document

This document provides information regarding the SpringCard K531 OEM embedded software.

You will find a detailed description of the SpringCard K531 hardware in the product datasheet.

Audience

This document is to be used by anyone wishing to build embedded electronic systems implementing the use of a ISO 144443 contactless interface.

History

`Date`	Description
`05/02/2007`	Initial release

Disclaimer

The "console" included in K531 OEM embedded software is not a part of the specified product features. They provide only a tool for product evaluation and test.

Depending on firmware version, the list of available commands, and the format of their parameters, may dramatically change, due to new features being included, and to heavy differences in memory footprint.

Therefore, the console commands shall not be used at a production stage, and only be understood as a meany for developer or integrators to validate their hardware before writing host-side software.

Overview

Default communication parameters are :

Baudrate : 38400 bps,
8 data bits, 1 stop bit,
No parity,
No flow control.

Baudrate can be changed either at runtime (see below) or at startup (see K531 settings).

Mode : for performance reason, once firmware has started working either in OSI or in Binary protocol, the console is disabled. You must reset the module to enable the console (and the ASCII protocol BTW) again.

Basics

Getting the command list

Enter help to get the list of commands available in your module.

Remember the list may vary when firmware version is updated.

Getting product version

Enter info to get the list of commands available in your module.

Remember the list may vary when firmware version is updated.

Non-volatile settings (EEPROM)

Enter const to read current value of non-volatile settings.

Enter const=xxxxxxxx to set a new value, where xxxxxxxx is a 32-bit number (hexadecimal format) built according to K531 Settings document.

Non-volatile settings (FEED)

Enter feed to list all the data stored in FEED.
Enter feedyy to read data located at address yy (8-bit number, hexadecimal format).
Enter feedyy=xx...xx to update (or insert) data at address yy.

xx...xx

Enter feedyy=! to delete data at address yy.

Please refer to K531 Settings document for a list of valid data (address and length). Do not try to change undocumented data !

Looking for cards (polling)

Enter poll to lookup for ISO/IEC 14443 cards (A & B).
Enter polla to lookup for ISO/IEC 14443-A cards.
Enter pollb to lookup for ISO/IEC 14443-B cards.
Enter pollc to lookup for Calypso cards.
Enter pollm to lookup for non-ISO memory cards (supported memory cards may wary with version of software).
Enter poll* to lookup for any supported card.

Card lookup is performed every 200ms, and RF field is switched OFF between each rounds. Add a "!" after the command to have a continuous polling, with RF field always ON.

Use the "Escape" key to exit from polling.

Advanced flags for polling

The polling command can be altered by those flags :

! continuous polling (suppress pauses in the RF field).
w use WUPA or WUPB instead of REQA or REQB.
g route a synchronization signal to USER (can be useful to synchronize a scope on the RF frame).
f route digital test signal to MFOUT (please refer to RC531's documentation for details).
s silent mode (nothing displayed).

Working with Mifare cards

Select a type A card

Enter tag or taga to select a card. Note there's no difference between a Mifare card and another kind of card at this level.

Read a Mifare card

Enter read to read the card.

Load "out-of-factory" keys into RC' EEPROM

Enter keys_e2 to load the default keys.

This will overwrite any other key you may have entered before, either through the console or by software.

Load a secret keys into RC' EEPROM

To change Mifare 'A' keys :

Enter keysa0=xxxxxxxxxxxx to change key A index 0,
Enter keysa1=xxxxxxxxxxxx to change key A index 1,
...
Enter keysa9=xxxxxxxxxxxx to change key A index 9,
Enter keysaa=xxxxxxxxxxxx to change key A index 10,
...
Enter keysaf=xxxxxxxxxxxx to change key A index 15,

To change Mifare 'B' keys :

Enter keysb0=xxxxxxxxxxxx to change key B index 0,
...
Enter keysbf=xxxxxxxxxxxx to change key B index 15,

xxxxxxxxxxxx is the 6-byte value of the key (hexadecimal format).

This will overwrite any other key you may have entered before, either through the console or by software.

Working with T=CL cards

Select a card

Enter tag, tagb or taga to select a card (14443-3 activation). Note there's no difference between a T=CL compliant card and another kind of card at this level.

Opening a T=CL session

Type A

Enter ats to ask a type A card to enter T=CL layer (14443-4 activation).

Type B

Enter attrib to ask a type B card to enter T=CL layer (14443-4 activation).

Exchanging T=CL frames

Enter apdu xx...xx to dialog with the T=CL card.

Closing T=CL session

Enter deselect to disconnect from the T=CL card.

Miscellaneous

LEDs

Enter leds=xxx to configure the LEDs.

First parameter drives red LED,
Second parameter drives green LED,
Third parameter drives yellow LED.

Allowed values for each parameter are :

0 LED remains OFF
1 LED is fixed ON
2 LED is blinking slowly
3 LED is driven by internal software (auto)
4 LED is blinking quickly
5 LED is pulsed ("heart-beat")

Changing baudrate

Enter 9600 to change baudrate to 9600 bps.
Enter 38400 to change baudrate to 38400 bps.
Enter 115200 to change baudrate to 11500 bps.

New baudrate is applied immediatly. Change baudrate in your terminal to be able to communicate with the module again.

Changing RC settings

Enter rc_cfg to read current RC settings.
Enter rc_cfg=xx...xx to change runtime RC settings (this is not stored in FEED).

See K531 settings for details.

Driving RF field

Enter rf off to switch OFF the RF field.
Enter rf on to switch ON the RF field again.

Any card-related command ("tag, poll for instance) will automatically switch ON this field if it was OFF.