emw3162 driver for mbed os 5
Fork of emw3162-driver by
Diff: emw3162/EMW3162.h
- Revision:
- 2:fb6251306b21
- Parent:
- 0:2d5090e1ceb4
--- a/emw3162/EMW3162.h Fri Nov 04 02:14:19 2016 +0000 +++ b/emw3162/EMW3162.h Mon Nov 14 02:30:49 2016 +0000 @@ -1,4 +1,4 @@ -/* ESP8266Interface Example +/* EMW3162Interface Example * Copyright (c) 2015 ARM Limited * * Licensed under the Apache License, Version 2.0 (the "License"); @@ -14,31 +14,31 @@ * limitations under the License. */ -#ifndef ESP8266_H -#define ESP8266_H +#ifndef EMW3162_H +#define EMW3162_H #include "ATParser.h" -/** ESP8266Interface class. - This is an interface to a ESP8266 radio. +/** EMW3162Interface class. + This is an interface to a EMW3162 radio. */ -class ESP8266 +class EMW3162 { public: - ESP8266(PinName tx, PinName rx, bool debug=false); + EMW3162(PinName tx, PinName rx, bool debug=false); /** - * Startup the ESP8266 + * Startup the EMW3162 * * @param mode mode of WIFI 1-client, 2-host, 3-both - * @return true only if ESP8266 was setup correctly + * @return true only if EMW3162 was setup correctly */ bool startup(); /** - * Reset ESP8266 + * Reset EMW3162 * - * @return true only if ESP8266 resets successfully + * @return true only if EMW3162 resets successfully */ bool reset(const char *reset); @@ -47,42 +47,42 @@ * * @param enabled DHCP enabled when true * @param mode mode of DHCP 0-softAP, 1-station, 2-both - * @return true only if ESP8266 enables/disables DHCP successfully + * @return true only if EMW3162 enables/disables DHCP successfully */ bool dhcp(bool enabled); /** - * Connect ESP8266 to AP + * Connect EMW3162 to AP * * @param ap the name of the AP * @param passPhrase the password of AP - * @return true only if ESP8266 is connected successfully + * @return true only if EMW3162 is connected successfully */ bool connect(const char *ap, const char *passPhrase); /** - * Disconnect ESP8266 from AP + * Disconnect EMW3162 from AP * - * @return true only if ESP8266 is disconnected successfully + * @return true only if EMW3162 is disconnected successfully */ bool disconnect(void); /** - * Get the IP address of ESP8266 + * 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 ESP8266 + * 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 ESP8266 is conenected + * Check if EMW3162 is conenected * * @return true only if the chip has an IP address */