Document Outline

• Welcome
• Audience
• Related Documentation
• Typographic Conventions for Syntax
• 1. Overview
  • What Is Neuron C?
    • Comparing Neuron C Version 2 to Version 1
  • Unique Aspects of Neuron C
    • Neuron C Integer Constants
    • Neuron C Variables
      • Neuron C Variable Types
      • Neuron C Storage Classes
      • Variable Initialization
      • Neuron C Declarations
    • Network Variables, SNVTs, and UNVTs
    • Configuration Properties
    • Functional Blocks and Functional Profiles
      • Data-Driven Compared with Command-Driven Protocols
    • Event-Driven Scheduling or Polled Scheduling
    • Low-Level Messaging
    • I/O Devices
  • Neuron-Hosted and Host-Based Compilation
  • Differences between Neuron C and ANSI C
• 2. Focusing on a Single Device
  • What Happens on a Single Device?
  • The Scheduler
    • When Clauses
    • When Statement
    • Types of Events Used in When Clauses
    • Predefined Events
      • Event Processing
      • Reset Event
    • User-Defined Events
    • Scheduling of When Clauses
    • Priority When Clauses
    • Interrupts
    • Function Prototypes
  • Timers
    • Declaring Timers
      • Examples
    • The timer_expires Event
  • Input/Output
    • I/O Object Types
    • Declaring I/O Objects in Neuron C
  • Device Self-Documentation
  • Examples
    • Example 1: Thermostat Interface
    • Example 2: Simple Light Dimmer Interface
    • Example 3: Seven-Segment LED Display Interface
  • Input Clock Frequency and Timer Accuracy
    • Fixed Timers
    • Scaled Timers and I/O Objects
    • Calculating Accuracy for Software Timers
      • Accuracy of Millisecond Timers
        • With a 10 MHz Input Clock
        • With Other Clock Speeds
        • Repeating Timers
      • Accuracy of Second Timers
    • Delay Functions
    • EEPROM Write Timer
• 3. How Devices Communicate Using Network Variables
  • Major Topics
  • Overview
    • Behavior of Writer and Reader Devices
    • When Updates Occur
  • Declaring Network Variables
    • Examples of Network Variable Declarations
  • Connecting Network Variables
    • Use of the is_bound( ) Function
  • Network Variable Events
    • The nv_update_occurs Event
    • The nv_update_succeeds and nv_update_fails Events
    • The nv_update_completes Event
  • Synchronous Network Variables
    • Declaring Synchronous Network Variables
    • Synchronous vs. Nonsynchronous Network Variables
    • Updating Synchronous Network Variables
      • Preemption Mode
  • Processing Completion Events for Network Variables
    • Partial Completion Event Testing
    • Comprehensive Completion Event Testing
    • Tradeoffs
  • Polling Network Variables
    • Declaring an Input Network Variable as Polled
    • Declaring an Output Network Variable as Polled
  • Explicit Propagation of Network Variables
  • Initial Value Updates for Input Network Variables
  • Monitoring Network Variables
  • Authentication
    • Setting Up Devices to Use Authentication
      • Declaring Authenticated Variables and Messages
      • Specifying the Authentication Key
    • How Authentication Works
  • Changeable-Type Network Variables
    • Processing Changes to a SCPTnvType CP
      • Validating a Type Change
      • Processing a Type Change
      • Processing a Size Change
      • Rejecting a Type Change
    • Changeable-Type Example
• 4. Using Configuration Properties to Configure Device Behavior
  • Overview
  • Declaring Configuration Properties
    • Declaration of Configuration Network Variables
    • Declaring Configuration Properties within Files
  • Instantiation of Configuration Properties
    • Device Property Lists
    • Network Variable Property Lists
  • Accessing Property Values from a Program
  • Advanced Configuration Property Features
    • Configuration Properties Applying to Arrays
    • Initialization of Configuration Properties at Instantiation
    • Sharing of Configuration Properties
    • Configuration Property Sharing Rules
    • Type-Inheriting Configuration Properties
      • Type-Inheriting Configuration Properties for Network Variables of Changeable Type
• 5. Using Functional Blocks to Implement a Device Interface
  • Overview
  • Functional Block Declarations
    • Functional Block Property Lists
    • Shared Functional Block Properties
  • Scope Rules
  • Accessing Members and Properties of a Functional Block from a Program
  • Accessing Members and Properties of a Functional Block from a Network Tool
  • The Director Function
  • Sharing of Configuration Properties
• 6. How Devices Communicate Using Application Messages
  • Introduction to Application Messages
  • Layers of Neuron Software
  • Implicit Messages: Network Variables
  • Application Messages
  • Constructing a Message
    • The msg_out Object Definition
      • Message Tags
      • Message Codes
    • Block Transfers of Data
  • Sending a Message
  • Receiving a Message
    • The msg_arrives Event
    • The msg_receive( ) Function
    • Format of an Incoming Message
    • Importance of a Default When Clause
  • Application Message Examples
    • Lamp Program
    • Switch Program
    • Connecting Message Tags
  • Explicit Addressing
  • Sending a Message with the Acknowledged Service
    • Message Completion Events
      • Processing Completion Events for Messages
  • Preemption Mode and Messages
  • Asynchronous and Direct Event Processing
  • Using the Request/Response Mechanism
    • Constructing a Response
    • Sending a Response
    • Receiving a Response
      • The resp_arrives Event
      • The resp_receive( ) Function
      • Format of a Response
    • Request/Response Examples
    • Comparison of resp_arrives and msg_succeeds
    • Idempotent Versus Non-Idempotent Requests
  • Application Buffers
    • Allocating Application Buffers
• 7. Additional Features
  • The Scheduler
  • Scheduler Reset Mechanism
    • Scheduler Example
  • Bypass Mode
    • The post_events( ) Function
  • Watchdog Timer
  • Additional Predefined Events
    • Going Offline in Bypass Mode
    • Wink Event
  • Interrupts
    • Interrupt Sources
      • I/O Interrupts
      • Timer/Counter Interrupts
      • Periodic System Timer Interrupts
    • Defining an Interrupt Task
      • Defining an I/O Interrupt Task
      • Defining a Timer/Counter Interrupt Task
      • Defining a System Timer Interrupt Task
    • Controlling Interrupts
    • Sharing Data with an Interrupt Task
    • Interrupt Latency
    • Debugging Interrupt Tasks
    • Restrictions for Using Interrupts
  • Sleep Mode
    • Flushing the Neuron Chip or Smart Transceiver
      • The flush( ) and flush_cancel( ) Functions
      • flush_completes Event
    • Putting the Device to Sleep
    • Forced Sleep
  • Error Handling
    • Resetting the Device
    • Restarting the Application
    • Taking an Application Offline
    • Disabling a Functional Block
    • Changing Functional Block Status
    • Logging Application Errors
    • System Errors
  • Access to Device Status and Statistics
• 8. Memory Management
  • Memory Use
    • RAM Use
    • EEPROM Use
  • Using Neuron Chip Memory
    • Chips with Off-Chip Memory
    • Chips without Off-Chip Memory
    • Memory Regions
    • Memory Areas
    • Default Memory Usage
    • Controlling Non-Default Memory Usage
      • eeprom Keyword (for Functions and Data Declarations)
      • far Keyword (for Data Declarations)
      • offchip Keyword (for Functions and Data Declarations)
      • onchip Keyword (for Functions and Data Declarations)
      • ram Keyword (for Functions)
      • uninit Keyword (for Data Declarations)
    • Compiler Directives
    • When the Program Is Relinked
    • Use of Flash Memory
      • Use of Flash Memory for Series 3100 Chips
      • Use of Flash Memory for Series 5000 Chips
    • The eeprom_memcpy( ) Function
  • Reallocating On-Chip EEPROM
    • Address Table
    • Alias Table
    • Domain Table
  • Allocating Buffers
    • Buffer Size
      • Application Buffer Size
      • Network Buffer Size
      • Errors
    • Buffer Counts
    • Compiler Directives for Buffer Allocation
      • Outgoing Application Buffers
      • Outgoing Network Buffers
      • Incoming Network Buffers
      • Incoming Application Buffers
      • Number of Receive Transactions
  • Usage Tip for Memory-Mapped I/O
  • What to Try When a Program Does Not Fit on a Neuron Chip
    • Reduce the Size of the Configuration Property Template File
    • Reduce the Number of Address Table Entries
    • Remove Self-Identification Data if Not Needed
    • Remove Network Variable Names if Not Needed
    • Declare Constant Data Properly
    • Use Efficient Constant Values
    • Take Advantage of Neuron Firmware Default Initialization Actions
    • Use Neuron C Utility Functions Effectively
    • Be Aware of Library Usage
    • Use More Efficient Data Types
    • Observe Declaration Order
    • Use the Optional fastaccess Feature
    • Eliminate Common Sub-Expressions
    • Use Function Calls Liberally
    • Use the Alternate Initialization Sequence
    • Use C Operators Effectively
    • Use Neuron C Extensions Effectively
  • Using the Link Map
• A. Neuron C Tools Stand-Alone Use
  • Stand-Alone Tools
    • Common Stand-Alone Tool Use
      • Common Syntax
      • Common Set of Basic Commands
  • Command Switches for Stand-alone Tools
    • Neuron C Compiler
    • Neuron Assembler
    • Neuron Linker
    • Neuron Exporter
    • Neuron Librarian
• B. Neuron C Function Libraries
  • Definitions
  • NodeBuilder Support for Libraries
  • Tradeoffs, Advantages, and Disadvantages
    • Advantages of a Library
    • Disadvantages of a Library
  • Library Construction Using the Librarian
  • Performing Neuron C Functions from Libraries
• C. Neuron C Custom System Images
  • Definitions
  • NodeBuilder Use of Custom System Images
  • Tradeoffs, Advantages, and Disadvantages
    • Advantages of a Custom System Image
    • Disadvantages of a Custom System Image
  • Constructing a Custom System Image
  • Providing a Large RAM Space
  • Performing Neuron C Functions
• D. Neuron C Language Implementation Characteristics
  • Neuron C Language Implementation Characteristics
    • Translation (J.3.1)
    • Environment (J.3.2)
    • Identifiers (J.3.3)
      • Identifiers (F.3.3 of ANSI C Standard)
    • Characters (J.3.4)
      • Characters (F.3.4 of ANSI C Standard)
    • Integers (J.3.5)
      • Integers (F.3.5 of ANSI C Standard)
    • Floating Point (J.3.6)
    • Arrays and Pointers (J.3.7)
      • Arrays and Pointers (F.3.7 of ANSI C Standard)
    • Hints (J.3.8)
    • Structures, Unions, Enumerations, and Bit-Fields (J.3.9)
      • Structures, Unions, Enumerations, and Bit-Fields (F.3.9 of ANSI C Standard)
    • Qualifiers (J.3.10)
      • Declarators (F.3.11 of ANSI C Standard)
      • Statements (F.3.12 of ANSI C Standard)
    • Preprocessing Directives (J.3.11)
    • Library Functions (J.3.12)
• Index