Diff: SPWFSA01.h

Revision:

0:9e5d98ceea74

Child:

3:2af9df1068a5

--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/SPWFSA01.h	Thu Jun 30 06:04:46 2016 +0000
@@ -0,0 +1,161 @@
+/* SPWFInterface Example
+ * Copyright (c) 2015 ARM Limited
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+ 
+#ifndef SPWFSA01_H
+#define SPWFSA01_H
+ 
+#include "ATParser.h"
+ 
+/** SPWFSA01Interface class.
+    This is an interface to a SPWFSA01 module.
+ */
+class SPWFSA01
+{
+public:
+    SPWFSA01(PinName tx, PinName rx, bool debug=false);
+ 
+    /**
+    * Init the SPWFSA01
+    *
+    * @param mode mode in which to startup
+    * @return true only if SPWFSA01 has started up correctly
+    */
+    bool startup(int mode);
+ 
+    void waitSPWFReady(void);
+    /**
+    * Reset SPWFSA01
+    *
+    * @return true only if SPWFSA01 resets successfully
+    */
+    bool reset(void);
+    
+    bool hw_reset(void);
+ 
+    /**
+    * Enable/Disable DHCP
+    *
+    * @param enabled DHCP enabled when true
+    * @param mode mode of DHCP 0-softAP, 1-station, 2-both
+    * @return true only if SPWFSA01 enables/disables DHCP successfully
+    */
+    bool dhcp(bool enabled, int mode);
+ 
+    /**
+    * Connect SPWFSA01 to AP
+    *
+    * @param ap the name of the AP
+    * @param passPhrase the password of AP
+    * @param securityMode the security mode of AP (WPA/WPA2, WEP, Open)
+    * @return true only if SPWFSA01 is connected successfully
+    */
+    bool connect(const char *ap, const char *passPhrase, int securityMode);
+ 
+    /**
+    * Disconnect SPWFSA01 from AP
+    *
+    * @return true only if SPWFSA01 is disconnected successfully
+    */
+    bool disconnect(void);
+ 
+    /**
+    * Get the IP address of SPWFSA01
+    *
+    * @return null-teriminated IP address or null if no IP address is assigned
+    */
+    const char *getIPAddress(void);
+ 
+    /**
+    * Get the MAC address of SPWFSA01
+    *
+    * @return null-terminated MAC address or null if no MAC address is assigned
+    */
+    const char *getMACAddress(void);
+ 
+    /**
+    * Check if SPWFSA01 is conenected
+    *
+    * @return true only if the chip has an IP address
+    */
+    bool isConnected(void);
+ 
+    /**
+    * Open a socketed connection
+    *
+    * @param type the type of socket to open "UDP" or "TCP"
+    * @param id id to give the new socket, valid 0-4
+    * @param port port to open connection with
+    * @param addr the IP address of the destination
+    * @return true only if socket opened successfully
+    */
+    bool open(const char *type, int id, const char* addr, int port);
+ 
+    /**
+    * Sends data to an open socket
+    *
+    * @param id id of socket to send to
+    * @param data data to be sent
+    * @param amount amount of data to be sent - max 1024
+    * @return true only if data sent successfully
+    */
+    bool send(int id, const void *data, uint32_t amount);
+ 
+    /**
+    * Receives data from an open socket
+    *
+    * @param id id to receive from
+    * @param data placeholder for returned information
+    * @param amount number of bytes to be received
+    * @return the number of bytes received
+    */
+    int32_t recv(int id, void *data, uint32_t amount);
+ 
+    /**
+    * Closes a socket
+    *
+    * @param id id of socket to close, valid only 0-4
+    * @return true only if socket is closed successfully
+    */
+    bool close(int id);
+ 
+    /**
+    * Allows timeout to be changed between commands
+    *
+    * @param timeout_ms timeout of the connection
+    */
+    void setTimeout(uint32_t timeout_ms);
+ 
+    /**
+    * Checks if data is available
+    */
+    bool readable();
+ 
+    /**
+    * Checks if data can be written
+    */
+    bool writeable();
+ 
+private:
+    BufferedSerial _serial;
+    ATParser _parser;
+    DigitalInOut _wakeup;
+    DigitalInOut _reset;
+ 
+    char _ip_buffer[16];
+    char _mac_buffer[18];
+};
+ 
+#endif  //SPWFSA01_H
\ No newline at end of file