#include <src/LoggerModem.h>

loggerModem class

Derived classes

class DigiXBee

The parent class for all Digi XBee and XBee3 wifi and cellular modules.

class EspressifESP8266

The loggerModem subclass for any breakout of the Espressif ESP8266 wifi chip or ESP32 wifi/bluetooth chip that has been flashed with Espressif's AT command firmware.

class QuectelBG96

The loggerModem subclass for Dragino, Nimbelink, or any other module based on the Quectel BG96.

class SIMComSIM7000

The loggerModem subclass for Botletics, And1, and other modules based on the SIMCOM SIM7000.

class SIMComSIM7080

The loggerModem subclass for modules based on the SIMCOMSIM7080".

class SIMComSIM800

The loggerModem subclass for the Adafruit Fona 2G, the Sodaq GPRSBeeR4 and almost any other module based on the SIMCOM SIM800 or SIM900 modules andthier variants".

class SequansMonarch

The loggerModem subclass for Nimbelink or other modules based on the Sequans Monarch VZM20Q.

class SodaqUBeeR410M

The loggerModem subclass for the LTE-M Sodaq UBee based on the u-blox SARA R410M LTE-M cellular module. This can be also used for any other breakout of the the u-blox R4 or N4 series modules.

class SodaqUBeeU201

The loggerModem subclass for the 2G/3G Sodaq UBee based on the u-blox SARA U201 2G/3G cellular module.

Constructors, destructors, conversion operators

loggerModem(int8_t powerPin, int8_t statusPin, bool statusLevel, int8_t modemResetPin, bool resetLevel, uint32_t resetPulse_ms, int8_t modemSleepRqPin, bool wakeLevel, uint32_t wakePulse_ms, uint32_t max_status_time_ms, uint32_t max_disconnetTime_ms, uint32_t wakeDelayTime_ms, uint32_t max_atresponse_time_ms)

Construct a new loggerModem object.

~loggerModem() virtual

Destroy the logger Modem object - no action taken.

Public functions

void setModemLED(int8_t modemLEDPin)

Set an LED to turn on (pin will be HIGH) when the modem is on.

String getModemName(void) -> String

Get the modem name.

String getModemDevId(void) -> String

Get a detailed printable description of the modem.

bool modemSetup(void) -> bool virtual

Set up the modem before first use.

bool setup(void) -> bool deprecated in v0.24.1

Retained for backwards compatibility; use modemSetup() in new code.

bool modemHardReset(void) -> bool virtual

Use the modem reset pin specified in the constructor to perform a "hard" or "panic" reset.

Protected static functions

static uint32_t parseNISTBytes(byte[4] nistBytes) -> uint32_t

Convert the 4 bytes returned on the NIST daytime protocol to the number of seconds since January 1, 1970 in UTC.

Protected variables

String _modemName

The modem name.

String _modemHwVersion

The modem hardware version.

String _modemFwVersion

The modem firmware version.

String _modemSerialNumber

The modem serial number.

uint8_t _pollModemMetaData

An 8-bit code for the enabled modem polling variables.

Member variables set in the constructor

These are all related to expected modem response times and the pin connections between the modem module and the logger MCU.

int8_t _powerPin protected

The digital pin number of the mcu pin controlling power to the modem (active HIGH).

int8_t _statusPin protected

The digital pin number of the mcu pin connected to the modem status output pin.

bool _statusLevel protected

The level (LOW or HIGH) of the _statusPin when the modem is active.

int8_t _modemResetPin protected

The digital pin number of the pin on the mcu attached the the hard or panic reset pin of the modem.

bool _resetLevel protected

The level (LOW or HIGH) of the _modemResetPin which will cause the modem to reset.

uint32_t _resetPulse_ms protected

The length of time in milliseconds at _resetLevel needed on _modemResetPin to reset the modem.

int8_t _modemSleepRqPin protected

The digital pin number of a pin on the mcu used to request the modem enter its lowest possible power state.

bool _wakeLevel protected

The level (LOW or HIGH) on the _modemSleepRqPin used to wake the modem.

uint32_t _wakePulse_ms protected

The length of pulse in milliseconds at _wakeLevel needed on the _modemSleepRqPin to wake the modem.

uint32_t _statusTime_ms protected

The time in milliseconds between when modemWake() is run and when the _statusPin is expected to be at _statusLevel.

uint32_t _disconnetTime_ms protected

The maximum length of time in milliseconds between when the modem is requested to enter lowest power state (modemSleep()) and when it should have completed necessary steps to shut down.

uint32_t _wakeDelayTime_ms protected

The time in milliseconds between when the modem is powered and when it is able to receive a wake command.

uint32_t _max_atresponse_time_ms protected

The time in milliseconds between when the modem is awake and when its serial ports reach full functionality and are ready to accept AT commands.

Flags and other member variables only used internally

int8_t _modemLEDPin protected

The digital pin number of a pin on the mcu used to indicate the modem's current activity state.

uint32_t _millisPowerOn protected

The processor elapsed time when the power was turned on for the modem.

uint32_t _lastNISTrequest protected

The processor elapsed time when the a connection to the NIST time server was last attempted.

bool _hasBeenSetup protected

Flag. True indicates that the modem has already successfully completed setup.

bool _pinModesSet protected

Flag. True indicates that the pins on the mcu attached to the modem are set to the correct mode (ie, input vs output).

Static member variables used to hold modem metadata

static int16_t _priorRSSI protected

The last stored RSSI value.

static int16_t _priorSignalPercent protected

The last stored signal strength percent value.

static float _priorModemTemp protected

The last stored modem chip temperature value.

static float _priorBatteryState protected

The last stored modem battery state value.

static float _priorBatteryPercent protected

The last stored modem battery percent value.

static float _priorBatteryVoltage protected

The last stored modem battery voltage value.

Functions related to the modem power and activity state

These are similar to the like-named Sensor functions.

bool modemWake(void) -> bool pure virtual

Wake up the modem.

bool wake(void) -> bool deprecated in v0.24.1

Retained for backwards compatibility; use modemWake() in new code.

void modemPowerUp(void) virtual

Power the modem by setting the modem power pin high.

void modemPowerDown(void) virtual

Cut power to the modem by setting the modem power pin low.

bool modemSleep(void) -> bool virtual

Request that the modem enter its lowest possible power state.

bool modemSleepPowerDown(void) -> bool virtual

Request that the modem enter its lowest possible power state and then set the power pin low after the modem has indicated it has successfully gone to low power.

Pin setting functions

Functions to set or re-set the the pin numbers for the connection between the modem module and the logger MCU.

void setModemStatusLevel(bool level)

Set the pin level to be expected when the on the modem status pin when the modem is active.

void setModemWakeLevel(bool level)

Set the pin level to be used to wake the modem.

void setModemResetLevel(bool level)

Set the pin level to be used to reset the modem.

Functions for internet connectivity

bool connectInternet(uint32_t maxConnectionTime = 50000L) -> bool pure virtual

Wait for the modem to successfully register on the cellular network and then request that it establish either EPS or GPRS data connection.

void disconnectInternet(void) pure virtual

Detatch from EPS or GPRS data connection and then deregister from the cellular network.

uint32_t getNISTTime(void) -> uint32_t pure virtual

Get the time from NIST via TIME protocol (rfc868).

Modem metadata functions

Functions to get metadata about modem functionality - using the modem like a sensor.

These functions will query the modem to get new values.

bool getModemSignalQuality(int16_t& rssi, int16_t& percent) -> bool pure virtual

Query the modem for the current signal quality and write the results to the supplied non-constant references.

bool getModemBatteryStats(int8_t& chargeState, int8_t& percent, int16_t& milliVolts) -> bool pure virtual

Query the modem for battery information and write the values to the supplied non-constant references.

float getModemChipTemperature(void) -> float pure virtual

Get the current temperature provided by the modem module.

void enableMetadataPolling(uint8_t pollingBitmask)

Enables metadata polling for one or more modem measured variables. Setting this to 0b11111111 will enable polling for all modem measured variables.

void disableMetadataPolling(uint8_t pollingBitmask)

Disables metadata polling for one or more modem measured variables. Setting this to 0b11111111 will disable polling for all modem measured variables.

void setMetadataPolling(uint8_t pollingBitmask)

Sets the bitmask for modem metadata polling.

bool updateModemMetadata(void) -> bool virtual

Query the modem for signal quality, battery, and temperature information and store the values to the static internal variables.

Functions to return the current value of static member variables

These functions do NOT query the modem for new values, they return the stored value.

static float getModemRSSI() -> float

Get the stored Modem RSSI value.

static float getModemSignalPercent() -> float

Get the stored modem signal strength as a percent.

static float getModemBatteryChargeState() -> float

Get the stored modem battery charge state.

static float getModemBatteryChargePercent() -> float

Get the stored modem battery charge percent object.

static float getModemBatteryVoltage() -> float

Get the stored modem battery voltage.

static float getModemTemperature() -> float

Get the stored modem temperature.

Functions to convert between signal strength measurement types

static int16_t getRSSIFromCSQ(int16_t csq) -> int16_t protected

Get approximate RSSI from CSQ (assuming no noise).

static int16_t getPctFromCSQ(int16_t csq) -> int16_t protected

Get signal percent from CSQ.

static int16_t getPctFromRSSI(int16_t rssi) -> int16_t protected

Get signal percent from CSQ.

Helper functions

void modemLEDOn(void) protected

Turn on the modem LED/alert pin - sets it HIGH

void modemLEDOff(void) protected

Turn off the modem LED/alert pin - sets it LOW

void setModemPinModes(void) protected virtual

Set the processor pin modes (input vs output, with and without pull-up) for all pins connected between the modem module and the mcu.

Pure virtual functions for each modem to implement

bool isInternetAvailable(void) -> bool protected pure virtual

Check whether there is an active internet connection available.

bool modemSleepFxn(void) -> bool protected pure virtual

Perform the parts of the modem sleep process that are unique to a specific module, as opposed to the parts of setup that are common to all modem modules.

bool modemWakeFxn(void) -> bool protected pure virtual

Perform the parts of the modem wake up process that are unique to a specific module, as opposed to the parts of setup that are common to all modem modules.

bool extraModemSetup(void) -> bool protected pure virtual

Perform the parts of the modem set up process that are unique to a specific module, as opposed to the parts of setup that are common to all modem modules.

bool isModemAwake(void) -> bool protected pure virtual

Check if the modem was awake using all possible means.

Function documentation

Variable documentation