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.profile.NodeProfile Class Referenceabstract
Inheritance diagram for com.sonycsl.echo.eoj.profile.NodeProfile:
com.sonycsl.echo.eoj.profile.ProfileObject com.sonycsl.echo.eoj.EchoObject com.sonycsl.echo.processing.defaults.DefaultNodeProfile

Classes

class  Getter
 
class  Informer
 
class  InformerC
 
class  Proxy
 
class  Receiver
 
class  Setter
 

Public Member Functions

byte getInstanceCode ()
 
short getEchoClassCode ()
 
void onNew ()
 
Setter set ()
 
Setter set (boolean responseRequired)
 
Getter get ()
 
Informer inform ()
 
- Public Member Functions inherited from com.sonycsl.echo.eoj.profile.ProfileObject
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 (boolean responseRequired)
 
static Getter getG ()
 
static Informer informG ()
 

Static Public Attributes

static final short ECHO_CLASS_CODE = 0x0EF0
 
static final byte INSTANCE_CODE = (byte)0x01
 
static final byte INSTANCE_CODE_TRANSMISSION_ONLY = 0x02
 
static final byte EPC_OPERATING_STATUS = (byte)0x80
 
static final byte EPC_VERSION_INFORMATION = (byte)0x82
 
static final byte EPC_IDENTIFICATION_NUMBER = (byte)0x83
 
static final byte EPC_FAULT_CONTENT = (byte)0x89
 
static final byte EPC_UNIQUE_IDENTIFIER_DATA = (byte)0xBF
 
static final byte EPC_NUMBER_OF_SELF_NODE_INSTANCES = (byte)0xD3
 
static final byte EPC_NUMBER_OF_SELF_NODE_CLASSES = (byte)0xD4
 
static final byte EPC_INSTANCE_LIST_NOTIFICATION = (byte)0xD5
 
static final byte EPC_SELF_NODE_INSTANCE_LIST_S = (byte)0xD6
 
static final byte EPC_SELF_NODE_CLASS_LIST = (byte)0xD7
 
static final byte[] EDT_VERSION_INFORMATION = {(byte)0x01, (byte)0x01, (byte)0x01, (byte) 0x00}
 
- Static Public Attributes inherited from com.sonycsl.echo.eoj.profile.ProfileObject
static final byte EPC_FAULT_STATUS = (byte)0x88
 
static final byte EPC_MANUFACTURER_CODE = (byte)0x8A
 
static final byte EPC_PLACE_OF_BUSINESS_CODE = (byte)0x8B
 
static final byte EPC_PRODUCT_CODE = (byte)0x8C
 
static final byte EPC_SERIAL_NUMBER = (byte)0x8D
 
static final byte EPC_DATE_OF_MANUFACTURE = (byte)0x8E
 
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
 

Protected Member Functions

void setupPropertyMaps ()
 
synchronized boolean setProperty (EchoProperty property)
 
synchronized byte[] getProperty (byte epc)
 
synchronized boolean isValidProperty (EchoProperty property)
 
boolean setOperatingStatus (byte[] edt)
 
abstract byte[] getOperatingStatus ()
 
boolean isValidOperatingStatus (byte[] edt)
 
byte[] getVersionInformation ()
 
boolean isValidVersionInformation (byte[] edt)
 
abstract byte[] getIdentificationNumber ()
 
boolean isValidIdentificationNumber (byte[] edt)
 
byte[] getFaultContent ()
 
boolean isValidFaultContent (byte[] edt)
 
abstract boolean setUniqueIdentifierData (byte[] edt)
 
abstract byte[] getUniqueIdentifierData ()
 
boolean isValidUniqueIdentifierData (byte[] edt)
 
byte[] getNumberOfSelfNodeInstances ()
 
boolean isValidNumberOfSelfNodeInstances (byte[] edt)
 
byte[] getNumberOfSelfNodeClasses ()
 
boolean isValidNumberOfSelfNodeClasses (byte[] edt)
 
byte[] getInstanceListNotification ()
 
boolean isValidInstanceListNotification (byte[] edt)
 
byte[] getSelfNodeInstanceListS ()
 
boolean isValidSelfNodeInstanceListS (byte[] edt)
 
byte[] getSelfNodeClassList ()
 
boolean isValidSelfNodeClassList (byte[] edt)
 
Informer inform (boolean multicast)
 
InformerC informC (String address)
 
- Protected Member Functions inherited from com.sonycsl.echo.eoj.profile.ProfileObject
void setupPropertyMaps ()
 
synchronized boolean setProperty (EchoProperty property)
 
synchronized byte[] getProperty (byte epc)
 
synchronized boolean isValidProperty (EchoProperty property)
 
byte[] getFaultStatus ()
 
boolean isValidFaultStatus (byte[] edt)
 
abstract byte[] getManufacturerCode ()
 
boolean isValidManufacturerCode (byte[] edt)
 
byte[] getPlaceOfBusinessCode ()
 
boolean isValidPlaceOfBusinessCode (byte[] edt)
 
byte[] getProductCode ()
 
boolean isValidProductCode (byte[] edt)
 
byte[] getSerialNumber ()
 
boolean isValidSerialNumber (byte[] edt)
 
byte[] getDateOfManufacture ()
 
boolean isValidDateOfManufacture (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)
 

Detailed Description

Definition at line 36 of file NodeProfile.java.

Member Function Documentation

Getter com.sonycsl.echo.eoj.profile.NodeProfile.get ( )

Definition at line 488 of file NodeProfile.java.

short com.sonycsl.echo.eoj.profile.NodeProfile.getEchoClassCode ( )

Definition at line 67 of file NodeProfile.java.

byte [] com.sonycsl.echo.eoj.profile.NodeProfile.getFaultContent ( )
protected

Fault content

0x0000-0x03E8 (0-1000)

Name : Fault content
EPC : 0x89
Data Type : unsigned short
Data Size(Byte) : 2

AccessRule
Announce : undefined
Set : undefined
Get : optional

Definition at line 265 of file NodeProfile.java.

static Getter com.sonycsl.echo.eoj.profile.NodeProfile.getG ( )
static

Definition at line 1490 of file NodeProfile.java.

abstract byte [] com.sonycsl.echo.eoj.profile.NodeProfile.getIdentificationNumber ( )
abstractprotected

Number to identify the node implementing the device object in the domain.

1st byte: lower communication ID field
0x01 to 0xFD:
Set arbitrarily for the protocol when the communication protocol used in the lower communication layer has a unique number. (not used in the ECHONET Lite Specification)
0xFE:
Set 2 to 17 bytes in the manufacturer-specified format.
0xFF:
Set 2 to 9 bytes when the protocol generated by random numbers is used in the lower communication layer.
0x00:
Identification number is not set.
Over 2nd byte: unique number field

Name : Identification number
EPC : 0x83
Data Type : unsigned char×9 or unsigned char × 17
Data Size(Byte) : 9 or 17

AccessRule
Announce : undefined
Set : undefined
Get : mandatory

byte com.sonycsl.echo.eoj.profile.NodeProfile.getInstanceCode ( )

Definition at line 62 of file NodeProfile.java.

byte [] com.sonycsl.echo.eoj.profile.NodeProfile.getInstanceListNotification ( )
protected

Instance list when self-node instance configuration is changed

1st byte: Number of notification instances
2nd to 253rd bytes: ECHONET object codes (EOJ3 bytes) enumerated

Name : Instance list notification
EPC : 0xD5
Data Type : unsigned char×(MAX) 253
Data Size(Byte) : Max.253

AccessRule
Announce : mandatory
Set : undefined
Get : undefined

Announcement at status change

Definition at line 395 of file NodeProfile.java.

byte [] com.sonycsl.echo.eoj.profile.NodeProfile.getNumberOfSelfNodeClasses ( )
protected

Total number of classes held by self-node

1st and 2nd bytes: Total number of classes

Name : Number of self-node classes
EPC : 0xD4
Data Type : unsigned char×2
Data Size(Byte) : 2

AccessRule
Announce : undefined
Set : undefined
Get : mandatory

Definition at line 359 of file NodeProfile.java.

byte [] com.sonycsl.echo.eoj.profile.NodeProfile.getNumberOfSelfNodeInstances ( )
protected

Total number of instances held by self-node

1st to 3rd bytes: Total number of instances

Name : Number of self-node instances
EPC : 0xD3
Data Type : unsigned char×3
Data Size(Byte) : 3

AccessRule
Announce : undefined
Set : undefined
Get : mandatory

Definition at line 329 of file NodeProfile.java.

abstract byte [] com.sonycsl.echo.eoj.profile.NodeProfile.getOperatingStatus ( )
abstractprotected

Indicates node operating status.

Booting = 0x30, not booting = 0x31

Name : Operating status
EPC : 0x80
Data Type : unsigned char
Data Size(Byte) : 1

AccessRule
Announce : undefined
Set : optional
Get : mandatory

Announcement at status change

synchronized byte [] com.sonycsl.echo.eoj.profile.NodeProfile.getProperty ( byte  epc)
protected

Definition at line 111 of file NodeProfile.java.

byte [] com.sonycsl.echo.eoj.profile.NodeProfile.getSelfNodeClassList ( )
protected

Self-node class list

1st byte: Total number of classes
2nd to 17th bytes: Class codes (EOJ high-order 2 bytes) enumerated

Name : Self-node class list
EPC : 0xD7
Data Type : unsigned char×(MAX) 17
Data Size(Byte) : Max.17

AccessRule
Announce : undefined
Set : undefined
Get : mandatory

Definition at line 452 of file NodeProfile.java.

byte [] com.sonycsl.echo.eoj.profile.NodeProfile.getSelfNodeInstanceListS ( )
protected

Self-node instance list

1st byte: Total number of instances
2nd to 253rd bytes: ECHONET object codes (EOJ3 bytes) enumerated

Name : Self-node instance list S
EPC : 0xD6
Data Type : unsigned char×(MAX) 253
Data Size(Byte) : Max.253

AccessRule
Announce : undefined
Set : undefined
Get : mandatory

Definition at line 425 of file NodeProfile.java.

abstract byte [] com.sonycsl.echo.eoj.profile.NodeProfile.getUniqueIdentifierData ( )
abstractprotected

Stipulated in 2 bytes

See (3) below.

Name : Unique identifier data
EPC : 0xBF
Data Type : unsigned short
Data Size(Byte) : 2

AccessRule
Announce : undefined
Set : mandatory
Get : mandatory

byte [] com.sonycsl.echo.eoj.profile.NodeProfile.getVersionInformation ( )
protected

Indicates ECHONET Lite version
used by communication middleware and message types supported by communication middleware.

1st byte: Indicates major version number (digits to left of decimal point) in binary notation.
2nd byte: Indicates minor version number (digits to right of decimal point) in binary notation.
3rd and 4th bytes: Indicate message types with a bitmap.

Name : Version information
EPC : 0x82
Data Type : unsigned char×4
Data Size(Byte) : 4

AccessRule
Announce : undefined
Set : undefined
Get : mandatory

Definition at line 212 of file NodeProfile.java.

Informer com.sonycsl.echo.eoj.profile.NodeProfile.inform ( )

Definition at line 494 of file NodeProfile.java.

Informer com.sonycsl.echo.eoj.profile.NodeProfile.inform ( boolean  multicast)
protected

Definition at line 499 of file NodeProfile.java.

InformerC com.sonycsl.echo.eoj.profile.NodeProfile.informC ( String  address)
protected

Definition at line 512 of file NodeProfile.java.

static Informer com.sonycsl.echo.eoj.profile.NodeProfile.informG ( )
static

Definition at line 1495 of file NodeProfile.java.

boolean com.sonycsl.echo.eoj.profile.NodeProfile.isValidFaultContent ( byte[]  edt)
protected

Definition at line 269 of file NodeProfile.java.

boolean com.sonycsl.echo.eoj.profile.NodeProfile.isValidIdentificationNumber ( byte[]  edt)
protected

Definition at line 245 of file NodeProfile.java.

boolean com.sonycsl.echo.eoj.profile.NodeProfile.isValidInstanceListNotification ( byte[]  edt)
protected

Definition at line 400 of file NodeProfile.java.

boolean com.sonycsl.echo.eoj.profile.NodeProfile.isValidNumberOfSelfNodeClasses ( byte[]  edt)
protected

Definition at line 372 of file NodeProfile.java.

boolean com.sonycsl.echo.eoj.profile.NodeProfile.isValidNumberOfSelfNodeInstances ( byte[]  edt)
protected

Definition at line 339 of file NodeProfile.java.

boolean com.sonycsl.echo.eoj.profile.NodeProfile.isValidOperatingStatus ( byte[]  edt)
protected

Definition at line 189 of file NodeProfile.java.

synchronized boolean com.sonycsl.echo.eoj.profile.NodeProfile.isValidProperty ( EchoProperty  property)
protected

Definition at line 131 of file NodeProfile.java.

boolean com.sonycsl.echo.eoj.profile.NodeProfile.isValidSelfNodeClassList ( byte[]  edt)
protected

Definition at line 472 of file NodeProfile.java.

boolean com.sonycsl.echo.eoj.profile.NodeProfile.isValidSelfNodeInstanceListS ( byte[]  edt)
protected

Definition at line 431 of file NodeProfile.java.

boolean com.sonycsl.echo.eoj.profile.NodeProfile.isValidUniqueIdentifierData ( byte[]  edt)
protected

Definition at line 309 of file NodeProfile.java.

boolean com.sonycsl.echo.eoj.profile.NodeProfile.isValidVersionInformation ( byte[]  edt)
protected

Definition at line 214 of file NodeProfile.java.

void com.sonycsl.echo.eoj.profile.NodeProfile.onNew ( )

Definition at line 73 of file NodeProfile.java.

Setter com.sonycsl.echo.eoj.profile.NodeProfile.set ( )

Definition at line 477 of file NodeProfile.java.

Setter com.sonycsl.echo.eoj.profile.NodeProfile.set ( boolean  responseRequired)

Definition at line 482 of file NodeProfile.java.

static Setter com.sonycsl.echo.eoj.profile.NodeProfile.setG ( )
static

Definition at line 1481 of file NodeProfile.java.

static Setter com.sonycsl.echo.eoj.profile.NodeProfile.setG ( boolean  responseRequired)
static

Definition at line 1485 of file NodeProfile.java.

boolean com.sonycsl.echo.eoj.profile.NodeProfile.setOperatingStatus ( byte[]  edt)
protected

Indicates node operating status.

Booting = 0x30, not booting = 0x31

Name : Operating status
EPC : 0x80
Data Type : unsigned char
Data Size(Byte) : 1

AccessRule
Announce : undefined
Set : optional
Get : mandatory

Announcement at status change

Definition at line 167 of file NodeProfile.java.

synchronized boolean com.sonycsl.echo.eoj.profile.NodeProfile.setProperty ( EchoProperty  property)
protected

Definition at line 99 of file NodeProfile.java.

abstract boolean com.sonycsl.echo.eoj.profile.NodeProfile.setUniqueIdentifierData ( byte[]  edt)
abstractprotected

Stipulated in 2 bytes

See (3) below.

Name : Unique identifier data
EPC : 0xBF
Data Type : unsigned short
Data Size(Byte) : 2

AccessRule
Announce : undefined
Set : mandatory
Get : mandatory

void com.sonycsl.echo.eoj.profile.NodeProfile.setupPropertyMaps ( )
protected

Definition at line 79 of file NodeProfile.java.

Member Data Documentation

final short com.sonycsl.echo.eoj.profile.NodeProfile.ECHO_CLASS_CODE = 0x0EF0
static

Definition at line 41 of file NodeProfile.java.

final byte [] com.sonycsl.echo.eoj.profile.NodeProfile.EDT_VERSION_INFORMATION = {(byte)0x01, (byte)0x01, (byte)0x01, (byte) 0x00}
static

Definition at line 59 of file NodeProfile.java.

final byte com.sonycsl.echo.eoj.profile.NodeProfile.EPC_FAULT_CONTENT = (byte)0x89
static

Definition at line 51 of file NodeProfile.java.

final byte com.sonycsl.echo.eoj.profile.NodeProfile.EPC_IDENTIFICATION_NUMBER = (byte)0x83
static

Definition at line 50 of file NodeProfile.java.

final byte com.sonycsl.echo.eoj.profile.NodeProfile.EPC_INSTANCE_LIST_NOTIFICATION = (byte)0xD5
static

Definition at line 55 of file NodeProfile.java.

final byte com.sonycsl.echo.eoj.profile.NodeProfile.EPC_NUMBER_OF_SELF_NODE_CLASSES = (byte)0xD4
static

Definition at line 54 of file NodeProfile.java.

final byte com.sonycsl.echo.eoj.profile.NodeProfile.EPC_NUMBER_OF_SELF_NODE_INSTANCES = (byte)0xD3
static

Definition at line 53 of file NodeProfile.java.

final byte com.sonycsl.echo.eoj.profile.NodeProfile.EPC_OPERATING_STATUS = (byte)0x80
static

Definition at line 48 of file NodeProfile.java.

final byte com.sonycsl.echo.eoj.profile.NodeProfile.EPC_SELF_NODE_CLASS_LIST = (byte)0xD7
static

Definition at line 57 of file NodeProfile.java.

final byte com.sonycsl.echo.eoj.profile.NodeProfile.EPC_SELF_NODE_INSTANCE_LIST_S = (byte)0xD6
static

Definition at line 56 of file NodeProfile.java.

final byte com.sonycsl.echo.eoj.profile.NodeProfile.EPC_UNIQUE_IDENTIFIER_DATA = (byte)0xBF
static

Definition at line 52 of file NodeProfile.java.

final byte com.sonycsl.echo.eoj.profile.NodeProfile.EPC_VERSION_INFORMATION = (byte)0x82
static

Definition at line 49 of file NodeProfile.java.

final byte com.sonycsl.echo.eoj.profile.NodeProfile.INSTANCE_CODE = (byte)0x01
static

Definition at line 44 of file NodeProfile.java.

final byte com.sonycsl.echo.eoj.profile.NodeProfile.INSTANCE_CODE_TRANSMISSION_ONLY = 0x02
static

Definition at line 45 of file NodeProfile.java.


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