Onsystemservicepin – Echelon OpenLNS User Manual

Page 763

Advertising
background image

OpenLNS Programmer's Reference

726

Syntax

OnSystemNssIdle()

Added to API

Prior to LNS Release 3.0.

OnSystemServicePin

Summary

Indicates that a qualifying service pin message has been

received

.

You must call the System

object’s BeginServicePinEvent

method to enable service pin events. The appDeviceObject

parameter contains the application device that originated the

service pin event. The eventTag parameter contains the

corresponding event tag. You can call the

EndServicePinEvent method to disable the service pin

events.
If the service pin was pressed on a router, the auxClassId

parameter will contain lcaClassIdRouter; otherwise it will

contain lcaClassIdObjectServer.

Syntax

OnSystemServicePin(networkHandle as Long,

systemHandle as Long, eventTag as Integer, neuronId as

String, programId as String, location as String,

channelHandle as Long, auxClassId as Integer, objectHandle

as Long)

Element

Description

networkHandle

The Handle of the Network object

containing the modified connection.

systemHandle

The Handle of the System

object

containing the modified connection.

eventTag

The Event tag value corresponding to

this event, set by the

BeginServicePinEvent method.

neuronId

The Neuron ID returned by the service

pin event.

programId

The Program ID returned by the service

pin event.

location

The location string of the device that

caused the event.

channelHandle

The handle of the channel in which the

service pin event occured.

auxClassId

Indicates the type of device whose

service pin was pressed.

objectHandle

The handle of the object whose service

pin was grounded. If the device that

caused the event has not been

registered, this will return 0.

Added to API

Prior to LNS Release 3.0.

Advertising