Henry Leinen / WifiPlusClick

Implementation of the WifiPlusClick hardware module.

Dependents:   WifiPlusKlickExample

WifiPlusClick Libary

Overview

http://www.mikroe.com/img/development-tools/accessory-boards/click/wifi-plus/wifi_plus_click_main.png

This library implements the functionality exposed by a WifiPlusClick module from MikroElektronika (http://www.mikroe.com/click/wifi-plus/).

The WifiPlusClick module is an easy to handle module which provides access to up to 8 simultaneous socket objects - which is an an important aspect when you want to implement your own web server.

When I first started with the more commonly used Wifly module, I found out that the Wifly module does not reliably serve webpages which include other resources like images, JavaScript files or CSS files. The root cause seems to be the limitation that Wifly is only able to handle a single socket at this time. So I searched for an alternative and found this (actually cheaper) alternative :

WifiPlusClick HW Module

This module comes with its own limitations. The WifiPlusClick Module interface does not allow to use broadcasting or multicasting on UDP sockets. There are some additional limitations, but I think these are not so important. The following functionality is provided by the module and my library implementation :

  1. Wifi functionality
    1. Connections using AD-HOC or INFRASTRUCTURE mode
    2. List all available Wifi beacons
    3. WEP and WPA/WPA2 security modes including binary and ASCII keys
    4. reading binary WPA key after successfull Connection to speed up connection time
  2. Socket functionality
    1. UDP sockets
    2. TCP sockets

Limitations

I found the following limitations:

  1. UDP sockets cannot use multicasting or broadcasting
  2. set_option functionality is not provided by the HW
  3. 8 sockets can be configured with 1024 bytes of buffer each or 1 socket with 8192 bytes of buffer.

Sample application

Here is my sample application which you can use as a starting point.

Import programWifiPlusKlickExample

Example application of the WifiPlusClick library for use of WifiPlusClick HW Module from Mikroe.com

Last commit 29 Jul 2013 by Henry Leinen

NOTE

The implementation of the Sockets in this library is still not completely tested. I only tested the TCP part of the sockets. Please let me know what your experiences are when using the library. I will be working on a multithreaded version of this library...

Socket/TCPSocketConnection.h@0:2a179bd4cc02, 2013-07-29 (annotated)

Committer:
leihen
Date:
Mon Jul 29 15:15:21 2013 +0000
Revision:
0:2a179bd4cc02
Initial Version of the WifiPlusClick Library.

; Tested in INFRASTRUCTURE mode only.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
leihen 0:2a179bd4cc02 1 /* Copyright (c) 2013 Henry Leinen (henry[dot]leinen [at] online [dot] de)
leihen 0:2a179bd4cc02 2 *
leihen 0:2a179bd4cc02 3 * Permission is hereby granted, free of charge, to any person obtaining a copy of this software
leihen 0:2a179bd4cc02 4 * and associated documentation files (the "Software"), to deal in the Software without restriction,
leihen 0:2a179bd4cc02 5 * including without limitation the rights to use, copy, modify, merge, publish, distribute,
leihen 0:2a179bd4cc02 6 * sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is
leihen 0:2a179bd4cc02 7 * furnished to do so, subject to the following conditions:
leihen 0:2a179bd4cc02 8 *
leihen 0:2a179bd4cc02 9 * The above copyright notice and this permission notice shall be included in all copies or
leihen 0:2a179bd4cc02 10 * substantial portions of the Software.
leihen 0:2a179bd4cc02 11 *
leihen 0:2a179bd4cc02 12 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING
leihen 0:2a179bd4cc02 13 * BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
leihen 0:2a179bd4cc02 14 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
leihen 0:2a179bd4cc02 15 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
leihen 0:2a179bd4cc02 16 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
leihen 0:2a179bd4cc02 17 */
leihen 0:2a179bd4cc02 18 #ifndef __TCPSOCKETCONNECTION_H__
leihen 0:2a179bd4cc02 19 #define __TCPSOCKETCONNECTION_H__
leihen 0:2a179bd4cc02 20
leihen 0:2a179bd4cc02 21 #include "Socket.h"
leihen 0:2a179bd4cc02 22 #include "Endpoint.h"
leihen 0:2a179bd4cc02 23
leihen 0:2a179bd4cc02 24 /** Class TCPSocketConnection inherits from Socket and Endpoint. Implements the client TCP socket functionality.
leihen 0:2a179bd4cc02 25 */
leihen 0:2a179bd4cc02 26 class TCPSocketConnection : public Socket, public Endpoint
leihen 0:2a179bd4cc02 27 {
leihen 0:2a179bd4cc02 28 friend class TCPSocketServer;
leihen 0:2a179bd4cc02 29 public:
leihen 0:2a179bd4cc02 30 /** Public constructor to instantiate an object of class TCPSocketConnection */
leihen 0:2a179bd4cc02 31 TCPSocketConnection();
leihen 0:2a179bd4cc02 32
leihen 0:2a179bd4cc02 33 /** Function connect allows to create an unused socket object to a remote host on a remote port.
leihen 0:2a179bd4cc02 34 * @param host : remote host to which to initiate a TCP connection.
leihen 0:2a179bd4cc02 35 * @param port : remote port to which to initiate a TCP connection.
leihen 0:2a179bd4cc02 36 * @returns : 0 if successfull or -1 on failure.
leihen 0:2a179bd4cc02 37 */
leihen 0:2a179bd4cc02 38 int connect(const char *host, const int port);
leihen 0:2a179bd4cc02 39
leihen 0:2a179bd4cc02 40 /** Function to query wheather the socket is already connected with a remote instance.
leihen 0:2a179bd4cc02 41 * @returns : true if already connected or false otherwise.
leihen 0:2a179bd4cc02 42 */
leihen 0:2a179bd4cc02 43 bool is_connected(void);
leihen 0:2a179bd4cc02 44
leihen 0:2a179bd4cc02 45 /** Function send allows to send data to an already connected TCP socket.
leihen 0:2a179bd4cc02 46 * @param data : pointer to a valid data buffer.
leihen 0:2a179bd4cc02 47 * @param length : Number of bytes from data buffer to send.
leihen 0:2a179bd4cc02 48 * @returns : number of bytes actually sent or -1 on failure.
leihen 0:2a179bd4cc02 49 */
leihen 0:2a179bd4cc02 50 int send(char *data, int length);
leihen 0:2a179bd4cc02 51
leihen 0:2a179bd4cc02 52 /** Function send_all allows to send data to an already connected TCP socket. The function will try to send all the data specified by length.
leihen 0:2a179bd4cc02 53 * If a timeout occurs in a blocking configuration the function returns the number of bytes actually sent.
leihen 0:2a179bd4cc02 54 * @param data : pointer to a valid data buffer.
leihen 0:2a179bd4cc02 55 * @param length : Number of bytes from data buffer to send.
leihen 0:2a179bd4cc02 56 * @returns : number of bytes actually send or -1 on failure.
leihen 0:2a179bd4cc02 57 */
leihen 0:2a179bd4cc02 58 int send_all(char *data, int length);
leihen 0:2a179bd4cc02 59
leihen 0:2a179bd4cc02 60 /** Function recv allows to receive data from an already connected TCP socket. Please note that this function will return once a first bunch
leihen 0:2a179bd4cc02 61 * of data has been received. It will not wait until all the requested data is available.
leihen 0:2a179bd4cc02 62 * @param data : pointer to a valid data buffer which will receive the received data. The buffer must be big enough to hold all the requested data.
leihen 0:2a179bd4cc02 63 * @param length : Maximum numnber of bytes to receive.
leihen 0:2a179bd4cc02 64 * @returns : number of bytes actually received and stored in data buffer or -1 on failure.
leihen 0:2a179bd4cc02 65 */
leihen 0:2a179bd4cc02 66 int recv(char *data, int length);
leihen 0:2a179bd4cc02 67
leihen 0:2a179bd4cc02 68 /** Function recv_all allows to receive data entirely from an already connected TCP socket. Please note that this function will only return if
leihen 0:2a179bd4cc02 69 * all the requested data was received or a timeout occured.
leihen 0:2a179bd4cc02 70 * @param data : pointer to a valid data buffer which will receive the received data. The buffer must be big enough to hold all the requested data.
leihen 0:2a179bd4cc02 71 * @param length : Number of bytes to receive.
leihen 0:2a179bd4cc02 72 * @returns : number of bytes actually received and stored in data buffer or -1 on failure.
leihen 0:2a179bd4cc02 73 */
leihen 0:2a179bd4cc02 74 int recv_all(char * data, int length);
leihen 0:2a179bd4cc02 75
leihen 0:2a179bd4cc02 76 private:
leihen 0:2a179bd4cc02 77 bool _is_connected;
leihen 0:2a179bd4cc02 78 };
leihen 0:2a179bd4cc02 79
leihen 0:2a179bd4cc02 80 #endif // __TCPSOCKETCONNECTION_H__