Loom_LTE class

LTE InternetPlat.

Contents

Base classes

class LoomInternetPlat
Abstract internet communication module.

Protected functions

auto get_client() -> SSLClient& override
Get the underlying SSLClient implementation, which we will use for all of the other requests.

Protected variables

const char* APN
LTE Network name.
const char* gprsUser
GPRS username crendtial.
const char* gprsPass
GPRS password credenital.
const int powerPin
Wired analog pin to power on LTE shield.
TinyGsmClient m_base_client
SSLClient object for LTE.
SSLClient m_client
Underlying LTE SSLClient instance.

CONSTRUCTORS / DESTRUCTOR

Loom_LTE(LoomManager* manager, const char* APN = "", const char* gprsUser = "", const char* gprsPass = "", const int powerPin = A5)
Constructor.
Loom_LTE(LoomManager* manager, JsonArrayConst p)
Constructor that takes Json Array, extracts args.
~Loom_LTE() defaulted virtual
Destructor.

OPERATION

void connect() override
Connect to internet.
void disconnect() override
Disconnect from internet.
auto is_connected() const -> bool override
Whether or not connected to internet.
auto open_socket(const uint port) -> UDPPtr override
Fails everytime, there is no UDP socket functionality in the TinyGSM library.
void power_up() override
Turn on any hardware.
void power_down() override
Turn off any hardware.

Function documentation

Loom_LTE::Loom_LTE(LoomManager* manager, const char* APN = "", const char* gprsUser = "", const char* gprsPass = "", const int powerPin = A5)

Constructor.

Parameters
manager
APN in LTE network name
gprsUser in GPRS username. Leave as empty unless you have GPRS credentials
gprsPass in GPRS password. Leave as empty unless you have GPRS credentials
powerPin in analog pin on the feather M0 that drives pin 5 on LTE shield to power on and off

Loom_LTE::Loom_LTE(LoomManager* manager, JsonArrayConst p)

Constructor that takes Json Array, extracts args.

Parameters
manager
p in The array of constuctor args to expand

and delegates to regular constructor

bool Loom_LTE::is_connected() const override

Whether or not connected to internet.

Returns True if connected, false otherwise

UDPPtr Loom_LTE::open_socket(const uint port) override

Fails everytime, there is no UDP socket functionality in the TinyGSM library.

Returns a UDP socket for transmitting and recieving