ESP8266Interface class Implementation of the NetworkStack for the ESP8266. More...

#include <EMW3162Interface.h>

Public Member Functions
	ESP8266Interface (PinName tx, PinName rx, bool debug=true)
	ESP8266Interface lifetime.
virtual int	connect (const char ssid, const char pass, nsapi_security_t security=NSAPI_SECURITY_NONE)
	Start the interface.
virtual int	disconnect ()
	Stop the interface.
virtual const char *	get_ip_address ()
	Get the internally stored IP address.
virtual const char *	get_mac_address ()
	Get the internally stored MAC address.
Protected Member Functions
virtual int	socket_open (void **handle, nsapi_protocol_t proto)
	Open a socket.
virtual int	socket_close (void *handle)
	Close the socket.
virtual int	socket_bind (void *handle, const SocketAddress &address)
	Bind a server socket to a specific port.
virtual int	socket_listen (void *handle, int backlog)
	Start listening for incoming connections.
virtual int	socket_connect (void *handle, const SocketAddress &address)
	Connects this TCP socket to the server.
virtual int	socket_accept (void *handle, void server)
	Accept a new connection.
virtual int	socket_send (void handle, const void data, unsigned size)
	Send data to the remote host.
virtual int	socket_recv (void handle, void data, unsigned size)
	Receive data from the remote host.
virtual int	socket_sendto (void handle, const SocketAddress &address, const void data, unsigned size)
	Send a packet to a remote endpoint.
virtual int	socket_recvfrom (void handle, SocketAddress address, void *buffer, unsigned size)
	Receive a packet from a remote endpoint.
virtual void	socket_attach (void handle, void(callback)(void ), void data)
	Register a callback on state change of the socket.
virtual NetworkStack *	get_stack ()
	Provide access to the NetworkStack object.

Detailed Description

ESP8266Interface class Implementation of the NetworkStack for the ESP8266.

Definition at line 30 of file EMW3162Interface.h.

Constructor & Destructor Documentation

ESP8266Interface	(	PinName	tx,
		PinName	rx,
		bool	debug = `true`
	)

ESP8266Interface lifetime.

Parameters:

tx	TX pin
rx	RX pin
debug	Enable debugging

Definition at line 28 of file EMW3162Interface.cpp.

Member Function Documentation

int connect	(	const char *	ssid,
		const char *	pass,
		nsapi_security_t	security = `NSAPI_SECURITY_NONE`
	)		`[virtual]`

Start the interface.

Attempts to connect to a WiFi network. If passphrase is invalid, NSAPI_ERROR_AUTH_ERROR is returned.

Parameters:

ssid	Name of the network to connect to
pass	Security passphrase to connect to the network
security	Type of encryption for connection

Returns:: 0 on success, negative error code on failure

Definition at line 37 of file EMW3162Interface.cpp.

int disconnect ( void ) [virtual]

Stop the interface.

Returns:: 0 on success, negative on failure

Definition at line 63 of file EMW3162Interface.cpp.

const char * get_ip_address ( ) [virtual]

Get the internally stored IP address.

Returns:: IP address of the interface or null if not yet connected

Definition at line 74 of file EMW3162Interface.cpp.

const char * get_mac_address ( ) [virtual]

Get the internally stored MAC address.

Returns:: MAC address of the interface

Definition at line 79 of file EMW3162Interface.cpp.

virtual NetworkStack* get_stack ( ) [protected, virtual]

Provide access to the NetworkStack object.

Returns:: The underlying NetworkStack object

Definition at line 173 of file EMW3162Interface.h.

int socket_accept	(	void **	handle,
		void *	server
	)		`[protected, virtual]`

Accept a new connection.

Parameters:

handle	Handle in which to store new socket
server	Socket handle to server to accept from

Returns:: 0 on success, negative on failure

Note:: This call is not-blocking, if this call would block, must immediately return NSAPI_ERROR_WOULD_WAIT

Definition at line 161 of file EMW3162Interface.cpp.

void socket_attach	(	void *	handle,
		void()(void )	callback,
		void *	data
	)		`[protected, virtual]`

Register a callback on state change of the socket.

Parameters:

handle	Socket handle
callback	Function to call on state change
data	Argument to pass to callback

Note:: Callback may be called in an interrupt context.

Definition at line 210 of file EMW3162Interface.cpp.

int socket_bind	(	void *	handle,
		const SocketAddress &	address
	)		`[protected, virtual]`

Bind a server socket to a specific port.

Parameters:

handle	Socket handle
address	Local address to listen for incoming connections on

Returns:: 0 on success, negative on failure.

Definition at line 136 of file EMW3162Interface.cpp.

int socket_close ( void * handle ) [protected, virtual]

Close the socket.

Parameters:

handle Socket handle

Returns:: 0 on success, negative on failure

Note:: On failure, any memory associated with the socket must still be cleaned up

Definition at line 121 of file EMW3162Interface.cpp.

int socket_connect	(	void *	handle,
		const SocketAddress &	address
	)		`[protected, virtual]`

Connects this TCP socket to the server.

Parameters:

handle	Socket handle
address	SocketAddress to connect to

Returns:: 0 on success, negative on failure

Definition at line 146 of file EMW3162Interface.cpp.

int socket_listen	(	void *	handle,
		int	backlog
	)		`[protected, virtual]`

Start listening for incoming connections.

Parameters:

handle	Socket handle
backlog	Number of pending connections that can be queued up at any one time [Default: 1]

Returns:: 0 on success, negative on failure

Definition at line 141 of file EMW3162Interface.cpp.

int socket_open	(	void **	handle,
		nsapi_protocol_t	proto
	)		`[protected, virtual]`

Open a socket.

Parameters:

handle	Handle in which to store new socket
proto	Type of socket to open, NSAPI_TCP or NSAPI_UDP

Returns:: 0 on success, negative on failure

Definition at line 91 of file EMW3162Interface.cpp.

int socket_recv	(	void *	handle,
		void *	data,
		unsigned	size
	)		`[protected, virtual]`

Receive data from the remote host.

Parameters:

handle	Socket handle
data	The buffer in which to store the data received from the host
size	The maximum length of the buffer

Returns:: Number of received bytes on success, negative on failure

Note:: This call is not-blocking, if this call would block, must immediately return NSAPI_ERROR_WOULD_WAIT

Definition at line 178 of file EMW3162Interface.cpp.

int socket_recvfrom	(	void *	handle,
		SocketAddress *	address,
		void *	buffer,
		unsigned	size
	)		`[protected, virtual]`

Receive a packet from a remote endpoint.

Parameters:

handle	Socket handle
address	Destination for the remote SocketAddress or null
buffer	The buffer for storing the incoming packet data If a packet is too long to fit in the supplied buffer, excess bytes are discarded
size	The length of the buffer

Returns:: The number of received bytes on success, negative on failure

Note:: This call is not-blocking, if this call would block, must immediately return NSAPI_ERROR_WOULD_WAIT

Definition at line 204 of file EMW3162Interface.cpp.

int socket_send	(	void *	handle,
		const void *	data,
		unsigned	size
	)		`[protected, virtual]`

Send data to the remote host.

Parameters:

handle	Socket handle
data	The buffer to send to the host
size	The length of the buffer to send

Returns:: Number of written bytes on success, negative on failure

Note:: This call is not-blocking, if this call would block, must immediately return NSAPI_ERROR_WOULD_WAIT

Definition at line 166 of file EMW3162Interface.cpp.

int socket_sendto	(	void *	handle,
		const SocketAddress &	address,
		const void *	data,
		unsigned	size
	)		`[protected, virtual]`

Send a packet to a remote endpoint.

Parameters:

handle	Socket handle
address	The remote SocketAddress
data	The packet to be sent
size	The length of the packet to be sent

Returns:: The number of written bytes on success, negative on failure

Note:: This call is not-blocking, if this call would block, must immediately return NSAPI_ERROR_WOULD_WAIT

Definition at line 191 of file EMW3162Interface.cpp.

Type:	Library
Created:	01 Nov 2016
Imports:	6
Forks:	0
Commits:	1
Dependents:	0
Dependencies:	0
Followers:	1

Important changes to repositories hosted on mbed.com

ESP8266Interface Class Reference

Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Repository toolbox

Repository details

Important Information for this Arm website

Important changes to repositories hosted on mbed.com

ESP8266Interface Class Reference

Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Repository toolbox

Repository details

Important Information for this Arm website

Access Warning