KDDI Fx0 hackathon / NySNICInterface

Fork of NySNICInterface by Ryo Iizuka

YDwifiInterface.h

Committer:
kishino
Date:
2014-03-13
Revision:
3:9f90024d7fb2
Parent:
2:0ba43344c814
Child:
5:ef3befe3edad

File content as of revision 3:9f90024d7fb2:

#ifndef _YD_WIFIINTERFACE_H_
#define _YD_WIFIINTERFACE_H_

#include "YDwifi.h"

namespace murata_wifi
{

/** C_YDwifiInterface class
 */
class C_YDwifiInterface: public C_YDwifi {
public:
    /** Constructor
        @param tx mbed pin to use for tx line of Serial interface
        @param rx mbed pin to use for rx line of Serial interface
        @param cts mbed pin to use for cts line of Serial interface
        @param rts mbed pin to use for rts line of Serial interface
        @param reset reset pin of the wifi module
        @param alarm alarm pin of the wifi module (default: NC)
        @param baud baud rate of Serial interface (default: 9600)
    */
    C_YDwifiInterface(PinName tx, PinName rx, PinName cts, PinName rts, PinName reset, PinName alarm = NC, int baud = 9600);

    /** Initialize the interface.
        @return 0 on success, a negative number on failure
    */
    int init();

    /** Get Firmware version string.
        @param  version_p Pointer of FW version string.(null terminated)[output]
        @return 0:success/other:fail
        @note   This function is blocked until a returns.
                When you use it by UI thread, be careful. 
    */
    int getFWVersion( unsigned char *version_p );

    /** Connect to AP
        @param ssid_p       Wi-Fi SSID(null terminated)
        @param ssid_len     Wi-Fi SSID length
        @param sec_type     Wi-Fi security type.
        @param sec_key_len  Wi-Fi passphrase or security key length
        @param sec_key_p    Wi-Fi passphrase or security key
        @return 0 on success, a negative number on failure
        @note   This function is blocked until a returns.
                When you use it by UI thread, be careful. 
    */
    int connect(const char *ssid_p, unsigned char ssid_len, E_SECURITY sec_type, const char *sec_key_p, unsigned char sec_key_len);
  
    /** Disconnect from AP
        @return 0 on success, a negative number on failure
        @note   This function is blocked until a returns.
                When you use it by UI thread, be careful. 
    */
    int disconnect();

    /** Scan AP
        @param  ssid_p  Wi-Fi SSID(null terminated)
                        If do not specify SSID, set to NULL.
        @param  bssid_p Wi-Fi BSSID(null terminated)
                        If do not specify SSID, set to NULL.
        @param  result_handler_p Pointer of scan result callback function.
        @return 0 on success, a negative number on failure
        @note   This function is blocked until a returns.
                When you use it by UI thread, be careful. 
                Scan results will be notified by asynchronous callback function.
    */
    int scan( const char *ssid_p, unsigned char *bssid_p
            ,void (*result_handler_p)(tagSCAN_RESULT_T *scan_result) );

#if 0  
  /** Get the MAC address of your Ethernet interface
   * \return a pointer to a string containing the MAC address
   */
  char* getMACAddress();
  
  /** Get the IP address of your Ethernet interface
   * \return a pointer to a string containing the IP address
   */
  char* getIPAddress();

  /** Get the Gateway address of your Ethernet interface
   * \return a pointer to a string containing the Gateway address
   */
  char* getGateway();
 
  /** Get the Network mask of your Ethernet interface
   * \return a pointer to a string containing the Network mask
   */
  char* getNetworkMask();
#endif
};
}
#endif  /* _YD_WIFIINTERFACE_H_ */