Rohm / GR-PEACH_WlanBP3595

This is GR_PEACH_WlanBP3595 class library. The base library is EthernetInterface.

Dependents:   GR-PEACH_WlanBP3595AP GR-PEACH_WlanBP3595STA

Embed: (wiki syntax)

« Back to documentation index

GR_PEACH_WlanBP3595 Class Reference
Static Public Member Functions

GR_PEACH_WlanBP3595 Class Reference

Interface using Wlan to connect to an IP-based network. More...

#include <GR_PEACH_WlanBP3595.h>

Static Public Member Functions

static int init ()
 Initialize the interface with DHCP.
static int init (const char *ip, const char *mask, const char *gateway)
 Initialize the interface with a static IP address.
static int connect (const char *ssid, const char *pass, nsapi_security_t security=NSAPI_SECURITY_WPA2, unsigned int timeout_ms=1800000)
 Connect Bring the interface up, start DHCP if needed.
static int disconnect ()
 Disconnect Bring the interface down.
static char * getMACAddress ()
 Get the MAC address of your Wlan interface.
static char * getIPAddress ()
 Get the IP address of your Wlan interface.
static char * getGateway ()
 Get the Gateway address of your Wlan interface.
static char * getNetworkMask ()
 Get the Network mask of your Wlan interface.
static int WlanIoctl (uint32_t ulFunc, void *pvParam)
 Execute WID function Please see "WID" of document "Software development specs of BP3595" for the details.
static void setWlanCbFunction (void(*fptr)(uint8_t ucType, uint16_t usWid, uint16_t usSize, uint8_t *pucData))
 Set WLAN Information callback function.

Detailed Description

Interface using Wlan to connect to an IP-based network.

Definition at line 51 of file GR_PEACH_WlanBP3595.h.

Member Function Documentation

int connect ( const char *  ssid,
const char *  pass,
nsapi_security_t  security = NSAPI_SECURITY_WPA2,
unsigned int  timeout_ms = 1800000 
) [static]

Connect Bring the interface up, start DHCP if needed.

Parameters:
ssidName of the network to connect to
passSecurity passphrase to connect to the network
securityType of encryption to connect with
timeout_mstimeout in ms (default: (15)s).
Returns:
0 on success, a negative number on failure

Definition at line 215 of file GR_PEACH_WlanBP3595.cpp.

int disconnect (  ) [static]

Disconnect Bring the interface down.

Returns:
0 on success, a negative number on failure

Definition at line 240 of file GR_PEACH_WlanBP3595.cpp.

char * getGateway (  ) [static]

Get the Gateway address of your Wlan interface.

Returns:
a pointer to a string containing the Gateway address

Definition at line 261 of file GR_PEACH_WlanBP3595.cpp.

char * getIPAddress (  ) [static]

Get the IP address of your Wlan interface.

Returns:
a pointer to a string containing the IP address

Definition at line 257 of file GR_PEACH_WlanBP3595.cpp.

char * getMACAddress (  ) [static]

Get the MAC address of your Wlan interface.

Returns:
a pointer to a string containing the MAC address

Definition at line 253 of file GR_PEACH_WlanBP3595.cpp.

char * getNetworkMask (  ) [static]

Get the Network mask of your Wlan interface.

Returns:
a pointer to a string containing the Network mask

Definition at line 265 of file GR_PEACH_WlanBP3595.cpp.

int init (  ) [static]

Initialize the interface with DHCP.

Initialize the interface and configure it to use DHCP (no connection at this point).

Returns:
0 on success, a negative number on failure

Definition at line 191 of file GR_PEACH_WlanBP3595.cpp.

int init ( const char *  ip,
const char *  mask,
const char *  gateway 
) [static]

Initialize the interface with a static IP address.

Initialize the interface and configure it with the following static configuration (no connection at this point).

Parameters:
ipthe IP address to use
maskthe IP address mask
gatewaythe gateway to use
Returns:
0 on success, a negative number on failure

Definition at line 199 of file GR_PEACH_WlanBP3595.cpp.

void setWlanCbFunction ( void(*)(uint8_t ucType, uint16_t usWid, uint16_t usSize, uint8_t *pucData)  fptr ) [static]

Set WLAN Information callback function.

Parameters:
fptrWLAN Information callback function

Definition at line 273 of file GR_PEACH_WlanBP3595.cpp.

int WlanIoctl ( uint32_t  ulFunc,
void *  pvParam 
) [static]

Execute WID function Please see "WID" of document "Software development specs of BP3595" for the details.

"https://developer.mbed.org/teams/Rohm/wiki/Datasheet"

Parameters:
ulFuncA function number
pvParamThe data buffer (the parameter)
Returns:
0 on success, "The others" on failure

Definition at line 269 of file GR_PEACH_WlanBP3595.cpp.

Generated on Tue Jul 12 2022 20:35:41 by  doxygen 1.7.2