basic.serial.javascript.rfid.lift

Interface SignStixLift

SignStixLift

Javascript-to-Player interface for implementing a 'Lift and Learn' experience using one or more SignStix RFID pads connected to the Player via USB. Note that this particular interface is only supported on M12S devices and later.

This interface builds on SignStixRfid and is used to implement the Lift and Learn 'Power Tool' feature available in SignStix Creator. However, it can be used directly if required.

The basic idea is that:

1. The Javascript calling this interface runs in an off-screen non-interactive Web View within the 'attractor' sign, where it will run continuously in the background.
2. The type of experience required (lift-and-learn or place-and-learn) is specified here.
3. A mapping from item names to the corresponding item signs is specified here.
4. The mapping from tag IDs to item names is defined via SignStixItem (or using the special 'Item Mode').

Then when a tag is presented to a pad (in the case of place-and-learn) or removed from a pad (in the case of lift-and-learn), the player will jump to the corresponding item sign, which is typically designed to provide more information about the selected item. When the tag is removed or returned (as appropriate), the player will jump back to the attractor sign.

If the user does not remove or return the item, then after a timeout (also specified here), the player will automatically jump back to the attractor sign.

While the experience is running, the user (a staff member in this instance) can trigger a special 'Item Mode', allowing tag IDs to be assigned to item names. To launch the mode, place the tag on a pad for 1 second then lift it for 1 second, and repeat 2 further times. Note that this only works within the time limit specified in the 'prepare' call.

Function Summary

Modifier and Type	Function and Description
void	close() Stop listening for tag information from connected RFID pads and close any open connections.
String	getTargetSignId(String itemName) Find the ID of the sign associated with the argument item name.
void	prepare(String attractorSignId, long itemTimeoutMs, long modeTriggerPeriodMs) Prepare and configure the Lift and Learn experience, causing the device to set up connections to the RFID pad(s).
void	setTargetSignId(String itemName, String signId) Set the ID of the sign that the player will jump to when the argument item name is selected (by lifting/placing a corresponding tag).
void	setType(String type) Set the type of experience.
void	update() Call this to send tag-read requests to the connected RFID pads, and give an opportunity for the device to receive the tag information and jump to a different sign accordingly.

Function Detail

prepare

void prepare(String attractorSignId,
             long itemTimeoutMs,
             long modeTriggerPeriodMs)

Prepare and configure the Lift and Learn experience, causing the device to set up connections to the RFID pad(s).

Parameters:

attractorSignId - the ID (not the name) of the attractor sign (the initial sign in the experience).

itemTimeoutMs - the number of milliseconds that an item sign will be shown for before jumping back to the attractor.

modeTriggerPeriodMs - the period (in milliseconds) after the device has been powered-up during which the user can trigger Item Mode. Setting this to a fairly short period (e.g. 2 minutes) will ensure that members of the general public cannot trigger the mode and disrupt the experience.

Since:

Player 3.3.0

setTargetSignId

void setTargetSignId(String itemName,
                     String signId)

Set the ID of the sign that the player will jump to when the argument item name is selected (by lifting/placing a corresponding tag).

Parameters:

itemName - the name of the item e.g. "Aftershave".

signId - the ID (not the name) of the sign to jump to. (A sign's ID can be found in the URL when browsing the sign in SignStix Director.)

Since:

Player 3.3.0

getTargetSignId

String getTargetSignId(String itemName)

Find the ID of the sign associated with the argument item name.

Parameters:

itemName - the name of the item e.g. "Aftershave".

Returns:

the ID of the corresponding sign, or null if no association has been set.

Since:

Player 3.3.0

setType

void setType(String type)

Set the type of experience.

Parameters:

type - must be "lift" for a lift-and-learn experience where the sign changes when an item is removed from a pad, or "place" for a place-and-learn experience where the sign changes when an item is placed on a pad. The default is lift-and-learn.

Since:

Player 3.3.0

update

void update()

Call this to send tag-read requests to the connected RFID pads, and give an opportunity for the device to receive the tag information and jump to a different sign accordingly. This should be called on a regular basis for a responsive performance. As a guide, every 200 ms generally works well.

Since:

Player 3.3.0

close

void close()

Stop listening for tag information from connected RFID pads and close any open connections. This should be called when communication is over to free-up resources. Do not attempt further updates after closing.

Since:

Player 3.3.0