Loom_LTE Class Reference

#include <Loom_LTE.h>

Inheritance diagram for Loom_LTE:

Collaboration diagram for Loom_LTE:

Public Member Functions
	Loom_LTE (Manager &man, const char *apn, const char *user, const char *pass, const int powerPin=A5)
	Loom_LTE (Manager &man)
void	initialize () override
void	power_up () override
void	power_down () override
void	package () override
void	loadConfigFromJSON (char *json)
void	setBatchSD (Loom_BatchSD &batch)
bool	connect ()
void	disconnect ()
bool	verifyConnection ()
TinyGsmClient &	getClient ()
bool	isConnected ()
void	restartModem ()
void	ipToString (IPAddress ip, char array[16])
Public Member Functions inherited from Module
	Module (const char *modName)
void	setModuleName (const char *modName)
virtual const char *	getModuleName ()
virtual void	printModuleName (const char *message)
virtual void	initialize ()=0
virtual void	measure ()=0
virtual void	package ()=0
virtual void	power_up ()=0
virtual void	power_down ()=0
virtual void	display_data ()

Protected Member Functions
void	measure () override

Additional Inherited Members
Public Attributes inherited from Module
bool	moduleInitialized = true
int	module_address = -1

Detailed Description

Loomified Control for a 4G LTE Board

Author

Will Richards

Constructor & Destructor Documentation

Loom_LTE() [1/2]

Loom_LTE::Loom_LTE	(	Manager &	man,
		const char *	apn,
		const char *	user,
		const char *	pass,
		const int	powerPin = A5
	)

Construct a new LTE instance

Parameters

man	Reference to the manager
apn	Name of the LTE network
user	Username to use
pass	Password to use
powerPin	Pin used to power the device

Loom_LTE() [2/2]

Loom_LTE::Loom_LTE

(

Manager &

man

)

Construct a new LTE instance assuming credentials will be pulled from an SD card

Parameters

man	Reference to the manager

Member Function Documentation

connect()

bool Loom_LTE::connect

(

)

Connect to the cellular network

disconnect()

void Loom_LTE::disconnect

(

)

Disconnect from the cellular network

getClient()

TinyGsmClient & Loom_LTE::getClient

(

)

Get the client to supply to publish platforms that need to communicate using this internet framework

initialize()

void Loom_LTE::initialize ( )

overridevirtual

Implements Module.

ipToString()

void Loom_LTE::ipToString ( IPAddress  ip, char  array[16]  )

inline

Convert an IP address to a string

isConnected()

bool Loom_LTE::isConnected

(

)

Checks if the modem is connected to a cellular network

loadConfigFromJSON()

void Loom_LTE::loadConfigFromJSON

(

char *

json

)

Load the config to connect to the LTE network from a JSON string

Parameters

json	Json file read, this is freed before returning

measure()

void Loom_LTE::measure ( )

inlineoverrideprotectedvirtual

Implements Module.

package()

void Loom_LTE::package ( )

overridevirtual

Implements Module.

power_down()

void Loom_LTE::power_down ( )

overridevirtual

Implements Module.

power_up()

void Loom_LTE::power_up ( )

overridevirtual

Implements Module.

setBatchSD()

void Loom_LTE::setBatchSD ( Loom_BatchSD &  batch )

inline

Turn on batch upload for the lte which means it will only initialize the module when we need to upload

Parameters

batch

BatchSD module

verifyConnection()

bool Loom_LTE::verifyConnection

(

)

Attempt to connect to something remote to see if we actually have an internet connection

---

The documentation for this class was generated from the following files:

• C:/Users/jwilt/AppData/Local/Arduino15/packages/loom4/hardware/samd/4.5/libraries/Loom/src/Internet/Connectivity/Loom_LTE/Loom_LTE.h
• C:/Users/jwilt/AppData/Local/Arduino15/packages/loom4/hardware/samd/4.5/libraries/Loom/src/Internet/Connectivity/Loom_LTE/Loom_LTE.cpp