ACKme / WiConnect

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependents:   wiconnect-ota_example wiconnect-web_setup_example wiconnect-test-console wiconnect-tcp_server_example ... more

Embed: (wiki syntax)

« Back to documentation index

Settings Methods
Functions

Settings Methods
[Network]

API getters/setters for module network settings. More...

Functions

WiconnectResult setDhcpEnabled (bool enabled)
 Set DHCP enabled.
WiconnectResult getDhcpEnabled (bool *enabledPtr)
 Get if DHCP enabled.
WiconnectResult setIpSettings (uint32_t ip, uint32_t netmask, uint32_t gateway)
 Set static IP settings.
WiconnectResult setIpSettings (const char *ip, const char *netmask, const char *gateway)
 Set static IP settings (with string parameters)
WiconnectResult getIpSettings (uint32_t *ip, uint32_t *netmask, uint32_t *gateway)
 Get network IP settings.
WiconnectResult setDnsAddress (uint32_t dnsAddress)
 Set static DNS Address.
WiconnectResult getDnsAddress (uint32_t *dnsAddress)
 Get the static DNS address.
const char * getIpAddress (char *buffer ALLOW_NULL_STRING_BUFFER)
 Return the current IP address of the module if possible, else return 0.0.0.0.

Detailed Description

API getters/setters for module network settings.

Function Documentation

WiconnectResult getDhcpEnabled ( bool *  enabledPtr ) [inherited]

Get if DHCP enabled.

WiconnectResult getDnsAddress ( uint32_t *  dnsAddress ) [inherited]

Get the static DNS address.

const char* getIpAddress ( char *buffer  ALLOW_NULL_STRING_BUFFER ) [inherited]

Return the current IP address of the module if possible, else return 0.0.0.0.

Note:
This method is only supported in blocking mode.
Parameters:
[in]bufferOptional, buffer to IP address string. If omitted, the IP address string is stored in a local static buffer (this is non-reentrant!)
WiconnectResult getIpSettings ( uint32_t *  ip,
uint32_t *  netmask,
uint32_t *  gateway 
) [inherited]

Get network IP settings.

WiconnectResult setDhcpEnabled ( bool  enabled ) [inherited]

Set DHCP enabled.

Returns:
Result of method. See WiconnectResult
WiconnectResult setDnsAddress ( uint32_t  dnsAddress ) [inherited]

Set static DNS Address.

WiconnectResult setIpSettings ( const char *  ip,
const char *  netmask,
const char *  gateway 
) [inherited]

Set static IP settings (with string parameters)

WiconnectResult setIpSettings ( uint32_t  ip,
uint32_t  netmask,
uint32_t  gateway 
) [inherited]

Set static IP settings.

Generated on Tue Jul 12 2022 17:35:59 by  doxygen 1.7.2