Application messaging api functions, Table 13 on pag – Echelon FTXL User Manual

Page 162

Advertising
background image

150

FTXL LonTalk API

Table 13. Other FTXL LonTalk API Functions

Function

Description

LonFreeNvTypeData()

Frees internal buffers that were allocated by a call to the

LonQueryNvType() function.

LonGetDeclaredNvSize() Gets the declared size for a network variable.

LonGetNvValue()

Gets a pointer to the value for a network variable. This function
is required for dynamic network variables, but could be used for

any network variable.

LonGetUniqueId()

Gets the unique ID (Neuron ID) value of the FTXL Transceiver.

LonGetVersion()

Gets the version number of the FTXL LonTalk API.

LonPollNv()

Requests a network variable value from the network. An FTXL
application can call LonPollNv() to request that another

L

ON

W

ORKS

device (or devices) send the latest value (or values)

for network variables that are bound to the specified input
variable. To be able to poll a network variable, it must be

declared in the model file as an input network variable and

include the polled modifier.

LonQueryNvType()

Queries the information about a network variable.

LonSendServicePin()

Broadcasts a service-pin message to the network. The service-

pin message is used during configuration, installation, and

maintenance of a L

ON

W

ORKS

device. The FTXL LonTalk

protocol stack automatically broadcasts service-pin messages

when needed.

Application Messaging API Functions

Table 14 lists the FTXL LonTalk API functions that are used for implementing
application messaging and for responding to an application message. Application

messages can be used to implement a proprietary interface that does not need to

interface to devices from other manufacturers. Support for application
messaging is optional.

Table 14. Application Messaging FTXL LonTalk API Functions

Function

Description

LonReleaseCorrelator() Releases a request correlator for an application message without

sending a response.

LonSendMsg()

Sends an application message.

Advertising