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

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...

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 __SOCKET_H__
leihen 0:2a179bd4cc02 19 #define __SOCKET_H__
leihen 0:2a179bd4cc02 20
leihen 0:2a179bd4cc02 21
leihen 0:2a179bd4cc02 22 #include "Wifi.h"
leihen 0:2a179bd4cc02 23
leihen 0:2a179bd4cc02 24 /** Class socket is the base class implementation for TCP and UDP sockets. As the socket class does not provide a full implementation of any kind, it is not recommended to use it.
leihen 0:2a179bd4cc02 25 * Class socket is required to implement the base functionality for UDP and TCP sockets in the WifiPlusClick library implementation.
leihen 0:2a179bd4cc02 26 * @note Please note that in this implementation the set_option function is not working as the WifiPlusClick module does not support this functionality.
leihen 0:2a179bd4cc02 27 */
leihen 0:2a179bd4cc02 28 class Socket
leihen 0:2a179bd4cc02 29 {
leihen 0:2a179bd4cc02 30 public:
leihen 0:2a179bd4cc02 31 /** Constructor of socket object.
leihen 0:2a179bd4cc02 32 */
leihen 0:2a179bd4cc02 33 Socket();
leihen 0:2a179bd4cc02 34
leihen 0:2a179bd4cc02 35 /** Function set_blocking sets the socket into a blocking or non-blocking status. In case of a blocking socket a timeout can be specified.
leihen 0:2a179bd4cc02 36 * @param blocking : set to true if time consuming socket operations shall block execution until they are finished or until a timeout occurs. If set to false, socket operations will terminated immediately.
leihen 0:2a179bd4cc02 37 * @param timeout : a timeout value in milliseconds for use in blocking operations.
leihen 0:2a179bd4cc02 38 */
leihen 0:2a179bd4cc02 39 void set_blocking(bool blocking, unsigned int timeout = 1500);
leihen 0:2a179bd4cc02 40
leihen 0:2a179bd4cc02 41 /** Function set_option is not working as expected, because there this functionality is not supported by the WifiPlusClick module.
leihen 0:2a179bd4cc02 42 * @note This functionality is just kept for compatibility reasons. */
leihen 0:2a179bd4cc02 43 int set_option(int level, int optname, const void* optval, int socklen);
leihen 0:2a179bd4cc02 44
leihen 0:2a179bd4cc02 45 /** Function close will close the socket.
leihen 0:2a179bd4cc02 46 * @param shutdown : This parameter will actually be ignored by the implementation.
leihen 0:2a179bd4cc02 47 * @returns :
leihen 0:2a179bd4cc02 48 * -1 if not successfull
leihen 0:2a179bd4cc02 49 * >=0 if successfull
leihen 0:2a179bd4cc02 50 */
leihen 0:2a179bd4cc02 51 int close( bool shutdown = true );
leihen 0:2a179bd4cc02 52
leihen 0:2a179bd4cc02 53 ~Socket();
leihen 0:2a179bd4cc02 54
leihen 0:2a179bd4cc02 55 protected:
leihen 0:2a179bd4cc02 56 bool _blocking;
leihen 0:2a179bd4cc02 57 unsigned int _timeout;
leihen 0:2a179bd4cc02 58
leihen 0:2a179bd4cc02 59 protected:
leihen 0:2a179bd4cc02 60 SOCKET_HANDLE_t _socket;
leihen 0:2a179bd4cc02 61 };
leihen 0:2a179bd4cc02 62
leihen 0:2a179bd4cc02 63
leihen 0:2a179bd4cc02 64 #endif // __SOCKET_H__