 |
WINC1500 IoT Software APIs
19.5.2
WINC Software API Reference Manual
|
Data Structures
Here are the data structures with brief descriptions:
| Cin_addr | IPv4 address representation |
| Csockaddr | Generic socket address structure |
| Csockaddr_in | Socket address structure for IPV4 addresses. Used to specify socket address information to which to connect to. Can be cast to sockaddr structure |
| Ctstr1xAuthCredentials | Credentials for the user to authenticate with the AAA server (WPA-Enterprise Mode IEEE802.1x) |
| CtstrCyptoResp | Crypto response |
| CtstrEthInitParam | Structure to hold Ethernet interface parameters. Structure is to be defined and have its attributes set,based on the application's functionality before a call is made to initialize the Wi-Fi operations by calling the m2m_wifi_init function. This structure is part of the Wi-Fi configuration structure tstrWifiInitParam. Applications shouldn't need to define this structure, if the bypass mode is not defined |
| CtstrM2MAPConfig | AP Configuration |
| CtstrM2mBatteryVoltage | Battery Voltage |
| CtstrM2mClientState | PS Client State |
| CtstrM2MConnInfo | M2M Provisioning Information obtained from the HTTP Provisioning server |
| CtstrM2MDefaultConnResp | Response error of the m2m_default_connect |
| CtstrM2MDeviceNameConfig | Device name |
| CtstrM2mEnableLogs | Enable Firmware logs |
| CtstrM2MIPConfig | Static IP configuration |
| CtstrM2mIpCtrlBuf | Structure 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 |
| CtstrM2mIpRsvdPkt | Received Packet Size and Data Offset |
| CtstrM2mLsnInt | Listen interval |
| CtstrM2MMulticastMac | M2M add/remove multi-cast mac address |
| CtstrM2MP2PConnect | Set the device to operate in the Wi-Fi Direct (P2P) mode |
| CtstrM2MProvisionInfo | M2M Provisioning Information obtained from the HTTP Provisioning server |
| CtstrM2MProvisionModeConfig | M2M Provisioning Mode Configuration |
| CtstrM2mPsType | Power Save Configuration |
| CtstrM2mPwrMode | |
| CtstrM2mPwrState | Power Mode |
| CtstrM2mReqScanResult | Scan Result Request |
| CtstrM2MScan | Wi-Fi Scan Request |
| CtstrM2mScanDone | Wi-Fi Scan Result |
| CtstrM2MScanOption | Scan options and configurations |
| CtstrM2MScanRegion | Wi-Fi channel regulation region information |
| CtstrM2Mservercmd | PS Server CMD |
| CtstrM2mServerInit | PS Server initialization |
| CtstrM2mSetMacAddress | Sets 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 |
| CtstrM2mSlpReqTime | Manual power save request sleep time |
| CtstrM2mTxPwrLevel | Tx power level |
| CtstrM2mWifiConnect | Wi-Fi Connect Request |
| CtstrM2mWifiGainsParams | Gain Values |
| CtstrM2MWifiMonitorModeCtrl | Wi-Fi Monitor Mode Filter |
| CtstrM2MWifiRxPacketInfo | Wi-Fi RX Frame Header |
| CtstrM2mWifiscanResult | Wi-Fi Scan Result |
| CtstrM2MWifiSecInfo | Authentication credentials to connect to a Wi-Fi network |
| CtstrM2mWifiStateChanged | Wi-Fi Connection State |
| CtstrM2MWifiTxPacketInfo | Wi-Fi TX Packet Info |
| CtstrM2mWifiWepParams | WEP security key parameters |
| CtstrM2MWPSConnect | WPS Configuration parameters |
| CtstrM2MWPSInfo | WPS Result |
| CtstrOtaControlSec | Control 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 |
| CtstrOtaInitHdr | OTA Image Header |
| CtstrOtaUpdateInfo | OTA Update Information |
| CtstrOtaUpdateStatusResp | OTA Update Information |
| CtstrPrng | M2M Request PRNG |
| CtstrSocketAcceptMsg | Socket accept status |
| CtstrSocketBindMsg | Socket bind status |
| CtstrSocketConnectMsg | Socket connect status |
| CtstrSocketListenMsg | Socket listen status |
| CtstrSocketRecvMsg | Socket recv status |
| CtstrSslSetActiveCsList | |
| CtstrSystemTime | Used for time storage |
| CtstrTlsCrlEntry | Certificate data for inclusion in a revocation list (CRL) |
| CtstrTlsCrlInfo | Certificate revocation list details |
| CtstrTlsSrvSecFileEntry | This struct contains a TLS certificate |
| CtstrTlsSrvSecHdr | This struct contains a set of TLS certificates |
| CtstrWifiInitParam | Structure, holding the Wi-fi configuration attributes such as the wi-fi callback , monitoring mode callback and Ethernet parameter initialization structure. Such configuration parameters are required to be set before calling the wi-fi initialization function m2m_wifi_init. pfAppWifiCb attribute must be set to handle the wi-fi callback operations. pfAppMonCb attribute, is optional based on whether the application requires the monitoring mode configuration, and can there not be set before the initialization. strEthInitParam structure, is another optional configuration based on whether the bypass mode is set |
| CtuniM2MWifiAuth | Wi-Fi Security Parameters for all supported security modes |
Generated on Thu Jan 26 2017 22:15:21 for WINC1500 IoT Software APIs by
1.8.13