Integrator Resources

The official home for NAI Support

Not sure where to start? Try Quick Start Guide or ask a question below!

Toggle Components with Visual Button
JavaScript Form Processing

First Time User Guide

First Time User Guide

This guide will review the contents of the NAI documentation site and discuss the best path of navigation to gain a better understanding of your NAI hardware and jumpstart development.

Site Map

The site has eight main categories:

Quick Start Guides

The Quick Start Guides section contains guides aimed at expediting getting started. This is the recommended place for any user to start and will ensure you make full use of the suite of tools NAI provides.

Manuals

The Manuals section contains manuals for all the latest NAI products. NAI manuals contain information on the theory of operation, register maps, pin mappings, and much more.

API

The API section provides a link to the web based API documentation for the NAI Software Support Kit (SSK). There is also a link to download the SSK. In the API NAI uses custom types. It also provides guides with code snippets for using many of our motherboard features, such as Interrupts and Watchdog Timers. Information about the parameters for these custom types can be found both in the header files and in tables with explanations in the API section.

FAQ

The FAQ section covers frequently asked questions about setting up and using NAI products. These questions will either have their own dedicated response guides, or provide links to sections of guides in other parts of the site.

Note
Due to the large amount of content in the FAQ section it is recommended to use the search feature.
Technical Standards

This section includes a list of technical standards for which different NAI products are aligned or in compliance with. Please contact NAI for more information regarding product compliance and testing.

Sample Applications

The Sample Applications section provides in-depth guides for every sample application included in the NAI Software Support Kit. Each guide walks through the application’s API call sequences step by step — from board connection and module selection through configuration, data transfer, and cleanup — with annotated code snippets you can lift directly into your own project. Guides also include troubleshooting tables covering common errors and their resolutions, platform-specific notes for Petalinux, VxWorks, and DEOS, and a collapsible block containing the complete source file for reference. The section is organized into SSK 1.x and SSK 2.x tabs, so you can find the guides that match the version of the SSK you are developing against.

Power Supplies

Power Supplies contains all resources relating to NAI power supplies. This documentation includes everything pertaining to how to setup, configure, and use NAI power supplies.

NAI has a variety of resources that have been created to simplify getting started both before and after the receipt of hardware. These manuals and guides inform each step from unboxing and cabling your unit to deploying your application. The following section is a breakdown of the general getting started process accompanied by the order of resources that will accelerate your time to mission.

Note
If you do not have your NAI hardware yet it is still possible to begin development. NAI libraries are designed to work identically with any OS and processor combination that we support, so the resources below will instruct you on how to begin developing applications using our Software Support Kit that can be deployed on your hardware. Simply write your code in your favorite environment and later add the source files to the target environment for whichever board you choose, such as the Xilinx SDK or Workbench.

Getting Started with Hardware

  • Manuals - The first goal after choosing an NAI product is likely to gain a better understanding of its capabilities, specifications, and how you will be interacting with it. NAI’s product manuals contain a general introduction, several categories of specifications, and a detailed memory map which depicts exactly where and how you can exercise all of the product’s functionality.

  • Connectors and Cabling Info - Once you have received your NAI board(s) and modules, the first thing that you will need to do is get everything connected. Our cabling guide includes schematics and descriptions for connections that will be necessary to interface with your unit, including power, ethernet & IO, and breakout boards for wiring up module pins during development.

Getting Started with Software

  • Downloads - Now that your hardware is connected, you can make use of NAI’s software resources to communicate with your board and begin exercising the modules. The downloads page includes several versions of our Software Support Kit for various operating systems and architectures as well as our Embedded Soft Panel, which will be your primary method of testing with your function modules before developing an application.

Note
NAI currently offers both a 1.x and 2.x version of our Software Support Kit, depending on which board and operating system you are using. Do not download the SSK from this page if a version of the SSK has already been delivered to you alongside your hardware.
  • Embedded Soft Panel 2 Quick Start Guide - ESP 2 has several uses throughout the development process, including a Demo Mode to be used before receipt of hardware, soft panel tabs to interact with nearly any module family, an API Logger to demonstrate which NAI API calls are used for any changes that are made, and more. Consult this guide to help get connected to your hardware and learn more about how you can use your function modules.

  • Software Development Guide 1.x or Software Development Guide 2.x - Now that you are more familiar with how to use your board and function modules (and with the API Logger as a jumping-off point), you can begin the process of developing an application that targets them. If you are not sure which guide and SSK you will be using, check each one for a tab of instructions labeled with the operating system that you are targeting. These guides cover setting up your development environment, building our libraries and sample applications, and how to create and deploy your own application from scratch using the NAI libraries.

  • Sample Applications - The sample application guides are your primary reference when writing code against the NAI API. Each guide walks through a real sample application function by function, showing exactly which naibrd_*() calls to make and in what order — covering configuration, data reading, interrupt setup, communication transfers, and diagnostics. Code snippets are extracted from the actual source so you can copy them directly into your own project. Every guide also includes a troubleshooting table for common errors, platform notes where behavior differs across Petalinux, VxWorks, and DEOS, and the complete source file in a collapsible block. Start with the "Using NAI SSK Sample Applications" overview at the top of the SSK 1.x or 2.x tab for a walkthrough of the board connection menu and an introduction to the guide categories.

  • Connecting to Boards - As previously mentioned, NAI sample applications use a menu-based approach for opening a handle to your board(s). When writing an application intended for deployment, you will most likely require a connection process that does not rely on user input. This guide lists all of the different types of board access that may be used, along with the necessary API calls and configuration that are required to complete this process automatically.

  • API - NAI’s API Library provides every API call available to the user for each module family along with a description of its function, its parameters, and variable types. These APIs are identical for every target architecture and OS, and have many custom types that are defined in the naibrd library source. The API tab also includes additional guides for specific functionality and use cases that may be helpful once you have entered the development process.

Some NAI products may have a special development procedure that is not covered/supported in the general guides listed above. In this case, please locate any additional documentation in the software package included in your hardware delivery or contact NAI for support.

Help Bot

X