ModemManager.ModemSignal¶

Subclasses:: None

Methods¶

Inherited:: ModemManager.GdbusModemSignalProxy (6), Gio.DBusProxy (25), GObject.Object (37), Gio.AsyncInitable (4), Gio.DBusInterface (3), Gio.Initable (2), ModemManager.GdbusModemSignal (10)
Structs:: GObject.ObjectClass (5)

	`dup_path` ()
	`get_cdma` ()
	`get_error_rate_threshold` ()
	`get_evdo` ()
	`get_gsm` ()
	`get_lte` ()
	`get_nr5g` ()
	`get_path` ()
	`get_rate` ()
	`get_rssi_threshold` ()
	`get_umts` ()
	`peek_cdma` ()
	`peek_evdo` ()
	`peek_gsm` ()
	`peek_lte` ()
	`peek_nr5g` ()
	`peek_umts` ()
	`setup` (rate, cancellable, callback, *user_data)
	`setup_finish` (res)
	`setup_sync` (rate, cancellable)
	`setup_thresholds` (properties, cancellable, callback, *user_data)
	`setup_thresholds_finish` (res)
	`setup_thresholds_sync` (properties, cancellable)

Virtual Methods¶

Inherited:: Gio.DBusProxy (2), GObject.Object (7), Gio.AsyncInitable (2), Gio.DBusInterface (3), Gio.Initable (1), ModemManager.GdbusModemSignal (2)

Properties¶

Inherited:: Gio.DBusProxy (9), ModemManager.GdbusModemSignal (9)

Signals¶

Inherited:: Gio.DBusProxy (2), GObject.Object (1), ModemManager.GdbusModemSignal (2)

Fields¶

Inherited:: Gio.DBusProxy (2), GObject.Object (1), ModemManager.GdbusModemSignal (2)

Name	Type	Access	Description
parent	`ModemManager.GdbusModemSignalProxy`	r

Class Details¶

class ModemManager.ModemSignal(**kwargs)¶

Bases:: ModemManager.GdbusModemSignalProxy
Abstract:: No
Structure:: ModemManager.ModemSignalClass

The ModemManager.ModemSignal structure contains private data and should only be accessed using the provided API.

dup_path()¶

Returns:: The DBus path of the ModemManager.Object. The returned value should be freed with GLib.free().
Return type:: str

Gets a copy of the DBus path of the ModemManager.Object object which implements this interface.

New in version 1.2.

get_cdma()¶

Returns:: A ModemManager.Signal that must be freed with GObject.Object.unref() or None if unknown.
Return type:: ModemManager.Signal

Gets a ModemManager.Signal object specifying the CDMA signal information.

The values reported by self are not updated when the values in the interface change. Instead, the client is expected to call ModemManager.ModemSignal.get_cdma() again to get a new ModemManager.Signal with the new values.

New in version 1.2.

get_error_rate_threshold()¶

Returns:: True if the error rate threshold is enabled, False otherwise.
Return type:: bool

Gets whether the error rate threshold is enabled or not.

New in version 1.20.

get_evdo()¶

Returns:: A ModemManager.Signal that must be freed with GObject.Object.unref() or None if unknown.
Return type:: ModemManager.Signal

Gets a ModemManager.Signal object specifying the EV-DO signal information.

The values reported by self are not updated when the values in the interface change. Instead, the client is expected to call ModemManager.ModemSignal.get_evdo() again to get a new ModemManager.Signal with the new values.

New in version 1.2.

get_gsm()¶

Returns:: A ModemManager.Signal that must be freed with GObject.Object.unref() or None if unknown.
Return type:: ModemManager.Signal

Gets a ModemManager.Signal object specifying the GSM signal information.

The values reported by self are not updated when the values in the interface change. Instead, the client is expected to call ModemManager.ModemSignal.get_gsm() again to get a new ModemManager.Signal with the new values.

New in version 1.2.

get_lte()¶

Returns:: A ModemManager.Signal that must be freed with GObject.Object.unref() or None if unknown.
Return type:: ModemManager.Signal

Gets a ModemManager.Signal object specifying the LTE signal information.

The values reported by self are not updated when the values in the interface change. Instead, the client is expected to call ModemManager.ModemSignal.get_lte() again to get a new ModemManager.Signal with the new values.

New in version 1.2.

get_nr5g()¶

Returns:: A ModemManager.Signal that must be freed with GObject.Object.unref() or None if unknown.
Return type:: ModemManager.Signal

Gets a ModemManager.Signal object specifying the 5G signal information.

The values reported by self are not updated when the values in the interface change. Instead, the client is expected to call ModemManager.ModemSignal.get_nr5g() again to get a new ModemManager.Signal with the new values.

New in version 1.16.

get_path()¶

Returns:: The DBus path of the ModemManager.Object object.
Return type:: str

Gets the DBus path of the ModemManager.Object which implements this interface.

New in version 1.2.

get_rate()¶

Returns:: the refresh rate, in seconds.
Return type:: int

Gets the currently configured refresh rate.

New in version 1.2.

get_rssi_threshold()¶

Returns:: the RSSI threshold.
Return type:: int

Gets the currently configured RSSI threshold, in dBm.

A value of 0 indicates the threshold is disabled.

New in version 1.20.

get_umts()¶

Returns:: A ModemManager.Signal that must be freed with GObject.Object.unref() or None if unknown.
Return type:: ModemManager.Signal

Gets a ModemManager.Signal object specifying the UMTS signal information.

The values reported by self are not updated when the values in the interface change. Instead, the client is expected to call ModemManager.ModemSignal.get_umts() again to get a new ModemManager.Signal with the new values.

New in version 1.2.

peek_cdma()¶

Returns:: A ModemManager.Signal. Do not free the returned value, it belongs to self.
Return type:: ModemManager.Signal

Gets a ModemManager.Signal object specifying the CDMA signal information.

The returned value is only valid until the property changes so it is only safe to use this function on the thread where self was constructed. Use ModemManager.ModemSignal.get_cdma() if on another thread.

New in version 1.2.

peek_evdo()¶

Returns:: A ModemManager.Signal. Do not free the returned value, it belongs to self.
Return type:: ModemManager.Signal

Gets a ModemManager.Signal object specifying the EV-DO signal information.

The returned value is only valid until the property changes so it is only safe to use this function on the thread where self was constructed. Use ModemManager.ModemSignal.get_evdo() if on another thread.

New in version 1.2.

peek_gsm()¶

Returns:: A ModemManager.Signal. Do not free the returned value, it belongs to self.
Return type:: ModemManager.Signal

Gets a ModemManager.Signal object specifying the GSM signal information.

The returned value is only valid until the property changes so it is only safe to use this function on the thread where self was constructed. Use ModemManager.ModemSignal.get_gsm() if on another thread.

New in version 1.2.

peek_lte()¶

Returns:: A ModemManager.Signal. Do not free the returned value, it belongs to self.
Return type:: ModemManager.Signal

Gets a ModemManager.Signal object specifying the LTE signal information.

The returned value is only valid until the property changes so it is only safe to use this function on the thread where self was constructed. Use ModemManager.ModemSignal.get_lte() if on another thread.

New in version 1.2.

peek_nr5g()¶

Returns:: A ModemManager.Signal. Do not free the returned value, it belongs to self.
Return type:: ModemManager.Signal

Gets a ModemManager.Signal object specifying the 5G signal information.

The returned value is only valid until the property changes so it is only safe to use this function on the thread where self was constructed. Use ModemManager.ModemSignal.get_nr5g() if on another thread.

New in version 1.16.

peek_umts()¶

Returns:: A ModemManager.Signal. Do not free the returned value, it belongs to self.
Return type:: ModemManager.Signal

Gets a ModemManager.Signal object specifying the UMTS signal information.

The returned value is only valid until the property changes so it is only safe to use this function on the thread where self was constructed. Use ModemManager.ModemSignal.get_umts() if on another thread.

New in version 1.2.

setup(rate, cancellable, callback, *user_data)¶

Parameters:

rate (int) – Refresh rate to set, in seconds. Use 0 to disable periodic polling.
cancellable (Gio.Cancellable or None) – A Gio.Cancellable or None.
callback (Gio.AsyncReadyCallback or None) – A Gio.AsyncReadyCallback to call when the request is satisfied or None.
user_data (object or None) – User data to pass to callback.

Asynchronously enables or disables the extended signal quality information retrieval via periodic polling.

When the operation is finished, callback will be invoked in the

thread-default main loop of the thread you are calling this method from. You can then call ModemManager.ModemSignal.setup_finish() to get the result of the operation.

See ModemManager.ModemSignal.setup_sync() for the synchronous, blocking version of this method.

New in version 1.2.

setup_finish(res)¶

Parameters:: res (Gio.AsyncResult) – The Gio.AsyncResult obtained from the Gio.AsyncReadyCallback passed to ModemManager.ModemSignal.setup().
Raises:: GLib.Error
Returns:: True if the setup was successful, False if error is set.
Return type:: bool

Finishes an operation started with ModemManager.ModemSignal.setup().

New in version 1.2.

setup_sync(rate, cancellable)¶

Parameters:

rate (int) – Refresh rate to set, in seconds. Use 0 to disable periodic polling.
cancellable (Gio.Cancellable or None) – A Gio.Cancellable or None.

Raises:

GLib.Error

Returns:

True if the setup was successful, False if error is set.

Return type:

bool

Synchronously enables or disables the extended signal quality information retrieval via periodic polling.

The calling thread is blocked until a reply is received. See ModemManager.ModemSignal.setup() for the asynchronous version of this method.

New in version 1.2.

setup_thresholds(properties, cancellable, callback, *user_data)¶

Parameters:

properties (ModemManager.SignalThresholdProperties) – Threshold values to set.
cancellable (Gio.Cancellable or None) – A Gio.Cancellable or None.
callback (Gio.AsyncReadyCallback or None) – A Gio.AsyncReadyCallback to call when the request is satisfied or None.
user_data (object or None) – User data to pass to callback.

Asynchronously setups thresholds so that the device itself decides when to report the extended signal quality information updates.

When the operation is finished, callback will be invoked in the

thread-default main loop of the thread you are calling this method from. You can then call ModemManager.ModemSignal.setup_thresholds_finish() to get the result of the operation.

See ModemManager.ModemSignal.setup_thresholds_sync() for the synchronous, blocking version of this method.

New in version 1.20.

setup_thresholds_finish(res)¶

Parameters:: res (Gio.AsyncResult) – The Gio.AsyncResult obtained from the Gio.AsyncReadyCallback passed to ModemManager.ModemSignal.setup_thresholds().
Raises:: GLib.Error
Returns:: True if the setup was successful, False if error is set.
Return type:: bool

Finishes an operation started with ModemManager.ModemSignal.setup_thresholds().

New in version 1.20.

setup_thresholds_sync(properties, cancellable)¶

Parameters:

properties (ModemManager.SignalThresholdProperties) – Threshold values to set.
cancellable (Gio.Cancellable or None) – A Gio.Cancellable or None.

Raises:

GLib.Error

Returns:

True if the setup was successful, False if error is set.

Return type:

bool

Synchronously setups thresholds so that the device itself decides when to report the extended signal quality information updates.

The calling thread is blocked until a reply is received. See ModemManager.ModemSignal.setup_thresholds() for the asynchronous version of this method.

New in version 1.20.