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.housingfacilities.ElectricallyOperatedShade Class Referenceabstract
Inheritance diagram for com.sonycsl.echo.eoj.device.housingfacilities.ElectricallyOperatedShade:
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)0x0260
 
static final byte EPC_OPEN_CLOSE_SETTING = (byte)0xE0
 
static final byte EPC_DEGREE_OF_OPENI_NG_LEVEL = (byte)0xE1
 
static final byte EPC_SET_VALUE_OF_SHADE_ANGLE = (byte)0xE2
 
static final byte EPC_SHADE_OPEN_CLOSE_SPEED = (byte)0xE3
 
- 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 ()
 
abstract boolean setOpenCloseSetting (byte[] edt)
 
abstract byte[] getOpenCloseSetting ()
 
boolean isValidOpenCloseSetting (byte[] edt)
 
abstract boolean setDegreeOfOpeniNgLevel (byte[] edt)
 
abstract byte[] getDegreeOfOpeniNgLevel ()
 
boolean isValidDegreeOfOpeniNgLevel (byte[] edt)
 
boolean setSetValueOfShadeAngle (byte[] edt)
 
byte[] getSetValueOfShadeAngle ()
 
boolean isValidSetValueOfShadeAngle (byte[] edt)
 
boolean setShadeOpenCloseSpeed (byte[] edt)
 
byte[] getShadeOpenCloseSpeed ()
 
boolean isValidShadeOpenCloseSpeed (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 ElectricallyOperatedShade.java.

Member Function Documentation

Getter com.sonycsl.echo.eoj.device.housingfacilities.ElectricallyOperatedShade.get ( )

Definition at line 459 of file ElectricallyOperatedShade.java.

abstract byte [] com.sonycsl.echo.eoj.device.housingfacilities.ElectricallyOperatedShade.getDegreeOfOpeniNgLevel ( )
abstractprotected

Property name : Degree-of-openi ng level

EPC : 0xE1

Contents of property :
Used to specify the Degree-of-opening level by selecting a level from among the 8 predefined levels, and to acquire the current setting.

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

Data type : unsigned char

Data size : 1 byte

Unit : -

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

short com.sonycsl.echo.eoj.device.housingfacilities.ElectricallyOperatedShade.getEchoClassCode ( )

Definition at line 56 of file ElectricallyOperatedShade.java.

static Getter com.sonycsl.echo.eoj.device.housingfacilities.ElectricallyOperatedShade.getG ( )
static

Definition at line 1355 of file ElectricallyOperatedShade.java.

static Getter com.sonycsl.echo.eoj.device.housingfacilities.ElectricallyOperatedShade.getG ( byte  instanceCode)
static

Definition at line 1359 of file ElectricallyOperatedShade.java.

abstract byte [] com.sonycsl.echo.eoj.device.housingfacilities.ElectricallyOperatedShade.getOpenCloseSetting ( )
abstractprotected

Property name : Open/close setting

EPC : 0xE0

Contents of property :
Open/close

Value range (decimal notation) :
Open = 0x41, close = 0x42

Data type : unsigned char

Data size : 1 byte

Unit : -

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

Announcement at status change

abstract byte [] com.sonycsl.echo.eoj.device.housingfacilities.ElectricallyOperatedShade.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

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

Definition at line 420 of file ElectricallyOperatedShade.java.

byte [] com.sonycsl.echo.eoj.device.housingfacilities.ElectricallyOperatedShade.getSetValueOfShadeAngle ( )
protected

Property name : Set value of shade angle

EPC : 0xE2

Contents of property :
Shade angle value

Value range (decimal notation) :
0x00.0xB4 (0.180.)

Data type : unsigned char

Data size : 1 byte

Unit : deg

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

Definition at line 305 of file ElectricallyOperatedShade.java.

byte [] com.sonycsl.echo.eoj.device.housingfacilities.ElectricallyOperatedShade.getShadeOpenCloseSpeed ( )
protected

Property name : Shade open/close speed

EPC : 0xE3

Contents of property :
Low/Medium/High

Value range (decimal notation) :
Low = 0x41, Medium = 0x42, High = 0x43

Data type : unsigned char

Data size : 1 byte

Unit : -

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

Definition at line 377 of file ElectricallyOperatedShade.java.

Informer com.sonycsl.echo.eoj.device.housingfacilities.ElectricallyOperatedShade.inform ( )

Definition at line 465 of file ElectricallyOperatedShade.java.

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

Definition at line 470 of file ElectricallyOperatedShade.java.

static Informer com.sonycsl.echo.eoj.device.housingfacilities.ElectricallyOperatedShade.informG ( )
static

Definition at line 1364 of file ElectricallyOperatedShade.java.

static Informer com.sonycsl.echo.eoj.device.housingfacilities.ElectricallyOperatedShade.informG ( byte  instanceCode)
static

Definition at line 1368 of file ElectricallyOperatedShade.java.

boolean com.sonycsl.echo.eoj.device.housingfacilities.ElectricallyOperatedShade.isValidDegreeOfOpeniNgLevel ( byte[]  edt)
protected

Property name : Degree-of-openi ng level

EPC : 0xE1

Contents of property :
Used to specify the Degree-of-opening level by selecting a level from among the 8 predefined levels, and to acquire the current setting.

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

Data type : unsigned char

Data size : 1 byte

Unit : -

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

Definition at line 256 of file ElectricallyOperatedShade.java.

boolean com.sonycsl.echo.eoj.device.housingfacilities.ElectricallyOperatedShade.isValidOpenCloseSetting ( byte[]  edt)
protected

Property name : Open/close setting

EPC : 0xE0

Contents of property :
Open/close

Value range (decimal notation) :
Open = 0x41, close = 0x42

Data type : unsigned char

Data size : 1 byte

Unit : -

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

Announcement at status change

Definition at line 184 of file ElectricallyOperatedShade.java.

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

Definition at line 434 of file ElectricallyOperatedShade.java.

boolean com.sonycsl.echo.eoj.device.housingfacilities.ElectricallyOperatedShade.isValidSetValueOfShadeAngle ( byte[]  edt)
protected

Property name : Set value of shade angle

EPC : 0xE2

Contents of property :
Shade angle value

Value range (decimal notation) :
0x00.0xB4 (0.180.)

Data type : unsigned char

Data size : 1 byte

Unit : deg

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

Definition at line 328 of file ElectricallyOperatedShade.java.

boolean com.sonycsl.echo.eoj.device.housingfacilities.ElectricallyOperatedShade.isValidShadeOpenCloseSpeed ( byte[]  edt)
protected

Property name : Shade open/close speed

EPC : 0xE3

Contents of property :
Low/Medium/High

Value range (decimal notation) :
Low = 0x41, Medium = 0x42, High = 0x43

Data type : unsigned char

Data size : 1 byte

Unit : -

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

Definition at line 400 of file ElectricallyOperatedShade.java.

void com.sonycsl.echo.eoj.device.housingfacilities.ElectricallyOperatedShade.onNew ( )

Definition at line 50 of file ElectricallyOperatedShade.java.

Setter com.sonycsl.echo.eoj.device.housingfacilities.ElectricallyOperatedShade.set ( )

Definition at line 448 of file ElectricallyOperatedShade.java.

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

Definition at line 453 of file ElectricallyOperatedShade.java.

abstract boolean com.sonycsl.echo.eoj.device.housingfacilities.ElectricallyOperatedShade.setDegreeOfOpeniNgLevel ( byte[]  edt)
abstractprotected

Property name : Degree-of-openi ng level

EPC : 0xE1

Contents of property :
Used to specify the Degree-of-opening level by selecting a level from among the 8 predefined levels, and to acquire the current setting.

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

Data type : unsigned char

Data size : 1 byte

Unit : -

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

static Setter com.sonycsl.echo.eoj.device.housingfacilities.ElectricallyOperatedShade.setG ( )
static

Definition at line 1338 of file ElectricallyOperatedShade.java.

static Setter com.sonycsl.echo.eoj.device.housingfacilities.ElectricallyOperatedShade.setG ( byte  instanceCode)
static

Definition at line 1342 of file ElectricallyOperatedShade.java.

static Setter com.sonycsl.echo.eoj.device.housingfacilities.ElectricallyOperatedShade.setG ( boolean  responseRequired)
static

Definition at line 1346 of file ElectricallyOperatedShade.java.

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

Definition at line 1350 of file ElectricallyOperatedShade.java.

abstract boolean com.sonycsl.echo.eoj.device.housingfacilities.ElectricallyOperatedShade.setOpenCloseSetting ( byte[]  edt)
abstractprotected

Property name : Open/close setting

EPC : 0xE0

Contents of property :
Open/close

Value range (decimal notation) :
Open = 0x41, close = 0x42

Data type : unsigned char

Data size : 1 byte

Unit : -

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

Announcement at status change

boolean com.sonycsl.echo.eoj.device.housingfacilities.ElectricallyOperatedShade.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 84 of file ElectricallyOperatedShade.java.

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

Definition at line 406 of file ElectricallyOperatedShade.java.

boolean com.sonycsl.echo.eoj.device.housingfacilities.ElectricallyOperatedShade.setSetValueOfShadeAngle ( byte[]  edt)
protected

Property name : Set value of shade angle

EPC : 0xE2

Contents of property :
Shade angle value

Value range (decimal notation) :
0x00.0xB4 (0.180.)

Data type : unsigned char

Data size : 1 byte

Unit : deg

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

Definition at line 282 of file ElectricallyOperatedShade.java.

boolean com.sonycsl.echo.eoj.device.housingfacilities.ElectricallyOperatedShade.setShadeOpenCloseSpeed ( byte[]  edt)
protected

Property name : Shade open/close speed

EPC : 0xE3

Contents of property :
Low/Medium/High

Value range (decimal notation) :
Low = 0x41, Medium = 0x42, High = 0x43

Data type : unsigned char

Data size : 1 byte

Unit : -

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

Definition at line 354 of file ElectricallyOperatedShade.java.

void com.sonycsl.echo.eoj.device.housingfacilities.ElectricallyOperatedShade.setupPropertyMaps ( )
protected

Definition at line 36 of file ElectricallyOperatedShade.java.

Member Data Documentation

final short com.sonycsl.echo.eoj.device.housingfacilities.ElectricallyOperatedShade.ECHO_CLASS_CODE = (short)0x0260
static

Definition at line 28 of file ElectricallyOperatedShade.java.

final byte com.sonycsl.echo.eoj.device.housingfacilities.ElectricallyOperatedShade.EPC_DEGREE_OF_OPENI_NG_LEVEL = (byte)0xE1
static

Definition at line 31 of file ElectricallyOperatedShade.java.

final byte com.sonycsl.echo.eoj.device.housingfacilities.ElectricallyOperatedShade.EPC_OPEN_CLOSE_SETTING = (byte)0xE0
static

Definition at line 30 of file ElectricallyOperatedShade.java.

final byte com.sonycsl.echo.eoj.device.housingfacilities.ElectricallyOperatedShade.EPC_SET_VALUE_OF_SHADE_ANGLE = (byte)0xE2
static

Definition at line 32 of file ElectricallyOperatedShade.java.

final byte com.sonycsl.echo.eoj.device.housingfacilities.ElectricallyOperatedShade.EPC_SHADE_OPEN_CLOSE_SPEED = (byte)0xE3
static

Definition at line 33 of file ElectricallyOperatedShade.java.


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