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

YDwifi/YDwifi_uartmsg.h@7:e88ccbe0225f, 2014-03-14 (annotated)

Committer:
kishino
Date:
Fri Mar 14 08:48:12 2014 +0000
Revision:
7:e88ccbe0225f
Parent:
2:0ba43344c814 
Scan handler interface modify

Who changed what in which revision?

UserRevisionLine numberNew contents of line
kishino 0:61c402886fbb 1 #ifndef _YD_WIFI_UART_MSG_H_
kishino 0:61c402886fbb 2 #define _YD_WIFI_UART_MSG_H_
kishino 0:61c402886fbb 3
kishino 0:61c402886fbb 4 #include "mbed.h"
kishino 0:61c402886fbb 5 #include "rtos.h"
kishino 0:61c402886fbb 6 #include "RawSerial.h"
kishino 0:61c402886fbb 7
kishino 7:e88ccbe0225f 8 namespace murata_wifi
kishino 7:e88ccbe0225f 9 {
kishino 7:e88ccbe0225f 10
kishino 0:61c402886fbb 11 #define UART_CMD_SOM 0x02
kishino 0:61c402886fbb 12 #define UART_CMD_EOM 0x04
kishino 0:61c402886fbb 13 #define UART_CMD_ESC 0x10
kishino 0:61c402886fbb 14
kishino 0:61c402886fbb 15 /* SNIC UART Command ID */
kishino 0:61c402886fbb 16 #define UART_CMD_ID_GEN 0x01 //General command
kishino 0:61c402886fbb 17 #define UART_CMD_ID_WIFI 0x50 //Wi-Fi command
kishino 0:61c402886fbb 18
kishino 0:61c402886fbb 19 /* SNIC UART Subcommand ID */
kishino 0:61c402886fbb 20 #define UART_CMD_SID_GEN_PWR_UP_IND 0x00 //Power up indication
kishino 0:61c402886fbb 21 #define UART_CMD_SID_GEN_FW_VER_GET_REQ 0x08 //Get firmware version string
kishino 0:61c402886fbb 22
kishino 0:61c402886fbb 23 #define UART_CMD_SID_WIFI_ON_REQ 0x00 // Turn on Wifi
kishino 0:61c402886fbb 24 #define UART_CMD_SID_WIFI_OFF_REQ 0x01 // Turn off Wifi
kishino 0:61c402886fbb 25 #define UART_CMD_SID_WIFI_JOIN_REQ 0x02 // Associate to a network
kishino 0:61c402886fbb 26 #define UART_CMD_SID_WIFI_DISCONNECT_REQ 0x03 // Disconnect from a network
kishino 0:61c402886fbb 27 #define UART_CMD_SID_WIFI_GET_STATUS_REQ 0x04 // Get WiFi status
kishino 0:61c402886fbb 28 #define UART_CMD_SID_WIFI_SCAN_REQ 0x05 // Scan WiFi networks
kishino 0:61c402886fbb 29 #define UART_CMD_SID_WIFI_GET_STA_RSSI_REQ 0x06 // Get STA signal strength (RSSI)
kishino 0:61c402886fbb 30 #define UART_CMD_SID_WIFI_AP_CTRL_REQ 0x07 // Soft AP on-off control
kishino 0:61c402886fbb 31 #define UART_CMD_SID_WIFI_WPS_REQ 0x08 // Start WPS process
kishino 0:61c402886fbb 32 #define UART_CMD_SID_WIFI_AP_GET_CLIENT_REQ 0x0A // Get clients that are associated to the soft AP.
kishino 0:61c402886fbb 33 #define UART_CMD_SID_WIFI_NETWORK_STATUS_IND 0x10 // Network status indication
kishino 0:61c402886fbb 34 #define UART_CMD_SID_WIFI_SCAN_RESULT_IND 0x11 // Scan result indication
kishino 0:61c402886fbb 35
kishino 0:61c402886fbb 36 /* SNIC UART Command response status code */
kishino 0:61c402886fbb 37 #define UART_CMD_RES_SNIC_SUCCESS 0x00
kishino 0:61c402886fbb 38 #define UART_CMD_RES_SNIC_FAIL 0x01
kishino 0:61c402886fbb 39 #define UART_CMD_RES_SNIC_INIT_FAIL 0x02
kishino 0:61c402886fbb 40 #define UART_CMD_RES_SNIC_CLEANUP_FAIL 0x03
kishino 0:61c402886fbb 41 #define UART_CMD_RES_SNIC_GETADDRINFO_FAIL 0x04
kishino 0:61c402886fbb 42 #define UART_CMD_RES_SNIC_CREATE_SOCKET_FAIL 0x05
kishino 0:61c402886fbb 43 #define UART_CMD_RES_SNIC_BIND_SOCKET_FAIL 0x06
kishino 0:61c402886fbb 44 #define UART_CMD_RES_SNIC_LISTEN_SOCKET_FAIL 0x07
kishino 0:61c402886fbb 45 #define UART_CMD_RES_SNIC_ACCEPT_SOCKET_FAIL 0x08
kishino 0:61c402886fbb 46 #define UART_CMD_RES_SNIC_PARTIAL_CLOSE_FAIL 0x09
kishino 0:61c402886fbb 47 #define UART_CMD_RES_SNIC_SOCKET_PARTIALLY_CLOSED 0x0A
kishino 0:61c402886fbb 48 #define UART_CMD_RES_SNIC_SOCKET_CLOSED 0x0B
kishino 0:61c402886fbb 49 #define UART_CMD_RES_SNIC_CLOSE_SOCKET_FAIL 0x0C
kishino 0:61c402886fbb 50 #define UART_CMD_RES_SNIC_PACKET_TOO_LARGE 0x0D
kishino 0:61c402886fbb 51 #define UART_CMD_RES_SNIC_SEND_FAIL 0x0E
kishino 0:61c402886fbb 52 #define UART_CMD_RES_SNIC_CONNECT_TO_SERVER_FAIL 0x0F
kishino 0:61c402886fbb 53 #define UART_CMD_RES_SNIC_NOT_ENOUGH_MEMORY 0x10
kishino 0:61c402886fbb 54 #define UART_CMD_RES_SNIC_TIMEOUT 0x11
kishino 0:61c402886fbb 55 #define UART_CMD_RES_SNIC_CONNECTION_UP 0x12
kishino 0:61c402886fbb 56 #define UART_CMD_RES_SNIC_GETSOCKOPT_FAIL 0x13
kishino 0:61c402886fbb 57 #define UART_CMD_RES_SNIC_SETSOCKOPT_FAIL 0x14
kishino 0:61c402886fbb 58 #define UART_CMD_RES_SNIC_INVALID_ARGUMENT 0x15
kishino 0:61c402886fbb 59 #define UART_CMD_RES_SNIC_SEND_ARP_FAIL 0x16
kishino 0:61c402886fbb 60 #define UART_CMD_RES_SNIC_INVALID_SOCKET 0x17
kishino 0:61c402886fbb 61 #define UART_CMD_RES_SNIC_COMMAND_PENDING 0x18
kishino 0:61c402886fbb 62 #define UART_CMD_RES_SNIC_SOCKET_NOT_BOUND 0x19
kishino 0:61c402886fbb 63 #define UART_CMD_RES_SNIC_SOCKET_NOT_CONNECTED 0x1A
kishino 0:61c402886fbb 64 #define UART_CMD_RES_SNIC_NO_NETWORK 0x20
kishino 0:61c402886fbb 65 #define UART_CMD_RES_SNIC_INIT_NOT_DONE 0x21
kishino 0:61c402886fbb 66 #define UART_CMD_RES_SNIC_NET_IF_FAIL 0x22
kishino 0:61c402886fbb 67 #define UART_CMD_RES_SNIC_NET_IF_NOT_UP 0x23
kishino 0:61c402886fbb 68 #define UART_CMD_RES_SNIC_DHCP_START_FAIL 0x24
kishino 0:61c402886fbb 69
kishino 0:61c402886fbb 70 #define UART_CMD_RES_WIFI_SUCCESS 0x00
kishino 0:61c402886fbb 71 #define UART_CMD_RES_WIFI_ERR_UNKNOWN_COUNTRY 0x01
kishino 0:61c402886fbb 72 #define UART_CMD_RES_WIFI_ERR_INIT_FAIL 0x02
kishino 0:61c402886fbb 73 #define UART_CMD_RES_WIFI_ERR_ALREADY_JOINED 0x03
kishino 0:61c402886fbb 74 #define UART_CMD_RES_WIFI_ERR_AUTH_TYPE 0x04
kishino 0:61c402886fbb 75 #define UART_CMD_RES_WIFI_ERR_JOIN_FAIL 0x05
kishino 0:61c402886fbb 76 #define UART_CMD_RES_WIFI_ERR_NOT_JOINED 0x06
kishino 0:61c402886fbb 77 #define UART_CMD_RES_WIFI_ERR_LEAVE_FAILED 0x07
kishino 0:61c402886fbb 78 #define UART_CMD_RES_WIFI_COMMAND_PENDING 0x08
kishino 0:61c402886fbb 79 #define UART_CMD_RES_WIFI_WPS_NO_CONFIG 0x09
kishino 0:61c402886fbb 80 #define UART_CMD_RES_WIFI_NETWORK_UP 0x10
kishino 0:61c402886fbb 81 #define UART_CMD_RES_WIFI_NETWORK_DOWN 0x11
kishino 0:61c402886fbb 82 #define UART_CMD_RES_WIFI_FAIL 0xFF
kishino 0:61c402886fbb 83
kishino 0:61c402886fbb 84 /** UART Command sequence number
kishino 0:61c402886fbb 85 */
kishino 0:61c402886fbb 86 static unsigned char mUartRequestSeq;
kishino 0:61c402886fbb 87
kishino 0:61c402886fbb 88 /** C_YD_UartMsg class
kishino 0:61c402886fbb 89 */
kishino 0:61c402886fbb 90 class C_YD_UartMsg
kishino 0:61c402886fbb 91 {
kishino 0:61c402886fbb 92
kishino 0:61c402886fbb 93 public:
kishino 0:61c402886fbb 94 C_YD_UartMsg();
kishino 0:61c402886fbb 95
kishino 0:61c402886fbb 96 /** Make SNIC UART command payload.
kishino 1:c6e5f49dce5f 97 @param cmd_len Command length
kishino 1:c6e5f49dce5f 98 @param cmd_p Command pointer
kishino 1:c6e5f49dce5f 99 @param payload_p Payload pointer[output]
kishino 1:c6e5f49dce5f 100 @return payload length
kishino 0:61c402886fbb 101 */
kishino 0:61c402886fbb 102 static unsigned short makePayload( unsigned int cmd_len, unsigned char *cmd_p, unsigned char *payload_p );
kishino 0:61c402886fbb 103
kishino 0:61c402886fbb 104 /** Make SNIC UART command.
kishino 1:c6e5f49dce5f 105 @param cmd_id Command ID
kishino 1:c6e5f49dce5f 106 @param payload_p Payload pointer
kishino 1:c6e5f49dce5f 107 @param uart_command_p UART Command pointer [output]
kishino 1:c6e5f49dce5f 108 @return UART Command length
kishino 0:61c402886fbb 109 */
kishino 1:c6e5f49dce5f 110 static unsigned int makeRequest( unsigned char cmd_id, unsigned char *payload_p, unsigned short payload_len, unsigned char *uart_command_p );
kishino 1:c6e5f49dce5f 111
kishino 0:61c402886fbb 112
kishino 1:c6e5f49dce5f 113 /** Get uart command from receive data.
kishino 2:0ba43344c814 114 @param recvdata_len Receive data length
kishino 2:0ba43344c814 115 @param recvdata_p Pointer of received data from UART
kishino 2:0ba43344c814 116 @param command_id_p Pointer of command ID[output]
kishino 2:0ba43344c814 117 @param payload_p Pointer of payload[output]
kishino 2:0ba43344c814 118 @return Payload length
kishino 1:c6e5f49dce5f 119 */
kishino 2:0ba43344c814 120 static unsigned int getResponsePayload( unsigned int recvdata_len, unsigned char *recvdata_p
kishino 1:c6e5f49dce5f 121 , unsigned char *command_id_p, unsigned char *payload_p );
kishino 0:61c402886fbb 122 protected:
kishino 0:61c402886fbb 123
kishino 0:61c402886fbb 124 };
kishino 7:e88ccbe0225f 125 }
kishino 0:61c402886fbb 126 #endif /* _YD_WIFI_UART_MSG_H_ */