muRata / SNICInterface

SNIC UART　Interface library: Serial to Wi-Fi library for Murata TypeYD Wi-Fi module. For more information about TypeYD: http://www.murata.co.jp/products/microwave/module/lbwb1zzydz/index.html

Dependents:   SNIC-xively-jumpstart-demo SNIC-FluentLogger-example TCPEchoServer murataDemo ... more

Fork of YDwifiInterface by Takao Kishino

Files at this revision

API Documentation at this revision

Revision 23:4ff2231ff9ba, committed 2014-03-27

Comitter:
kishino
Date:
Thu Mar 27 10:11:59 2014 +0000
Parent:
22:a9ec0cad4f84
Child:
24:987e412ae879
Commit message:
Modified the description of classes.

Changed in this revision

SNIC/SNIC_Core.h Show annotated file Show diff for this revision Revisions of this file
SNIC/SNIC_UartCommandManager.h Show annotated file Show diff for this revision Revisions of this file
SNIC/SNIC_UartMsgUtil.h Show annotated file Show diff for this revision Revisions of this file
SNIC_WifiInterface.h Show annotated file Show diff for this revision Revisions of this file
Socket/TCPSocketConnection.h Show annotated file Show diff for this revision Revisions of this file
Socket/TCPSocketServer.h Show annotated file Show diff for this revision Revisions of this file
Socket/UDPSocket.h Show annotated file Show diff for this revision Revisions of this file 
--- a/SNIC/SNIC_Core.h	Thu Mar 27 07:37:55 2014 +0000
+++ b/SNIC/SNIC_Core.h	Thu Mar 27 10:11:59 2014 +0000
@@ -58,7 +58,7 @@
     e_AP_STARTED
 }E_WIFI_STATUS;
 
-/** C_SNIC_Core class
+/** Internal class used by any other classes. This class is singleton.
  */
 class C_SNIC_Core
 {

--- a/SNIC/SNIC_UartCommandManager.h	Thu Mar 27 07:37:55 2014 +0000
+++ b/SNIC/SNIC_UartCommandManager.h	Thu Mar 27 10:11:59 2014 +0000
@@ -30,7 +30,7 @@
 /** Timeout of UART command wait(ms)*/
 #define UART_COMMAND_WAIT_TIMEOUT  10000
 
-/** Scan result 
+/** Scan result structure used by scanresults handler
 */
 typedef struct {
     bool          is_complete;
@@ -50,7 +50,7 @@
     char          ssid[SSID_MAX_LENGTH+1];
 }tagSCAN_RESULT_T;
 
-/** C_SNIC_UartCommandManager class
+/** Internal class for managing the SNIC UART command.
  */
 class C_SNIC_UartCommandManager
 {

--- a/SNIC/SNIC_UartMsgUtil.h	Thu Mar 27 07:37:55 2014 +0000
+++ b/SNIC/SNIC_UartMsgUtil.h	Thu Mar 27 10:11:59 2014 +0000
@@ -131,7 +131,7 @@
 */
 static unsigned char mUartRequestSeq;  
 
-/** C_SNIC_UartMsgUtil class
+/** Internal utility class used by any other classes.
  */
 class C_SNIC_UartMsgUtil
 {

--- a/SNIC_WifiInterface.h	Thu Mar 27 07:37:55 2014 +0000
+++ b/SNIC_WifiInterface.h	Thu Mar 27 10:11:59 2014 +0000
@@ -18,7 +18,7 @@
 namespace murata_wifi
 {
 
-/** Wi-Fi status */
+/** Wi-Fi status used by getWifiStatus(). */
 typedef struct
 {
     /** status */
@@ -29,7 +29,7 @@
     char ssid[SSID_MAX_LENGTH+1];
 }tagWIFI_STATUS_T;
 
-/** C_SNIC_WifiInterface class
+/** Interface class for using SNIC UART.
  */
 class C_SNIC_WifiInterface {
 public:

--- a/Socket/TCPSocketConnection.h	Thu Mar 27 07:37:55 2014 +0000
+++ b/Socket/TCPSocketConnection.h	Thu Mar 27 10:11:59 2014 +0000
@@ -38,7 +38,7 @@
 {
 
 /**
-TCP socket connection
+    Interface class for TCP socket of using SNIC UART.
 */
 class TCPSocketConnection : public Socket, public Endpoint {
     

--- a/Socket/TCPSocketServer.h	Thu Mar 27 07:37:55 2014 +0000
+++ b/Socket/TCPSocketServer.h	Thu Mar 27 10:11:59 2014 +0000
@@ -36,8 +36,10 @@
 namespace murata_wifi
 {
 
-/** TCP Server.
-  */
+/** 
+    Interface class for TCP server socket of using SNIC UART.
+
+*/
 class TCPSocketServer : public Socket {
   public:
     /** Instantiate a TCP Server.

--- a/Socket/UDPSocket.h	Thu Mar 27 07:37:55 2014 +0000
+++ b/Socket/UDPSocket.h	Thu Mar 27 10:11:59 2014 +0000
@@ -38,7 +38,7 @@
 {
 
 /**
-UDP Socket
+Interface class for UDP socket of using SNIC UART.
 */
 class UDPSocket : public Socket {