OpenECHO
 All Classes Namespaces Files Functions Variables
Classes | Public Member Functions | Static Public Attributes | Protected Member Functions | Protected Attributes | List of all members
com.sonycsl.echo.eoj.device.DeviceObject Class Referenceabstract
Inheritance diagram for com.sonycsl.echo.eoj.device.DeviceObject:
com.sonycsl.echo.eoj.EchoObject com.sonycsl.echo.eoj.device.airconditioner.AirCleaner com.sonycsl.echo.eoj.device.airconditioner.AirConditionerVentilationFan com.sonycsl.echo.eoj.device.airconditioner.ElectricHeater com.sonycsl.echo.eoj.device.airconditioner.FanHeater com.sonycsl.echo.eoj.device.airconditioner.HomeAirConditioner com.sonycsl.echo.eoj.device.airconditioner.Humidifier com.sonycsl.echo.eoj.device.airconditioner.PackageTypeCommercialAirConditionerIndoorUnit com.sonycsl.echo.eoj.device.airconditioner.PackageTypeCommercialAirConditionerOutdoorUnit com.sonycsl.echo.eoj.device.airconditioner.VentilationFan com.sonycsl.echo.eoj.device.audiovisual.Display com.sonycsl.echo.eoj.device.audiovisual.Television com.sonycsl.echo.eoj.device.cookinghousehold.ClothesDryer com.sonycsl.echo.eoj.device.cookinghousehold.CombinationMicrowaveOven com.sonycsl.echo.eoj.device.cookinghousehold.CookingHeater com.sonycsl.echo.eoj.device.cookinghousehold.ElectricHotWaterPot com.sonycsl.echo.eoj.device.cookinghousehold.Refrigerator com.sonycsl.echo.eoj.device.cookinghousehold.RiceCooker com.sonycsl.echo.eoj.device.cookinghousehold.WasherAndDryer com.sonycsl.echo.eoj.device.cookinghousehold.WashingMachine com.sonycsl.echo.eoj.device.health.Weighing com.sonycsl.echo.eoj.device.housingfacilities.BathroomHeaterAndDryer com.sonycsl.echo.eoj.device.housingfacilities.Battery com.sonycsl.echo.eoj.device.housingfacilities.Buzzer com.sonycsl.echo.eoj.device.housingfacilities.ColdOrHotWaterHeatSourceEquipment com.sonycsl.echo.eoj.device.housingfacilities.ElectricallyOperatedShade com.sonycsl.echo.eoj.device.housingfacilities.ElectricLock com.sonycsl.echo.eoj.device.housingfacilities.ElectricShutter com.sonycsl.echo.eoj.device.housingfacilities.ElectricStormWindow com.sonycsl.echo.eoj.device.housingfacilities.ElectricToiletSeat com.sonycsl.echo.eoj.device.housingfacilities.ElectricVehicle com.sonycsl.echo.eoj.device.housingfacilities.ElectricWaterHeater com.sonycsl.echo.eoj.device.housingfacilities.EngineCogeneration com.sonycsl.echo.eoj.device.housingfacilities.FloorHeater com.sonycsl.echo.eoj.device.housingfacilities.FuelCell com.sonycsl.echo.eoj.device.housingfacilities.GasMeter com.sonycsl.echo.eoj.device.housingfacilities.GeneralLighting com.sonycsl.echo.eoj.device.housingfacilities.HouseholdSolarPowerGeneration com.sonycsl.echo.eoj.device.housingfacilities.InstantaneousWaterHeater com.sonycsl.echo.eoj.device.housingfacilities.LPGasMeter com.sonycsl.echo.eoj.device.housingfacilities.PowerDistributionBoardMetering com.sonycsl.echo.eoj.device.housingfacilities.SmartElectricEnergyMeter com.sonycsl.echo.eoj.device.housingfacilities.SmartGasMeter com.sonycsl.echo.eoj.device.housingfacilities.Sprinkler com.sonycsl.echo.eoj.device.housingfacilities.WaterFlowmeter com.sonycsl.echo.eoj.device.housingfacilities.WattHourMeter com.sonycsl.echo.eoj.device.managementoperation.Controller com.sonycsl.echo.eoj.device.managementoperation.Switch com.sonycsl.echo.eoj.device.sensor.ActivityAmountSensor com.sonycsl.echo.eoj.device.sensor.AirPollutionSensor com.sonycsl.echo.eoj.device.sensor.AirSpeedSensor com.sonycsl.echo.eoj.device.sensor.BathHeatingStatusSensor com.sonycsl.echo.eoj.device.sensor.BathWaterLevelSensor com.sonycsl.echo.eoj.device.sensor.BedPresenceSensor com.sonycsl.echo.eoj.device.sensor.CallSensor com.sonycsl.echo.eoj.device.sensor.CigaretteSmokeSensor com.sonycsl.echo.eoj.device.sensor.CO2Sensor com.sonycsl.echo.eoj.device.sensor.CondensationSensor com.sonycsl.echo.eoj.device.sensor.CrimePreventionSensor com.sonycsl.echo.eoj.device.sensor.CurrentValueSensor com.sonycsl.echo.eoj.device.sensor.DifferentialPressureSensor com.sonycsl.echo.eoj.device.sensor.EarthquakeSensor com.sonycsl.echo.eoj.device.sensor.ElectricEnergySensor com.sonycsl.echo.eoj.device.sensor.ElectricLeakSensor com.sonycsl.echo.eoj.device.sensor.EmergencyButton com.sonycsl.echo.eoj.device.sensor.FireSensor com.sonycsl.echo.eoj.device.sensor.FirstAidSensor com.sonycsl.echo.eoj.device.sensor.FlameSensor com.sonycsl.echo.eoj.device.sensor.GasLeakSensor com.sonycsl.echo.eoj.device.sensor.GasSensor com.sonycsl.echo.eoj.device.sensor.HumanBodyLocationSensor com.sonycsl.echo.eoj.device.sensor.HumanDetectionSensor com.sonycsl.echo.eoj.device.sensor.HumiditySensor com.sonycsl.echo.eoj.device.sensor.IlluminanceSensor com.sonycsl.echo.eoj.device.sensor.MailingSensor com.sonycsl.echo.eoj.device.sensor.MicromotionSensor com.sonycsl.echo.eoj.device.sensor.OdorSensor com.sonycsl.echo.eoj.device.sensor.OpenCloseSensor com.sonycsl.echo.eoj.device.sensor.OxygenSensor com.sonycsl.echo.eoj.device.sensor.PassageSensor com.sonycsl.echo.eoj.device.sensor.RainSensor com.sonycsl.echo.eoj.device.sensor.SnowSensor com.sonycsl.echo.eoj.device.sensor.SoundSensor com.sonycsl.echo.eoj.device.sensor.TemperatureSensor com.sonycsl.echo.eoj.device.sensor.VisitorSensor com.sonycsl.echo.eoj.device.sensor.VOCSensor com.sonycsl.echo.eoj.device.sensor.WaterFlowRateSensor com.sonycsl.echo.eoj.device.sensor.WaterLeakSensor com.sonycsl.echo.eoj.device.sensor.WaterLevelSensor com.sonycsl.echo.eoj.device.sensor.WaterOverflowSensor com.sonycsl.echo.eoj.device.sensor.WeightSensor

Classes

class  Getter
 
class  Informer
 
class  Proxy
 
class  Receiver
 
class  Setter
 

Public Member Functions

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 Attributes

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

Protected Attributes

byte mEchoInstanceCode = 0
 

Detailed Description

Definition at line 24 of file DeviceObject.java.

Member Function Documentation

void com.sonycsl.echo.eoj.device.DeviceObject.allocateSelfDeviceInstanceCode ( )

Definition at line 63 of file DeviceObject.java.

Getter com.sonycsl.echo.eoj.device.DeviceObject.get ( )

Definition at line 877 of file DeviceObject.java.

byte [] com.sonycsl.echo.eoj.device.DeviceObject.getBusinessFacilityCode ( )
protected

3-byte business facility code

(Defined by each manufacturer.)

Data Type : unsigned char×3
Data Size(Byte) : 3

AccessRule
Announce : undefined
Set : undefined
Get : optional

Definition at line 502 of file DeviceObject.java.

byte [] com.sonycsl.echo.eoj.device.DeviceObject.getCumulativeOperatingTime ( )
protected

This property indicates the cumulative number of days, hours, minutes or seconds for which the device has operated, using 1 byte for the unit and 4 bytes for the time.

First byte: Indicates the unit.
Second: 0x41; Minute: 0x42; Hour: 0x43; Day:0x44
Second to fifth bytes :
Indicates the elapsed time in the unit specified by the first byte. 0x00000000-0xFFFFFFFF (0-4294967295)

Data Type : unsigned char + unsigned long
Data Size(Byte) : 1+4 Byte

AccessRule
Announce : undefined
Set : undefined
Get : optional

Definition at line 796 of file DeviceObject.java.

byte [] com.sonycsl.echo.eoj.device.DeviceObject.getCurrentDateSetting ( )
protected

Current date (YYYY:MM:DD format)

1 ~ 0x270F : 1 ~ 0x0C : 1 ~ 0x1F (=1 ~ 9999) : (=1 ~ 12) : (=1 ~ 31)

Data Type : unsigned char×4
Data Size(Byte) : 4

AccessRule
Announce : undefined
Set : optional
Get : optional

Definition at line 732 of file DeviceObject.java.

byte [] com.sonycsl.echo.eoj.device.DeviceObject.getCurrentLimitSetting ( )
protected

This property indicates the current limit setting (0-100%).

0x00-0x64 (=0-100)

Data Type : unsigned char
Data Size(Byte) : 1

AccessRule
Announce : undefined
Set : optional
Get : optional

Definition at line 416 of file DeviceObject.java.

byte [] com.sonycsl.echo.eoj.device.DeviceObject.getCurrentTimeSetting ( )
protected

Current time (HH:MM format)

0x00-0x17 : 0x00-0x3B( = 0-23):( = 0-59)

Data Type : unsigned char×2
Data Size(Byte) : 2

AccessRule
Announce : undefined
Set : optional
Get : optional

Definition at line 693 of file DeviceObject.java.

byte [] com.sonycsl.echo.eoj.device.DeviceObject.getFaultDescription ( )
protected

Describes the fault.

See “2.5 ‘Fault Description’ Property.”

Data Type : unsigned short
Data Size(Byte) : 2

AccessRule
Announce : undefined
Set : undefined
Get : optional

Definition at line 460 of file DeviceObject.java.

abstract byte [] com.sonycsl.echo.eoj.device.DeviceObject.getFaultStatus ( )
abstractprotected

This property indicates whether a fault (e.g. a sensor trouble) has occurred or not.

Fault occurred=0x41, No fault has occurred=0x42

Data Type : unsigned char
Data Size(Byte) : 1

AccessRule
Announce : undefined
Set : undefined
Get : mandatory

Announcement at status change

byte [] com.sonycsl.echo.eoj.device.DeviceObject.getGetPropertyMap ( )
protected

See Appendix 1.

Data Type : unsigned char×(MAX17)
Data Size(Byte) : Max.17

AccessRule
Announce : undefined
Set : undefined
Get : mandatory

Definition at line 856 of file DeviceObject.java.

byte [] com.sonycsl.echo.eoj.device.DeviceObject.getIdentificationNumber ( )
protected

A number that allows each object to be uniquely identified.

First byte: lower-layer communication ID field
0x01-0xFD:This is a communication protocol used in the lower-layer communication and is set arbitrarily according to the protocol class in the case where unique number is assigned (not used in ECHONET Lite).
0x11-0x1F: Power line Communication Protocol A and B systems
0x31-0x3F: Designated low-powor radio
0x41-0x4F: Extended HBS
0x51-0x5F: IrDA
0x61-0x6F: LonTalk®
0x71-0x7F: BlueTooth
0x81-0x8F: Ethernet
0x91-0x9F: IEEE802.11/11B
0xA1: Power line Communication Protocol C systems
0xB2:IPv6/6LoWPAN
0xFE:2-17 bytes are defined by the manufacturer, and are set according to the type.
0xFF:2-9 bytes are defined when randomly generated protocol is used in the lower-layer communication.
0x00:Identification number is not set.
Second and succeeding bytes: unique number field

Data Type : unsigned char
Data Size(Byte) : 9 or 17

AccessRule
Announce : undefined
Set : undefined
Get : optional

Definition at line 310 of file DeviceObject.java.

abstract byte [] com.sonycsl.echo.eoj.device.DeviceObject.getInstallationLocation ( )
abstractprotected

This property indicates the installation location

See “2.2 ‘Installation location’ property.”

Data Type : unsigned char
Data Size(Byte) : 1

AccessRule
Announce : undefined
Set : mandatory
Get : mandatory

Announcement at status change

byte com.sonycsl.echo.eoj.device.DeviceObject.getInstanceCode ( )

Definition at line 59 of file DeviceObject.java.

abstract byte [] com.sonycsl.echo.eoj.device.DeviceObject.getManufacturerCode ( )
abstractprotected

3-byte manufacturer code

(Defined by the ECHONET Consortium.)

Data Type : unsigned char×3
Data Size(Byte) : 3

AccessRule
Announce : undefined
Set : undefined
Get : mandatory

byte [] com.sonycsl.echo.eoj.device.DeviceObject.getManufacturersFaultCode ( )
protected

This property indicates the manufacturer-defined fault code.

First byte: Indicates the data size of the fault code field.
Second to fourth bytes: Manufacturer code
Fifth and succeeding bytes: Field for manufacturer-defined fault code

Data Type : unsigned char×(MAX)225
Data Size(Byte) : Max 225

AccessRule
Announce : undefined
Set : undefined
Get : optional

Definition at line 378 of file DeviceObject.java.

byte [] com.sonycsl.echo.eoj.device.DeviceObject.getMeasuredCumulativePowerConsumption ( )
protected

This property indicates the cumulative power consumption of the device in increments of 0.001kWh.

0x0-0x3B9AC9FF(0-999,999.999kWh)

Data Type : unsigned long
Data Size(Byte) : 4

AccessRule
Announce : undefined
Set : undefined
Get : optional

Definition at line 354 of file DeviceObject.java.

byte [] com.sonycsl.echo.eoj.device.DeviceObject.getMeasuredInstantaneousPowerConsumption ( )
protected

This property indicates the instantaneous power consumption of the device in watts.

0x0000-0xFFFF(0-65535W)

Data Type : unsigned short
Data Size(Byte) : 2

AccessRule
Announce : undefined
Set : undefined
Get : optional

Definition at line 332 of file DeviceObject.java.

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

This property indicates the ON/OFF status.

ON=0x30,OFF=0x31

Data Type : unsigned char
Data Size(Byte) : 1

AccessRule
Announce : undefined
Set : optional
Get : mandatory

Announcement at status change

byte [] com.sonycsl.echo.eoj.device.DeviceObject.getPowerLimitSetting ( )
protected

This property indicates the power limit setting in watts.

0x0000~0xFFFF(0-65535W)

Data Type : unsigned short
Data Size(Byte) : 2

AccessRule
Announce : undefined
Set : optional
Get : optional

Definition at line 771 of file DeviceObject.java.

byte [] com.sonycsl.echo.eoj.device.DeviceObject.getPowerSavingOperationSetting ( )
protected

This property indicates whether the device is operating in power-saving mode.

Operating in power-saving mode =0x41
Operating in normal operation mode =0x42

Data Type : unsigned char
Data Size(Byte) : 1

AccessRule
Announce : undefined
Set : optional
Get : optional

Definition at line 611 of file DeviceObject.java.

byte [] com.sonycsl.echo.eoj.device.DeviceObject.getProductCode ( )
protected

Identifies the product usingASCI I code.
(Defined by each manufacturer.)

Data Type : unsigned char×12
Data Size(Byte) : 12

AccessRule
Announce : undefined
Set : undefined
Get : optional

Definition at line 523 of file DeviceObject.java.

byte [] com.sonycsl.echo.eoj.device.DeviceObject.getProductionDate ( )
protected

4-byte production date code

This property indicates the product ion date in the YYMD format (1 character = 1 byte) .
YY: Year (e.g. 1999= 0x07CF)
M: Month (e.g. December=0x0C)
D: Day (e.g. 20th= 0x14)

Data Type : unsigned char×4
Data Size(Byte) : 4

AccessRule
Announce : undefined
Set : undefined
Get : optional

Definition at line 570 of file DeviceObject.java.

byte [] com.sonycsl.echo.eoj.device.DeviceObject.getProductionNumber ( )
protected

This property indicates the production number using ASCI I code.

(Defined by each manufacturer.)

Data Type : unsigned char×12
Data Size(Byte) : 12

AccessRule
Announce : undefined
Set : undefined
Get : optional

Definition at line 545 of file DeviceObject.java.

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

Definition at line 113 of file DeviceObject.java.

byte [] com.sonycsl.echo.eoj.device.DeviceObject.getRemoteControlSetting ( )
protected

This property indicates whether remote control is through a public network or not.

Not through a public network=0x41
Through a public network=0x42

Data Type : unsigned char
Data Size(Byte) : 1

AccessRule
Announce : undefined
Set : optional
Get : optional

Definition at line 654 of file DeviceObject.java.

byte [] com.sonycsl.echo.eoj.device.DeviceObject.getSetPropertyMap ( )
protected

See Appendix 1.

Data Type : unsigned char×(MAX17)
Data Size(Byte) : Max.17

AccessRule
Announce : undefined
Set : undefined
Get : mandatory

Definition at line 836 of file DeviceObject.java.

byte [] com.sonycsl.echo.eoj.device.DeviceObject.getStandardVersionInformation ( )
protected

This property indicates the version number of the corresponding standard.

First byte: Fixed at 0x00 (for future reserved).
Second byte: Fixed at 0x00 (for future reserved).
Third byte: Indicates the order of release in the ASCII format.
Fourth byte: Fixed at 0x00 (for future reserved).

Data Type : unsigned char×4
Data Size(Byte) : 4

AccessRule
Announce : undefined
Set : undefined
Get : mandatory

Definition at line 274 of file DeviceObject.java.

byte [] com.sonycsl.echo.eoj.device.DeviceObject.getStatusChangeAnnouncementPropertyMap ( )
protected

See Appendix 1.

Data Type : unsigned char×(MAX17)
Data Size(Byte) : Max.17

AccessRule
Announce : undefined
Set : undefined
Get : mandatory

Definition at line 816 of file DeviceObject.java.

Informer com.sonycsl.echo.eoj.device.DeviceObject.inform ( )

Definition at line 883 of file DeviceObject.java.

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

Definition at line 888 of file DeviceObject.java.

boolean com.sonycsl.echo.eoj.device.DeviceObject.isValidBusinessFacilityCode ( byte[]  edt)
protected

Definition at line 506 of file DeviceObject.java.

boolean com.sonycsl.echo.eoj.device.DeviceObject.isValidCumulativeOperatingTime ( byte[]  edt)
protected

Definition at line 800 of file DeviceObject.java.

boolean com.sonycsl.echo.eoj.device.DeviceObject.isValidCurrentDateSetting ( byte[]  edt)
protected

Definition at line 736 of file DeviceObject.java.

boolean com.sonycsl.echo.eoj.device.DeviceObject.isValidCurrentLimitSetting ( byte[]  edt)
protected

Definition at line 420 of file DeviceObject.java.

boolean com.sonycsl.echo.eoj.device.DeviceObject.isValidCurrentTimeSetting ( byte[]  edt)
protected

Definition at line 697 of file DeviceObject.java.

boolean com.sonycsl.echo.eoj.device.DeviceObject.isValidFaultDescription ( byte[]  edt)
protected

Definition at line 464 of file DeviceObject.java.

boolean com.sonycsl.echo.eoj.device.DeviceObject.isValidFaultStatus ( byte[]  edt)
protected

Definition at line 442 of file DeviceObject.java.

boolean com.sonycsl.echo.eoj.device.DeviceObject.isValidGetPropertyMap ( byte[]  edt)
protected

Definition at line 860 of file DeviceObject.java.

boolean com.sonycsl.echo.eoj.device.DeviceObject.isValidIdentificationNumber ( byte[]  edt)
protected

Definition at line 314 of file DeviceObject.java.

boolean com.sonycsl.echo.eoj.device.DeviceObject.isValidInstallationLocation ( byte[]  edt)
protected

Definition at line 254 of file DeviceObject.java.

boolean com.sonycsl.echo.eoj.device.DeviceObject.isValidManufacturerCode ( byte[]  edt)
protected

Definition at line 484 of file DeviceObject.java.

boolean com.sonycsl.echo.eoj.device.DeviceObject.isValidManufacturersFaultCode ( byte[]  edt)
protected

Definition at line 382 of file DeviceObject.java.

boolean com.sonycsl.echo.eoj.device.DeviceObject.isValidMeasuredCumulativePowerConsumption ( byte[]  edt)
protected

Definition at line 358 of file DeviceObject.java.

boolean com.sonycsl.echo.eoj.device.DeviceObject.isValidMeasuredInstantaneousPowerConsumption ( byte[]  edt)
protected

Definition at line 336 of file DeviceObject.java.

boolean com.sonycsl.echo.eoj.device.DeviceObject.isValidOperationStatus ( byte[]  edt)
protected

Definition at line 215 of file DeviceObject.java.

boolean com.sonycsl.echo.eoj.device.DeviceObject.isValidPowerLimitSetting ( byte[]  edt)
protected

Definition at line 775 of file DeviceObject.java.

boolean com.sonycsl.echo.eoj.device.DeviceObject.isValidPowerSavingOperationSetting ( byte[]  edt)
protected

Definition at line 615 of file DeviceObject.java.

boolean com.sonycsl.echo.eoj.device.DeviceObject.isValidProductCode ( byte[]  edt)
protected

Definition at line 527 of file DeviceObject.java.

boolean com.sonycsl.echo.eoj.device.DeviceObject.isValidProductionDate ( byte[]  edt)
protected

Definition at line 574 of file DeviceObject.java.

boolean com.sonycsl.echo.eoj.device.DeviceObject.isValidProductionNumber ( byte[]  edt)
protected

Definition at line 549 of file DeviceObject.java.

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

Definition at line 147 of file DeviceObject.java.

boolean com.sonycsl.echo.eoj.device.DeviceObject.isValidRemoteControlSetting ( byte[]  edt)
protected

Definition at line 658 of file DeviceObject.java.

boolean com.sonycsl.echo.eoj.device.DeviceObject.isValidSetPropertyMap ( byte[]  edt)
protected

Definition at line 840 of file DeviceObject.java.

boolean com.sonycsl.echo.eoj.device.DeviceObject.isValidStandardVersionInformation ( byte[]  edt)
protected

Definition at line 277 of file DeviceObject.java.

boolean com.sonycsl.echo.eoj.device.DeviceObject.isValidStatusChangeAnnouncementPropertyMap ( byte[]  edt)
protected

Definition at line 820 of file DeviceObject.java.

void com.sonycsl.echo.eoj.device.DeviceObject.onNew ( )

Definition at line 69 of file DeviceObject.java.

Setter com.sonycsl.echo.eoj.device.DeviceObject.set ( )

Definition at line 866 of file DeviceObject.java.

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

Definition at line 871 of file DeviceObject.java.

boolean com.sonycsl.echo.eoj.device.DeviceObject.setCurrentDateSetting ( byte  edt[])
protected

Current date (YYYY:MM:DD format)

1 ~ 0x270F : 1 ~ 0x0C : 1 ~ 0x1F (=1 ~ 9999) : (=1 ~ 12) : (=1 ~ 31)

Data Type : unsigned char×4
Data Size(Byte) : 4

AccessRule
Announce : undefined
Set : optional
Get : optional

Definition at line 715 of file DeviceObject.java.

boolean com.sonycsl.echo.eoj.device.DeviceObject.setCurrentLimitSetting ( byte[]  edt)
protected

This property indicates the current limit setting (0-100%).
0x00-0x64 (=0-100)

Data Type : unsigned char
Data Size(Byte) : 1

AccessRule
Announce : undefined
Set : optional
Get : optional

Definition at line 399 of file DeviceObject.java.

boolean com.sonycsl.echo.eoj.device.DeviceObject.setCurrentTimeSetting ( byte[]  edt)
protected

Current time (HH:MM format)

0x00-0x17:0x00-0x3B( = 0-23):( = 0-59)

Data Type : unsigned char×2
Data Size(Byte) : 2

AccessRule
Announce : undefined
Set : optional
Get : optional

Definition at line 676 of file DeviceObject.java.

abstract boolean com.sonycsl.echo.eoj.device.DeviceObject.setInstallationLocation ( byte[]  edt)
abstractprotected

This property indicates the installation location

See “2.2 ‘Installation location’ property.”

Data Type : unsigned char
Data Size(Byte) : 1

AccessRule
Announce : undefined
Set : mandatory
Get : mandatory

Announcement at status change

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

This property indicates the ON/OFF status.

ON=0x30,OFF=0x31

Data Type : unsigned char
Data Size(Byte) : 1

AccessRule
Announce : undefined
Set : optional
Get : mandatory

Announcement at status change

Definition at line 194 of file DeviceObject.java.

boolean com.sonycsl.echo.eoj.device.DeviceObject.setPowerLimitSetting ( byte[]  edt)
protected

This property indicates the power limit setting in watts.

0x0000~0xFFFF(0-65535W)

Data Type : unsigned short
Data Size(Byte) : 2

AccessRule
Announce : undefined
Set : optional
Get : optional

Definition at line 754 of file DeviceObject.java.

boolean com.sonycsl.echo.eoj.device.DeviceObject.setPowerSavingOperationSetting ( byte[]  edt)
protected

This property indicates whether the device is operating in power-saving mode.

Operating in power-saving mode =0x41
Operating in normal operation mode =0x42

Data Type : unsigned char
Data Size(Byte) : 1

AccessRule
Announce : undefined
Set : optional
Get : optional

Definition at line 593 of file DeviceObject.java.

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

Definition at line 95 of file DeviceObject.java.

boolean com.sonycsl.echo.eoj.device.DeviceObject.setRemoteControlSetting ( byte[]  edt)
protected

This property indicates whether remote control is through a public network or not.

Not through a public network=0x41
Through a public network=0x42

Data Type : unsigned char
Data Size(Byte) : 1

AccessRule
Announce : undefined
Set : optional
Get : optional

Definition at line 635 of file DeviceObject.java.

void com.sonycsl.echo.eoj.device.DeviceObject.setupPropertyMaps ( )
protected

Definition at line 75 of file DeviceObject.java.

Member Data Documentation

final byte [] com.sonycsl.echo.eoj.device.DeviceObject.EDT_OPERATION_STATUS_OFF = {(byte)0x31}
static

Definition at line 52 of file DeviceObject.java.

final byte [] com.sonycsl.echo.eoj.device.DeviceObject.EDT_OPERATION_STATUS_ON = {(byte)0x30}
static

Definition at line 51 of file DeviceObject.java.

final byte [] com.sonycsl.echo.eoj.device.DeviceObject.EDT_STANDARD_VERSION_INFORMATION = {(byte)0x00, (byte)0x00, (byte)0x41, (byte)0x00}
static

Definition at line 54 of file DeviceObject.java.

final byte com.sonycsl.echo.eoj.device.DeviceObject.EPC_BUSINESS_FACILITY_CODE = (byte)0x8B
static

Definition at line 37 of file DeviceObject.java.

final byte com.sonycsl.echo.eoj.device.DeviceObject.EPC_CUMULATIVE_OPERATING_TIME = (byte)0x9A
static

Definition at line 46 of file DeviceObject.java.

final byte com.sonycsl.echo.eoj.device.DeviceObject.EPC_CURRENT_DATE_SETTING = (byte)0x98
static

Definition at line 44 of file DeviceObject.java.

final byte com.sonycsl.echo.eoj.device.DeviceObject.EPC_CURRENT_LIMIT_SETTING = (byte)0x87
static

Definition at line 33 of file DeviceObject.java.

final byte com.sonycsl.echo.eoj.device.DeviceObject.EPC_CURRENT_TIME_SETTING = (byte)0x97
static

Definition at line 43 of file DeviceObject.java.

final byte com.sonycsl.echo.eoj.device.DeviceObject.EPC_FAULT_DESCRIPTION = (byte)0x89
static

Definition at line 35 of file DeviceObject.java.

final byte com.sonycsl.echo.eoj.device.DeviceObject.EPC_FAULT_STATUS = (byte)0x88
static

Definition at line 34 of file DeviceObject.java.

final byte com.sonycsl.echo.eoj.device.DeviceObject.EPC_GET_PROPERTY_MAP = (byte)0x9F
static

Definition at line 49 of file DeviceObject.java.

final byte com.sonycsl.echo.eoj.device.DeviceObject.EPC_IDENTIFICATION_NUMBER = (byte)0x83
static

Definition at line 29 of file DeviceObject.java.

final byte com.sonycsl.echo.eoj.device.DeviceObject.EPC_INSTALLATION_LOCATION = (byte)0x81
static

Definition at line 27 of file DeviceObject.java.

final byte com.sonycsl.echo.eoj.device.DeviceObject.EPC_MANUFACTURER_CODE = (byte)0x8A
static

Definition at line 36 of file DeviceObject.java.

final byte com.sonycsl.echo.eoj.device.DeviceObject.EPC_MANUFACTURERS_FAULT_CODE = (byte)0x86
static

Definition at line 32 of file DeviceObject.java.

final byte com.sonycsl.echo.eoj.device.DeviceObject.EPC_MEASURED_CUMULATIVE_POWER_CONSUMPTION = (byte)0x85
static

Definition at line 31 of file DeviceObject.java.

final byte com.sonycsl.echo.eoj.device.DeviceObject.EPC_MEASURED_INSTANTANEOUS_POWER_CONSUMPTION = (byte)0x84
static

Definition at line 30 of file DeviceObject.java.

final byte com.sonycsl.echo.eoj.device.DeviceObject.EPC_OPERATION_STATUS = (byte)0x80
static

Definition at line 26 of file DeviceObject.java.

final byte com.sonycsl.echo.eoj.device.DeviceObject.EPC_POWER_LIMIT_SETTING = (byte)0x99
static

Definition at line 45 of file DeviceObject.java.

final byte com.sonycsl.echo.eoj.device.DeviceObject.EPC_POWER_SAVING_OPERATION_SETTING = (byte)0x8F
static

Definition at line 41 of file DeviceObject.java.

final byte com.sonycsl.echo.eoj.device.DeviceObject.EPC_PRODUCT_CODE = (byte)0x8C
static

Definition at line 38 of file DeviceObject.java.

final byte com.sonycsl.echo.eoj.device.DeviceObject.EPC_PRODUCTION_DATE = (byte)0x8E
static

Definition at line 40 of file DeviceObject.java.

final byte com.sonycsl.echo.eoj.device.DeviceObject.EPC_PRODUCTION_NUMBER = (byte)0x8D
static

Definition at line 39 of file DeviceObject.java.

final byte com.sonycsl.echo.eoj.device.DeviceObject.EPC_REMOTE_CONTROL_SETTING = (byte)0x93
static

Definition at line 42 of file DeviceObject.java.

final byte com.sonycsl.echo.eoj.device.DeviceObject.EPC_SET_PROPERTY_MAP = (byte)0x9E
static

Definition at line 48 of file DeviceObject.java.

final byte com.sonycsl.echo.eoj.device.DeviceObject.EPC_STANDARD_VERSION_INFORMATION = (byte)0x82
static

Definition at line 28 of file DeviceObject.java.

final byte com.sonycsl.echo.eoj.device.DeviceObject.EPC_STATUS_CHANGE_ANNOUNCEMENT_PROPERTY_MAP = (byte)0x9D
static

Definition at line 47 of file DeviceObject.java.

byte com.sonycsl.echo.eoj.device.DeviceObject.mEchoInstanceCode = 0
protected

Definition at line 56 of file DeviceObject.java.


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