Diff: XBeeWiFi.h

Revision:

2:6efb3541af61

Child:

3:8573b122fa84

--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/XBeeWiFi.h	Fri Jul 29 16:22:15 2011 +0000
@@ -0,0 +1,188 @@
+/**
+ * XBee Wi-Fi library for mbed
+ * Copyright (c) 2011 Hiroshi Suga
+ * Released under the MIT License: http://mbed.org/license/mit
+ */
+
+/** @file
+ * @brief Weather Station
+ */
+
+#ifndef XBeeWiFi_h
+#define XBeeWiFi_h
+
+#include "mbed.h"
+#include "EthernetNetIf.h"
+#include "XBee.h"
+#include <inttypes.h>
+
+#undef USE_WIFICLASS
+#undef USE_WIFIDNS
+
+// the non-variable length of the frame data (not including frame id or api id or variable data size (e.g. payload, at command set value)
+#define IPv4_TRANSMIT_REQUEST_API_LENGTH 10
+
+/**
+ * Api Id constants
+ */
+#define IPv4_TRANSMIT_REQUEST 0x20
+#define IPv4_RX_FRAME 0xb0
+#define IPv4_TRANSMIT_STATUS 0x89
+
+/// status
+#define MAC_FAILUE 0x01
+#define PHYSICAL_ERROR 0x04
+#define NETWORK_ACK_FAILUE 0x21
+#define NOT_ASSOCIATED 0x22
+#define NO_RESOURCES 0x32
+#define CONNECTIONS_FAILUE 0x76
+
+/// protocol
+#define PROTOCOL_UDP 0
+#define PROTOCOL_TCP 1
+
+/// option
+#define OPTION_LEAVEOPEN 1
+
+/// security
+#define SECURITY_OPEN 0
+#define SECURITY_WPA 1
+#define SECURITY_WPA2 2
+#define SECURITY_WEP40 3
+#define SECURITY_WEP104 4
+
+/// modem status
+#define JOINED_AP 0
+#define SSID_NOT_CONFIGURED 0x23
+#define JOINING_AP 0xff
+
+/// dns
+#define DNS_QUERY_A 1
+#define DNS_QUERY_NS 2
+#define DNS_QUERY_CNAME 5
+#define DNS_QUERY_PTR 12
+#define DNS_QUERY_MX 15
+#define DNS_QUERY_AAAA 28
+#define DNS_QUERY_ANY 255
+#define DNS_CLASS_IN 1
+
+struct DNSHeader {
+        uint16_t id; 
+        uint16_t flags; 
+        uint16_t questions; 
+        uint16_t answers; 
+        uint16_t authorities; 
+        uint16_t additional; 
+};
+
+struct DnsQuestionEnd { 
+        uint16_t type; 
+        uint16_t clas; 
+};
+
+struct DnsAnswer {
+        uint16_t name; 
+        uint16_t type; 
+        uint16_t clas; 
+        uint32_t ttl; 
+        uint16_t length; 
+} __attribute__((packed)); 
+
+
+#ifdef USE_WIFICLASS
+/**
+ * Primary interface for communicating with an XBee Wi-Fi.
+ */
+class XBeeWiFi : public XBee {
+public:
+    XBeeWiFi (PinName p_tx, PinName p_rx);
+
+    int setup (int security, const char *ssid, const char *pin);
+    int setup (const char *ssid);
+    int reset ();
+    int setAddress ();
+    int setAddress (IpAddr &ipaddr, IpAddr &netmask, IpAddr &gateway, IpAddr &nameserver);
+    int setTimeout (int timeout);
+    int getStatus ();
+#ifdef USE_WIFIDNS
+    int getHostByName (const char* name, IpAddr &addr);
+#endif
+
+protected:
+    int getWiResponse (int apiId, int timeout = 1500);
+#ifdef USE_WIFIDNS
+    int createDnsRequest (const char* name, char *buf);
+    int getDnsResponse (const uint8_t *buf, int len, IpAddr &addr);
+#endif
+
+private:
+    IpAddr _nameserver;
+};
+#endif
+
+/**
+ * Represents a Wi-Fi TX packet that corresponds to Api Id: IPv4_TRANSMIT_REQUEST
+ */
+class IPv4TransmitRequest : public PayloadRequest {
+public:
+    /**
+     * Creates a unicast IPv4TransmitRequest with the DEFAULT_FRAME_ID
+     */
+    IPv4TransmitRequest(IpAddr &dstAddr, uint16_t dstPort, uint16_t srcPort, uint8_t protocol, uint8_t option, uint8_t *data, uint8_t dataLength, uint8_t frameId);
+    IPv4TransmitRequest(IpAddr &dstAddr, uint16_t dstPort, uint8_t *data, uint8_t dataLength);
+    /**
+     * Creates a default instance of this class.  At a minimum you must specify
+     * a payload, payload length and a destination address before sending this request.
+     */
+    IPv4TransmitRequest();
+    IpAddr& getAddress();
+    uint16_t getDstPort();
+    uint16_t getSrcPort();
+    uint8_t getProtocol();
+    uint8_t getOption();
+    void setAddress(IpAddr& dstAddr);
+    void setDstPort(uint16_t dstPort);
+    void setSrcPort(uint16_t srcPort);
+    void setProtocol(uint8_t protocol);
+    void setOption(uint8_t option);
+protected:
+    // declare virtual functions
+    virtual uint8_t getFrameData(uint8_t pos);
+    virtual uint8_t getFrameDataLength();
+private:
+    IpAddr _dstAddr;
+    uint16_t _dstPort;
+    uint16_t _srcPort;
+    uint8_t _protocol;
+    uint8_t _option;
+};
+
+/**
+ * Represents a Wi-Fi TX status packet
+ */
+class Transmit_Status : public FrameIdResponse {
+public:
+    Transmit_Status();
+    uint8_t getStatus();
+    bool isSuccess();
+};
+
+/**
+ * Represents a Wi-Fi RX packet
+ */
+class IPV4RxFrame : public RxDataResponse {
+public:
+    IPV4RxFrame();
+    IpAddr& getSrcAddress();
+    uint16_t getDstPort();
+    uint16_t getSrcPort();
+    uint8_t getProtocol();
+    uint8_t getStatus();
+    virtual uint8_t getDataLength();
+    // frame position where data starts
+    virtual uint8_t getDataOffset();
+private:
+    IpAddr _srcAddr;
+};
+
+#endif //XBeeWiFi_h