LTEAccessProvider.h

Go to the documentation of this file.

/*
 *  LTEAccessProvider.h - LTEAccessProvider include file for Spresense Arduino
 *  Copyright 2019, 2021 Sony Semiconductor Solutions Corporation
 *
 *  This library is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU Lesser General Public
 *  License as published by the Free Software Foundation; either
 *  version 2.1 of the License, or (at your option) any later version.
 *
 *  This library is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *  Lesser General Public License for more details.
 *
 *  You should have received a copy of the GNU Lesser General Public
 *  License along with this library; if not, write to the Free Software
 *  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 */
 
#ifndef __SPRESENSE_LTEACCESSPROVIDER_H__
#define __SPRESENSE_LTEACCESSPROVIDER_H__
 
#ifdef SUBCORE
#error "LTE library is NOT supported by SubCore."
#endif
 
/****************************************************************************
 * Included Files
 ****************************************************************************/
 
#include <LTEDefinition.h>
 
class IPAddress;
 
/****************************************************************************
 * class declaration
 ****************************************************************************/
 
class LTEAccessProvider{
public:
 
  LTEAccessProvider();
 
  ~LTEAccessProvider();
 
  LTEModemStatus begin(char* pinCode = NULL, bool restart = true, bool synchronous = true);
 
  void shutdown();
 
  LTEModemStatus attach(const char *apn,
                        const char *userName = NULL,
                        const char *password = NULL,
                        LTENetworkAuthType authType = LTE_NET_AUTHTYPE_CHAP,
                        LTENetworkIPType ipType = LTE_NET_IPTYPE_V4V6,
                        bool synchronous = true);
 
  LTEModemStatus attach(LTENetworkRatType rat,
                        const char *apn,
                        const char *userName = NULL,
                        const char *password = NULL,
                        LTENetworkAuthType authType = LTE_NET_AUTHTYPE_CHAP,
                        LTENetworkIPType ipType = LTE_NET_IPTYPE_V4V6, 
                        bool synchronous = true);
 
  LTEModemStatus detach();
 
  IPAddress getIPAddress();
 
  unsigned long getTime();
 
  LTEModemStatus getStatus();
};
 
#endif // __SPRESENSE_LTEACCESSPROVIDER_H__