com.spacecode.sdk.network

Class TcpDevice

java.lang.Object

com.spacecode.sdk.device.Device

com.spacecode.sdk.network.TcpDevice

public final class TcpDevice
extends Device

Specialized subclass of Device designed for Spacecode remote devices.

Nested Class Summary

Nested classes/interfaces inherited from class com.spacecode.sdk.device.Device

Device.EventDispatcher

Constructor Summary

Constructors

Constructor and Description
TcpDevice(java.lang.String ip) Default constructor.
TcpDevice(java.lang.String ip, int tcpPort) Create a TcpDevice instance and connect it to a remote device.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	addAlert(Alert alert) Ask the remote device to add an Alert.
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.
boolean	addTemperatureProbe(java.lang.String serialNumber, int delay, double eventDelta) Try to connect and add a temperature probe with given serial number.
java.util.List<AlertReport>	getAlertReports(java.util.Date from, java.util.Date to, java.util.List<Alert> alertsList) Get alert reports (if any) made during a certain period, for given alerts.
java.util.List<Alert>	getAlertsList()
java.util.List<Authentication>	getAuthentications(java.util.Date from, java.util.Date to) Allow getting authentications (if any) recorded during a certain period.
double	getCurrentTemperature()
DbConfiguration	getDbConfiguration() Get the configuration of the remote device database.
java.lang.String	getHardwareVersion()
DeviceStatus	getImmediateStatus()
java.util.List<Inventory>	getInventories(java.util.Date from, java.util.Date to) Allow getting inventories (if any) recorded during a certain period.
Inventory	getInventoryById(int id) Deprecated. Internal usage. Should not be used by SDK users. Allow getting an inventory by its unique identifier.
java.lang.String	getIpAddress()
AlertReport	getLastAlertReport()
Inventory	getLastInventory() Get the inventory (if any) resulting from the last scan operation.
ProbeSettings	getProbeSettings() Get the configuration of the temperature probe.
SmtpServer	getSmtpServer()
java.lang.String	getSoftwareVersion()
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.
java.util.Map<java.util.Date,java.lang.Double>	getTemperatureMeasures(java.util.Date from, java.util.Date to) Get temperature measures (if any) recorded during a certain period.
UsersService	getUsersService() Provide access to the Users Management service.
boolean	reconnect() Try to reconnect the TCP client to SmartServer.
void	release() Closes the TCP connection, shutdown the thread pool dedicated to event handling.
boolean	removeAlert(Alert alert) Ask the remote device to remove an Alert.
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) This implementation sends the "rewrite UID" order to SmartServer.
boolean	setDbConfiguration(DbConfiguration dbConfiguration) Update the settings of the remote device database.
boolean	setLightIntensity(int value) Set the embedded LED's light intensity (for devices equipped with embedded LED's, like the SAS).
boolean	setProbeSettings(ProbeSettings settings) Configure the temperature probe of the remote device.
boolean	setSmtpServer(SmtpServer smtpServer) Set or update the SMTP server used by the device to raise alerts by email.
boolean	setThiefFingerIndex(java.lang.String username, FingerIndex fingerIndex) Ask the remote device to set a user's "thief finger" index.
boolean	startLightingTagsLed(java.util.List<java.lang.String> tagsUid) Sends a StartLighting request to the device.
boolean	stopLightingTagsLed() This implementation sends the "stop lighting" order to SmartServer.
boolean	stopScan() Ask the device to stop the current scan (if any).
boolean	updateAlert(Alert alert) Ask the remote device to update an Alert.
void	updateStatus(DeviceStatus status) Apply the new (given) status and emit the event "Device Status Changed" with its value.

Methods inherited from class com.spacecode.sdk.device.Device

addListener, addScale, addScale, adminQuery, disconnectTemperatureProbe, flashFirmware, getDeviceType, getPluggedDevices, getSerialNumber, getStatus, removeListener, setLastInventory, setStatus

Methods inherited from class java.lang.Object

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

Constructor Detail

TcpDevice

public TcpDevice(java.lang.String ip)
          throws DeviceCreationException

Default constructor. Create a TcpDevice instance and connect it to a remote device.

Parameters:

ip - IPv4 address of the remote device.

Throws:

DeviceCreationException

TcpDevice

public TcpDevice(java.lang.String ip,
         int tcpPort)
          throws DeviceCreationException

Create a TcpDevice instance and connect it to a remote device.

Parameters:

ip - IPv4 address of the remote device.

tcpPort - TCP Port number.

Throws:

DeviceCreationException - If a parameter is invalid or the connection failed.

Method Detail

getIpAddress

public java.lang.String getIpAddress()

Returns:

IP address of the remote device.

reconnect

public boolean reconnect()

Try to reconnect the TCP client to SmartServer.

Returns:

True if the client is connected again. False otherwise.

addAlert

public boolean addAlert(Alert alert)

Ask the remote device to add an Alert.

Parameters:

alert - Alert to be added.

Returns:

true if operation succeeded, false otherwise.

updateAlert

public boolean updateAlert(Alert alert)

Ask the remote device to update an Alert.

Parameters:

alert - Alert to be updated.

Returns:

true if operation succeeded, false otherwise.

removeAlert

public boolean removeAlert(Alert alert)

Ask the remote device to remove an Alert.

Parameters:

alert - Alert to be removed.

Returns:

true if operation succeeded, false otherwise.

getAlertsList

public java.util.List<Alert> getAlertsList()

Returns:

List of alerts added to the remote device (empty if none). Or null if any error occurred

getAlertReports

public java.util.List<AlertReport> getAlertReports(java.util.Date from,
                                          java.util.Date to,
                                          java.util.List<Alert> alertsList)

Get alert reports (if any) made during a certain period, for given alerts. The alerts given in alertsList must come from the remote device (see getAlertsList).

Parameters:

from - Period start date.

to - Period end date.

alertsList - Alerts (/!\ provided by the remote device) concerned by the reports research.

Returns:

A list of AlertReport (empty if none). Or null if any error occurred

getAuthentications

public java.util.List<Authentication> getAuthentications(java.util.Date from,
                                                java.util.Date to)

Allow getting authentications (if any) recorded during a certain period.

Parameters:

from - Period start date.

to - Period end date.

Returns:

A list with all Authentications recorded during this period. Or null if any error occurred.

getDbConfiguration

public DbConfiguration getDbConfiguration()

Get the configuration of the remote device database. The password is never provided (left empty).

Returns:

Current Database configuration (the password is left empty), or null if any error occurred.

getLastAlertReport

public AlertReport getLastAlertReport()

Returns:

An AlertReport for the last alert raised, or null (if no alert has been raised, or any error occurred).

getInventories

public java.util.List<Inventory> getInventories(java.util.Date from,
                                       java.util.Date to)

Allow getting inventories (if any) recorded during a certain period.

Parameters:

from - Period start date.

to - Period end date.

Returns:

A list with all Inventories in this period. Or null if any error occurred.

getImmediateStatus

public DeviceStatus getImmediateStatus()

Returns:

"Real time" status of the remote device (as a DeviceStatus value), or null if any error occurred.

getInventoryById

@Deprecated
public Inventory getInventoryById(int id)

Deprecated. Internal usage. Should not be used by SDK users.
Allow getting an inventory by its unique identifier.

Parameters:

id - Integer value (Id of the desired Inventory)

Returns:

An inventory instance matching the given id, or null if:

• No result was found
• An error occurred

getProbeSettings

public ProbeSettings getProbeSettings()

Get the configuration of the temperature probe. Delay and Delta can be equal to -1 if not set.

Returns:

Current configuration, or null if any error occurred (communication failed, or no probe is available).

getSmtpServer

public SmtpServer getSmtpServer()

Returns:

SmtpServer containing the configuration details (null if no server is set, or if any error occurred).

getTemperatureMeasures

public java.util.Map<java.util.Date,java.lang.Double> getTemperatureMeasures(java.util.Date from,
                                                                    java.util.Date to)

Get temperature measures (if any) recorded during a certain period.

Parameters:

from - Period start date.

to - Period end date.

Returns:

A map with measure date as key, and measure value as value. Or null if any error occurred.

setDbConfiguration

public boolean setDbConfiguration(DbConfiguration dbConfiguration)

Update the settings of the remote device database.

Parameters:

dbConfiguration - New Database Configuration to be set.

Returns:

True if the operation succeeded, false otherwise.

setProbeSettings

public boolean setProbeSettings(ProbeSettings settings)

Configure the temperature probe of the remote device.

Parameters:

settings - Configuration of the probe (delay, delta, enabled/disabled).

Returns:

True if the operation succeeded, false otherwise.

setSmtpServer

public boolean setSmtpServer(SmtpServer smtpServer)

Set or update the SMTP server used by the device to raise alerts by email.

Parameters:

smtpServer - SmtpServer instance to be used as new SMTP server by this device.

Returns:

True if operation succeeded, false otherwise.

setThiefFingerIndex

public boolean setThiefFingerIndex(java.lang.String username,
                          FingerIndex fingerIndex)

Ask the remote device to set a user's "thief finger" index. "Thief finger" is the finger to be used (by an employee) in case of robbery/mugging, in order to raise an alert (if any alert is enabled).

Parameters:

username - User to be updated.

fingerIndex - FingerIndex value (null to remove "thief finger" from User).

Returns:

true if operation succeeded, false otherwise.

release

public void release()

Closes the TCP connection, shutdown the thread pool dedicated to event handling.

Overrides:

release in class Device

getUsersService

public UsersService getUsersService()

Provide access to the Users Management service.

Overrides:

getUsersService in class Device

Returns:

UsersService instance.

requestScan

public void requestScan(ScanOption... options)

Description copied from class: Device

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

Overrides:

requestScan in class Device

Parameters:

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

stopScan

public boolean stopScan()

Ask the device to stop the current scan (if any).

Overrides:

stopScan in class Device

Returns:

True if the order was successfully sent on the network. False otherwise.

getHardwareVersion

public java.lang.String getHardwareVersion()

Overrides:

getHardwareVersion in class Device

Returns:

Hardware version provided by SmartServer during initialization process.

getSoftwareVersion

public java.lang.String getSoftwareVersion()

Overrides:

getSoftwareVersion in class Device

Returns:

Software version provided by SmartServer during initialization process.

startLightingTagsLed

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

Sends a StartLighting request to the device.

Overrides:

startLightingTagsLed in class Device

Parameters:

tagsUid - Tags UID's to be lighted.

Returns:

True if operation succeeded. False otherwise (failure or timeout).

stopLightingTagsLed

public boolean stopLightingTagsLed()

This implementation sends the "stop lighting" order to SmartServer.

Overrides:

stopLightingTagsLed in class Device

Returns:

True if request is successful, false otherwise (device not lighting, failure, timeout).

rewriteUid

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

This implementation sends the "rewrite UID" order to SmartServer.

Overrides:

rewriteUid in class Device

Parameters:

oldUid - UID of the tag the User wants to "rename".

newUid - new UID to be written.

Returns:

A value from RewriteUidResult enumeration.

getLastInventory

public Inventory getLastInventory()

Description copied from class: Device

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

Overrides:

getLastInventory in class Device

Returns:

Last inventory as an Inventory instance, or null if any error occurred.

getCurrentTemperature

public double getCurrentTemperature()

Overrides:

getCurrentTemperature in class Device

Returns:

Current temperature (°C) or ProbeModule.ERROR_VALUE (if an error occurred, or no sensor).

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.

Overrides:

getTagToDrawerNumber in class Device

Returns:

A Map (String, Byte) with keys as UID and values as drawer number. Or null if any error occurred.

setLightIntensity

public boolean setLightIntensity(int value)

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

Overrides:

setLightIntensity in class Device

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).

updateStatus

public void updateStatus(DeviceStatus status)

Description copied from class: Device

Apply the new (given) status and emit the event "Device Status Changed" with its value.

Parameters:

status - New status.

addFingerprintReader

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

Description copied from class: Device

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

Overrides:

addFingerprintReader in class 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)

Description copied from class: Device

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

Overrides:

addBadgeReader in class 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)

Description copied from class: Device

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

Overrides:

addTemperatureProbe in class Device

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, ...).