com.lf.battman.io.device

Class EnerGeniePM2LAN

java.lang.Object

com.lf.battman.io.AbstractDevice

com.lf.battman.io.CustomDevice

com.lf.battman.io.device.EnerGeniePM2LAN

All Implemented Interfaces:

com.lf.commons.docking.ApplicationStateListener, com.lf.commons.model.ConfigurableUnit, java.awt.event.ActionListener, java.util.EventListener, javax.swing.event.DocumentListener

Direct Known Subclasses:

EnerGeniePMS2LAN, EnerGeniePMS2WLAN

public class EnerGeniePM2LAN
extends CustomDevice
implements java.awt.event.ActionListener, javax.swing.event.DocumentListener, com.lf.commons.docking.ApplicationStateListener

Represents a EnerGenie EG-PM2-LAN power management device connected via LAN, not a charger.

The power management device can be used to turn other devices on/off (e.g. charging devices).

Since:

1.6

Version:

$Revision: 1.14 $, $Date: 2015/01/30 16:12:26 $

Author:

Axel Schwolow

Field Summary

Fields

Modifier and Type	Field and Description
protected com.lf.commons.gui.button.TouchKeyFlatButton[]	buttons The live data components (4).
protected java.awt.Component	compDisplay The canvas to display the device live data.
protected java.awt.Component	compFigure The canvas to display the device figure.
protected java.awt.Component	compOptions The canvas to display additional device options.
java.lang.String	configPage Default web page to configure the device.
java.lang.String	contentType Default character set.
protected boolean	deviceBusy Device currently in use?
protected boolean	initialized Object has been initialized?
java.lang.String	loginPage Default web page to login to the device.
protected PM2LANOptionsPanel	panelOptions The additional options component.
protected PowerSwitchPanel[]	panelsLiveData The live data components (4+1).
protected java.util.Properties	params The cached parameters for this device (saves queries, call reset()) to reset.
protected java.util.Date	refreshDate The date and time of the previous socket state refreshment.
java.lang.String	requestEncoding Default character set.
protected java.lang.Boolean[]	socketStates The current socket status values (4).
protected java.awt.Color	touchBgActivated Touch key default color.
protected java.awt.Color	touchBgDisabled Touch key default color.
protected java.awt.Color	touchBgNormal Touch key default color.
protected java.awt.Color	touchBgPressed Touch key default color.
protected java.awt.Color	touchFgActivated Touch key default color.
protected java.awt.Color	touchFgDisabled Touch key default color.
protected java.awt.Color	touchFgNormal Touch key default color.
protected java.awt.Color	touchFgPressed Touch key default color.
static java.lang.String	TYPE Device type identifier (max. 50 characters), add to CustomDevice.getSupportedTypes().

Fields inherited from class com.lf.battman.io.CustomDevice

customDeviceWindow

Fields inherited from class com.lf.battman.io.AbstractDevice

BARCODE_FORMAT_GENERIC, BARCODE_FORMAT_TEXTCRLF, BARCODE_READER_FORMAT, BARCODE_READER_REGEX, BARCODE_READER_REGEX_GROUP, COMM_BAUDRATE, COMM_DATABITS, COMM_FLOWCONTROL, COMM_INTERFACE, COMM_PARITY, COMM_STOPBITS, DEV_BARCODE_READER, DEV_CHARGER, DEV_POWER, DEV_RFID_READER, dvConnector, dvid, figureURL, RFID_CONVERT_10DEC, RFID_CONVERT_10HEX, RFID_CONVERT_8HEX, RFID_FORMAT_10DEC_STX8ETX, RFID_FORMAT_10HEX_STX10CRLFETX, RFID_FORMAT_8HEX_STX8CRLFETX, RFID_FORMAT_GENERIC_DEC, RFID_FORMAT_GENERIC_HEX, RFID_READER_CONVERT, RFID_READER_FORMAT, RFID_READER_REGEX, RFID_READER_REGEX_GROUP, type, USB_PRODUCT_ID, USB_RELEASE, USB_VENDOR_ID, USB_VERSION

Constructor Summary

Constructors

Constructor and Description
EnerGeniePM2LAN() Constructor method.

Method Summary

Methods

Modifier and Type	Method and Description
void	actionPerformed(java.awt.event.ActionEvent event) Called whenever the one of the components was activated.
boolean	canExit() Checks if the application can exit.
void	changedUpdate(javax.swing.event.DocumentEvent event) Called whenever text is updated.
void	configureUnit(java.lang.String id, com.lf.commons.config.Configuration config) Restores values from persistent data stores.
protected static com.lf.commons.gui.button.TouchKeyFlatButton	createButton(java.lang.String socket, java.lang.String socketno, java.awt.event.ActionListener listener, java.awt.Font font) Creates a button representing a socket (shared code).
protected PowerSwitchPanel	createPanel(java.lang.String socket, java.lang.String socketno, java.awt.event.ActionListener listener, boolean evenrow) Creates a panel representing a socket (shared code).
void	doOnExit() Executed of the program is exited finally.
void	doOnStart() Executed of the program is started.
protected void	executeTask(java.lang.Runnable task) Convenience to entertain the user while some action is performed.
protected void	finalize() Clean-up method to help the gc.
java.lang.String	getDeviceClass() Provides the class type of this device (charger, RFID reader, ...).
java.awt.Component	getFigureDisplay() Provides the canvas to display the device figure.
java.awt.Component	getLiveDisplay() Provides the canvas to display the device live data.
java.awt.Component	getOptionsDisplay() Provides the canvas to display additional device options.
java.util.Properties	getParams() Provides the parameters to configure the device.
boolean	getParamsConfigurable() May the parameters of this device be configured?
void	insertUpdate(javax.swing.event.DocumentEvent event) Called whenever text is inserted.
boolean	isFunctional() Checks if this device can be used.
protected void	layoutButtons() Adjusts the layout of the figure buttons.
protected java.util.Properties	loginToDevice(java.lang.String host, char[] password) Logs in to the current device and reads the current status.
protected boolean	logoutFromDevice(java.lang.String host) Logs out from the current device.
protected static java.util.Properties	parseHTML(java.lang.String response) Parses the response data from the device for necessary values like the current socket states.
protected java.lang.Boolean[]	readSocketStates(java.lang.String host, char[] password) Sends the command to receive the current socket states.
void	removeUpdate(javax.swing.event.DocumentEvent event) Called whenever text is removed.
void	setCustomDeviceWindow(CustomDeviceWindow window) Setter for the parental window with status bar (optional)
protected boolean	setSocketState(boolean login, java.lang.String host, char[] password, int socketno, boolean newstate) Sends the command to set the sockets to certain states (on/off).
protected com.lf.commons.gui.CommonsSwingWorker	startUpdateThread(boolean entertainment) Starts a separate thread to get the current socket states and update the window.
void	storeUnit(java.lang.String id, com.lf.commons.config.Configuration config) Stores the current configuration values persistently.
protected void	updateAllButton() Sets the current status of the all button (all buttons off).
protected void	updateButton(com.lf.commons.gui.button.TouchKeyFlatButton figurebutton, java.lang.Boolean state, java.lang.String socketname, com.lf.commons.gui.button.TouchKeyFlatButton livebutton) Called regularly by a separate thread e.g. to update connected status icon.
protected void	updateGUI() Lets the GUI reflect the current device status.
void	updateStatus() Called regularly by a separate thread e.g. to update connected status icon.

Methods inherited from class com.lf.battman.io.CustomDevice

createCustomDevice, getDeviceClassByType, getSupportedTypes

Methods inherited from class com.lf.battman.io.AbstractDevice

createDevice, getConnector, getDeviceClass, getDeviceIcon, getDeviceID, getDeviceToolTip, getSupportedBarcodeFormatDescription, getSupportedBarcodeFormatDescriptions, getSupportedBarcodeFormatRegex, getSupportedBarcodeFormats, getSupportedBaudrates, getSupportedBays, getSupportedBays, getSupportedDatabits, getSupportedFlowControlDescription, getSupportedFlowControlDescriptions, getSupportedFlowControls, getSupportedInterfaces, getSupportedParities, getSupportedParityDescription, getSupportedParityDescriptions, getSupportedPrograms, getSupportedPrograms, getSupportedRFIDConvertFormatDescription, getSupportedRFIDConvertFormatDescriptions, getSupportedRFIDConvertFormats, getSupportedRFIDFormatDescription, getSupportedRFIDFormatDescriptions, getSupportedRFIDFormatRegex, getSupportedRFIDFormats, getSupportedStatus, getSupportedStatus, getSupportedStopbitDescription, getSupportedStopbitDescriptions, getSupportedStopbits, getType, getUSBVersionDescription, setDevice, unitRegistered, unitUnregistered

Methods inherited from class java.lang.Object

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

Field Detail

TYPE

public static final java.lang.String TYPE

Device type identifier (max. 50 characters), add to CustomDevice.getSupportedTypes().

See Also:

Constant Field Values

requestEncoding

public java.lang.String requestEncoding

Default character set.

loginPage

public java.lang.String loginPage

Default web page to login to the device.

configPage

public java.lang.String configPage

Default web page to configure the device.

contentType

public java.lang.String contentType

Default character set.

buttons

protected com.lf.commons.gui.button.TouchKeyFlatButton[] buttons

The live data components (4).

compFigure

protected java.awt.Component compFigure

The canvas to display the device figure.

compOptions

protected java.awt.Component compOptions

The canvas to display additional device options.

panelOptions

protected PM2LANOptionsPanel panelOptions

The additional options component.

params

protected java.util.Properties params

The cached parameters for this device (saves queries, call reset()) to reset.

socketStates

protected java.lang.Boolean[] socketStates

The current socket status values (4).

refreshDate

protected java.util.Date refreshDate

The date and time of the previous socket state refreshment.

deviceBusy

protected boolean deviceBusy

Device currently in use?

compDisplay

protected java.awt.Component compDisplay

The canvas to display the device live data.

panelsLiveData

protected PowerSwitchPanel[] panelsLiveData

The live data components (4+1).

initialized

protected boolean initialized

Object has been initialized?

touchBgNormal

protected java.awt.Color touchBgNormal

Touch key default color.

touchBgPressed

protected java.awt.Color touchBgPressed

Touch key default color.

touchBgActivated

protected java.awt.Color touchBgActivated

Touch key default color.

touchBgDisabled

protected java.awt.Color touchBgDisabled

Touch key default color.

touchFgNormal

protected java.awt.Color touchFgNormal

Touch key default color.

touchFgPressed

protected java.awt.Color touchFgPressed

Touch key default color.

touchFgActivated

protected java.awt.Color touchFgActivated

Touch key default color.

touchFgDisabled

protected java.awt.Color touchFgDisabled

Touch key default color.

Constructor Detail

EnerGeniePM2LAN

public EnerGeniePM2LAN()

Constructor method.

Since:

1.6

Method Detail

finalize

protected void finalize()
                 throws java.lang.Throwable

Clean-up method to help the gc.

Overrides:

finalize in class java.lang.Object

Throws:

java.lang.Throwable

Since:

1.6

getParams

public java.util.Properties getParams()

Provides the parameters to configure the device.

Specified by:

getParams in class AbstractDevice

Returns:

The parameters

Since:

1.6

getParamsConfigurable

public boolean getParamsConfigurable()

May the parameters of this device be configured?

Specified by:

getParamsConfigurable in class AbstractDevice

Returns:

Configurable?

Since:

1.6

getDeviceClass

public java.lang.String getDeviceClass()

Provides the class type of this device (charger, RFID reader, ...).

Specified by:

getDeviceClass in class AbstractDevice

Returns:

The class DEV_CHARGER, ...

Since:

1.6

getOptionsDisplay

public java.awt.Component getOptionsDisplay()

Provides the canvas to display additional device options.

Specified by:

getOptionsDisplay in class AbstractDevice

Returns:

The canvas, maybe null

Since:

1.6

getFigureDisplay

public java.awt.Component getFigureDisplay()

Provides the canvas to display the device figure.

Specified by:

getFigureDisplay in class AbstractDevice

Returns:

The canvas, maybe null

Since:

1.6

createButton

protected static com.lf.commons.gui.button.TouchKeyFlatButton createButton(java.lang.String socket,
                                                        java.lang.String socketno,
                                                        java.awt.event.ActionListener listener,
                                                        java.awt.Font font)

Creates a button representing a socket (shared code).

Parameters:

socket - The socket

socketno - The parsable socket number

listener - The listener

font - The font

Returns:

The button

Since:

1.6

layoutButtons

protected void layoutButtons()

Adjusts the layout of the figure buttons.

Since:

1.6

getLiveDisplay

public java.awt.Component getLiveDisplay()

Provides the canvas to display the device live data.

Specified by:

getLiveDisplay in class AbstractDevice

Returns:

The canvas, maybe null

Since:

1.6

isFunctional

public boolean isFunctional()

Checks if this device can be used.

Specified by:

isFunctional in class AbstractDevice

Returns:

Device OK?

Since:

1.6

updateStatus

public void updateStatus()

Called regularly by a separate thread e.g. to update connected status icon.

Specified by:

updateStatus in class AbstractDevice

Since:

1.6

updateButton

protected void updateButton(com.lf.commons.gui.button.TouchKeyFlatButton figurebutton,
                java.lang.Boolean state,
                java.lang.String socketname,
                com.lf.commons.gui.button.TouchKeyFlatButton livebutton)

Called regularly by a separate thread e.g. to update connected status icon.

Parameters:

figurebutton - The figure button

state - Socket on/off, null = no connection

socketname - The name of the socket (optional)

livebutton - The live data button

Since:

1.6

updateAllButton

protected void updateAllButton()

Sets the current status of the all button (all buttons off).

Since:

1.6

readSocketStates

protected java.lang.Boolean[] readSocketStates(java.lang.String host,
                                   char[] password)

Sends the command to receive the current socket states.

Parameters:

host - The host name/IP

password - The password

Returns:

The array with states, elements = null means no connection

Since:

1.6

setSocketState

protected boolean setSocketState(boolean login,
                     java.lang.String host,
                     char[] password,
                     int socketno,
                     boolean newstate)

Sends the command to set the sockets to certain states (on/off).

This code should always be called from a CommonsSwingWorker since it may take a while and may also fail!

Parameters:

login - Login to device first?

host - The host name/IP

password - The password

socketno - The socket number (1,2,3,4)

newstate - The new socket state

Returns:

Successful?

Since:

1.6

loginToDevice

protected java.util.Properties loginToDevice(java.lang.String host,
                                 char[] password)

Logs in to the current device and reads the current status.

Parameters:

host - The host name or IP address

password - The password

Returns:

The HTML status values, null means no connection/wrong password

Since:

1.6

logoutFromDevice

protected boolean logoutFromDevice(java.lang.String host)

Logs out from the current device.

Necessary since the number of concurrent users on the device is limited (avoid error messages).

Parameters:

host - The host name or IP address

Returns:

Successful?

Since:

1.6

createPanel

protected PowerSwitchPanel createPanel(java.lang.String socket,
                           java.lang.String socketno,
                           java.awt.event.ActionListener listener,
                           boolean evenrow)

Creates a panel representing a socket (shared code).

Parameters:

socket - The socket

socketno - The parsable socket number

listener - The listener

evenrow - Even row number with different background color?

Returns:

The panel

Since:

1.6

setCustomDeviceWindow

public void setCustomDeviceWindow(CustomDeviceWindow window)

Setter for the parental window with status bar (optional)

Overrides:

setCustomDeviceWindow in class CustomDevice

Parameters:

window - The port window

Since:

1.6

configureUnit

public void configureUnit(java.lang.String id,
                 com.lf.commons.config.Configuration config)

Restores values from persistent data stores.

Specified by:

configureUnit in interface com.lf.commons.model.ConfigurableUnit

Overrides:

configureUnit in class AbstractDevice

Parameters:

id - The unique identifier for the instance

config - The configuration

Since:

1.6

storeUnit

public void storeUnit(java.lang.String id,
             com.lf.commons.config.Configuration config)

Stores the current configuration values persistently.

Specified by:

storeUnit in interface com.lf.commons.model.ConfigurableUnit

Overrides:

storeUnit in class AbstractDevice

Parameters:

id - The unique identifier for the instance

config - The configuration

Since:

1.6

actionPerformed

public void actionPerformed(java.awt.event.ActionEvent event)

Called whenever the one of the components was activated.

Specified by:

actionPerformed in interface java.awt.event.ActionListener

Parameters:

event - The event object

Since:

1.6

insertUpdate

public void insertUpdate(javax.swing.event.DocumentEvent event)

Called whenever text is inserted.

Specified by:

insertUpdate in interface javax.swing.event.DocumentListener

Parameters:

event - The event object

Since:

1.6

removeUpdate

public void removeUpdate(javax.swing.event.DocumentEvent event)

Called whenever text is removed.

Specified by:

removeUpdate in interface javax.swing.event.DocumentListener

Parameters:

event - The event object

Since:

1.6

changedUpdate

public void changedUpdate(javax.swing.event.DocumentEvent event)

Called whenever text is updated.

Specified by:

changedUpdate in interface javax.swing.event.DocumentListener

Parameters:

event - The event object

Since:

1.6

canExit

public boolean canExit()

Checks if the application can exit.

If there is any pending data e.g. managed by docking windows the shutdown sequence can be stopped by returning false.

Specified by:

canExit in interface com.lf.commons.docking.ApplicationStateListener

Returns:

Exit OK?

Since:

1.6

doOnStart

public void doOnStart()

Executed of the program is started.

Since:

1.6

doOnExit

public void doOnExit()

Executed of the program is exited finally.

Specified by:

doOnExit in interface com.lf.commons.docking.ApplicationStateListener

Since:

1.6

executeTask

protected void executeTask(java.lang.Runnable task)

Convenience to entertain the user while some action is performed.

Parameters:

task - The executable

Since:

1.6

startUpdateThread

protected com.lf.commons.gui.CommonsSwingWorker startUpdateThread(boolean entertainment)

Starts a separate thread to get the current socket states and update the window.

Parameters:

entertainment - Give feedback?

Returns:

The worker, null if directly executed (without entertainment)

Since:

1.6

updateGUI

protected void updateGUI()

Lets the GUI reflect the current device status.

Since:

1.6

parseHTML

protected static java.util.Properties parseHTML(java.lang.String response)

Parses the response data from the device for necessary values like the current socket states.

Parameters:

response - The HTML response

Returns:

The container with parsed values, may be empty

Since:

1.6