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/YDwifiUartCommand.h@3:9f90024d7fb2, 2014-03-13 (annotated)

Committer:
kishino
Date:
Thu Mar 13 01:34:56 2014 +0000
Revision:
3:9f90024d7fb2
Parent:
2:0ba43344c814
Child:
5:ef3befe3edad
The following API was created.;  =>Connect to AP.;  =>Disconnect from AP.;  =>Scan AP.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
kishino 2:0ba43344c814 1 #ifndef _YD_WIFI_UART_COMMAND_H_
kishino 2:0ba43344c814 2 #define _YD_WIFI_UART_COMMAND_H_
kishino 2:0ba43344c814 3 #include "mbed.h"
kishino 2:0ba43344c814 4 #include "rtos.h"
kishino 2:0ba43344c814 5
kishino 2:0ba43344c814 6 namespace murata_wifi
kishino 2:0ba43344c814 7 {
kishino 3:9f90024d7fb2 8 /** Max length of SSID */
kishino 3:9f90024d7fb2 9 #define SSID_MAX_LENGTH 32
kishino 3:9f90024d7fb2 10 /** Max length of BSSID */
kishino 3:9f90024d7fb2 11 #define BSSID_MAC_LENTH 6
kishino 2:0ba43344c814 12
kishino 2:0ba43344c814 13 /** Wait signal ID of UART command */
kishino 2:0ba43344c814 14 #define UART_COMMAND_SIGNAL 0x00000001
kishino 2:0ba43344c814 15 /** Timeout of UART command wait(ms)*/
kishino 2:0ba43344c814 16 #define UART_COMMAND_WAIT_TIMEOUT 10000
kishino 2:0ba43344c814 17
kishino 3:9f90024d7fb2 18 /** Scan result
kishino 3:9f90024d7fb2 19 */
kishino 3:9f90024d7fb2 20 typedef struct {
kishino 3:9f90024d7fb2 21 /** Channel */
kishino 3:9f90024d7fb2 22 unsigned char channel;
kishino 3:9f90024d7fb2 23 /** RSSI */
kishino 3:9f90024d7fb2 24 signed char rssi;
kishino 3:9f90024d7fb2 25 /** Security type */
kishino 3:9f90024d7fb2 26 unsigned char security;
kishino 3:9f90024d7fb2 27 /** BSSID */
kishino 3:9f90024d7fb2 28 unsigned char bssid[BSSID_MAC_LENTH];
kishino 3:9f90024d7fb2 29 /** Network type */
kishino 3:9f90024d7fb2 30 unsigned char network_type;
kishino 3:9f90024d7fb2 31 /** Max data rate */
kishino 3:9f90024d7fb2 32 unsigned char max_rate;
kishino 3:9f90024d7fb2 33 /** SSID */
kishino 3:9f90024d7fb2 34 char ssid[SSID_MAX_LENGTH+1];
kishino 3:9f90024d7fb2 35 }tagSCAN_RESULT_T;
kishino 3:9f90024d7fb2 36
kishino 3:9f90024d7fb2 37 /** C_YDwifiUartCommand class
kishino 3:9f90024d7fb2 38 */
kishino 2:0ba43344c814 39 class C_YDwifiUartCommand
kishino 2:0ba43344c814 40 {
kishino 2:0ba43344c814 41 public:
kishino 2:0ba43344c814 42 /** Set Command ID
kishino 2:0ba43344c814 43 @param cmd_id Command ID
kishino 2:0ba43344c814 44 */
kishino 2:0ba43344c814 45 void setCommandID( unsigned char cmd_id );
kishino 2:0ba43344c814 46
kishino 2:0ba43344c814 47 /** Get Command ID
kishino 2:0ba43344c814 48 @return Command ID
kishino 2:0ba43344c814 49 */
kishino 2:0ba43344c814 50 unsigned char getCommandID();
kishino 2:0ba43344c814 51
kishino 2:0ba43344c814 52 /** Set Command SubID
kishino 2:0ba43344c814 53 @param cmd_sid Command Sub ID
kishino 2:0ba43344c814 54 */
kishino 2:0ba43344c814 55 void setCommandSID( unsigned char cmd_sid );
kishino 2:0ba43344c814 56
kishino 2:0ba43344c814 57 /** Get Command SubID
kishino 2:0ba43344c814 58 @return Command Sub ID
kishino 2:0ba43344c814 59 */
kishino 2:0ba43344c814 60 unsigned char getCommandSID();
kishino 2:0ba43344c814 61
kishino 2:0ba43344c814 62 /** Set Command status
kishino 2:0ba43344c814 63 @param status Command status
kishino 2:0ba43344c814 64 */
kishino 2:0ba43344c814 65 void setCommandStatus( unsigned char status );
kishino 2:0ba43344c814 66
kishino 2:0ba43344c814 67 /** Get Command status
kishino 2:0ba43344c814 68 @return Command status
kishino 2:0ba43344c814 69 */
kishino 2:0ba43344c814 70 unsigned char getCommandStatus();
kishino 2:0ba43344c814 71
kishino 2:0ba43344c814 72 /** Set Response buffer
kishino 2:0ba43344c814 73 @param buf_p Pointer of response buffer
kishino 2:0ba43344c814 74 */
kishino 2:0ba43344c814 75 void setResponseBuf( unsigned char *buf_p );
kishino 2:0ba43344c814 76
kishino 2:0ba43344c814 77 /** Get Response buffer
kishino 2:0ba43344c814 78 @return Pointer of response buffer
kishino 2:0ba43344c814 79 */
kishino 2:0ba43344c814 80 unsigned char *getResponseBuf();
kishino 3:9f90024d7fb2 81
kishino 3:9f90024d7fb2 82 /** Set scan result callback hander
kishino 3:9f90024d7fb2 83 @param handler_p Pointer of callback function
kishino 3:9f90024d7fb2 84 */
kishino 3:9f90024d7fb2 85 void setScanResultHandler( void (*handler_p)(tagSCAN_RESULT_T *scan_result) );
kishino 3:9f90024d7fb2 86
kishino 3:9f90024d7fb2 87 void scanResultIndicate( unsigned char *payload_p, int payload_len );
kishino 2:0ba43344c814 88
kishino 2:0ba43344c814 89 /** Checks in the command which is waiting from Command ID and Sub ID.
kishino 2:0ba43344c814 90 @param command_id Command ID
kishino 2:0ba43344c814 91 @param payload_p Command payload
kishino 2:0ba43344c814 92 @return true: Waiting command / false: Not waiting command
kishino 2:0ba43344c814 93 */
kishino 2:0ba43344c814 94 bool isWaitingCommand( unsigned int command_id, unsigned char *payload_p );
kishino 2:0ba43344c814 95
kishino 2:0ba43344c814 96 int wait();
kishino 2:0ba43344c814 97
kishino 2:0ba43344c814 98 int signal();
kishino 2:0ba43344c814 99
kishino 2:0ba43344c814 100 protected:
kishino 2:0ba43344c814 101 /** Command request thread ID */
kishino 2:0ba43344c814 102 osThreadId mCommandThreadID;
kishino 2:0ba43344c814 103 /** Command ID */
kishino 2:0ba43344c814 104 unsigned char mCommandID;
kishino 2:0ba43344c814 105 /** Command SubID */
kishino 2:0ba43344c814 106 unsigned char mCommandSID;
kishino 2:0ba43344c814 107 /** Status of command response */
kishino 2:0ba43344c814 108 unsigned char mCommandStatus;
kishino 2:0ba43344c814 109 /** ResponseData of command response */
kishino 2:0ba43344c814 110 unsigned char *mResponseBuf_p;
kishino 3:9f90024d7fb2 111 /** Scan result handler */
kishino 3:9f90024d7fb2 112 void (*mScanResultHandler_p)(tagSCAN_RESULT_T *scan_result);
kishino 2:0ba43344c814 113 };
kishino 2:0ba43344c814 114
kishino 2:0ba43344c814 115 }
kishino 2:0ba43344c814 116 #endif