NetBurner 3.1
What Is Stored

What Is Stored

By default, the configuration server holds the module's boot settings and all of the network interface information.

Config

Config is the top level object that contains everything else. Underneath are the AppData and Sys settings. There is also a Version field that is updated automatically when new settings are saved. There is also a Reboot value that, when checked, will force the module to reboot every time the configuration record is updated.

AppData

Everything under the AppData settings will be defined by the user application. There are several configuration objects that can be used defined by the NetBurner system libraries. More information on how to use these can be found in the BasicConfig NetBurner Basic Config Demo.

Sys Settings

Inside the Sys settings, you will find everything for the module itself. Under this top heading you can determine which application is running on the device, as well as what kind of platform it is.

Boot Settings

The following settings pertain to how the module boots.

  • Abort: This specifies the keys that needs to be pressed in order to break out of the normal boot sequence. This prevents anything after the init() function from running in UserMain(). This will load the serial configuration server, enable the config web interface and effectively stops the user's application from running. The default value for this is "A".
  • BootBaud: The baud rate that the BootUart will use.
  • BootDelay: How long the application will delay to wait for the Abort characters before continuing.
  • BootQuiet: Whether or not to display the boot output data on the BootUart.
  • BootUart: The UART used by the system to display output related to the device booting.
  • Password: When this is set along with User, both will be required when making changes to the congif settings, or when updating the user application.
  • Serial Config: There are four different options for this, which are outlined below.
    • DuringBoot: This will make the serial configuration server available during the boot process by using the Abort characters set above.
    • AlwaysEnabled: This will set the serial configuration server to always be available through the BootUart. Note that if this is selected, attempting to receive other serial input through the BootUart (such as debug commands, etc.) has the potential to break the configuration record.
    • PauseAfterBoot: This option will cause the boot process to pause indefinitely before the user's application is launched (specifically after init() is called), and will cause the serial configuration server to be enabled over the BootUart. The user's application can be resumed by typing boot.
    • Disabled: This prevents the serial config server from being enabled, and does not pause during the boot process, which stops the user from being able to enter the Abort character sequence.
  • User: When this is set along with Password, it must be entered when trying to make changes to the configuration record's values or uploading a new application to the module.

NetIf Settings

The settings underneath NetIf deal with the different network interfaces available on the module. This will include all of the Ethernet ports, as well as any Wifi ports available. What is actually listed underneath these interfaces will depend on the interface itself, but we have a summary of common settings below.

Ethernet Settings

Underneath the Ethernet settings tab, you will find the following:

  • DeviceName: A name given to the interface, which is used to register for DDNS and NetBIOS.
  • DhcpDiscoverSec: How long to wait after boot before sending a DHCP Discover message.
  • DiscoveryReportInterval: How often a device should report itself to the discovery server.
  • DiscoveryReportUrl: The location of the discovery server. By default, this points to NetBurner's discovery server. However, if desired, this field can changed to be blank so that the device does not report itself. It can also be set to another URL if the user wishes to run their own discovery server.
  • MAC: The MAC address of the interface.

IPv4 Settings

The following outlines settings specific to IPv4.

  • ActiveAddr: The current IPv4 IP address in use.
  • ActiveDNS1: The current IPv4 DNS server (1) in use.
  • ActiveDNS2: The current IPv4 DNS server (2) in use.
  • ActiveGate: The current IPv4 gateway in use.
  • ActiveMask: The current IPv4 mask in use.
  • AutoIPAddr: The current IPv4 auto address in use.
  • AutoIPEn:
  • Mode: Specifies which method to use to acquire IPv4 active values. The options are as follows:
    • DHCP: Use the values provided by the DHCP server.
    • DHCP w Fallback: Try to get values from the DHCP server, and use the static values as a backup.
    • Static: Use the static values defined in the interface's config record.
    • Disabled: Disable the interface.
  • StaticAddr: The manually configured IPv4 IP address.
  • StaticDNS1: The manually configured IPv4 DNS(1).
  • StaticDNS2: The manually configured IPv4 DNS(2).
  • StaticGate: The manually configured IPv4 gateway.
  • StaticMask: The manually configured IPv4 mask.

IPv6 Settings

The following outlines settings specific to IPv6.

  • ActiveAddr: Lists the current IPv6 addresses in use.
  • ActiveDNS: Lists the current IPv6 DNS servers in use.
  • ActiveRoutes: Lists the current IPv6 routes in use.
  • Mode: Specifies which method to use to acquire IPv4 active values. The options are as follows:
    • DHCP: Use the values provided by the DHCP server.
    • DHCP w Fallback: Try to get values from the DHCP server, and use the static values as a backup.
    • Static: Use the static values defined in the interface's config record.
    • Disabled: Disable the interface.
  • StaticAddr: The manually configured IPv6 IP address.
  • StaticDNS1: The manually configured IPv6 DNS(1).
  • StaticDNS2: The manually configured IPv6 DNS(2).