The asset location indication Interface provides a method for making a device emit visual signals (e.g., blinking LEDs) or audible signals (e.g., sounds) to facilitate its physical identification among other assets.
IAssetLocationIndicationType can be implemented by any object that represents a physical device and that is able to indicate its position by blinking and / or making a sound.
The minimal implementation supports turning a default indication on and off for a specified duration. Optionally a device can declare its supported indication types (audible, visual) and let the client select the used indication types (one or more).
The Interface is formally defined in Table 29.
Table 29 – IAssetLocationIndicationType definition
|
Attribute |
Value |
||||
|
BrowseName |
1:IAssetLocationIndicationType |
||||
|
IsAbstract |
True |
||||
|
References |
NodeClass |
BrowseName |
DataType |
TypeDefinition |
Other |
|
Subtype of the BaseInterfaceType defined in OPC 10000-5 |
|||||
|
|
|
|
|
|
|
|
0:HasComponent |
Method |
1:StartLocationIndication |
|
|
M |
|
0:HasComponent |
Method |
1:StopLocationIndication |
|
|
M |
|
0:HasProperty |
Variable |
1:IsIndicating |
0:Boolean |
0:PropertyType |
M |
|
0:HasProperty |
Variable |
1:UsedIndicationType |
1:LocationIndicationType |
0:PropertyType |
O |
|
0:HasProperty |
Variable |
1:SupportedIndicationTypes |
1:LocationIndicationType |
0:PropertyType |
O |
|
Conformance Units |
|||||
|
DI AssetLocationIndication |
|||||
The read only Property IsIndicating is true when the indication is currently active.
The optional Property SupportedIndicationType is an OptionSet whose values describe the types of location indications that are supported by the device.
The optional UsedIndicationType can be written to set the indication types that shall be used when StartLocationIndication is called.
The StartLocationIndication Method is used to start the indication. As a result to this call the IsIndicating property is set to true.
The signature of this Method is specified below. Table 30 and Table 31 specify the Arguments and AddressSpace representation, respectively.
Signature
StartLocationIndication(
[in] 0:Duration IndicationDuration);
Table 30 – StartLocationIndication Method Arguments
|
Argument |
Description |
|
IndicationDuration |
0 => infinite duration or duration in milliseconds |
Method Result Codes (defined in Call Service)
|
Result Code |
Description |
|
Bad_InvalidArgument |
If the device does not support a duration other than infinite |
Table 31 – StartLocationIndication Method AddressSpace definition
|
Attribute |
Value |
||||
|
BrowseName |
1:StartLocationIndication |
||||
|
References |
NodeClass |
BrowseName |
DataType |
TypeDefinition |
Other |
|
0:HasProperty |
Variable |
0:InputArguments |
0:Argument[] |
0:PropertyType |
M |
|
Conformance Units |
|||||
|
DI AssetLocationIndication |
|||||
The StopLocationIndication Method is used to stop the indication. As a result to this call, the IsIndicating property is set to false. This method also can be called when the indication is already stopped (e.g., because the specified IndicationDuration is over).
The signature of this Method is specified below.
Signature
StopLocationIndication();