Simple detection for LE910-NA1 modules
Fork of MTS-Cellular by
Diff: Cellular/UIP.h
- Revision:
- 34:7d412c989964
- Parent:
- 33:3b6f3904dde0
- Child:
- 46:56ab41157957
diff -r 3b6f3904dde0 -r 7d412c989964 Cellular/UIP.h --- a/Cellular/UIP.h Wed Jul 16 14:26:10 2014 +0000 +++ b/Cellular/UIP.h Wed Jul 16 15:05:10 2014 +0000 @@ -56,10 +56,21 @@ virtual bool init(MTSBufferedIO* io); - // Wifi connection based commands derived from CommInterface.h + // Cell connection based commands derived from CommInterface.h + /** Initiates a PPP connection between the radio and the cell network */ virtual bool connect(); + + /** Disconnects the PPP connection between the radio and the cell network */ virtual void disconnect(); + + /** Checks if the radio has a PPP connection established with the cell network + * (Can reach the internet essentially) + */ virtual bool isConnected(); + + /** Resets the radio, must first close active socket and PPP connections + * to do so + */ virtual void reset(); // TCP and UDP Socket related commands @@ -76,7 +87,11 @@ virtual std::string getDeviceIP(); virtual bool setDeviceIP(std::string address = "DHCP"); - /** A method for setting the APN */ + /** A method for setting the APN + * + * @param apn APN to be passed as a c-string + * @returns the standard AT Code enumeration + */ virtual Code setApn(const std::string& apn); /** A method for configuring command ehco capability on the radio. This command @@ -93,6 +108,8 @@ * this class must process all read and write data on the socket to guard the special * escape character used to close an open socket connection. It is recommened that you * use the default of true unless the overhead of these operations is too significant. + * If set to false, socket must be closed using physical pin signals rather than through + * the use of the ETX data character * * @param enabled set to true if you want the socket closeable, otherwise false. The default * is true.