NetBurner 3.5.8
PDF Version
NetBurner Library API
Here is a list of all topics with brief descriptions:
 AES - Advanced Encryption Standard
 ARP - Address Resolution ProtocolAddress Resolution Protocol implementation and cache management
 AT CommandsFunctions for serial modem AT commands
 Base64
 Buffers - System Buffer Pool
  Buffer Ownership States
  Buffer State Flags
 CAN
  MOD5441x, NANO54415, SB800EX
  MODM7AE70
   MCAN Driver Internals
 Command Processor
  Command Processor Disconnect Causes
  Command Processor Listen Channels
  Command Processor Response Codes
 Configuration SystemConfiguration System Variables
  Configuration Network Objects
  Configuration Server
  Configuration Time Objects
  Configuration VariablesConfiguration System Variables
   Configuration Variable Flags
 Constants (constants.h)NetBurner System Constants
 DHCP
  DHCP Server
  DHCPv4 Client
   DHCP State
  DHCPv6 Client
 DNS - Domain Name System
  DNS Record Types
  DNS Return Codes
 Device Interrupts
 Diagnostics (DIAG)
 EFFS - Embedded Flash File System
  EFFS-STD Flash File SystemThe Standard Embedded Flash File System, EFFS-STD
#include< fsf.h>
   STD File System Seek Codes
  FAT File SystemThe FAT32 Embedded Flash File System for Flash Cards, EFFS-FAT
#include< api_f.h>
   FAT File System Seek Codes
 Ethernet
  Ethernet I/O Counters
 Extra File Descriptors
 FTP Client
 FTP Server
  FTP Server CallbackCore functions for running a FTP Server on a NetBurner device
   FTP Server Core Return Codes
   FTP Server File Return Codes
  FTP Server with EFFS-FAT
  FTP Server with EFFS-STD
 File Descriptor Printf - fdprintfPrintf-style formatted output to file descriptors
 GDB Stub (Remote Debugging)GDB Stub functions
 GPIO & Pin Configuration
  MOD5441x, NANO54415, SB800EX (PinIO)The NetBurner GPIO PinIO class driver for the MOD5441X family (MOD54415, MOD54417, NANO54415, SB800EX)
  MODM7AE70, SBE70LC (PinIO)The NetBurner GPIO PinIO class driver for the MODM7AE70 and SBE70LC (SAME70)
  MODRT1171 (PinIO)The NetBurner GPIO PinIO class driver for the MODRT1171 (i.MX RT11xx)
  Pin Function Constants
   MOD5441x
   MODM7AE70
   MODRT1171
   NANO54415
   SB800EX
   SBE70LC
   SOMRT1061
  SOMRT1061 (PinIO)The NetBurner GPIO PinIO class driver for the SOMRT1061 (i.MX RT10xx)
 HAL - Hardware Abstraction Layer
 HTTP and HTML Functions
 I2C
  Bit Bang I2C (GPIO)Software I2C master driven directly from a pair of GPIO pins
  Legacy API MOD5441x, NANO54415, SB800EX
  Wire InterfaceArduino-compatible TwoWire I2C controller/target interface
   Wire Result Codes
 IOSYS - I/O System
 IPCore IP layer definitions, structures, and functions for IPv4/IPv6 networking
  IPADDR4 Class
  IPADDR6 Class
 IPv6 Interface Management
  IPv6 DNS
  IPv6 Data Structures
  IPv6 Frame Processing
  IPv6 Multicast Constants
  IPv6 Neighbor Discovery
  IPv6 Routing
 Initialization - System Initialization Functions
 JSON LexerNetBurner's JSON library. See more details and examples below
 MQTTNetBurner MQTT Library.
See the MQTT namespace for details.
#include <mqtt/mqtt.h>
 Multicast
 Multihome and VLAN
 NBRTOS Real Time Operating System
  NBRTOS Error Codes
  NBRTOS Task Flags
  NBRTOS Task Status
 NBString - NetBurner String Class
 Network InterfacesNetwork Interface Functions
  IPADDR4 FunctionsNetwork Interface functions with IPADDR4 return types
  Low Level Processing (NetDoRx)Callback functions to add custom Ethernet handlers and pass Ethernet frames at the bottom of the TCP/IP stack
 PEM Conversion UtilitiesPrivacy-Enhanced Mail (PEM) format conversion and endianness utilities
  PEM Data Type IdentifiersReturn values indicating the type of PEM data that was converted
  PEM Format FootersStandard PEM footer markers for different data types
  PEM Format HeadersStandard PEM header markers for different data types
 POP3 - Post Office Protocol
  POP3 Return Codes
 PPP - Point to Point Protocol
  PPP Connection State
  PPP Return Codes
 Platform Specific API
  MOD5441x, NANO54415, SB800EX
   Interrupt Macro: MOD5441x,NANO54415, SB800EX
    ColdFire Exception and Interrupt VectorsVector offset definitions for predefined ColdFire exception and interrupt vectors
  MODM7AE70, SBE70LC
   EBI - External Bus Interface
  MODRT1171
   SEMCSmart External Memory Controller functions (SOMRT1061, MODRT1171)
  SOMRT1061
   SEMCSmart External Memory Controller functions (SOMRT1061, MODRT1171)
   USB CDC ACM Device DriverUSB CDC Device Class - Abstract Control Model Implementation
 SMTP - Send Email
  MIME Content Types
  SMTP Error Codes
  SSL SMTP Functions
 SNMP
  Read/write callback function signaturesFunction typedefs your callbacks must match. The shape of the callback selects the dispatcher overload automatically
  Registering SNMP table rows and cellsRegister per-row read callbacks and per-cell write callbacks for tabular MIB objects, and remove rows at runtime
  Registering scalar (single-value) MIB variablesBind one C getter/setter to one OID that ends in .0
  SMI type aliases, ASN.1 tags, and SET return codesThe vocabulary used when registering a variable: pick a SMI type for the value, pass the matching ASN_type* tag, return SNMP_SET_OK / SNMP_SET_FAIL from setters
 SOCKS
  SOCKS Error Codes
 SPI
  MOD5441x, NANO54415, SB800EX
   DSPIDSPI for MCF5441x (MOD5441x, NANO, SB800EX)
   QSPI 2.x compatibility layerQSPI for MCF5441x (MOD5441x, NANO, SB800EX)
    QSPI state
  MODM7AE70, SBE70LC
   DSPIDSPI for ARM SAME70 (MODM7AE70, SBE70LC)
   QuadSPIQSPI for SAME70 (MODM7AE70, SBE70LC)
   USARTUSART for SAME70 (MODM7AE70, SBE70LC)
    UsartModuleNumberUSART Peripheral Module
  MODRT1171 (DSPI)DSPI for ARM MIMX11xx (MODRT1171)
   DspiModuleNumberDSPI Peripheral Module
   DspiStateDSPI Bus State
  SOMRT1061 (DSPI)DSPI for ARM MIMX10xx (SOMRT1061)
   DspiModuleNumberDSPI Peripheral Module
   DspiStateDSPI Bus State
 SSH
  SSH Error Codes
 SSL/TLSThe NetBurner SSL/TLS Library. See SSL/TLS and Certificates and examples in the examples/SSL folder
  ACME Certificate GenerationRequest valid public certificates from an ACME certificate authority for devices with a public IP and DNS
  Onboard Self-Signed Certificate GenerationSee On-board Cert Generation - Simple and other examples in the examples/SSL folder
  SSL Error Codes
 Serial Interfaces
  Serial ISR Callbacks
  Serial Port Error Codes
  UART Error Register Bits
 Shutdown Notifications
  ShutdownReasonsShutdown Reasons #include< ShutDownNotifications.h>


 Signed Application Update
  NBUpdate Function Return Values
 Stream Update
  Stream Update Return Values
  Stream Update Timeouts
 Synchronous Audio Interface (SOMRT1061)
  SAI Callback Types
  SAI Configuration Enumerations
  SAI Configuration Structures
  SAI Driver Class
  SAI Driver Constants
  SAI Predefined Configurations
 Syslog
 System FunctionsNetBurner General System Functions
 TCPTCP socket programming interface
  TCP Notification SystemAdvanced callback mechanism for asynchronous TCP socket event notification
  TCP Socket OptionsConfiguration flags for TCP socket behavior
  TCP Socket StateTCP connection state machine values (RFC 793)
  TCP Socket StatusStatus codes and error values for TCP socket operations
 TFTP
  TFTP Client
   TFTP Return Codes
  TFTP Server
 TimeTime management functions including time zones, NTP, and system clock
 Timers
  High Resolution Delay TimerHigh-precision microsecond delay functionality
  Interval Timer
  Stopwatch Timer
 UDPNetBurner User Datagram Protocol (UDP) Implementation
  UDP Error Codes
  UDP Packet API
  UDP Socket APIBSD-style socket functions for UDP communication
 User Authorization Manager
  Authorization Responses
  Authorization Types
 Utilities
 Web Client
  Web Client Error Codes
 Web SocketsWeb Socket functions and defintions
  Web Socket DefinitionsWebSocket Protocol Implementation for Real-Time Bidirectional Communication #include< websockets.h>
 WifiNetBurner WiFi API
  BSS OptionsOption list BSS type values
  Cipher Options
  Configuration Errors
  Connect Request Errors
  Save Config Record Errors
  Scan Request Errors
  Security Options