com.spacecode.sdk.device

Class Device

java.lang.Object

com.spacecode.sdk.device.Device

Direct Known Subclasses:

TcpDevice

public class Device
extends java.lang.Object

Spacecode Device class.
Allows operating local devices. For remote devices, see TcpDevice.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	Device.EventDispatcher Dispatch events to listeners.

Constructor Summary

Constructors

Constructor and Description
Device(java.lang.String serialNumber) Try to detect the desired device on each serial port available.
Device(java.lang.String serialNumber, java.lang.String serialPortName) Try to connect with a device on a specific serial port.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	addBadgeReader(java.lang.String serialNumber, java.lang.String serialPortName, boolean isMaster) Allows virtually "plugging-in" a Badge Reader to this Device.
boolean	addFingerprintReader(java.lang.String serialNumber, boolean isMaster) Allows virtually "plugging-in" a Fingerprint Reader to this Device.
void	addListener(DeviceEventHandler eventHandler) Add a new listener (implementing at least DeviceEventHandler) to be informed of any new event.
boolean	addScale(java.lang.String serialPortName, ScaleSettings settings, byte[] command) Try to connect a scale using a custom configuration.
boolean	addScale(java.lang.String serialPortName, ScaleType type) Allow connecting a scale using the configuration of a predefined model (see ScaleType.
boolean	addTemperatureProbe(java.lang.String serialNumber, int delay, double eventDelta) Try to connect and add a temperature probe with given serial number.
java.lang.Object	adminQuery(java.lang.String query, java.lang.Object... params) Deprecated.
void	disconnectTemperatureProbe() Ask the current device to "release" its temperature probe(s) (if any has been added) and remove it.
boolean	flashFirmware(java.util.List<java.lang.String> lines) Deprecated.
double	getCurrentTemperature()
DeviceType	getDeviceType() Get information about the current device type.
java.lang.String	getHardwareVersion()
Inventory	getLastInventory() Get the inventory (if any) resulting from the last scan operation.
static java.util.Map<java.lang.String,PluggedDevice>	getPluggedDevices() Try to initialize a device on each serial port available.
java.lang.String	getSerialNumber() Mind that serial number can be set by user (constructor) or by RFID board (if set to null in constructor).
java.lang.String	getSoftwareVersion()
DeviceStatus	getStatus() See DeviceStatus enum for values.
java.util.Map<java.lang.String,java.lang.Byte>	getTagToDrawerNumber() Spacecode Devices equipped with many drawers memorize (for each tag) by which drawer a given UID has been scanned for the last time.
UsersService	getUsersService() Provide access to the Users Management service.
void	release() Disconnect the device and release resources.
void	removeListener(DeviceEventHandler eventHandler) Remove an event listener.
void	requestScan(ScanOption... options) Order the RFID reader board to process a "MANUAL" scan operation.
RewriteUidResult	rewriteUid(java.lang.String oldUid, java.lang.String newUid) Rewrite the UID of a tag (the tag must be from the E2 generation (or above)).
void	setLastInventory(Inventory inventory) Manually set "last inventory".
boolean	setLightIntensity(int value) Set the embedded LED's light intensity (for devices equipped with embedded LED's, like the SAS).
void	setStatus(DeviceStatus status) Update the device status.
boolean	startLightingTagsLed(java.util.List<java.lang.String> tagsUid) Send a "Lighting" order to the device. An event LedEventHandler.lightingStarted(List) is raised when the operation successfully started. The status of the device must be "READY" (i.e.
boolean	stopLightingTagsLed() Order the device to stop any lighting operation.
boolean	stopScan() Ask the RFID reader to stop the current scan (if any).

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Device

public Device(java.lang.String serialNumber)
       throws DeviceCreationException

Try to detect the desired device on each serial port available.

Parameters:

serialNumber - Device's serial number.

Throws:

DeviceCreationException - If any error occurred or the device could not be found.

Device

public Device(java.lang.String serialNumber,
      java.lang.String serialPortName)
       throws DeviceCreationException

Try to connect with a device on a specific serial port.

Parameters:

serialNumber - Serial number of the desired device. If null, any device available will be connected.

serialPortName - Serial port used by the device.

Throws:

DeviceCreationException - If any error occurred or no device could be found.

Method Detail

getPluggedDevices

public static java.util.Map<java.lang.String,PluggedDevice> getPluggedDevices()

Try to initialize a device on each serial port available.

Returns:

A mapping of the device serial number (key) and the PluggedDevice structure (value).

getSerialNumber

public java.lang.String getSerialNumber()

Mind that serial number can be set by user (constructor) or by RFID board (if set to null in constructor).

Returns:

Device board serial number.

addListener

public void addListener(DeviceEventHandler eventHandler)

Add a new listener (implementing at least DeviceEventHandler) to be informed of any new event.

Parameters:

eventHandler - An implementation of DeviceEventHandler, to be notified of any new event.

removeListener

public void removeListener(DeviceEventHandler eventHandler)

Remove an event listener.

Parameters:

eventHandler - Implementation of DeviceEventHandler to be removed.

requestScan

public void requestScan(ScanOption... options)

Order the RFID reader board to process a "MANUAL" scan operation.

Parameters:

options - List of ScanOption (or none) to be used for the new scan operation.

stopScan

public boolean stopScan()

Ask the RFID reader to stop the current scan (if any).

Returns:

True if the device was SCANNING (status), AND, the "stop scan" order was sent. False otherwise.

getStatus

public DeviceStatus getStatus()

See DeviceStatus enum for values.

Returns:

Device status.

setStatus

public void setStatus(DeviceStatus status)

Update the device status.

Parameters:

status - New value.

getTagToDrawerNumber

public java.util.Map<java.lang.String,java.lang.Byte> getTagToDrawerNumber()

Spacecode Devices equipped with many drawers memorize (for each tag) by which drawer a given UID has been scanned for the last time.

Returns:

A Map (String, Byte) with keys as UID and values as drawer number.

release

public void release()

Disconnect the device and release resources. Stop any lighting process currently in progress (local devices only). Notify event dispatcher of the disconnection ("deviceDisconnected" event).

startLightingTagsLed

public boolean startLightingTagsLed(java.util.List<java.lang.String> tagsUid)

Send a "Lighting" order to the device.
An event LedEventHandler.lightingStarted(List) is raised when the operation successfully started.
The status of the device must be "READY" (i.e. not scanning or already lighting LED's) in order to proceed.

Parameters:

tagsUid - UID's of the tags to be lighted.

Returns:

True if the device executed the order. False otherwise.

stopLightingTagsLed

public boolean stopLightingTagsLed()

Order the device to stop any lighting operation. If successful, this operation emits the "lighting stopped" event.

Returns:

False if stopping the lighting failed, or if it has not been started.

rewriteUid

public RewriteUidResult rewriteUid(java.lang.String oldUid,
                          java.lang.String newUid)

Rewrite the UID of a tag (the tag must be from the E2 generation (or above)).

Parameters:

oldUid - UID of the tag to be rewritten.

newUid - New UID.

Returns:

A value from RewriteUidResult enumeration.

getLastInventory

public Inventory getLastInventory()

Get the inventory (if any) resulting from the last scan operation.

Returns:

Last inventory recorded, or default/empty inventory if none has been done yet.

setLastInventory

public void setLastInventory(Inventory inventory)

Manually set "last inventory". Allow creating a new inventory (with a scan) based on the one passed as parameter. Thus, the tag already known (as "added" or "present") in the given inventory will not be considered as "added" in the next inventory. And the tags not present will be considered as "removed".

Parameters:

inventory - Inventory to be set as "last inventory".

getSoftwareVersion

public java.lang.String getSoftwareVersion()

Returns:

A String value representing Software version. Format : {MAJOR_VERSION}.{MINOR_VERSION}.

getHardwareVersion

public java.lang.String getHardwareVersion()

Returns:

A String representing Hardware version. Format : {MAJOR_VERSION}.{MINOR_VERSION}.

getDeviceType

public DeviceType getDeviceType()

Get information about the current device type.

Returns:

DeviceType enumeration value.

getUsersService

public UsersService getUsersService()

Provide access to the Users Management service.

Returns:

UsersService instance.

addFingerprintReader

public boolean addFingerprintReader(java.lang.String serialNumber,
                           boolean isMaster)

Allows virtually "plugging-in" a Fingerprint Reader to this Device.

Parameters:

serialNumber - Serial number of the Fingerprint Reader.

isMaster - If true, the reader will be considered as Master.

Returns:

True if FingerprintReader instantiation and capture starting succeeded, false otherwise.

addBadgeReader

public boolean addBadgeReader(java.lang.String serialNumber,
                     java.lang.String serialPortName,
                     boolean isMaster)

Allows virtually "plugging-in" a Badge Reader to this Device.

Parameters:

serialNumber - Serial number of the Badge reader (can't be null nor empty, must be unique).

serialPortName - Serial port name to be used to connect to the Badge Reader (e.g. "COM7").

isMaster - If true, the reader will be considered as Master.

Returns:

True if BadgeReader instantiation succeeded, false otherwise.

addTemperatureProbe

public boolean addTemperatureProbe(java.lang.String serialNumber,
                          int delay,
                          double eventDelta)

Try to connect and add a temperature probe with given serial number.

Parameters:

serialNumber - Serial number of the probe to be connected. If empty, the first probe available will be used.

delay - Delay (seconds) between each measurement. Minimum: ProbeModule.MIN_MEASURE_DELAY

eventDelta - Measure of next variation (°C) required to notify a new measure (event). Minimum: ProbeModule.MIN_MEASURE_DELTA

Returns:

True if succeeded, false otherwise (invalid parameter, module already added, ...).

getCurrentTemperature

public double getCurrentTemperature()

Returns:

Current temperature or ProbeModule.ERROR_VALUE (if error or no sensor).

disconnectTemperatureProbe

public void disconnectTemperatureProbe()

Ask the current device to "release" its temperature probe(s) (if any has been added) and remove it.

addScale

public boolean addScale(java.lang.String serialPortName,
               ScaleType type)

Allow connecting a scale using the configuration of a predefined model (see ScaleType.
The scale is asked for a new measure when a new scan is started. Measures received are passed by ScaleEventHandler.

Parameters:

serialPortName - Name of the serial port used by the scale.

type - Model (producer).

Returns:

True if the serial communication has been established. False otherwise.

addScale

public boolean addScale(java.lang.String serialPortName,
               ScaleSettings settings,
               byte[] command)

Try to connect a scale using a custom configuration.
The scale is asked for a new measure when a new scan is started. Measures received are passed by ScaleEventHandler.

Parameters:

serialPortName - Name of the serial port used by the scale.

settings - ScaleSettings attached to that scale.

command - Command to be sent over the serial port to query a new measure.

Returns:

True if the serial communication has been established. False otherwise.

flashFirmware

public boolean flashFirmware(java.util.List<java.lang.String> lines)

Deprecated. Exclusively designed for internal usages.
To be used extremely carefully.

Parameters:

lines - Firmware lines (ordered) list.

Returns:

True if the operation succeeded, false otherwise.

setLightIntensity

public boolean setLightIntensity(int value)

Set the embedded LED's light intensity (for devices equipped with embedded LED's, like the SAS).

Parameters:

value - [0;300] (0 - turn off, 300 - maximal intensity).

Returns:

True if the order has been sent and executed, false otherwise (not sent or not executed).

adminQuery

public java.lang.Object adminQuery(java.lang.String query,
                          java.lang.Object... params)

Deprecated. Exclusively designed for internal usages.

Parameters:

query - Query code.

params - Query parameters.

Returns:

Query result.