Rod Landers / ublox-at-cellular-interface-ext

Dependencies:   ublox-at-cellular-interface

Embed: (wiki syntax)

« Back to documentation index

Show/hide line numbers UbloxATCellularInterfaceExt.h Source File

UbloxATCellularInterfaceExt.h

00001 /* Copyright (c) 2017 ARM Limited
00002  *
00003  * Licensed under the Apache License, Version 2.0 (the "License");
00004  * you may not use this file except in compliance with the License.
00005  * You may obtain a copy of the License at
00006  *
00007  *     http://www.apache.org/licenses/LICENSE-2.0
00008  *
00009  * Unless required by applicable law or agreed to in writing, software
00010  * distributed under the License is distributed on an "AS IS" BASIS,
00011  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
00012  * See the License for the specific language governing permissions and
00013  * limitations under the License.
00014  */
00015 
00016 #ifndef _UBLOX_AT_CELLULAR_INTERFACE_EXT_
00017 #define _UBLOX_AT_CELLULAR_INTERFACE_EXT_
00018 
00019 #include "UbloxATCellularInterface.h"
00020 #include "UbloxCellularDriverGen.h"
00021 
00022 /**UbloxATCellularInterfaceExt class.
00023  *
00024  * This interface extends the UbloxATCellularInterface to
00025  * include other features that use the IP stack on board the
00026  * cellular modem: HTTP, FTP and Cell Locate.
00027  *
00028  * Note: the UbloxCellularGeneric class is required because
00029  * reading a large HTTP response is performed via a modem
00030  * file system call and the UbloxCellularGeneric class is
00031  * where modem file system support is provided.
00032  */
00033 class UbloxATCellularInterfaceExt : public  UbloxATCellularInterface, public UbloxCellularDriverGen {
00034 
00035 public:
00036     /** Constructor.
00037      *
00038      * @param tx       the UART TX data pin to which the modem is attached.
00039      * @param rx       the UART RX data pin to which the modem is attached.
00040      * @param baud     the UART baud rate.
00041      * @param debugOn  true to switch AT interface debug on, otherwise false.
00042      */
00043     UbloxATCellularInterfaceExt(PinName tx = MDMTXD,
00044                                 PinName rx = MDMRXD,
00045                                 int baud = MBED_CONF_UBLOX_CELL_BAUD_RATE,
00046                                 bool debugOn = false);
00047 
00048      /* Destructor.
00049       */
00050      virtual ~UbloxATCellularInterfaceExt();
00051 
00052     /**********************************************************************
00053      * PUBLIC: General
00054      **********************************************************************/
00055 
00056     /** Infinite timeout.
00057      */
00058     #define TIMEOUT_BLOCKING -1
00059 
00060     /** A struct containing an HTTP or FTP error class and code
00061      */
00062      typedef struct {
00063         int eClass;
00064         int eCode;
00065     } Error;
00066 
00067     /**********************************************************************
00068      * PUBLIC: HTTP
00069      **********************************************************************/
00070 
00071     /** HTTP profile unused marker.
00072      */
00073     #define HTTP_PROF_UNUSED -1
00074 
00075     /** HTTP configuration parameters (reference to HTTP control +UHTTP).
00076      */
00077     typedef enum {
00078         HTTP_IP_ADDRESS = 0,
00079         HTTP_SERVER_NAME = 1,
00080         HTTP_USER_NAME = 2,
00081         HTTP_PASSWORD = 3,
00082         HTTP_AUTH_TYPE = 4,
00083         HTTP_SERVER_PORT = 5,
00084         HTTP_SECURE = 6
00085     } HttpOpCode;
00086 
00087     /** Type of HTTP Command.
00088      */
00089     typedef enum {
00090         HTTP_HEAD = 0,
00091         HTTP_GET = 1,
00092         HTTP_DELETE = 2,
00093         HTTP_PUT = 3,
00094         HTTP_POST_FILE = 4,
00095         HTTP_POST_DATA = 5
00096     } HttpCmd;
00097 
00098     /** HTTP content types.
00099      */
00100     typedef enum {
00101         HTTP_CONTENT_URLENCODED = 0,
00102         HTTP_CONTENT_TEXT = 1,
00103         HTTP_CONTENT_OCTET_STREAM = 2,
00104         HTTP_CONTENT_FORM_DATA = 3,
00105         HTTP_CONTENT_JSON = 4,
00106         HTTP_CONTENT_XML = 5,
00107         HTTP_CONTENT_USER_DEFINED = 6
00108     } HttpContentType;
00109 
00110     /** Find a free HTTP profile.
00111      *
00112      * A profile will be blocking when first allocated.
00113      *
00114      * @return the profile or negative if none are available.
00115      */
00116     int httpAllocProfile();
00117     
00118     /** Free the HTTP profile.
00119      *
00120      * @param profile the HTTP profile handle.
00121      * @return           true if successful, otherwise false.
00122      */
00123     bool httpFreeProfile(int profile);
00124 
00125     /** Set the timeout for this profile.
00126      *
00127      * @param profile    the HTTP profile handle.
00128      * @param timeout    -1 blocking, else non-blocking timeout in milliseconds.
00129      * @return           true if successful, otherwise false.
00130      */
00131     bool httpSetTimeout(int profile, int timeout);
00132     
00133     /** Reset a HTTP profile back to defaults.
00134      *
00135      * This may be called if the state of a HTTP profile
00136      * during parameter setting or exchange of HTTP commands
00137      * has become confusing/unknown.
00138      *
00139      * @param httpProfile the HTTP profile to be reset.
00140      * @return            true if successful, false otherwise.
00141      */
00142     bool httpResetProfile(int httpProfile);
00143     
00144     /** Set HTTP parameters.
00145      *
00146      * This should be called as many times as is necessary
00147      * to set all the possible parameters (HttpOpCode).
00148      *
00149      * See section 28.1 of u-blox-ATCommands_Manual(UBX-13002752).pdf
00150      * for full details.  By example:
00151      *
00152      * httpOpCode          httpInPar
00153      * HTTP_IP_ADDRESS     "145.33.18.10" (the target HTTP server IP address)
00154      * HTTP_SERVER_NAME    "www.myhttpserver.com" (the target HTTP server name)
00155      * HTTP_USER_NAME      "my_username"
00156      * HTTP_PASSWORD       "my_password"
00157      * HTTP_AUTH_TYPE      "0" for no authentication, "1" for username/password
00158      *                     authentication (the default is 0)
00159      * HTTP_SERVER_PORT    "81" (default is port 80)
00160      * HTTP_SECURE         "0" for no security, "1" for TLS (the default is 0),
00161      *                     not all modems support this parameter
00162      *
00163      * @param httpProfile the HTTP profile identifier.
00164      * @param httpOpCode  the HTTP operation code.
00165      * @param httpInPar   the HTTP input parameter.
00166      * @return            true if successful, false otherwise.
00167      */
00168     bool httpSetPar(int httpProfile, HttpOpCode httpOpCode, const char * httpInPar);
00169     
00170     /** Perform a HTTP command.
00171      *
00172      * See section 28.3 of u-blox-ATCommands_Manual(UBX-13002752).pdf
00173      * for full details.  By example, it works like this:
00174      *
00175      * httpCmd        httpPath       rspFile     sendStr  httpContentType httpCustomPar
00176      * HEAD       "path/file.html"     NULL       NULL         0             NULL
00177      * GET        "path/file.html"     NULL       NULL         0             NULL
00178      * DELETE     "path/file.html"     NULL       NULL         0             NULL
00179      * PUT        "path/file.html"     NULL    "myfile.txt"  0 to 6         Note 1
00180      * POST_FILE  "path/file.html"     NULL    "myfile.txt"  0 to 6         Note 1
00181      * POST       "path/file.html"     NULL   "hello there!" 0 to 6         Note 1
00182      *
00183      * Note 1: httpCustomPar is only applicable when httpContentType = HTTP_CONTENT_USER_DEFINED.
00184      *
00185      * The server to which this command is directed must have previously been
00186      * set with a call to httpSetPar().  If the server requires TLS (i.e. "HTTPS"),
00187      * then set that up with httpSetPar() also (HTTP_SECURE).
00188      *
00189      * rspFile may be left as NULL as the server response will be returned in buf.
00190      * Alternatively, a rspFile may be given (e.g. "myresponse.txt") and this can
00191      * later be read from the modem file system using readFile().
00192      *
00193      * @param httpProfile     the HTTP profile identifier.
00194      * @param httpCmd         the HTTP command.
00195      * @param httpPath        the path of resource on the HTTP server.
00196      * @param rspFile         the local modem file where the server
00197      *                        response will be stored, use NULL for
00198      *                        don't care.
00199      * @param sendStr         the filename or string to be sent
00200      *                        to the HTTP server with the command request.
00201      * @param httpContentType the HTTP Content-Type identifier.
00202      * @param httpCustomPar   the parameter for a user defined HTTP Content-Type.
00203      * @param buf             the buffer to read into.
00204      * @param len             the size of the buffer to read into.
00205      * @return                NULL if successful, otherwise a pointer to
00206      *                        a Error struct containing the error class and error
00207      *                        code, see section Appendix A.B of
00208      *                        u-blox-ATCommands_Manual(UBX-13002752).pdf for details.
00209      */
00210     Error * httpCommand(int httpProfile, HttpCmd httpCmd, const char* httpPath,
00211                         const char* rspFile, const char* sendStr,
00212                         int httpContentType, const char* httpCustomPar,
00213                         char* buf, int len);
00214 
00215     /**********************************************************************
00216      * PUBLIC: FTP
00217      **********************************************************************/
00218 
00219     /** FTP configuration parameters (reference to FTP control +UFTP).
00220      */
00221     typedef enum {
00222         FTP_IP_ADDRESS = 0,
00223         FTP_SERVER_NAME = 1,
00224         FTP_USER_NAME = 2,
00225         FTP_PASSWORD = 3,
00226         FTP_ACCOUNT = 4,
00227         FTP_INACTIVITY_TIMEOUT = 5,
00228         FTP_MODE = 6,
00229         FTP_SERVER_PORT = 7,
00230         FTP_SECURE = 8,
00231         NUM_FTP_OP_CODES
00232     } FtpOpCode;
00233 
00234     /** Type of FTP Command.
00235      */
00236     typedef enum {
00237         FTP_LOGOUT = 0,
00238         FTP_LOGIN = 1,
00239         FTP_DELETE_FILE = 2,
00240         FTP_RENAME_FILE = 3,
00241         FTP_GET_FILE = 4,
00242         FTP_PUT_FILE = 5,
00243         FTP_GET_DIRECT = 6,
00244         FTP_PUT_DIRECT = 7,
00245         FTP_CD = 8,
00246         FTP_MKDIR = 10,
00247         FTP_RMDIR = 11,
00248         FTP_FILE_INFO = 13,
00249         FTP_LS = 14,
00250         FTP_FOTA_FILE = 100
00251     } FtpCmd;
00252 
00253     /** Set the timeout for FTP operations.
00254      *
00255      * @param timeout -1 blocking, else non-blocking timeout in milliseconds.
00256      * @return         true if successful, otherwise false.
00257      */
00258     bool ftpSetTimeout(int timeout);
00259 
00260     /** Reset the FTP configuration back to defaults.
00261      */
00262     void ftpResetPar();
00263     
00264     /** Set FTP parameters.
00265      *
00266      * This should be called as many times as is necessary
00267      * to set all the possible parameters (FtpOpCode).
00268      *
00269      * See section 27.1 of u-blox-ATCommands_Manual(UBX-13002752).pdf
00270      * for full details.  By example:
00271      *
00272      * ftpOpCode              ftpInPar
00273      * FTP_IP_ADDRESS         "145.33.18.10" (the target FTP server IP address)
00274      * FTP_SERVER_NAME        "www.ftpserver.com" (the target FTP server name)
00275      * FTP_USER_NAME          "my_username"
00276      * FTP_PASSWORD           "my_password"
00277      * FTP_ACCOUNT            "my_account" (not required by most FTP servers)
00278      * FTP_INACTIVITY_TIMEOUT "60" (the default is 0, which means no timeout)
00279      * FTP_MODE               "0" for active, "1" for passive (the default is 0) 
00280      * FTP_SERVER_PORT        "25" (default is port 21)
00281      * FTP_SECURE             "0" for no security, "1" for SFTP (the default is 0)
00282      *
00283      * @param ftpOpCode  the FTP operation code.
00284      * @param ftpInPar   the FTP input parameter.
00285      * @return           true if successful, false otherwise.
00286      */
00287     bool ftpSetPar(FtpOpCode ftpOpCode, const char * ftpInPar);
00288     
00289     /** Perform an FTP command.
00290      *
00291      * Connect() must have been called previously to establish a data
00292      * connection.
00293      *
00294      * See section 27.2 of u-blox-ATCommands_Manual(UBX-13002752).pdf
00295      * for full details.  By example, it works like this:
00296      *
00297      * ftpCmd               file1      file2    buf     len  offset
00298      * FTP_LOGOUT            N/A        N/A     N/A     N/A    N/A 
00299      * FTP_LOGIN             N/A        N/A     N/A     N/A    N/A 
00300      * FTP_DELETE_FILE   "the_file"     N/A     N/A     N/A    N/A
00301      * FTP_RENAME_FILE   "old_name"  "new_name" N/A     N/A    N/A 
00302      * FTP_GET_FILE      "the_file"    Note 1   N/A     N/A   0 - 1    (Notes 2 & 3)
00303      * FTP_PUT_FILE      "the_file"    Note 1   N/A     N/A  0 - 65535 (Notes 2 & 4 & 5)
00304      * FTP_CD            "dir1\dir2"    N/A     N/A     N/A    N/A 
00305      * FTP_MKDIR         "newdir"       N/A     N/A     N/A    N/A 
00306      * FTP_RMDIR         "dir"          N/A     N/A     N/A    N/A 
00307      * FTP_FILE_INFO     "the_path"     N/A        Note 6      N/A
00308      * FTP_LS            "the_path"     N/A        Note 6      N/A
00309      * FTP_FOTA_FILE     "the_file"     N/A        Note 7      N/A
00310      *
00311      * Note 1: for this case, file2 is the name that the file should be
00312      * given when it arrives (in the modem file system for a GET, at the FTP
00313      * server for a PUT); if set to NULL then file1 is used.
00314      * Note 2: the file will placed into the modem file system for the
00315      * GET case (and can be read with readFile()), or must already be in the
00316      * modem file system, (can be written using writeFile()) for the PUT case.
00317      * Note 3: if offset is 1 then, where supported, the FTP GET
00318      * will be continued from the point it previously stopped.
00319      * Note 4: if the file already exists in the modem file system some
00320      * modems will return an error.  It is up to the caller to ensure that
00321      * the file does not exist before the FTP PUT operation.
00322      * Note 5: where supported, offset is the position in the file to continue
00323      * the FTP PUT from.
00324      * Note 6: buf should point to the location where the file info
00325      * or directory listing is to be stored and len should be the maximum
00326      * length that can be stored.
00327      * Note 7: a hex string representing the MD5 sum of the FOTA file will be
00328      * stored at buf; len must be at least 32 as an MD5 sum is 16 bytes.
00329      * FTP_FOTA_FILE is not supported on SARA-U2.
00330      * Note 8: FTP_GET_DIRECT and FTP_PUT_DIRECT are not supported by
00331      * this driver.
00332      *
00333      * @param ftpCmd     the FTP command.
00334      * @param file1      the first file name if required (NULL otherwise).
00335      * @param file2      the second file name if required (NULL otherwise).
00336      * @param buf        pointer to a buffer, required for FTP_DIRECT mode
00337      *                   and FTP_LS only.
00338      * @param len        the size of buf.
00339      * @param continue   if true then attempt to continue a download that
00340      *                   was previously interrupted.
00341      * @return           NULL if successful, otherwise a pointer to
00342      *                   a Error struct containing the error class and error
00343      *                   code, see section Appendix A.B of
00344      *                   u-blox-ATCommands_Manual(UBX-13002752).pdf for details.
00345      */
00346     Error *ftpCommand(FtpCmd ftpCmd, const char* file1 = NULL, const char* file2 = NULL,
00347                       char* buf = NULL, int len = 0, int offset = 0);
00348 
00349     /**********************************************************************
00350      * PUBLIC: Cell Locate
00351      **********************************************************************/
00352  
00353     /** Which form of Cell Locate sensing to use.
00354      */
00355     typedef enum {
00356         CELL_LAST,
00357         CELL_GNSS,
00358         CELL_LOCATE,
00359         CELL_HYBRID
00360     } CellSensType;
00361 
00362     /** Types of Cell Locate response.
00363      */
00364     typedef enum {
00365         CELL_DETAILED = 1,
00366         CELL_MULTIHYP = 2
00367     } CellRespType;
00368 
00369     /** Cell Locate data.
00370      */
00371     typedef struct {
00372         volatile bool validData;      //!< Flag for indicating if data is valid.
00373         volatile struct tm time;      //!< GPS Timestamp.
00374         volatile float longitude;     //!< Estimated longitude, in degrees.
00375         volatile float latitude;      //!< Estimated latitude, in degrees.
00376         volatile int altitude;        //!< Estimated altitude, in meters^2.
00377         volatile int uncertainty;     //!< Maximum possible error, in meters.
00378         volatile int speed;           //!< Speed over ground m/s^2.
00379         volatile int direction;       //!< Course over ground in degrees.
00380         volatile int verticalAcc;     //!< Vertical accuracy, in meters^2.
00381         volatile CellSensType sensor; //!< Sensor used for last calculation.
00382         volatile int svUsed;          //!< number of satellite used.
00383     } CellLocData;
00384 
00385     /** Configure the Cell Locate TCP aiding server.
00386      *
00387      * Connect() must have been called previously to establish
00388      * a data connection.
00389      *
00390      * @param server_1   host name of the primary MGA server.
00391      * @param server_2   host name of the secondary MGA server.
00392      * @param token      authentication token for MGA server access.
00393      * @param days       the number of days into the future the off-line
00394      *                   data for the u-blox 7.
00395      * @param period     the number of weeks into the future the off-line
00396      *                   data for u-blox M8.
00397      * @param resolution resolution of off-line data for u-blox M8: 1 every
00398      *                   day, 0 every other day.
00399      * @return           true if the request is successful, otherwise false.
00400      */
00401     bool cellLocSrvTcp(const char* token, const char* server_1 = "cell-live1.services.u-blox.com",
00402                        const char* server_2 = "cell-live2.services.u-blox.com",
00403                        int days = 14, int period = 4, int resolution = 1);
00404  
00405     /** Configure Cell Locate UDP aiding server.
00406      *
00407      * Connect() must have been called previously to establish
00408      * a data connection.
00409      *
00410      * @param server_1   host name of the primary MGA server.
00411      * @param port       server port.
00412      * @param latency    expected network latency in seconds from 0 to 10000 milliseconds.
00413      * @param mode       Assist Now management, mode of operation:
00414      *                   0 data downloaded at GNSS power up,
00415      *                   1 automatically kept alive, manual download.
00416      * @return           true if the request is successful, otherwise false.
00417      */
00418     bool cellLocSrvUdp(const char* server_1 = "cell-live1.services.u-blox.com",
00419                        int port = 46434, int latency = 1000, int mode = 0);
00420  
00421     /** Configure Cell Locate location sensor.
00422      *
00423      * @param scanMode network scan mode: 0 normal, 1 deep scan.
00424      * @return         true if the request is successful, otherwise false.
00425      */
00426     bool cellLocConfig(int scanMode);
00427  
00428     /** Request a one-shot Cell Locate.
00429      *
00430      * This function is non-blocking, the result is retrieved using cellLocGetxxx.
00431      *
00432      * Note: none of the CellLocate methods switch on the GNSS receiver chip.
00433      * That should be done by instantiating the GnssSerial or GnssI2C classes and
00434      * calling the init() method.
00435      *
00436      * Note: during the location process, unsolicited result codes will be returned
00437      * by the modem indicating progress and potentially flagging interesting errors.
00438      * In order to see these errors, instantiate this class with debugOn set to true.
00439      *   
00440      * @param sensor     sensor selection.
00441      * @param timeout    timeout period in seconds (1 - 999).
00442      * @param accuracy   target accuracy in meters (1 - 999999).
00443      * @param type       detailed or multi-hypothesis.
00444      * @param hypothesis maximum desired number of responses from CellLocate (up to 16),
00445      *                   must be 1 if type is CELL_DETAILED.
00446      * @return           true if the request is successful, otherwise false.
00447      */
00448     bool cellLocRequest(CellSensType sensor, int timeout, int accuracy,
00449                         CellRespType type = CELL_DETAILED, int hypothesis = 1);
00450 
00451     /** Get a position record.
00452      *
00453      * @param data  pointer to a CellLocData structure where the location will be put.
00454      * @param index of the position to retrieve.
00455      * @return      true if data has been retrieved and copied, false otherwise.
00456      */
00457     bool cellLocGetData(CellLocData *data, int index = 0);
00458     
00459     /** Get the number of position records received.
00460      *
00461      * @return number of position records received.
00462      */
00463     int cellLocGetRes();
00464     
00465     /** Get the number of position records expected to be received.
00466      *
00467      * @return number of position records expected to be received.
00468      */
00469     int cellLocGetExpRes();
00470     
00471 protected:
00472 
00473     /**********************************************************************
00474      * PROTECTED: HTTP
00475      **********************************************************************/
00476 
00477     /** Check for timeout.
00478      */
00479     #define TIMEOUT(t, ms)  ((ms != TIMEOUT_BLOCKING) && (ms < t.read_ms()))
00480 
00481     /** Check for a valid profile.
00482      */
00483     #define IS_PROFILE(p) (((p) >= 0) && (((unsigned int) p) < (sizeof(_httpProfiles)/sizeof(_httpProfiles[0]))) \
00484                            && (_httpProfiles[p].modemHandle != HTTP_PROF_UNUSED))
00485 
00486     /** Management structure for HTTP profiles.
00487      *
00488      * It is possible to have up to 4 different HTTP profiles (LISA-C200, LISA-U200 and SARA-G350) having:
00489      *
00490      * @param handle     the current HTTP profile is in handling state or not (default value is HTTP_ERROR).
00491      * @param timeout    the timeout for the current HTTP command.
00492      * @param pending    the status for the current HTTP command (in processing state or not).
00493      * @param cmd        the code for the current HTTP command.
00494      * @param result     the result for the current HTTP command once processed.
00495      */
00496      typedef struct {
00497          int modemHandle;
00498          int timeout;
00499          volatile bool pending;
00500          volatile int cmd;
00501          volatile int result;
00502          Error httpError;
00503      } HttpProfCtrl;
00504 
00505     /** The HTTP profile storage.
00506      */
00507     HttpProfCtrl _httpProfiles[4];
00508 
00509     /** Callback to capture the response to an HTTP command.
00510      */
00511     void UUHTTPCR_URC();
00512 
00513     /** Find a profile with a given handle.  If no handle is given, find the next
00514      * free profile.
00515      *
00516      * @param modemHandle the handle of the profile to find.
00517      * @return            the profile handle or negative if not found/created.
00518      */
00519     int findProfile(int modemHandle = HTTP_PROF_UNUSED);
00520 
00521     /** Helper function to get a HTTP command as a text string, useful
00522      * for debug purposes.
00523      *
00524      * @param httpCmdCode the HTTP command.
00525      * @return            HTTP command in string format.
00526      */
00527     const char* getHttpCmd(HttpCmd httpCmd);
00528 
00529     /**********************************************************************
00530      * PROTECTED: FTP
00531      **********************************************************************/
00532 
00533     /** Unused FTP op code marker.
00534      */
00535     #define FTP_OP_CODE_UNUSED -1
00536 
00537     /** The FTP timeout in milliseconds.
00538      */
00539     int _ftpTimeout;
00540 
00541     /** A place to store the FTP op code for the last result.
00542      */
00543     volatile int _lastFtpOpCodeResult;
00544 
00545     /** A place to store the last FTP result.
00546      */
00547     volatile int _lastFtpResult;
00548 
00549     /** A place to store the last FTP op code for data response.
00550      */
00551     volatile int _lastFtpOpCodeData;
00552 
00553     /** A place to store data returns from an FTP operation.
00554      */
00555     char * _ftpBuf;
00556 
00557     /** The length of FTP data that can be stored (at _ftpBuf).
00558      */
00559     int _ftpBufLen;
00560 
00561     /** storage for the last FTP error
00562      */
00563     Error _ftpError;
00564 
00565     /** Callback to capture the result of an FTP command.
00566      */
00567     void UUFTPCR_URC();
00568 
00569     /** Callback to capture data returned from an FTP command.
00570      */
00571     void UUFTPCD_URC();
00572 
00573     /** Helper function to get an FTP command as a text string, useful
00574      * for debug purposes.
00575      *
00576      * @param ftpCmdCode  the FTP command.
00577      * @return            FTP command in string format.
00578      */
00579     const char * getFtpCmd(FtpCmd ftpCmd);
00580 
00581     /**********************************************************************
00582      * PROTECTED: Cell Locate
00583      **********************************************************************/
00584 
00585     /**  The maximum number of hypotheses
00586      */
00587     #define CELL_MAX_HYP    (16 + 1)
00588 
00589     /** Received positions.
00590      */
00591     volatile int _locRcvPos;
00592 
00593     /** Expected positions.
00594      */
00595     volatile int _locExpPos;
00596 
00597     /**  The Cell Locate data.
00598      */
00599     CellLocData _loc[CELL_MAX_HYP];
00600 
00601     /** Buffer for the URC to work with
00602      */
00603     char urcBuf[128];
00604 
00605     /** Callback to capture +UULOCIND.
00606      */
00607     void UULOCIND_URC();
00608 
00609     /** Callback to capture +UULOC.
00610      */
00611     void UULOC_URC();
00612 };
00613 
00614 #endif // _UBLOX_AT_CELLULAR_INTERFACE_EXT_
00615