ACKme / WiConnect

Host library for controlling a WiConnect enabled Wi-Fi module.

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

Embed: (wiki syntax)

« Back to documentation index

Conversion Utilities
Functions

Conversion Utilities

This contains all the conversion utility static functions. More...

Functions

static const char * fileVersionIntToStr (uint32_t version, bool verbose=true, char *buffer=NULL)
 Convert file version uint32 to string.
static bool fileVersionStrToInt (const char *versionStr, uint32_t *versionIntPtr)
 Convert string to file version uint32.
static const char * fileTypeToStr (FileType type)
 Convert FileType to string.
static const char * fileFlagsToStr (FileFlags flags, char *buffer=NULL)
 Convert FileFlags to string.
static bool strToIp (const char *str, uint32_t *intPtr)
 Convert string to IP address.
static const char * ipToStr (uint32_t ip, char *ipStrBuffer ALLOW_NULL_STRING_BUFFER)
 Convert IP address to string.
static const char * networkStatusToStr (NetworkStatus status)
 Convert NetworkStatus to string.
static const char * networkJoinResultToStr (NetworkJoinResult joinResult)
 Convert NetworkJoinResult to string.
static const char * signalStrengthToStr (NetworkSignalStrength signalStrenth)
 Convert NetworkSignalStrength to string.
static NetworkSignalStrength rssiToSignalStrength (int rssi)
 Convert RSSI (in dBm) to NetworkSignalStrength.
static NetworkSecurity strToNetworkSecurity (const char *str)
 Convert string to NetworkSecurity.
static const char * networkSecurityToStr (NetworkSecurity security)
 Convert NetworkSecurity to string.
static bool strToSsid (const char *str, Ssid *ssid)
 Convert string Ssid.
static const char * ssidToStr (const Ssid *ssid, char *ssidStrBuffer ALLOW_NULL_STRING_BUFFER)
 Convert Ssid to string.
static bool strToMacAddress (const char *str, MacAddress *macAddress)
 Convert string MacAddress.
static const char * macAddressToStr (const MacAddress *macAddress, char *macStrBuffer ALLOW_NULL_STRING_BUFFER)
 Convert MacAddress to string.
static const char * getWiconnectResultStr (WiconnectResult wiconnectResult)
 Converts a WiconnectResult to string representation.
static uint32_t wiconnectVersionToInt (char *versionStr)
 Converts wiconnect version string to uint32_t representation.

Detailed Description

This contains all the conversion utility static functions.

Function Documentation

static const char* fileFlagsToStr ( FileFlags  flags,
char *  buffer = NULL 
) [static, inherited]

Convert FileFlags to string.

static const char* fileTypeToStr ( FileType  type ) [static, inherited]

Convert FileType to string.

static const char* fileVersionIntToStr ( uint32_t  version,
bool  verbose = true,
char *  buffer = NULL 
) [static, inherited]

Convert file version uint32 to string.

static bool fileVersionStrToInt ( const char *  versionStr,
uint32_t *  versionIntPtr 
) [static, inherited]

Convert string to file version uint32.

const char * getWiconnectResultStr ( WiconnectResult  wiconnectResult ) [static, inherited]

Converts a WiconnectResult to string representation.

Parameters:
[in]wiconnectResultResult code
Returns:
String representaion of result code

Definition at line 323 of file Wiconnect.cpp.

static const char* ipToStr ( uint32_t  ip,
char *ipStrBuffer  ALLOW_NULL_STRING_BUFFER 
) [static, inherited]

Convert IP address to string.

static const char* macAddressToStr ( const MacAddress *  macAddress,
char *macStrBuffer  ALLOW_NULL_STRING_BUFFER 
) [static, inherited]

Convert MacAddress to string.

static const char* networkJoinResultToStr ( NetworkJoinResult  joinResult ) [static, inherited]

Convert NetworkJoinResult to string.

static const char* networkSecurityToStr ( NetworkSecurity  security ) [static, inherited]

Convert NetworkSecurity to string.

static const char* networkStatusToStr ( NetworkStatus  status ) [static, inherited]

Convert NetworkStatus to string.

static NetworkSignalStrength rssiToSignalStrength ( int  rssi ) [static, inherited]

Convert RSSI (in dBm) to NetworkSignalStrength.

static const char* signalStrengthToStr ( NetworkSignalStrength  signalStrenth ) [static, inherited]

Convert NetworkSignalStrength to string.

static const char* ssidToStr ( const Ssid *  ssid,
char *ssidStrBuffer  ALLOW_NULL_STRING_BUFFER 
) [static, inherited]

Convert Ssid to string.

static bool strToIp ( const char *  str,
uint32_t *  intPtr 
) [static, inherited]

Convert string to IP address.

static bool strToMacAddress ( const char *  str,
MacAddress *  macAddress 
) [static, inherited]

Convert string MacAddress.

static NetworkSecurity strToNetworkSecurity ( const char *  str ) [static, inherited]

Convert string to NetworkSecurity.

static bool strToSsid ( const char *  str,
Ssid *  ssid 
) [static, inherited]

Convert string Ssid.

uint32_t wiconnectVersionToInt ( char *  versionStr ) [static, inherited]

Converts wiconnect version string to uint32_t representation.

Parameters:
[in]Outputof getVersion() API call.
Returns:
32bit integer WiConnect firmware version

Definition at line 367 of file Wiconnect.cpp.

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