NetBurner 3.3.3
PDF Version
Production & Deployment

Production Releases and Customer Deployment

Once product development is complete, there are a number of choices for device location and configuration:

  • How to find the device on a network
  • How to program the application into devices in production
  • How to configure devices in production
  • How Customers can change configuration settings

    Note
    Utility source code is located in \nburn\pctools, and built versions are in \nburn\pcbin. You may modify or rebrand these utilities and distribute to your end customers, so long as they are only run with NetBurner target hardware.


Finding a Device on a Network

A device can be located the following ways:

  • If the device and computer have Internet access, open a web browser and go to discover.netburner.com
  • Use the localdiscover utility. This is a multi-platform utility written in Golang for windows, osx and linux. The compiled version can be distributed to your customers, but not the Golang source code.
  • The Python find utility, located in \nburn\pctools\find.
  • Use the debug/console serial port



Application Programming

Applications are programmed into flash memory by sending an application image to the device's configuration server, located at it's IP address on port 20034. This can be done in a number of ways, all of which are multi-platform (win, osx, linux):

  • A web browser from the device's configuration server web page
  • The nbupdate command-line utility
  • The WGET command-line utility
  • A serial port using the serial command processor



Configuration Web Page

To send a file from a web browser, enter the URL of your device. The URL format is "<ip address>:<port number>", such as: "10.1.1.100:20034". Once at the web page, browse for the application image file and select "Update".

nbupdate Utility

nbupdate is a multi-platform command-line utility written by NetBurner. The format is: nbupdate <filename> <ip address>. For example, nbupdate myApp.bin 10.1.1.196, or nbupdate myApp.s19 10.1.1.196.
If the environment variable DEVIP is set the IP address parameter is not required. For example, SET DEVIP=10.1.1.196. Now you can call nbupdate with only the application file name. To determine the current setting of DEVIP, type "SET DEVIP".

wget Utility

WGET is an industry standard utility that allows you to download files over TCP/IP protocols FTP, HTTP and HTTPS. If you are using OSX or Linux, WGET is usually already installed (or can using your package manager). Windows users will need to install it, please refer to https://www.gnu.org/software/wget/.

The WGET utility can be used for a number of things:

  • Updating the device application image
  • Retrieving device configuration information in JASON
  • Updating device configuration information in JASON
    In the examples below we use an example device IP address of 10.1.1.60, and an application name of myApplication.bin.

Program an Application

To program a new application into the device:
wget --post-file=myApplication.bin 10.1.1.60:20034/appupdate.html

All updates are processed by the Configuration Server running on the device. The --post-file specifies a POST operation is to be performed. The IP address and configuration port number are next, along with the server post destination that will always be appupdate.html.

If using authentication with a username of "user", and password of "pass":
wget --auth-no-challenge --user=user --password=pass --post-file=myApplication.bin 10.1.1.60:20034/appupdate.html


Read The Configuration

Read the current configuration into a file named config.txt: wget 10.1.1.60:20034/Config.
In this case the destination is Config, rather than appupdate.html.
If you would like to specify a directory to store the file, use the -P option: wget 10.1.1.60:20034/Config -P \myDir

Program New Configuration Settings

The easiest way to do this is to first read the configuration and save to a file so you have a template to work with, then edit the settings you need. Then post the configuration file to each new device:
wget --post-file=newconfig 10.1.1.60:20034/Config



Customer Configuration

Once deployed, your customers can modify the configuration by:

  • Using the interactive web interface at 10.1.1.60:20034. Note that you can create your own web interface to override the default NetBurner interface, and use your custom brand.
  • If connected to the Internet, a web broswer at: discover.netburner.com, which provides a link to the device configuration page and also the device's main web page on port 80.
  • The NetBurner localdiscover utility, which provides a link to the device configuration page, and also the device's main web page on port 80.
  • Using WGET
  • Your application can provide the means to change configuration