NNN50 WIFI_API library

Dependents:   NNN50_CE_Test_UDP NNN50_linux_firmware NNN50_SoftAP_HelloWorld NNN50_BLEWIFISensor ... more

Embed: (wiki syntax)

« Back to documentation index

Data Structures

Data Structures

Here are the data structures with brief descriptions:
EndpointIP Endpoint (address, port)
EthernetInterfaceInterface using Ethernet to connect to an IP-based network
in_addrIPv4 address representation
sockaddrGeneric socket address structure
sockaddr_inSocket address structure for IPV4 addresses. Used to specify socket address information to which to connect to. Can be cast to sockaddr structure
SocketSocket file descriptor and select wrapper
TCPSocketConnectionTCP socket connection
TCPSocketServerTCP Server
tenuWifiCapabilityEnumeration for capability Information field bit. The value of the capability information field from the 802.11 management frames received by the wireless LAN interface. Defining the capabilities of the Wi-Fi system. Values are defined as per the IEEE 802.11 standard
TimeIntervalTime interval class used to specify timeouts
tstr1xAuthCredentialsCredentials for the user to authenticate with the AAA server (WPA-Enterprise Mode IEEE802.1x)
tstrConnectReplyConnect Reply, contains sock number and error value
tstrCyptoRespCrypto response
tstrDnsReplyDNS Reply, contains hostName and HostIP
tstrECDomainParamECC Curve Domain Parameters
tstrECPointElliptic Curve point representation
tstrEllipticCurveDefinition of an elliptic curve
tstrEthInitParamStructure to hold Ethernet interface parameters
tstrHifHdrStructure to hold HIF header
tstrI2cMasterInitParamI2C master configuration parameters
tstrM2MAPConfigAP Configuration
tstrM2mAteRxUsed for the reception(Rx) test configuration
tstrM2mAteRxStatusUsed to save statistics for receive(RX) test case
tstrM2mAteTxUsed for the transmission(Tx) test configuration
tstrM2mBatteryVoltageBattery Voltage
tstrM2mBinaryHeaderStructure holding compatibility version info for firmware binaries
tstrM2mClientStatePS Client State
tstrM2MConnInfoM2M Provisioning Information obtained from the HTTP Provisioning server
tstrM2MDefaultConnRespResponse error of the m2m_default_connect
tstrM2MDeviceNameConfigDevice name
tstrM2mEnableLogsEnable Firmware logs
tstrM2MIPConfigStatic IP configuration
tstrM2mIpCtrlBufStructure holding the incoming buffer's data size information, indicating the data size of the buffer and the remaining buffer's data size . The data of the buffer which holds the packet sent to the host when in the bypass mode, is placed in the tstrEthInitParam structure in the au8ethRcvBuf attribute. This following information is retrieved in the host when an event M2M_WIFI_RESP_ETHERNET_RX_PACKET is received in the Wi-Fi callback function tpfAppWifiCb
tstrM2mIpRsvdPktReceived Packet Size and Data Offset
tstrM2mLsnIntListen interval
tstrM2MMulticastMacM2M add/remove multi-cast mac address
tstrM2MP2PConnectSet the device to operate in the Wi-Fi Direct (P2P) mode
tstrM2MProvisionInfoM2M Provisioning Information obtained from the HTTP Provisioning server
tstrM2MProvisionModeConfigM2M Provisioning Mode Configuration
tstrM2mPsTypePower Save Configuration
tstrM2mPwrStatePower Mode
tstrM2mReqScanResultScan Result Request
tstrM2mRevStructure holding firmware version parameters and build date/time
tstrM2MScanWi-Fi Scan Request
tstrM2mScanDoneWi-Fi Scan Result
tstrM2MScanOptionScan options and configurations
tstrM2MScanRegionWi-Fi channel regulation region information
tstrM2MservercmdPS Server CMD
tstrM2mServerInitPS Server initialization
tstrM2mSetMacAddressSets the MAC address from application. The WINC load the mac address from the effuse by default to the WINC configuration memory, but that function is used to let the application overwrite the configuration memory with the mac address from the host
tstrM2mSha256CtxtSHA256 context data
tstrM2mSlpReqTimeManual power save request sleep time
tstrM2mTxPwrLevelTx power level
tstrM2mWifiConnectWi-Fi Connect Request
tstrM2mWifiGainsParamsGain Values
tstrM2MWifiMonitorModeCtrlWi-Fi Monitor Mode Filter
tstrM2MWifiRxPacketInfoWi-Fi RX Frame Header
tstrM2mWifiscanResultWi-Fi Scan Result
tstrM2MWifiSecInfoAuthentication credentials to connect to a Wi-Fi network
tstrM2mWifiStateChangedWi-Fi Connection State
tstrM2MWifiTxPacketInfoWi-Fi TX Packet Info
tstrM2mWifiWepParamsWEP security key parameters
tstrM2MWPSConnectWPS Configuration parameters
tstrM2MWPSInfoWPS Result
tstrNmBusCapabilitiesStructure holding bus capabilities information
tstrNmI2cDefaultStructure holding I2C default operation parameters
tstrNmI2cSpecialStructure holding I2C special operation parameters
tstrNmSpiRwStructure holding SPI R/W parameters
tstrNmUartDefaultStructure holding UART default operation parameters
tstrOtaControlSecControl section structure is used to define the working image and the validity of the roll-back image and its offset, also both firmware versions is kept in that structure
tstrOtaInitHdrOTA Image Header
tstrOtaUpdateInfoOTA Update Information
tstrOtaUpdateStatusRespOTA Update Information
tstrPerphInitParamPeripheral module initialization parameters
tstrPrngM2M Request PRNG
tstrSendReplySend Reply, contains socket number and number of sent bytes
tstrSocketAcceptMsgSocket accept status
tstrSocketBindMsgSocket bind status
tstrSocketConnectMsgSocket connect status
tstrSocketListenMsgSocket listen status
tstrSocketRecvMsgSocket recv status
tstrSslCertExpSettingsSSL Certificate Expiry Validation Settings
tstrSystemTimeUsed for time storage
tstrTlsCrlEntryCertificate data for inclusion in a revocation list (CRL)
tstrTlsCrlInfoCertificate revocation list details
tstrTlsSrvSecFileEntryThis struct contains a TLS certificate
tstrTlsSrvSecHdrThis struct contains a set of TLS certificates
tstrWifiInitParamStructure, holding the Wi-fi configuration attributes such as the wi-fi callback , monitoring mode callback and Ethernet parameter initialization structure
tuniM2MWifiAuthWi-Fi Security Parameters for all supported security modes
UDPSocketUDP Socket