Document Outline

• Welcome
• Audience
• Related Documentation
  • Related Altera Product Documentation
  • Related devboards.de Product Documentation
• Introduction to FTXL
  • Overview
    • A LonWorks Device with a Single Processor Chip
    • A LonWorks Device with Two Processor Chips
    • Comparing Neuron-Hosted, ShortStack, and FTXL Devices
  • Requirements and Restrictions for FTXL
  • Development Tools for FTXL
  • FTXL Architecture
  • The FTXL Developer’s Kit
  • Overview of the FTXL Development Process
• Getting Started with FTXL
  • FTXL Developer’s Kit Overview
  • Installing the FTXL Developer’s Kit
    • Hardware Requirements
    • Software Requirements
    • DBC2C20 Software
    • Installing the FTXL Developer’s Kit
  • FTXL API Files
  • LonTalk Interface Developer
  • Example FTXL Applications
• Creating a Model File
  • Model File Overview
  • Defining the Device Interface
    • Defining the Interface for an FTXL Application
    • Defining a Functional Block
    • Defining a Network Variable
    • Defining a Configuration Property
    • Declaring a Message Tag
    • Defining a Resource File
  • Writing Acceptable Neuron C Code
    • Anonymous Top-Level Types
    • Legacy Neuron C Constructs
  • Using Authentication for Network Variables
    • Specifying the Authentication Key
    • How Authentication Works
  • Managing Memory
    • Address Table
    • Alias Table
    • Domain Table
    • Network Variable Configuration Table
  • Example Model files
    • Simple Network Variable Declarations
    • Network Variables Using Standard Types
    • Functional Blocks without Configuration Properties
    • Functional Blocks with Configuration Network Variables
    • Functional Blocks with Configuration Properties Implemented in a Configuration File
• Using the LonTalk Interface Developer Utility
  • Running the LonTalk Interface Developer
    • Specifying the Project File
    • Specifying the FTXL Transceiver Configuration
    • Specifying Service Pin Held Events
    • Configuring the FTXL LonTalk Protocol Stack
    • Configuring the Buffers
    • Configuring the Application
    • Configuring Support for Non-Volatile Data
    • Specifying the Device Program ID
    • Specifying the Model File
    • Specifying Neuron C Compiler Preferences
    • Specifying Code Generator Preferences
    • Compiling and Generating the Files
  • Using the LonTalk Interface Developer Files
    • Copied Files
    • LonNvTypes.h and LonCpTypes.h
    • FtxlDev.h
    • FtxlDev.c
    • project.xif and project.xfb
  • Using Types
    • Bit Field Members
    • Enumerations
    • Floating Point Variables
  • Network Variable and Configuration Property Declarations
  • Constant Configuration Properties
  • The Network Variable Table
    • Network Variable Attributes
  • The Message Tag Table
• Developing an FTXL Application
  • Overview of an FTXL Application
    • Using the FTXL LonTalk API
    • Callbacks and Events
    • Integrating the Application with an Operating System
    • Providing Persistent Storage for Non-Volatile Data
  • Tasks Performed by an FTXL Application
    • Initializing the FTXL Device
    • Periodically Calling the Event Pump
    • Sending a Network Variable Update
    • Receiving a Network Variable Update from the Network
    • Handling a Network Variable Poll Request from the Network
    • Handling Changes to Changeable-Type Network Variables
    • Handling Dynamic Network Variables
    • Communicating with Other Devices Using Application Messages
    • Handling Management Commands
    • Handling Local Network Management Tasks
    • Handling Reset Events
    • Querying the Error Log
  • Working with ECS Devices
  • Using Direct Memory Files
    • The DMF Memory Window
    • File Directory
  • Shutting Down the FTXL Device
• Working with the Nios II Development Environment
  • Development Tools
  • Using a Device Programmer for the FPGA Device
  • Setting up the Nios II IDE
    • Creating a New FTXL Application Project
    • Running the LonTalk Interface Developer Utility
    • Customizing the FTXL System Library
    • Specifying the Properties for the Application
  • Building the Application Image
  • Loading the Application Image into Persistent Memory
  • Running the Application
  • Debugging the Application
• LonTalk Interface Developer Command Line Usage
  • Overview
  • Command Usage
  • Command Switches
    • Specifying Buffers
• Model File Compiler Directives
  • Using Model File Compiler Directives
  • Acceptable Model File Compiler Directives
• Neuron C Syntax for the Model File
  • Functional Block Syntax
    • Keywords
    • Examples
  • Functional Block Properties Syntax
    • Keywords
    • Examples
  • Network Variable Syntax
    • Keywords
  • Configuration Property Syntax
    • Keywords
    • Declaring a Configuration Network Variable
    • Defining a Device Property List
  • Message Tag Syntax
    • Keywords
• FTXL LonTalk API
  • Introduction
  • The FTXL LonTalk API, Event Handler Functions, and Callback Handler Functions
    • FTXL LonTalk API Functions
    • FTXL Event Handler Functions
    • FTXL Callback Handler Functions
  • The FTXL Operating System Abstraction Layer
    • Managing Critical Sections
    • Managing Binary Semaphores
    • Managing Operating System Events
    • Managing System Timing
    • Managing Operating System Tasks
    • Debugging Operating System Functions
    • Configuring the Operating System
    • Configuring the Micrium µC/OS-II Operating System
      • MicroC/OS-II General Options
        • Event Flags
        • Mutex
        • Semaphores
        • Mailboxes
        • Queues
        • Memory Management
        • Miscellaneous
        • Task Management
        • Time Management
        • Timer Management
  • The FTXL Hardware Abstraction Layer
    • Managing the FTXL Transceiver
    • Managing the Service Pin
    • Managing Interrupts
• Determining Memory Usage for FTXL Applications
  • Overview
    • Total Memory Use
    • Memory Use for Transactions
    • Memory Use for Buffers
    • Memory for LonWorks Resources
    • Memory for Non-Volatile Data
    • Memory Usage Examples
• Downloading an FTXL Application Over the Network
  • Overview
  • Custom Application Download Protocol
  • Application Download Utility
  • Download Capability within the Application
• Example FTXL Applications
  • Overview of the Example Applications
    • Example Application Files
  • The Simple Example Application
    • Main Function
    • Application Task Function
    • Event Handler Function
    • Application-Specific Utility Functions
    • Callback Handler Function
    • Model File
  • The Dynamic Interface Example Application
    • Main Function
    • Application Task Function
    • Event Handler Functions
    • Application-Specific Utility Functions
    • Callback Handler Function
    • Model File
  • Setting up the Nios II IDE for the Example Applications
    • Creating a New FTXL Application Project
    • Running the LonTalk Interface Developer Utility
  • Building the Example Application Image
    • Building the Reference Design Hardware Image
    • Building the Example Software Image
  • Loading the Example Application Image into Flash
  • Running the Example Applications
    • Running the Simple Example
    • Running the Dynamic Interface Example
  • The Micrium Software License
• LonTalk Interface Developer Utility Error and Warning Messages
  • Introduction
  • Error Messages
  • Warning codes
  • Hint codes
• Glossary
• Index