esphome::modem Namespace Reference

Data Structures
class	ModemComponent

Typedefs
using	DceFactory

Enumerations
enum class	ModemState : uint8_t {   MODEM_STATE_DISABLED , MODEM_STATE_ENABLING , MODEM_STATE_SYNCED , MODEM_STATE_CONNECTING ,   MODEM_STATE_WAIT_IP , MODEM_STATE_CONNECTED , MODEM_STATE_DISCONNECTING }
enum class	ConnectStep : uint8_t { CONNECT_STEP_START , CONNECT_STEP_RADIO_ON , CONNECT_STEP_ATTACH_REQUESTED }
enum class	SimResult : uint8_t { SIM_RESULT_READY , SIM_RESULT_RETRY , SIM_RESULT_LOCKED , SIM_RESULT_HALT }
enum class	ModemFault : uint8_t {   MODEM_FAULT_NONE , MODEM_FAULT_NO_RESPONSE , MODEM_FAULT_BAUD , MODEM_FAULT_INIT_AT ,   MODEM_FAULT_SIM_NOT_READY , MODEM_FAULT_SIM_LOCKED , MODEM_FAULT_PIN_NOT_SENT , MODEM_FAULT_PIN_RECORD ,   MODEM_FAULT_SETUP , MODEM_FAULT_NOT_ATTACHED , MODEM_FAULT_PPP , MODEM_FAULT_TEARDOWN }
enum class	PinStep : uint8_t { PIN_STEP_IDLE , PIN_STEP_SAVING , PIN_STEP_SENT }
enum class	PinSave : uint8_t { PIN_SAVE_DONE , PIN_SAVE_PENDING , PIN_SAVE_FAILED }

Functions
	ESPHOME_LOG_TAG (TAG, "modem")
	PROGMEM_STRING_TABLE (ModemStateStrings, "DISABLED", "ENABLING", "SYNCED", "CONNECTING", "WAIT_IP", "CONNECTED", "DISCONNECTING", "UNKNOWN")
	PROGMEM_STRING_TABLE (ModemFaultStrings, "", "Modem not responding", "Configured baud rate failed", "init_at command failed", "SIM not ready", "SIM locked", "SIM PIN not sent; check pin_code", "PIN record not saved", "APN or radio setup failed", "No network attachment", "PPP link failed", "Modem teardown failed")
	PROGMEM_STRING_TABLE (CommandResultStrings, "OK", "FAIL", "TIMEOUT")

Variables
ModemComponent *	global_modem_component = nullptr

Typedef Documentation

DceFactory

using esphome::modem::DceFactory

Initial value:

 std::unique_ptr<esp_modem::DCE> (*)(const esp_modem::dce_config *, std::shared_ptr<esp_modem::DTE>,
                                                       esp_netif_t *)

Definition at line 82 of file modem_component.h.

Enumeration Type Documentation

ConnectStep

enum class esphome::modem::ConnectStep : uint8_t

strong

Enumerator
CONNECT_STEP_START
CONNECT_STEP_RADIO_ON
CONNECT_STEP_ATTACH_REQUESTED

Definition at line 37 of file modem_component.h.

ModemFault

enum class esphome::modem::ModemFault : uint8_t

strong

Enumerator
MODEM_FAULT_NONE
MODEM_FAULT_NO_RESPONSE
MODEM_FAULT_BAUD
MODEM_FAULT_INIT_AT
MODEM_FAULT_SIM_NOT_READY
MODEM_FAULT_SIM_LOCKED
MODEM_FAULT_PIN_NOT_SENT
MODEM_FAULT_PIN_RECORD
MODEM_FAULT_SETUP
MODEM_FAULT_NOT_ATTACHED
MODEM_FAULT_PPP
MODEM_FAULT_TEARDOWN

Definition at line 51 of file modem_component.h.

ModemState

enum class esphome::modem::ModemState : uint8_t

strong

Enumerator
MODEM_STATE_DISABLED
MODEM_STATE_ENABLING
MODEM_STATE_SYNCED
MODEM_STATE_CONNECTING
MODEM_STATE_WAIT_IP
MODEM_STATE_CONNECTED
MODEM_STATE_DISCONNECTING

Definition at line 26 of file modem_component.h.

PinSave

enum class esphome::modem::PinSave : uint8_t

strong

Enumerator
PIN_SAVE_DONE
PIN_SAVE_PENDING
PIN_SAVE_FAILED

Definition at line 74 of file modem_component.h.

PinStep

enum class esphome::modem::PinStep : uint8_t

strong

Enumerator
PIN_STEP_IDLE
PIN_STEP_SAVING
PIN_STEP_SENT

Definition at line 67 of file modem_component.h.

SimResult

enum class esphome::modem::SimResult : uint8_t

strong

Enumerator
SIM_RESULT_READY
SIM_RESULT_RETRY
SIM_RESULT_LOCKED
SIM_RESULT_HALT

Definition at line 43 of file modem_component.h.

Function Documentation

ESPHOME_LOG_TAG()

esphome::modem::ESPHOME_LOG_TAG	(	TAG	,
		"modem"	)

PROGMEM_STRING_TABLE() [1/3]

esphome::modem::PROGMEM_STRING_TABLE	(	CommandResultStrings	,
		"OK"	,
		"FAIL"	,
		"TIMEOUT"	)

PROGMEM_STRING_TABLE() [2/3]

esphome::modem::PROGMEM_STRING_TABLE	(	ModemFaultStrings	,
		""	,
		"Modem not responding"	,
		"Configured baud rate failed"	,
		"init_at command failed"	,
		"SIM not ready"	,
		"SIM locked"	,
		"SIM PIN not sent; check pin_code"	,
		"PIN record not saved"	,
		"APN or radio setup failed"	,
		"No network attachment"	,
		"PPP link failed"	,
		"Modem teardown failed"	)

PROGMEM_STRING_TABLE() [3/3]

esphome::modem::PROGMEM_STRING_TABLE	(	ModemStateStrings	,
		"DISABLED"	,
		"ENABLING"	,
		"SYNCED"	,
		"CONNECTING"	,
		"WAIT_IP"	,
		"CONNECTED"	,
		"DISCONNECTING"	,
		"UNKNOWN"	)

Variable Documentation

global_modem_component

ModemComponent * esphome::modem::global_modem_component = nullptr

Definition at line 37 of file modem_component.cpp.