Document Outline

• Table of Contents
• Welcome
• Audience
• Related Documentation
• 1 Introduction to LonTalk Stack
  • Overview
    • A LonWorks Device with a Single Processor Chip
    • A LonWorks Device with Two Processor Chips
      • ShortStack Developer’s Kit
      • LonTalk Stack Developer’s Kit
    • Comparing Neuron Hosted, ShortStack, and LonTalk Stack Devices
  • Requirements and Restrictions for LonTalk Stack
  • Development Tools for LonTalk Stack
  • LonTalk Stack Architecture
  • Overview of the LonTalk Stack Development Process
• 2 Getting Started with the LonTalk Stack Developer’s Kit
  • LonTalk Stack Overview
  • Installing the LonTalk Stack Developer’s Kit
    • Hardware Requirements
    • Software Requirements
    • Installing the LonTalk Stack Developer’s Kit
  • LonTalk Stack Files
  • LonTalk Interface Developer
  • Example LonTalk Stack Applications
• 3 Loading the Echelon Smart Transceiver or Neuron Chip
  • Loading Overview
  • Integrating a Custom Network Interface
    • Defining Incoming Layer 2 Packet Buffers
    • Functions
• 4 Designing the Serial I/O Hardware Interface
  • Overview of the Hardware Interface
    • Reliability
    • Serial Communication Lines
    • The RESET~ Pin
    • Selecting the Link Layer Bit Rate
    • Host Latency Considerations
  • SCI Interface
  • Performing an Initial Echelon Smart Transceiver Health Check
• 5 Creating a LonTalk Stack Serial MIP Driver
  • Overview of the Link Layer Protocol
    • Code Packet Layout
      • Type Code Values
      • Acknowledgment Rules
      • Sequence Number Cycling and Duplicate Detection
    • Supported MIP Command Set
    • Layer 2 / Layer 5 Modes
    • Product Query Network Management
  • Serial MIP Driver Example
  • Serial MIP Driver API
    • Structures
    • Functions
• 6 Creating a Model File
  • Model File Overview
  • Defining the Device Interface
    • Defining the Interface for a LonTalk Stack Application
      • Choosing the Data Type
    • Defining a Functional Block
      • Declaring a Functional Block
    • Defining a Network Variable
      • Defining a Changeable Type Network Variable
    • Defining a Configuration Property
      • Declaring a Configuration Property
      • Responding to Configuration Property Value Changes
      • Defining a Configuration Property Array
      • Sharing a Configuration Property
      • Inheriting a Configuration Property Type
    • Declaring a Message Tag
    • Defining a Resource File
      • Implementation Specific Scope Rules
  • 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
• 7 Using the LonTalk Interface Developer Utility
  • Running the LonTalk Interface Developer
    • Specifying the Project File
    • Specifying the Echelon Smart Transceiver or Neuron Chip Configuration
    • Configuring the LonTalk 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
• 8 Developing a LonTalk Stack Device Application
  • Overview of a LonTalk Stack Device Application
    • Using the LonTalk API
    • Callbacks and Events
    • Integrating the Application with an Operating System
    • Providing Persistent Storage for Non Volatile Data
      • Restoring Non Volatile Data
      • Writing Non Volatile Data
  • Tasks Performed by a LonTalk Stack Application
    • Initializing the LonTalk Stack 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
      • Validating a Type Change
      • Processing a Type Change
      • Processing a Size Change
      • Rejecting a Type Change
    • Handling Dynamic Network Variables
    • Communicating with Other Devices Using Application Messages
      • Sending an Application Message to the Network
      • Receiving an Application Message from the Network
    • 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 LonTalk Stack device
• 9 Developing an IP 852 Router Application
  • Developing an IP 852 Router Application
    • LtLogicalChannel
    • LtIp852Router
• 10 Porting a LonTalk Stack Application
  • Porting Overview
    • OSAL
    • LonLink Driver
    • Service LED
    • Socket Interfaces
    • LonTalkStack Source Files
    • Application Specific Files for LonTalk Stack Devices
  • Application Specific Code for IP 852 Interfaces
  • Selecting the Device Type
  • File System Requirements
• Appendix A LonTalk Interface Developer Command Line Usage
  • Overview
  • Command Usage
  • Command Switches
    • Specifying Buffers
• Appendix B Model File Compiler Directives
  • Using Model File Compiler Directives
  • Acceptable Model File Compiler Directives
• Appendix C Neuron C Syntax for the Model File
  • Functional Block Syntax
    • Keywords
    • Examples
  • Functional Block Properties Syntax
    • Keywords
    • Examples
  • Network Variable Syntax
    • Keywords
      • The Network Variable Modifier
      • The Network Variable Storage Class
      • The Network Variable Type
      • The Network Variable Connection Information
      • The Network Variable Initializer
      • The Network Variable Property List
  • Configuration Property Syntax
    • Keywords
      • The Configuration Property Type
      • The Configuration Property Modifiers
      • The Configuration Property Initializer
    • Declaring a Configuration Network Variable
    • Defining a Device Property List
  • Message Tag Syntax
    • Keywords
• Appendix D LonTalk API
  • Introduction
  • The LonTalk API, Event Handler Functions, and Callback Handler Functions
    • LonTalk API Functions
      • Commonly Used LonTalk API Functions
      • Other LonTalk API Functions
      • Application Messaging API Functions
      • Non Volatile Data API Functions
      • Extended API Functions
    • Event Handler Functions
      • Commonly Used Event Handler Functions
      • Dynamic Network Variable Event Handler Functions
      • Application Messaging Event Handler Functions
      • Non Volatile Data Event Handler Functions
    • LonTalk Stack Callback Handler Functions
      • Commonly Used Callback Handler Functions
      • Direct Memory Files Callback Handler Functions
      • Non Volatile Data Callback Handler Functions
  • The 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
• Appendix E Determining Memory Usage for LonTalk Stack Applications
  • Overview
    • Memory Use for Code
    • Memory Use for Transactions
    • Memory Use for Buffers
    • Memory for LonWorks Resources
    • Memory for Non Volatile Data
    • Memory Usage Examples for Data
• Appendix F Downloading a LonTalk Stack Application Over the Network
  • Overview
  • Custom Application Download Protocol
  • Application Download Utility
  • Download Capability within the Application
• Appendix G Example LonTalk Stack Applications
  • Overview of the Example Applications
    • Building the Example Applications
    • Running the Examples
      • Running the SimpleLtDevice Example
      • Running the SimpleIp852Device Example
      • Running the Ip852Router Example
  • SimpleLtDevice and SimpleIp852Device Example Application Details
    • Main Function
    • Application Task Function
    • Event Handler Function
    • Application Specific Utility Functions
    • Callback Handler Function
    • Model File
    • Extending the SimpleLtDevice and SimpleIp852 Examples
  • IP 852 Router Example Application Details
• Appendix H LonTalk Interface Developer Utility Error and Warning Messages
  • Introduction
  • Error Messages
  • Warning Codes
  • Hint Codes
• Appendix I Glossary