KDDI Fx0 hackathon / SNICInterface_mod

SNIC UART Interface library for Murata Type-YD module

Dependents:   WebSocketServerTest

Fork of SNICInterface_mod by Toyomasa Watarai

SNIC_WifiInterface.h@26:f2e1030964e4, 2014-03-28 (annotated)

Committer:
kishino
Date:
Fri Mar 28 03:03:40 2014 +0000
Revision:
26:f2e1030964e4
Parent:
25:67183ed15708
Child:
29:6a0ba999597d
Created a virtual destructor

Who changed what in which revision?

UserRevisionLine numberNew contents of line
kishino 14:54378c96d285 1 /******************* Murata Manufacturing Co.,Ltd. 2014 *****************
kishino 14:54378c96d285 2 *
kishino 14:54378c96d285 3 * Filename: SNIC_WifiInterface.h
kishino 14:54378c96d285 4 *
kishino 14:54378c96d285 5 * Purpose: This module has define of API for SNIC UART of Wi-Fi.
kishino 14:54378c96d285 6 *
kishino 14:54378c96d285 7 * $Author: kishino $
kishino 14:54378c96d285 8 *
kishino 14:54378c96d285 9 * $Date: 2014/03/26 $
kishino 14:54378c96d285 10 *
kishino 14:54378c96d285 11 * $Revision: 0.0.0.1 $
kishino 14:54378c96d285 12 * ***********************************************************************/
kishino 12:0254eaccfda2 13 #ifndef _SNIC_WIFIINTERFACE_H_
kishino 12:0254eaccfda2 14 #define _SNIC_WIFIINTERFACE_H_
kishino 12:0254eaccfda2 15
kishino 12:0254eaccfda2 16 #include "SNIC_Core.h"
kishino 25:67183ed15708 17 #include "MurataObject.h"
kishino 12:0254eaccfda2 18
kishino 12:0254eaccfda2 19 namespace murata_wifi
kishino 12:0254eaccfda2 20 {
kishino 12:0254eaccfda2 21
kishino 23:4ff2231ff9ba 22 /** Wi-Fi status used by getWifiStatus(). */
kishino 12:0254eaccfda2 23 typedef struct
kishino 12:0254eaccfda2 24 {
kishino 12:0254eaccfda2 25 /** status */
kishino 12:0254eaccfda2 26 E_WIFI_STATUS status;
kishino 12:0254eaccfda2 27 /** Mac address */
kishino 12:0254eaccfda2 28 char mac_address[BSSID_MAC_LENTH];
kishino 12:0254eaccfda2 29 /** SSID */
kishino 12:0254eaccfda2 30 char ssid[SSID_MAX_LENGTH+1];
kishino 12:0254eaccfda2 31 }tagWIFI_STATUS_T;
kishino 12:0254eaccfda2 32
kishino 23:4ff2231ff9ba 33 /** Interface class for using SNIC UART.
kishino 12:0254eaccfda2 34 */
kishino 25:67183ed15708 35 class C_SNIC_WifiInterface : public C_MurataObject {
kishino 12:0254eaccfda2 36 public:
kishino 12:0254eaccfda2 37 /** Constructor
kishino 12:0254eaccfda2 38 @param tx mbed pin to use for tx line of Serial interface
kishino 12:0254eaccfda2 39 @param rx mbed pin to use for rx line of Serial interface
kishino 12:0254eaccfda2 40 @param cts mbed pin to use for cts line of Serial interface
kishino 12:0254eaccfda2 41 @param rts mbed pin to use for rts line of Serial interface
kishino 12:0254eaccfda2 42 @param reset reset pin of the wifi module
kishino 12:0254eaccfda2 43 @param alarm alarm pin of the wifi module (default: NC)
kishino 12:0254eaccfda2 44 @param baud baud rate of Serial interface (default: 9600)
kishino 12:0254eaccfda2 45 */
kishino 12:0254eaccfda2 46 C_SNIC_WifiInterface(PinName tx, PinName rx, PinName cts, PinName rts, PinName reset, PinName alarm = NC, int baud = 115200);
kishino 26:f2e1030964e4 47 virtual ~C_SNIC_WifiInterface();
kishino 12:0254eaccfda2 48
kishino 12:0254eaccfda2 49 /** Initialize the interface.
kishino 12:0254eaccfda2 50 @return 0 on success, a negative number on failure
kishino 12:0254eaccfda2 51 */
kishino 12:0254eaccfda2 52 int init();
kishino 12:0254eaccfda2 53
kishino 12:0254eaccfda2 54 /** Get Firmware version string.
kishino 12:0254eaccfda2 55 @param version_p Pointer of FW version string.(null terminated)[output]
kishino 12:0254eaccfda2 56 @return 0:success/other:fail
kishino 12:0254eaccfda2 57 @note This function is blocked until a returns.
kishino 12:0254eaccfda2 58 When you use it by UI thread, be careful.
kishino 12:0254eaccfda2 59 */
kishino 12:0254eaccfda2 60 int getFWVersion( unsigned char *version_p );
kishino 12:0254eaccfda2 61
kishino 12:0254eaccfda2 62 /** Connect to AP
kishino 12:0254eaccfda2 63 @param ssid_p Wi-Fi SSID(null terminated)
kishino 12:0254eaccfda2 64 @param ssid_len Wi-Fi SSID length
kishino 12:0254eaccfda2 65 @param sec_type Wi-Fi security type.
kishino 12:0254eaccfda2 66 @param sec_key_len Wi-Fi passphrase or security key length
kishino 12:0254eaccfda2 67 @param sec_key_p Wi-Fi passphrase or security key
kishino 12:0254eaccfda2 68 @return 0 on success, a negative number on failure
kishino 12:0254eaccfda2 69 @note This function is blocked until a returns.
kishino 12:0254eaccfda2 70 When you use it by UI thread, be careful.
kishino 12:0254eaccfda2 71 */
kishino 12:0254eaccfda2 72 int connect(const char *ssid_p, unsigned char ssid_len, E_SECURITY sec_type, const char *sec_key_p, unsigned char sec_key_len);
kishino 12:0254eaccfda2 73
kishino 12:0254eaccfda2 74 /** Disconnect from AP
kishino 12:0254eaccfda2 75 @return 0 on success, a negative number on failure
kishino 12:0254eaccfda2 76 @note This function is blocked until a returns.
kishino 12:0254eaccfda2 77 When you use it by UI thread, be careful.
kishino 12:0254eaccfda2 78 */
kishino 12:0254eaccfda2 79 int disconnect();
kishino 12:0254eaccfda2 80
kishino 12:0254eaccfda2 81 /** Scan AP
kishino 12:0254eaccfda2 82 @param ssid_p Wi-Fi SSID(null terminated)
kishino 12:0254eaccfda2 83 If do not specify SSID, set to NULL.
kishino 12:0254eaccfda2 84 @param bssid_p Wi-Fi BSSID(null terminated)
kishino 12:0254eaccfda2 85 If do not specify SSID, set to NULL.
kishino 12:0254eaccfda2 86 @param result_handler_p Pointer of scan result callback function.
kishino 12:0254eaccfda2 87 @return 0 on success, a negative number on failure
kishino 12:0254eaccfda2 88 @note This function is blocked until a returns.
kishino 12:0254eaccfda2 89 When you use it by UI thread, be careful.
kishino 12:0254eaccfda2 90 Scan results will be notified by asynchronous callback function.
kishino 12:0254eaccfda2 91 If there is no continuity data, result_handler_p　will be set NULL..
kishino 12:0254eaccfda2 92 */
kishino 12:0254eaccfda2 93 int scan( const char *ssid_p, unsigned char *bssid_p
kishino 12:0254eaccfda2 94 ,void (*result_handler_p)(tagSCAN_RESULT_T *scan_result) );
kishino 12:0254eaccfda2 95
kishino 12:0254eaccfda2 96 /** Wi-Fi Turn on
kishino 12:0254eaccfda2 97 @param country_p Pointer of country code.
kishino 12:0254eaccfda2 98 @return 0 on success, a negative number on failure
kishino 12:0254eaccfda2 99 @note This function is blocked until a returns.
kishino 12:0254eaccfda2 100 When you use it by UI thread, be careful.
kishino 12:0254eaccfda2 101 */
kishino 12:0254eaccfda2 102 int wifi_on( const char *country_p );
kishino 12:0254eaccfda2 103
kishino 12:0254eaccfda2 104 /** Wi-Fi Turn off
kishino 12:0254eaccfda2 105 @return 0 on success, a negative number on failure
kishino 12:0254eaccfda2 106 @note This function is blocked until a returns.
kishino 12:0254eaccfda2 107 When you use it by UI thread, be careful.
kishino 12:0254eaccfda2 108 */
kishino 12:0254eaccfda2 109 int wifi_off();
kishino 12:0254eaccfda2 110
kishino 12:0254eaccfda2 111 /** Get Wi-Fi RSSI
kishino 12:0254eaccfda2 112 @param rssi_p Pointer of RSSI.[output]
kishino 12:0254eaccfda2 113 @return 0 on success, a negative number on failure
kishino 12:0254eaccfda2 114 @note This function is blocked until a returns.
kishino 12:0254eaccfda2 115 When you use it by UI thread, be careful.
kishino 12:0254eaccfda2 116 */
kishino 12:0254eaccfda2 117 int getRssi( signed char *rssi_p );
kishino 12:0254eaccfda2 118
kishino 12:0254eaccfda2 119 /** Get Wi-Fi status
kishino 12:0254eaccfda2 120 @param status_p Pointer of status structure.[output]
kishino 12:0254eaccfda2 121 @return 0 on success, a negative number on failure
kishino 12:0254eaccfda2 122 @note This function is blocked until a returns.
kishino 12:0254eaccfda2 123 When you use it by UI thread, be careful.
kishino 12:0254eaccfda2 124 */
kishino 12:0254eaccfda2 125 int getWifiStatus( tagWIFI_STATUS_T *status_p);
kishino 12:0254eaccfda2 126
kishino 12:0254eaccfda2 127 #if 0
kishino 12:0254eaccfda2 128 /** Get the MAC address of your Ethernet interface
kishino 12:0254eaccfda2 129 * \return a pointer to a string containing the MAC address
kishino 12:0254eaccfda2 130 */
kishino 12:0254eaccfda2 131 char* getMACAddress();
kishino 12:0254eaccfda2 132
kishino 12:0254eaccfda2 133 /** Get the IP address of your Ethernet interface
kishino 12:0254eaccfda2 134 * \return a pointer to a string containing the IP address
kishino 12:0254eaccfda2 135 */
kishino 12:0254eaccfda2 136 char* getIPAddress();
kishino 12:0254eaccfda2 137
kishino 12:0254eaccfda2 138 /** Get the Gateway address of your Ethernet interface
kishino 12:0254eaccfda2 139 * \return a pointer to a string containing the Gateway address
kishino 12:0254eaccfda2 140 */
kishino 12:0254eaccfda2 141 char* getGateway();
kishino 12:0254eaccfda2 142
kishino 12:0254eaccfda2 143 /** Get the Network mask of your Ethernet interface
kishino 12:0254eaccfda2 144 * \return a pointer to a string containing the Network mask
kishino 12:0254eaccfda2 145 */
kishino 12:0254eaccfda2 146 char* getNetworkMask();
kishino 12:0254eaccfda2 147 #endif
kishino 12:0254eaccfda2 148
kishino 12:0254eaccfda2 149 private:
kishino 12:0254eaccfda2 150 PinName mUART_tx;
kishino 12:0254eaccfda2 151 PinName mUART_rx;
kishino 12:0254eaccfda2 152 PinName mUART_cts;
kishino 12:0254eaccfda2 153 PinName mUART_rts;
kishino 12:0254eaccfda2 154 int mUART_baud;
kishino 12:0254eaccfda2 155 PinName mModuleReset;
kishino 12:0254eaccfda2 156 };
kishino 12:0254eaccfda2 157 }
kishino 12:0254eaccfda2 158 #endif /* _YD_WIFIINTERFACE_H_ */