emw3162 driver
Fork of emw3162-driver-mbed-os-5 by
emw3162/EMW3162.h
- Committer:
- sarahmarshy
- Date:
- 2017-02-16
- Revision:
- 7:635ff20df767
- Parent:
- 2:fb6251306b21
File content as of revision 7:635ff20df767:
/* EMW3162Interface 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 EMW3162_H #define EMW3162_H #include "ATParser.h" /** EMW3162Interface class. This is an interface to a EMW3162 radio. */ class EMW3162 { public: EMW3162(PinName tx, PinName rx, bool debug=false); /** * Startup the EMW3162 * * @param mode mode of WIFI 1-client, 2-host, 3-both * @return true only if EMW3162 was setup correctly */ bool startup(); /** * Reset EMW3162 * * @return true only if EMW3162 resets successfully */ bool reset(const char *reset); /** * Enable/Disable DHCP * * @param enabled DHCP enabled when true * @param mode mode of DHCP 0-softAP, 1-station, 2-both * @return true only if EMW3162 enables/disables DHCP successfully */ bool dhcp(bool enabled); /** * Connect EMW3162 to AP * * @param ap the name of the AP * @param passPhrase the password of AP * @return true only if EMW3162 is connected successfully */ bool connect(const char *ap, const char *passPhrase); /** * Disconnect EMW3162 from AP * * @return true only if EMW3162 is disconnected successfully */ bool disconnect(void); /** * Get the IP address of EMW3162 * * @return null-teriminated IP address or null if no IP address is assigned */ const char *getIPAddress(void); /** * Get the MAC address of EMW3162 * * @return null-terminated MAC address or null if no MAC address is assigned */ const char *getMACAddress(void); /** * Check if EMW3162 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 */ int 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(); /** * Attach a function to call whenever network state has changed * * @param func A pointer to a void function, or 0 to set as none */ void attach(Callback<void()> func); /** * Attach a function to call whenever network state has changed * * @param obj pointer to the object to call the member function on * @param method pointer to the member function to call */ template <typename T, typename M> void attach(T *obj, M method) { attach(Callback<void()>(obj, method)); } private: BufferedSerial _serial; ATParser _parser; struct packet { struct packet *next; int id; uint32_t len; // data follows } *_packets, **_packets_end; void _packet_handler(); char _ip_buffer[16]; char _mac_buffer[18]; }; #endif