Welcome to NetBurner Version 3!

This documentation package details the capabilities of your NetBurner Development Software and Tools. If you are viewing this document from your development tools installation, the latest version is available at www.netburner.com. There is also a pdf version of this document at PDF Version

Note: Version 3 is used as a development platform on all ARM based devices, as well as MOD5441x, NANO54415 and SB800EX devices. If you have an earlier ColdFire based device please refer to the version 2 development tools.

Who Is This Guide For?

NetBurner devices come in two forms:

Devices pre-programmed with factory applications that can be used without any custom programming on the device itself. Serial to Ethernet devices are a good example of this.
If you wish to customize any device, we provide development tools that enable you to create custom applications.

This guide is intended for software developers to create custom applications to run on NetBurner devices. If you are using a device that does not require custom programming, please refer to that device's product page for documentation and any appropriate software utilities.

Recommended Starting Point for New Developers

Your NetBurner development system is pre-programmed with a factory application. If connected to a network with Internet access and a DHCP server, you can open a web browser, go to discover.netburner.com, and access you device immediately; both the application web page and configuration interface.

If you are connected directly, such as a laptop with a direct Ethernet connection, or on a network without a DHCP server and Internet access, please see the procedure below:

Configure the development kit device/hardware (if necessary) as described in the Quick Start Guide.
Connect both your development computer and your NetBurner device to a network with Internet access. Internet access is not required for development, but will make the initial configuration of the device easier.
If using a development kit with a USB interface, connect it from the development board to your computer. It will provide both power and a console/debug serial port. To view status and debug information, run a serial terminal program such as the included MTTTY, although any serial terminal application should work.
Your NetBurner device will be running a pre-programmed factory application. Open a web browser and type "discover.netburner.com" to identify your device. Links on the web page are available to go directly to the device's web page and configuration page.
Note
If you do not have an Internet connection, you can use a utility such as localdiscover. Please refer to the Device Discovery and Configuration section of this guide.
Refer to the NBEclipse Getting Started Guide section of this document to learn how to create, build and download applications. If you prefer to use command line tools, they are available as well.
Select one of the examples from the "\nburn\examples" folder. Create a project and download per the NBEclipse Guide.
Refer to the Programmers Guide and NetBurner API documents for additional information.

Note: NBEclipse provides auto-complete functionality by pressing cntl-space. This makes accessing the API functions much easier.

Documentation Overview

The NetBurner Application Programming Interface (API)

Description of the functions and capabilities in the NetBurner Library API. These functions include:

Real-Time Operating System
TCP/IP Stack
Peripherals, such as SPI, I2C, 1-Wire, UARTs, ADC, DAC, Timers, etc
Description of objects, classes and structures
Function error codes

Device Discovery and Configuration

How to locate your NetBurner device as well as configure system parameters.

The NBEclipse Getting Started Guide

Describes how to create projects and build applications.

Migration Guides

Information for those moving from tools revision 2.x to 3.x.

Example Programs

Well over 100 example programs on everything from web servers, TCP, UDP, Configuration to hardware peripherals. The examples are described in this guide, and located in the "\nburn\examples" folder of your installation.

Note: NBEclipse provides an easy example import feature when you create a new project.

Interesting Starting Examples:

ShowInterfaces: Displays all available network interface information on a web page and serial port
SimpleHtml: Minimal web server
IPADDR-IP Address: IPADDR object operations for assignment and display
PlatformSpecific folder: Unique peripherals for each hardware platform, such as timers, ADC, DAC and unique I2C and SPI peripherals
RTOS folder: How to use the various system RTOS capabilities

Programmers Guide

Textbook style guide on how to use the various features of your device and networking.

Device configuration and the Configuration Server
HTML Processing and Web Server
NetBurner Real-Time Operating System (NBRTOS)
Network Protocols such as TCP and UDP
Security using SSL/TLS
Embedded Flash File System (EFFS)

Platform References

The Platform References of this guide provide hardware information such as memory maps and device recovery should your application crash in a way that is not easily reset. Schematics for your NetBurner devices are located in the \nburn\docs\NetBurner\platform folder.

System Diagnostics

Information on how to enable and use built-in device diagnostics as well as customizing to add your own.

Utilities

Tools and Utilities that are run on a client computer, such as discover, configuration, and application updates.

Production and Deployment

Creating a great application and end product is just part of what needs to be done for a successful product. NetBurner provides deployment information and utilities that you can use in your production environment to program and configure modules in volume, as well as offer to your end customers.

Location of Original Factory Program

If at any time you wish to restore the original factory program that was running on your device, the pre-built application image is located in the \nburn\platform\<your platform>\original folder. For example, \nburn\platform\MODM7AE70\original. This path assumes a default install to a folder named nburn.

Experienced NetBurner Customers

A significant change you will notice is how the device configuration is accomplished using a web interface. Please refer to the Migration Guide for a detailed description of the differences between release version 3 and previous releases.