Rudy Raab / WIZ820ioInterface

Fork of WIZ820ioInterface by ban4jp -

Embed: (wiki syntax)

« Back to documentation index

WIZ820ioInterface Class Reference

WIZ820ioInterface Class Reference

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

#include <WIZ820ioInterface.h>

Inherits WIZ820io.

Public Member Functions

 WIZ820ioInterface (PinName mosi, PinName miso, PinName sclk, PinName cs, PinName reset)
 Constructor.
int init ()
 Initialize the interface with DHCP.
int init (const char *ip, const char *mask, const char *gateway)
 Initialize the interface with a static IP address.
int connect ()
 Connect Bring the interface up, start DHCP if needed.
int disconnect ()
 Disconnect Bring the interface down.
char * getIPAddress ()
 Get IP address.

Detailed Description

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

Definition at line 27 of file WIZ820ioInterface.h.


Constructor & Destructor Documentation

WIZ820ioInterface ( PinName  mosi,
PinName  miso,
PinName  sclk,
PinName  cs,
PinName  reset 
)

Constructor.

Parameters:
mosimbed pin to use for SPI
misombed pin to use for SPI
sclkmbed pin to use for SPI
cs
resetreset pin of the WIZ820io module

Definition at line 5 of file WIZ820ioInterface.cpp.


Member Function Documentation

int connect (  )

Connect Bring the interface up, start DHCP if needed.

Returns:
0 on success, a negative number on failure

Definition at line 36 of file WIZ820ioInterface.cpp.

int disconnect (  )

Disconnect Bring the interface down.

Returns:
0 on success, a negative number on failure

Definition at line 48 of file WIZ820ioInterface.cpp.

char * getIPAddress (  )

Get IP address.

@ returns ip address

Definition at line 54 of file WIZ820ioInterface.cpp.

int init ( const char *  ip,
const char *  mask,
const char *  gateway 
)

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 24 of file WIZ820ioInterface.cpp.

int init ( void   )

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 17 of file WIZ820ioInterface.cpp.