homeassistant.components.sms.gateway.Gateway Class Reference

Public Member Functions
def	__init__ (self, config, hass)
def	get_and_delete_all_sms (self, state_machine, force=False)
def	get_firmware_async (self)
def	get_imei_async (self)
def	get_manufacturer_async (self)
def	get_model_async (self)
def	get_network_info_async (self)
def	get_signal_quality_async (self)
def	init_async (self)
def	send_sms_async (self, message)
def	sms_pull (self, state_machine)
def	sms_read_messages (self, state_machine, force=False)
def	terminate_async (self)

Public Attributes
	firmware
	manufacturer
	model

Private Member Functions
def	_notify_incoming_sms (self, messages)

Private Attributes
	_first_pull
	_hass
	_worker

Detailed Description

SMS gateway to interact with a GSM modem.

Definition at line 15 of file gateway.py.

Constructor & Destructor Documentation

__init__()

def homeassistant.components.sms.gateway.Gateway.__init__	(		self,
			config,
			hass
	)

Initialize the sms gateway.

Definition at line 18 of file gateway.py.

Member Function Documentation

_notify_incoming_sms()

def homeassistant.components.sms.gateway.Gateway._notify_incoming_sms (   self,   messages  )

private

Notify hass when an incoming SMS message is received.

Definition at line 137 of file gateway.py.

get_and_delete_all_sms()

def homeassistant.components.sms.gateway.Gateway.get_and_delete_all_sms	(		self,
			state_machine,
			force = False
	)

Read and delete all SMS in the modem.

Definition at line 84 of file gateway.py.

get_firmware_async()

def homeassistant.components.sms.gateway.Gateway.get_firmware_async

(

self

)

Get the firmware information of the modem.

Definition at line 183 of file gateway.py.

get_imei_async()

def homeassistant.components.sms.gateway.Gateway.get_imei_async

(

self

)

Get the IMEI of the device.

Definition at line 151 of file gateway.py.

get_manufacturer_async()

def homeassistant.components.sms.gateway.Gateway.get_manufacturer_async

(

self

)

Get the manufacturer of the modem.

Definition at line 169 of file gateway.py.

get_model_async()

def homeassistant.components.sms.gateway.Gateway.get_model_async

(

self

)

Get the model of the modem.

Definition at line 173 of file gateway.py.

get_network_info_async()

def homeassistant.components.sms.gateway.Gateway.get_network_info_async

(

self

)

Get the current network info of the modem.

Definition at line 159 of file gateway.py.

get_signal_quality_async()

def homeassistant.components.sms.gateway.Gateway.get_signal_quality_async

(

self

)

Get the current signal level of the modem.

Definition at line 155 of file gateway.py.

init_async()

def homeassistant.components.sms.gateway.Gateway.init_async

(

self

)

Initialize the sms gateway asynchronously. This method is also called in config flow to verify connection.

Definition at line 29 of file gateway.py.

send_sms_async()

def homeassistant.components.sms.gateway.Gateway.send_sms_async	(		self,
			message
	)

Send sms message via the worker.

Definition at line 147 of file gateway.py.

sms_pull()

def homeassistant.components.sms.gateway.Gateway.sms_pull	(		self,
			state_machine
	)

Pull device.

@param state_machine: state machine
@type state_machine: gammu.StateMachine

Definition at line 36 of file gateway.py.

sms_read_messages()

def homeassistant.components.sms.gateway.Gateway.sms_read_messages	(		self,
			state_machine,
			force = False
	)

Read all received SMS messages.

@param state_machine: state machine which invoked action
@type state_machine: gammu.StateMachine

Definition at line 48 of file gateway.py.

terminate_async()

def homeassistant.components.sms.gateway.Gateway.terminate_async

(

self

)

Terminate modem connection.

Definition at line 193 of file gateway.py.

Member Data Documentation

_first_pull

homeassistant.components.sms.gateway.Gateway._first_pull

private

Definition at line 24 of file gateway.py.

_hass

homeassistant.components.sms.gateway.Gateway._hass

private

Definition at line 23 of file gateway.py.

_worker

homeassistant.components.sms.gateway.Gateway._worker

private

Definition at line 21 of file gateway.py.

firmware

homeassistant.components.sms.gateway.Gateway.firmware

Definition at line 27 of file gateway.py.

manufacturer

homeassistant.components.sms.gateway.Gateway.manufacturer

Definition at line 25 of file gateway.py.

model

homeassistant.components.sms.gateway.Gateway.model

Definition at line 26 of file gateway.py.

---

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

• core/homeassistant/components/sms/gateway.py