Echelon OpenLNS - Manual (Page 125)

OpenLNS Programmer's Reference 88
Availability Local, full, and lightweight clients.
Syntax descriptionString = object.SelfDocumentation
Element Description
programIdValue The program ID value of the object.
object The object to be acted on.
Data Type String.
Read/Write Read only.
Added to API Prior to LNS Release 3.0.
State
Summary Describes the state of a device.
You cannot set the state of a device in the same transaction
as an Add , Commission , or Replace method. You cannot set
the state of a device during the definition phase of the
predefined components installation scenario.
The state change may fail if the device has not been
completely updated due to a previous communication
problem or if the device has not been commissioned. If a
failure occurs, use the Commission method to force an update
of the device.
Devices cannot receive network events related to monitor and
control while they are set to an offline state. For example, if
the State property of an app device installed on the network
is set to offline, then that device will not be able to receive
incoming network variable events.
While considering this, it is important to note that devices
are placed offline while they are being configured or
commissioned. For example, if you add or remove a
connection between an application device and the Network
Service Device, both the application device and Network
Service Device will be taken offline while the change is being
made.
Availability Local, full, and lightweight clients.
Syntax stateValue = object.State
Element Description
stateValue The state of the device (online or
offline). The enumerated values for
this property, which are stored in the
ConstDeviceStates constant, are as
follows:
Note: The only two values that may
be written to this property are
lcaStateCnfgOnline(4) and
lcaStateSoftOffline(12). All other