OpenECHO
 All Classes Namespaces Files Functions Variables
Classes | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | List of all members
com.sonycsl.echo.eoj.device.sensor.PassageSensor Class Referenceabstract
Inheritance diagram for com.sonycsl.echo.eoj.device.sensor.PassageSensor:
com.sonycsl.echo.eoj.device.DeviceObject com.sonycsl.echo.eoj.EchoObject

Classes

class  Getter
 
class  Informer
 
class  Proxy
 
class  Receiver
 
class  Setter
 

Public Member Functions

void onNew ()
 
short getEchoClassCode ()
 
Setter set ()
 
Setter set (boolean responseRequired)
 
Getter get ()
 
Informer inform ()
 
- Public Member Functions inherited from com.sonycsl.echo.eoj.device.DeviceObject
byte getInstanceCode ()
 
void allocateSelfDeviceInstanceCode ()
 
void onNew ()
 
Setter set ()
 
Setter set (boolean responseRequired)
 
Getter get ()
 
Informer inform ()
 
- Public Member Functions inherited from com.sonycsl.echo.eoj.EchoObject
 EchoObject ()
 
void onNew ()
 
void onFound ()
 
final byte[] getStatusChangeAnnouncementProperties ()
 
final byte[] getSetProperties ()
 
final byte[] getGetProperties ()
 
String toString ()
 
final byte getClassGroupCode ()
 
final byte getClassCode ()
 
abstract byte getInstanceCode ()
 
abstract short getEchoClassCode ()
 
final int getEchoObjectCode ()
 
final void setNode (EchoNode node)
 
final EchoNode getNode ()
 
final void removeNode ()
 
final boolean isSelfObject ()
 
final boolean isProxy ()
 
final void setReceiver (Receiver receiver)
 
final Receiver getReceiver ()
 
final EchoFrame onReceiveRequest (EchoFrame frame)
 
Setter set ()
 
Setter set (boolean responseRequired)
 
Getter get ()
 
Informer inform ()
 

Static Public Member Functions

static Setter setG ()
 
static Setter setG (byte instanceCode)
 
static Setter setG (boolean responseRequired)
 
static Setter setG (byte instanceCode, boolean responseRequired)
 
static Getter getG ()
 
static Getter getG (byte instanceCode)
 
static Informer informG ()
 
static Informer informG (byte instanceCode)
 

Static Public Attributes

static final short ECHO_CLASS_CODE = (short)0x0027
 
static final byte EPC_DETECTION_THRESHOLD_LEVEL = (byte)0xB0
 
static final byte EPC_PASSAGE_DETECTION_HOLD_TIME = (byte)0xBE
 
static final byte EPC_PASSAGE_DETECTION_DIRECTION = (byte)0xE0
 
- Static Public Attributes inherited from com.sonycsl.echo.eoj.device.DeviceObject
static final byte EPC_OPERATION_STATUS = (byte)0x80
 
static final byte EPC_INSTALLATION_LOCATION = (byte)0x81
 
static final byte EPC_STANDARD_VERSION_INFORMATION = (byte)0x82
 
static final byte EPC_IDENTIFICATION_NUMBER = (byte)0x83
 
static final byte EPC_MEASURED_INSTANTANEOUS_POWER_CONSUMPTION = (byte)0x84
 
static final byte EPC_MEASURED_CUMULATIVE_POWER_CONSUMPTION = (byte)0x85
 
static final byte EPC_MANUFACTURERS_FAULT_CODE = (byte)0x86
 
static final byte EPC_CURRENT_LIMIT_SETTING = (byte)0x87
 
static final byte EPC_FAULT_STATUS = (byte)0x88
 
static final byte EPC_FAULT_DESCRIPTION = (byte)0x89
 
static final byte EPC_MANUFACTURER_CODE = (byte)0x8A
 
static final byte EPC_BUSINESS_FACILITY_CODE = (byte)0x8B
 
static final byte EPC_PRODUCT_CODE = (byte)0x8C
 
static final byte EPC_PRODUCTION_NUMBER = (byte)0x8D
 
static final byte EPC_PRODUCTION_DATE = (byte)0x8E
 
static final byte EPC_POWER_SAVING_OPERATION_SETTING = (byte)0x8F
 
static final byte EPC_REMOTE_CONTROL_SETTING = (byte)0x93
 
static final byte EPC_CURRENT_TIME_SETTING = (byte)0x97
 
static final byte EPC_CURRENT_DATE_SETTING = (byte)0x98
 
static final byte EPC_POWER_LIMIT_SETTING = (byte)0x99
 
static final byte EPC_CUMULATIVE_OPERATING_TIME = (byte)0x9A
 
static final byte EPC_STATUS_CHANGE_ANNOUNCEMENT_PROPERTY_MAP = (byte)0x9D
 
static final byte EPC_SET_PROPERTY_MAP = (byte)0x9E
 
static final byte EPC_GET_PROPERTY_MAP = (byte)0x9F
 
static final byte[] EDT_OPERATION_STATUS_ON = {(byte)0x30}
 
static final byte[] EDT_OPERATION_STATUS_OFF = {(byte)0x31}
 
static final byte[] EDT_STANDARD_VERSION_INFORMATION = {(byte)0x00, (byte)0x00, (byte)0x41, (byte)0x00}
 

Protected Member Functions

void setupPropertyMaps ()
 
boolean setOperationStatus (byte[] edt)
 
abstract byte[] getOperationStatus ()
 
boolean setDetectionThresholdLevel (byte[] edt)
 
byte[] getDetectionThresholdLevel ()
 
boolean isValidDetectionThresholdLevel (byte[] edt)
 
boolean setPassageDetectionHoldTime (byte[] edt)
 
byte[] getPassageDetectionHoldTime ()
 
boolean isValidPassageDetectionHoldTime (byte[] edt)
 
abstract byte[] getPassageDetectionDirection ()
 
boolean isValidPassageDetectionDirection (byte[] edt)
 
synchronized boolean setProperty (EchoProperty property)
 
synchronized byte[] getProperty (byte epc)
 
synchronized boolean isValidProperty (EchoProperty property)
 
Informer inform (boolean multicast)
 
- Protected Member Functions inherited from com.sonycsl.echo.eoj.device.DeviceObject
void setupPropertyMaps ()
 
synchronized boolean setProperty (EchoProperty property)
 
synchronized byte[] getProperty (byte epc)
 
synchronized boolean isValidProperty (EchoProperty property)
 
boolean setOperationStatus (byte[] edt)
 
abstract byte[] getOperationStatus ()
 
boolean isValidOperationStatus (byte[] edt)
 
abstract boolean setInstallationLocation (byte[] edt)
 
abstract byte[] getInstallationLocation ()
 
boolean isValidInstallationLocation (byte[] edt)
 
byte[] getStandardVersionInformation ()
 
boolean isValidStandardVersionInformation (byte[] edt)
 
byte[] getIdentificationNumber ()
 
boolean isValidIdentificationNumber (byte[] edt)
 
byte[] getMeasuredInstantaneousPowerConsumption ()
 
boolean isValidMeasuredInstantaneousPowerConsumption (byte[] edt)
 
byte[] getMeasuredCumulativePowerConsumption ()
 
boolean isValidMeasuredCumulativePowerConsumption (byte[] edt)
 
byte[] getManufacturersFaultCode ()
 
boolean isValidManufacturersFaultCode (byte[] edt)
 
boolean setCurrentLimitSetting (byte[] edt)
 
byte[] getCurrentLimitSetting ()
 
boolean isValidCurrentLimitSetting (byte[] edt)
 
abstract byte[] getFaultStatus ()
 
boolean isValidFaultStatus (byte[] edt)
 
byte[] getFaultDescription ()
 
boolean isValidFaultDescription (byte[] edt)
 
abstract byte[] getManufacturerCode ()
 
boolean isValidManufacturerCode (byte[] edt)
 
byte[] getBusinessFacilityCode ()
 
boolean isValidBusinessFacilityCode (byte[] edt)
 
byte[] getProductCode ()
 
boolean isValidProductCode (byte[] edt)
 
byte[] getProductionNumber ()
 
boolean isValidProductionNumber (byte[] edt)
 
byte[] getProductionDate ()
 
boolean isValidProductionDate (byte[] edt)
 
boolean setPowerSavingOperationSetting (byte[] edt)
 
byte[] getPowerSavingOperationSetting ()
 
boolean isValidPowerSavingOperationSetting (byte[] edt)
 
boolean setRemoteControlSetting (byte[] edt)
 
byte[] getRemoteControlSetting ()
 
boolean isValidRemoteControlSetting (byte[] edt)
 
boolean setCurrentTimeSetting (byte[] edt)
 
byte[] getCurrentTimeSetting ()
 
boolean isValidCurrentTimeSetting (byte[] edt)
 
boolean setCurrentDateSetting (byte edt[])
 
byte[] getCurrentDateSetting ()
 
boolean isValidCurrentDateSetting (byte[] edt)
 
boolean setPowerLimitSetting (byte[] edt)
 
byte[] getPowerLimitSetting ()
 
boolean isValidPowerLimitSetting (byte[] edt)
 
byte[] getCumulativeOperatingTime ()
 
boolean isValidCumulativeOperatingTime (byte[] edt)
 
byte[] getStatusChangeAnnouncementPropertyMap ()
 
boolean isValidStatusChangeAnnouncementPropertyMap (byte[] edt)
 
byte[] getSetPropertyMap ()
 
boolean isValidSetPropertyMap (byte[] edt)
 
byte[] getGetPropertyMap ()
 
boolean isValidGetPropertyMap (byte[] edt)
 
Informer inform (boolean multicast)
 
- Protected Member Functions inherited from com.sonycsl.echo.eoj.EchoObject
void setupPropertyMaps ()
 
final void addStatusChangeAnnouncementProperty (byte epc)
 
final void removeStatusChangeAnnouncementProperty (byte epc)
 
final void clearStatusChangeAnnouncementProperties ()
 
final void addSetProperty (byte epc)
 
final void removeSetProperty (byte epc)
 
final void clearSetProperties ()
 
final void addGetProperty (byte epc)
 
final void removeGetProperty (byte epc)
 
final void clearGetProperties ()
 
synchronized boolean setProperty (EchoProperty property)
 
synchronized byte[] getProperty (byte epc)
 
synchronized boolean isValidProperty (EchoProperty property)
 
final void onReceiveSetRequest (EchoProperty property, EchoFrame response)
 
final void onReceiveGetRequest (byte epc, EchoFrame response)
 
Informer inform (boolean multicast)
 
InformerC informC (String address)
 

Additional Inherited Members

- Protected Attributes inherited from com.sonycsl.echo.eoj.device.DeviceObject
byte mEchoInstanceCode = 0
 

Detailed Description

Definition at line 26 of file PassageSensor.java.

Member Function Documentation

Getter com.sonycsl.echo.eoj.device.sensor.PassageSensor.get ( )

Definition at line 358 of file PassageSensor.java.

byte [] com.sonycsl.echo.eoj.device.sensor.PassageSensor.getDetectionThresholdLevel ( )
protected

Property name : Detection threshold level

EPC : 0xB0

Contents of property :
Specifies detection threshold level (8-step).

Value range (decimal notation) :
0x31.0x38

Data type : unsigned char

Data size : 1 byte

Unit : -

Access rule :
Announce - undefined
Set - optional
Get - optional

Definition at line 151 of file PassageSensor.java.

short com.sonycsl.echo.eoj.device.sensor.PassageSensor.getEchoClassCode ( )

Definition at line 52 of file PassageSensor.java.

static Getter com.sonycsl.echo.eoj.device.sensor.PassageSensor.getG ( )
static

Definition at line 1068 of file PassageSensor.java.

static Getter com.sonycsl.echo.eoj.device.sensor.PassageSensor.getG ( byte  instanceCode)
static

Definition at line 1072 of file PassageSensor.java.

abstract byte [] com.sonycsl.echo.eoj.device.sensor.PassageSensor.getOperationStatus ( )
abstractprotected

Property name : Operation status

EPC : 0x80

Contents of property :
This property indicates the ON/OFF status.

Value range (decimal notation) :
ON=0x30, OFF=0x31

Data type : unsigned char

Data size : 1 byte

Unit : —

Access rule :
Announce - undefined
Set - optional
Get - mandatory

Announcement at status change

abstract byte [] com.sonycsl.echo.eoj.device.sensor.PassageSensor.getPassageDetectionDirection ( )
abstractprotected

Property name : Passage detection direction

EPC : 0xE0

Contents of property :
This property indicates direction of passage (one of 8 different directions).

Value range (decimal notation) :
0x30: No passage.
0x31 to 0x38: Direction of passage. 0x39: Passage detected but not located. Or, a sensor incapable of detecting passage direction was
passed.

Data type : unsigned char

Data size : 1 byte

Unit : -

Access rule :
Announce - undefined
Set - undefined
Get - mandatory

Announcement at status change

byte [] com.sonycsl.echo.eoj.device.sensor.PassageSensor.getPassageDetectionHoldTime ( )
protected

Property name : Passage detection hold time

EPC : 0xBE

Contents of property :
This property indicates passage detection hold time in ms.

Value range (decimal notation) :
0x0000.0xFFFD (0.65533 ms)

Data type : unsigned char

Data size : 2 bytes

Unit : ms

Access rule :
Announce - undefined
Set - optional
Get - optional

Definition at line 223 of file PassageSensor.java.

synchronized byte [] com.sonycsl.echo.eoj.device.sensor.PassageSensor.getProperty ( byte  epc)
protected

Definition at line 321 of file PassageSensor.java.

Informer com.sonycsl.echo.eoj.device.sensor.PassageSensor.inform ( )

Definition at line 364 of file PassageSensor.java.

Informer com.sonycsl.echo.eoj.device.sensor.PassageSensor.inform ( boolean  multicast)
protected

Definition at line 369 of file PassageSensor.java.

static Informer com.sonycsl.echo.eoj.device.sensor.PassageSensor.informG ( )
static

Definition at line 1077 of file PassageSensor.java.

static Informer com.sonycsl.echo.eoj.device.sensor.PassageSensor.informG ( byte  instanceCode)
static

Definition at line 1081 of file PassageSensor.java.

boolean com.sonycsl.echo.eoj.device.sensor.PassageSensor.isValidDetectionThresholdLevel ( byte[]  edt)
protected

Property name : Detection threshold level

EPC : 0xB0

Contents of property :
Specifies detection threshold level (8-step).

Value range (decimal notation) :
0x31.0x38

Data type : unsigned char

Data size : 1 byte

Unit : -

Access rule :
Announce - undefined
Set - optional
Get - optional

Definition at line 174 of file PassageSensor.java.

boolean com.sonycsl.echo.eoj.device.sensor.PassageSensor.isValidPassageDetectionDirection ( byte[]  edt)
protected

Property name : Passage detection direction

EPC : 0xE0

Contents of property :
This property indicates direction of passage (one of 8 different directions).

Value range (decimal notation) :
0x30: No passage.
0x31 to 0x38: Direction of passage. 0x39: Passage detected but not located. Or, a sensor incapable of detecting passage direction was
passed.

Data type : unsigned char

Data size : 1 byte

Unit : -

Access rule :
Announce - undefined
Set - undefined
Get - mandatory

Announcement at status change

Definition at line 303 of file PassageSensor.java.

boolean com.sonycsl.echo.eoj.device.sensor.PassageSensor.isValidPassageDetectionHoldTime ( byte[]  edt)
protected

Property name : Passage detection hold time

EPC : 0xBE

Contents of property :
This property indicates passage detection hold time in ms.

Value range (decimal notation) :
0x0000.0xFFFD (0.65533 ms)

Data type : unsigned char

Data size : 2 bytes

Unit : ms

Access rule :
Announce - undefined
Set - optional
Get - optional

Definition at line 246 of file PassageSensor.java.

synchronized boolean com.sonycsl.echo.eoj.device.sensor.PassageSensor.isValidProperty ( EchoProperty  property)
protected

Definition at line 334 of file PassageSensor.java.

void com.sonycsl.echo.eoj.device.sensor.PassageSensor.onNew ( )

Definition at line 46 of file PassageSensor.java.

Setter com.sonycsl.echo.eoj.device.sensor.PassageSensor.set ( )

Definition at line 347 of file PassageSensor.java.

Setter com.sonycsl.echo.eoj.device.sensor.PassageSensor.set ( boolean  responseRequired)

Definition at line 352 of file PassageSensor.java.

boolean com.sonycsl.echo.eoj.device.sensor.PassageSensor.setDetectionThresholdLevel ( byte[]  edt)
protected

Property name : Detection threshold level

EPC : 0xB0

Contents of property :
Specifies detection threshold level (8-step).

Value range (decimal notation) :
0x31.0x38

Data type : unsigned char

Data size : 1 byte

Unit : -

Access rule :
Announce - undefined
Set - optional
Get - optional

Definition at line 128 of file PassageSensor.java.

static Setter com.sonycsl.echo.eoj.device.sensor.PassageSensor.setG ( )
static

Definition at line 1051 of file PassageSensor.java.

static Setter com.sonycsl.echo.eoj.device.sensor.PassageSensor.setG ( byte  instanceCode)
static

Definition at line 1055 of file PassageSensor.java.

static Setter com.sonycsl.echo.eoj.device.sensor.PassageSensor.setG ( boolean  responseRequired)
static

Definition at line 1059 of file PassageSensor.java.

static Setter com.sonycsl.echo.eoj.device.sensor.PassageSensor.setG ( byte  instanceCode,
boolean  responseRequired 
)
static

Definition at line 1063 of file PassageSensor.java.

boolean com.sonycsl.echo.eoj.device.sensor.PassageSensor.setOperationStatus ( byte[]  edt)
protected

Property name : Operation status

EPC : 0x80

Contents of property :
This property indicates the ON/OFF status.

Value range (decimal notation) :
ON=0x30, OFF=0x31

Data type : unsigned char

Data size : 1 byte

Unit : —

Access rule :
Announce - undefined
Set - optional
Get - mandatory

Announcement at status change

Definition at line 80 of file PassageSensor.java.

boolean com.sonycsl.echo.eoj.device.sensor.PassageSensor.setPassageDetectionHoldTime ( byte[]  edt)
protected

Property name : Passage detection hold time

EPC : 0xBE

Contents of property :
This property indicates passage detection hold time in ms.

Value range (decimal notation) :
0x0000.0xFFFD (0.65533 ms)

Data type : unsigned char

Data size : 2 bytes

Unit : ms

Access rule :
Announce - undefined
Set - optional
Get - optional

Definition at line 200 of file PassageSensor.java.

synchronized boolean com.sonycsl.echo.eoj.device.sensor.PassageSensor.setProperty ( EchoProperty  property)
protected

Definition at line 309 of file PassageSensor.java.

void com.sonycsl.echo.eoj.device.sensor.PassageSensor.setupPropertyMaps ( )
protected

Definition at line 35 of file PassageSensor.java.

Member Data Documentation

final short com.sonycsl.echo.eoj.device.sensor.PassageSensor.ECHO_CLASS_CODE = (short)0x0027
static

Definition at line 28 of file PassageSensor.java.

final byte com.sonycsl.echo.eoj.device.sensor.PassageSensor.EPC_DETECTION_THRESHOLD_LEVEL = (byte)0xB0
static

Definition at line 30 of file PassageSensor.java.

final byte com.sonycsl.echo.eoj.device.sensor.PassageSensor.EPC_PASSAGE_DETECTION_DIRECTION = (byte)0xE0
static

Definition at line 32 of file PassageSensor.java.

final byte com.sonycsl.echo.eoj.device.sensor.PassageSensor.EPC_PASSAGE_DETECTION_HOLD_TIME = (byte)0xBE
static

Definition at line 31 of file PassageSensor.java.


The documentation for this class was generated from the following file: