Introduction – Echelon FTXL User Manual
Page 160
148
FTXL LonTalk API
Introduction
The FTXL LonTalk API provides the functions that you call from your FTXL
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 FTXL application must provide to handle L
ON
W
ORKS
events from the
network and FTXL LonTalk protocol stack. Because each FTXL 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 FTXL LonTalk API includes the
FTXL operating system abstraction layer (OSAL) API. To provide hardware
independence, the FTXL LonTalk API provides the FTXL hardware abstraction
layer (HAL) API. To provide non-volatile data independence, the FTXL LonTalk
API provides two complete (and one skeletal) non-volatile data driver (NVD)
APIs.
Typically, you use the FTXL LonTalk API functions with the event handler
functions for FTXL device initialization and for sending and receiving network
variable updates. See Chapter 5,
Developing an FTXL Application
, on page 73,
for more information about using these functions.
The implementations of the FTXL LonTalk API are contained in the following
files:
• libFtxl100.a, the FTXL library – implements the FTXL LonTalk protocol
stack, FTXL LonTalk API, and parallel interface driver
• FtxlHandlers.c, stub functions for the FTXL event handler functions and
callback handler functions
• FtxlOsal.c, the Micrium μC/OS-II implementation of the FTXL OSAL
• FtxlHal.c, the FTXL Developer’s Kit hardware implementation of the
FTXL HAL
• 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
on page 20 for a list of the files that are included with the
FTXL Developer’s Kit.
The FTXL LonTalk API, Event Handler Functions,
and Callback Handler Functions
This section provides an overview of the FTXL 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 FTXL
Developer’s Kit → Documentation → API Reference