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/TCPSocketServer.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 __TCPSOCKETSERVER_H__
leihen 0:2a179bd4cc02 19 #define __TCPSOCKETSERVER_H__
leihen 0:2a179bd4cc02 20
leihen 0:2a179bd4cc02 21 #include "Socket/Socket.h"
leihen 0:2a179bd4cc02 22 #include "Socket/TCPSocketConnection.h"
leihen 0:2a179bd4cc02 23
leihen 0:2a179bd4cc02 24 /** Class TCPSocketServer inherits from class Socket. Implements the TCP server socket which is used to listen for a new incoming connection.
leihen 0:2a179bd4cc02 25 * This implementation can have a backlog of up to 8 sockets. Please note that the number of listening sockets depends on how the WifiPlusClick
leihen 0:2a179bd4cc02 26 * Module has been configured.
leihen 0:2a179bd4cc02 27 */
leihen 0:2a179bd4cc02 28 class TCPSocketServer : public Socket
leihen 0:2a179bd4cc02 29 {
leihen 0:2a179bd4cc02 30 public:
leihen 0:2a179bd4cc02 31 /** Public constructor to instantiate an object of TCPSocketServer. */
leihen 0:2a179bd4cc02 32 TCPSocketServer();
leihen 0:2a179bd4cc02 33
leihen 0:2a179bd4cc02 34 /** Bind function to bind the TCPSocketServer to a specific local port as a precondition to listen to new connection requests.
leihen 0:2a179bd4cc02 35 * @param port : local port to which the server socket shall be bound.
leihen 0:2a179bd4cc02 36 * @returns : 0 if successfull, or -1 on failure.
leihen 0:2a179bd4cc02 37 */
leihen 0:2a179bd4cc02 38 int bind(int port);
leihen 0:2a179bd4cc02 39
leihen 0:2a179bd4cc02 40 /** Listen function allows a bound socket to listen for incoming connections. The number of connectable socket objects can be specified.
leihen 0:2a179bd4cc02 41 * @note: the number of sockets is a configurable resource on WifiPlusClick modules. Use the configuration function Wifi::SocketAllocate to
leihen 0:2a179bd4cc02 42 * specify the number of sockets to allocate.
leihen 0:2a179bd4cc02 43 * @param backlog : number of sockets which are connectable in the listen state.
leihen 0:2a179bd4cc02 44 * @returns : the new backlog number, or -1 on failure
leihen 0:2a179bd4cc02 45 */
leihen 0:2a179bd4cc02 46 int listen( int backlog = 1 );
leihen 0:2a179bd4cc02 47
leihen 0:2a179bd4cc02 48 /** Accept function will be used on a bound and listening socket. Function will return if a socket connection has been made or a timeout occured.
leihen 0:2a179bd4cc02 49 * @param connection : A reference to a TCCPSocketConnection object which will be a valid client socket if a connection has been made.
leihen 0:2a179bd4cc02 50 * @returns : 0 if successfull, or -1 on failure.
leihen 0:2a179bd4cc02 51 */
leihen 0:2a179bd4cc02 52 int accept(TCPSocketConnection& connection);
leihen 0:2a179bd4cc02 53 };
leihen 0:2a179bd4cc02 54
leihen 0:2a179bd4cc02 55 #endif // __TCPSOCKETSERVER_H__