NetBurner 3.3.2b
PDF Version
NetBurner 3.3.2b Documentation

Welcome to NetBurner Version 3! This documentation package details the capabilities of your NetBurner Development Software and Tools. Please refer to the overview described below. The recommended starting points at the bottom of this page will help you get your system up and running quickly.
There is also a pdf version of this document: PDF Version

The NBEclipse Getting Started Guide

Describes how to create projects and build applications.

Migration Guides

Migration guides for those moving from tools revision 2.x.

The NetBurner Application Programming Interface (API)

Description of the classes, structures and function calls provided in the NetBurner libraries.

Example Programs

Examples demonstrating the use of the hardware and software. Source code is located in "\nburn\examples"

Programmers Guides

Programmers Guides detail how to use various system capabilities

  • 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.

Utilities

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

Production and Deployment

Utilities that you can use in your production environment to program and configure modules in volume

Recommended Starting Point for New Developers

  • Configure the development kit hardware 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 initial the configuration of the device easier.
  • Connect the USB interface 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 for Windows.
  • Your NetBurner device should 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 it's configuration page. Note: if you are unable to see your device, but know it's IP address, you can type the IP address into your browser manually. You can also try the IPSetup utility identify an IP address.
  • Refer to the NBEclipse Getting Started Guide section of this document to learn how to create, build and download applications.
  • Create a new project for the Factory Application example for your platform. The example will be located in the "\nburn\examples\PlatformSpecific" directory. You should be able to easily modify and experiment with the example code.
  • Refer to the Programmers Guide and NetBurner API documents for additional information.

Additional Suggested Starting Examples

Over 100 examples are located in the \nburn\examples folder:

  • 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: Unique peripherals for each hardware platform, such as timers, ADC, DAC and unique I2C and SPI peripherals
  • RTOS: How to use the various system RTOS capabilities

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.

Useful Topics:
Device Discovery and Configuration
NBEclipse
Command Line Tools
Migration Guides
Programmers Guide
Platform References
PC Tools and Utilities
Production & Deployment