Introduction, Lontalk api functions, Functions – Echelon LonTal Stack User Manual

Page 192

Advertising
background image

180

Appendix D: LonTalk API

Introduction

The LonTalk API provides the functions that you call from your LonTalk Stack

application to send and receive information to and from a L

ON

W

ORKS

network.

The API also defines the event handler functions and callback handler functions

that your LonTalk Stack application must provide to handle L

ON

W

ORKS

events

from the network and LonTalk Host stack. Because each LonTalk Stack
application handles these events and callbacks in its own specific way, you need

to modify the event and callback handler functions.
To provide operating system independence, the LonTalk API includes the
operating system abstraction layer (OSAL) API. To provide non-volatile data

independence, the LonTalk API provides two complete (and one skeletal)
non-volatile data driver (NVD) APIs.
Typically, you use the LonTalk API functions with the event handler functions

for LonTalk Stack device initialization and for sending and receiving network
variable updates. See Chapter 8, Developing a LonTalk Stack Device Application,

for more information about using these functions.
The implementations of the LonTalk API are contained in the following files:

FtxlHandlers.c, stub functions for the LonTalk API event handler

functions and callback handler functions

FtxlNvdFlashDirect.c, the direct-access model for working with flash

memory

FtxlNvdFlashFs.c, the file-system model for working with flash memory
FtxlNvdUserDefined.c, a skeletal implementation for a user-defined

non-volatile memory model

See LonTalk API Files for a list of the files that are included with the LonTalk

Stack.

The LonTalk API, Event Handler Functions, and
Callback Handler Functions

This section provides an overview of the LonTalk API functions, event handler

functions, and callback handler functions. For detailed information about these

functions, see the HTML API documentation and the API source code:

• HTML API documentation: Start → Programs → Echelon LonTalk

Stack Developer’s Kit → Documentation → API Reference

• API source code for the example applications: Start → Programs →

Echelon LonTalk Stack Developer’s Kit→ LonTalk Stack Example

Applications

LonTalk API Functions

The LonTalk API includes functions for managing network data, the LonTalk
Stack device, and non-volatile data.

Advertising