takashi yamanoue / Mbed 2 deprecated XBee_API_ex3

Xbee API Test 3

Dependencies:   XBee mbed 

> help
h or help
m <status-in-hex>,. ... Modem status
l <cmd>,<val-in-hex>.   ... exec <cmd> (AT) at this host.
lset fid <val-in-hex>. ... set local frame id. default is 1.
lset cmd <val-in-hex>. ... set local command.
lset val <val-in-hex>. ... set local command value.
q <cmd>,<val-in-hex>.   ... set queue parameter value.
r <cmd>,<val-in-hex>.   ... exec <cmd> (AT)at remote host.
rset a16 <val-in-hex>. ... set remote address high.
rset a64 <val-in-hex>,<val-in-hex>.  ... set remote address low.
rset fid <val-in-hex>. ... set remote frame id. default is 1.

> l D4,0x05
cmd=D4 val=0x05
apiId=88

object 100008c8:35 01 00 10 88 00 05 FE 04 01 00 FF

l OK:

> l D4,0x04
cmd=D4 val=0x04
apiId=88

object 100008c8:35 01 00 10 88 00 05 FE 04 01 00 FF

l OK:

>

LPC1768/api/TCPSocket.h@0:3edcfa3aba71, 2012-07-21 (annotated)

Committer:
takashiyamanoue
Date:
Sat Jul 21 04:09:54 2012 +0000
Revision:
0:3edcfa3aba71
xbee test 3

Who changed what in which revision?

UserRevisionLine numberNew contents of line
takashiyamanoue 0:3edcfa3aba71 1
takashiyamanoue 0:3edcfa3aba71 2 /*
takashiyamanoue 0:3edcfa3aba71 3 Copyright (c) 2010 Donatien Garnier (donatiengar [at] gmail [dot] com)
takashiyamanoue 0:3edcfa3aba71 4
takashiyamanoue 0:3edcfa3aba71 5 Permission is hereby granted, free of charge, to any person obtaining a copy
takashiyamanoue 0:3edcfa3aba71 6 of this software and associated documentation files (the "Software"), to deal
takashiyamanoue 0:3edcfa3aba71 7 in the Software without restriction, including without limitation the rights
takashiyamanoue 0:3edcfa3aba71 8 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
takashiyamanoue 0:3edcfa3aba71 9 copies of the Software, and to permit persons to whom the Software is
takashiyamanoue 0:3edcfa3aba71 10 furnished to do so, subject to the following conditions:
takashiyamanoue 0:3edcfa3aba71 11
takashiyamanoue 0:3edcfa3aba71 12 The above copyright notice and this permission notice shall be included in
takashiyamanoue 0:3edcfa3aba71 13 all copies or substantial portions of the Software.
takashiyamanoue 0:3edcfa3aba71 14
takashiyamanoue 0:3edcfa3aba71 15 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
takashiyamanoue 0:3edcfa3aba71 16 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
takashiyamanoue 0:3edcfa3aba71 17 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
takashiyamanoue 0:3edcfa3aba71 18 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
takashiyamanoue 0:3edcfa3aba71 19 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
takashiyamanoue 0:3edcfa3aba71 20 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
takashiyamanoue 0:3edcfa3aba71 21 THE SOFTWARE.
takashiyamanoue 0:3edcfa3aba71 22 */
takashiyamanoue 0:3edcfa3aba71 23
takashiyamanoue 0:3edcfa3aba71 24 /** \file
takashiyamanoue 0:3edcfa3aba71 25 TCP Socket header file
takashiyamanoue 0:3edcfa3aba71 26 */
takashiyamanoue 0:3edcfa3aba71 27
takashiyamanoue 0:3edcfa3aba71 28 #ifndef TCPSOCKET_H
takashiyamanoue 0:3edcfa3aba71 29 #define TCPSOCKET_H
takashiyamanoue 0:3edcfa3aba71 30
takashiyamanoue 0:3edcfa3aba71 31 #include "core/net.h"
takashiyamanoue 0:3edcfa3aba71 32 #include "core/host.h"
takashiyamanoue 0:3edcfa3aba71 33 //Essentially it is a safe interface to NetTcpSocket
takashiyamanoue 0:3edcfa3aba71 34
takashiyamanoue 0:3edcfa3aba71 35 ///TCP Socket error codes
takashiyamanoue 0:3edcfa3aba71 36 enum TCPSocketErr
takashiyamanoue 0:3edcfa3aba71 37 {
takashiyamanoue 0:3edcfa3aba71 38 __TCPSOCKET_MIN = -0xFFFF,
takashiyamanoue 0:3edcfa3aba71 39 TCPSOCKET_SETUP, ///<TCPSocket not properly configured
takashiyamanoue 0:3edcfa3aba71 40 TCPSOCKET_TIMEOUT, ///<Connection timed out
takashiyamanoue 0:3edcfa3aba71 41 TCPSOCKET_IF, ///<Interface has problems, does not exist or is not initialized
takashiyamanoue 0:3edcfa3aba71 42 TCPSOCKET_MEM, ///<Not enough mem
takashiyamanoue 0:3edcfa3aba71 43 TCPSOCKET_INUSE, ///<Interface / Port is in use
takashiyamanoue 0:3edcfa3aba71 44 TCPSOCKET_EMPTY, ///<Connections queue is empty
takashiyamanoue 0:3edcfa3aba71 45 TCPSOCKET_RST, ///<Connection was reset by remote host
takashiyamanoue 0:3edcfa3aba71 46 //...
takashiyamanoue 0:3edcfa3aba71 47 TCPSOCKET_OK = 0 ///<Success
takashiyamanoue 0:3edcfa3aba71 48 };
takashiyamanoue 0:3edcfa3aba71 49
takashiyamanoue 0:3edcfa3aba71 50 ///TCP Socket Events
takashiyamanoue 0:3edcfa3aba71 51 enum TCPSocketEvent
takashiyamanoue 0:3edcfa3aba71 52 {
takashiyamanoue 0:3edcfa3aba71 53 TCPSOCKET_CONNECTED, ///<Connected to host
takashiyamanoue 0:3edcfa3aba71 54 TCPSOCKET_ACCEPT, ///<Client is connected, must call accept() to get a new Socket
takashiyamanoue 0:3edcfa3aba71 55 TCPSOCKET_READABLE, ///<Data in buf
takashiyamanoue 0:3edcfa3aba71 56 TCPSOCKET_WRITEABLE, ///<Can write data to buf
takashiyamanoue 0:3edcfa3aba71 57 TCPSOCKET_CONTIMEOUT, ///<Connection timed out
takashiyamanoue 0:3edcfa3aba71 58 TCPSOCKET_CONRST, ///<Connection was reset by remote host
takashiyamanoue 0:3edcfa3aba71 59 TCPSOCKET_CONABRT, ///<Connection was aborted
takashiyamanoue 0:3edcfa3aba71 60 TCPSOCKET_ERROR, ///<Unknown error
takashiyamanoue 0:3edcfa3aba71 61 TCPSOCKET_DISCONNECTED ///<Disconnected
takashiyamanoue 0:3edcfa3aba71 62 };
takashiyamanoue 0:3edcfa3aba71 63
takashiyamanoue 0:3edcfa3aba71 64 class NetTcpSocket;
takashiyamanoue 0:3edcfa3aba71 65 enum NetTcpSocketEvent;
takashiyamanoue 0:3edcfa3aba71 66
takashiyamanoue 0:3edcfa3aba71 67 ///This is a simple TCP Socket class
takashiyamanoue 0:3edcfa3aba71 68 /**
takashiyamanoue 0:3edcfa3aba71 69 This class exposes an API to deal with TCP Sockets
takashiyamanoue 0:3edcfa3aba71 70 */
takashiyamanoue 0:3edcfa3aba71 71 class TCPSocket
takashiyamanoue 0:3edcfa3aba71 72 {
takashiyamanoue 0:3edcfa3aba71 73 public:
takashiyamanoue 0:3edcfa3aba71 74 ///Creates a new socket
takashiyamanoue 0:3edcfa3aba71 75 TCPSocket();
takashiyamanoue 0:3edcfa3aba71 76 protected:
takashiyamanoue 0:3edcfa3aba71 77 TCPSocket(NetTcpSocket* pNetTcpSocket);
takashiyamanoue 0:3edcfa3aba71 78 public:
takashiyamanoue 0:3edcfa3aba71 79 ///Closes if needed and destroys the socket
takashiyamanoue 0:3edcfa3aba71 80 ~TCPSocket(); //close()
takashiyamanoue 0:3edcfa3aba71 81
takashiyamanoue 0:3edcfa3aba71 82 ///Binds the socket to (local) host
takashiyamanoue 0:3edcfa3aba71 83 TCPSocketErr bind(const Host& me);
takashiyamanoue 0:3edcfa3aba71 84
takashiyamanoue 0:3edcfa3aba71 85 ///Starts listening
takashiyamanoue 0:3edcfa3aba71 86 TCPSocketErr listen();
takashiyamanoue 0:3edcfa3aba71 87
takashiyamanoue 0:3edcfa3aba71 88 ///Connects socket to host
takashiyamanoue 0:3edcfa3aba71 89 TCPSocketErr connect(const Host& host);
takashiyamanoue 0:3edcfa3aba71 90
takashiyamanoue 0:3edcfa3aba71 91 ///Accepts connection from client and gets connected socket
takashiyamanoue 0:3edcfa3aba71 92 TCPSocketErr accept(Host* pClient, TCPSocket** ppNewTcpSocket);
takashiyamanoue 0:3edcfa3aba71 93
takashiyamanoue 0:3edcfa3aba71 94 ///Sends data
takashiyamanoue 0:3edcfa3aba71 95 /*
takashiyamanoue 0:3edcfa3aba71 96 @return a negative error code or the number of bytes transmitted
takashiyamanoue 0:3edcfa3aba71 97 */
takashiyamanoue 0:3edcfa3aba71 98 int /*if < 0 : TCPSocketErr*/ send(const char* buf, int len);
takashiyamanoue 0:3edcfa3aba71 99
takashiyamanoue 0:3edcfa3aba71 100 ///Receives data
takashiyamanoue 0:3edcfa3aba71 101 /*
takashiyamanoue 0:3edcfa3aba71 102 @return a negative error code or the number of bytes received
takashiyamanoue 0:3edcfa3aba71 103 */
takashiyamanoue 0:3edcfa3aba71 104 int /*if < 0 : TCPSocketErr*/ recv(char* buf, int len);
takashiyamanoue 0:3edcfa3aba71 105
takashiyamanoue 0:3edcfa3aba71 106 /* TODO NTH : printf / scanf helpers that call send/recv */
takashiyamanoue 0:3edcfa3aba71 107
takashiyamanoue 0:3edcfa3aba71 108 ///Closes socket
takashiyamanoue 0:3edcfa3aba71 109 TCPSocketErr close();
takashiyamanoue 0:3edcfa3aba71 110
takashiyamanoue 0:3edcfa3aba71 111 //Callbacks
takashiyamanoue 0:3edcfa3aba71 112 ///Setups callback
takashiyamanoue 0:3edcfa3aba71 113 /**
takashiyamanoue 0:3edcfa3aba71 114 @param pMethod : callback function
takashiyamanoue 0:3edcfa3aba71 115 */
takashiyamanoue 0:3edcfa3aba71 116 void setOnEvent( void (*pMethod)(TCPSocketEvent) );
takashiyamanoue 0:3edcfa3aba71 117
takashiyamanoue 0:3edcfa3aba71 118 class CDummy;
takashiyamanoue 0:3edcfa3aba71 119 ///Setups callback
takashiyamanoue 0:3edcfa3aba71 120 /**
takashiyamanoue 0:3edcfa3aba71 121 @param pItem : instance of class on which to execute the callback method
takashiyamanoue 0:3edcfa3aba71 122 @param pMethod : callback method
takashiyamanoue 0:3edcfa3aba71 123 */
takashiyamanoue 0:3edcfa3aba71 124 template<class T>
takashiyamanoue 0:3edcfa3aba71 125 void setOnEvent( T* pItem, void (T::*pMethod)(TCPSocketEvent) )
takashiyamanoue 0:3edcfa3aba71 126 {
takashiyamanoue 0:3edcfa3aba71 127 m_pCbItem = (CDummy*) pItem;
takashiyamanoue 0:3edcfa3aba71 128 m_pCbMeth = (void (CDummy::*)(TCPSocketEvent)) pMethod;
takashiyamanoue 0:3edcfa3aba71 129 }
takashiyamanoue 0:3edcfa3aba71 130
takashiyamanoue 0:3edcfa3aba71 131 ///Disables callback
takashiyamanoue 0:3edcfa3aba71 132 void resetOnEvent();
takashiyamanoue 0:3edcfa3aba71 133
takashiyamanoue 0:3edcfa3aba71 134 protected:
takashiyamanoue 0:3edcfa3aba71 135 void onNetTcpSocketEvent(NetTcpSocketEvent e);
takashiyamanoue 0:3edcfa3aba71 136 TCPSocketErr checkInst();
takashiyamanoue 0:3edcfa3aba71 137
takashiyamanoue 0:3edcfa3aba71 138 private:
takashiyamanoue 0:3edcfa3aba71 139 NetTcpSocket* m_pNetTcpSocket;
takashiyamanoue 0:3edcfa3aba71 140
takashiyamanoue 0:3edcfa3aba71 141 CDummy* m_pCbItem;
takashiyamanoue 0:3edcfa3aba71 142 void (CDummy::*m_pCbMeth)(TCPSocketEvent);
takashiyamanoue 0:3edcfa3aba71 143
takashiyamanoue 0:3edcfa3aba71 144 void (*m_pCb)(TCPSocketEvent);
takashiyamanoue 0:3edcfa3aba71 145
takashiyamanoue 0:3edcfa3aba71 146 };
takashiyamanoue 0:3edcfa3aba71 147
takashiyamanoue 0:3edcfa3aba71 148 #endif