Class w.c.m.WCDMAWrapper(BaseWrapper, WCDMADeviceConnection):

Part of wader.common.middleware View In Hierarchy

Known subclasses: wader.common.exported.ContactsExporter

Wrapper around WCDMADeviceConnection

Its main objective is to provide some error control on some operations and a cleaner API to deal with wader.common.protocol.WCDMADeviceConnection results
Method add_contact Adds contact to the SIM and returns the index where was stored
Method add_sms Adds sms to the SIM archive
Method change_pin Changes PIN from oldpin to newpin
Method check_pin Returns the SIM's auth state
Method delete_contact Deletes the contact specified by index
Method delete_sms Deletes the message specified by index
Method disable_pin Disables the PIN auth with pin
Method enable_pin Enables the PIN auth with pin
Method find_contacts Returns a list of Contact whose name matches pattern
Method get_available_charset Returns a list with the available character sets
Method get_charset Returns the current charset
Method get_contact_by_index Undocumented
Method get_contacts Returns a list with all the contacts in the SIM
Method get_free_contact_ids Returns a deque with the contact ids not used
Method get_imei Returns the card's IMEI number
Method get_imsi Returns the SIM's IMSI number
Method get_netreg_status Returns a tuple with the network registration status
Method get_network_info Returns the network info (a.k.a AT+COPS?)
Method get_network_names Returns a list of NetworkObjects (a.k.a AT+COPS=?)
Method get_phonebook_size Returns the phonebook size of the SIM card
Method get_pin_status Returns 1 if PIN auth is active and 0 if its not
Method get_roaming_ids Returns the network ids stored in the SIM to roam (a.k.a AT+CPOL?)
Method get_sms Returns a list of Message objects with all the SMS in the SIM card
Method get_sms_by_index Returns a Message object representing the SMS at index
Method get_sms_format Returns 1 if SMS format is text and 0 if SMS format is PDU
Method get_smsc Returns the SMSC number stored in the SIM
Method get_used_contact_ids Returns a list with the used contact ids
Method get_used_sms_ids Returns a list with used SMS ids in the SIM card
Method save_sms Returns the index where sms was stored
Method send_pin Sends pin and returns the auth result
Method send_sms Sends sms and returns the index
Method send_sms_from_storage Sends the SMS stored at index and returns the new index
Method set_charset Sets the SIMs charset to charset
Method set_sms_format Sets PDU mode or text mode in the SIM
Method set_smsc Sets the SIMS's SMSC number to smsc

Inherited from BaseWrapper:

Method disable_echo Disables echo of AT cmds
Method enable_echo Enables echo
Method get_card_model Returns the card model
Method get_card_version Returns the firmware version
Method get_manufacturer_name Returns the Manufacturer name
Method get_signal_level Returns the signal level
Method send_at Sends an arbitrary AT string atstr
Method get_bands Returns a list with the available bands
Method configure_connection Configures the connection with the given parameters
Method _configure_conn_mode Undocumented
Method _configure_band_mode Undocumented

Inherited from BaseDeviceConnection (via BaseWrapper):

Method __init__ Undocumented
Method reset_settings Resets the settings to factory settings

Inherited from SIMProtocol (via BaseWrapper, BaseDeviceConnection):

Method transition_to_idle Transitions to idle and processes next queued ATCmd
Method send_splitcmd Used to send the second part of a split command after prompt appears
Method _process_at_cmd Undocumented
Method _check_queue Undocumented
Method queue_at_cmd Queues an ATCmd and returns a deferred

Inherited from BufferingStateMachine (via BaseWrapper, BaseDeviceConnection, SIMProtocol):

Method _timeout_eb Executed when a command exceeds its timeout
Method cancel_current_delayed_call Cancels current ATCmd dellayed call if active
Method notify_success Notify success to current ATCmd callbacks
Method notify_failure Notify failure to current ATCmd errbacks
Method set_cmd Sets self.cmd to cmd
Method set_state Sets and logs the new state
Method emit_signal Emits a signal
Method dataReceived See twisted.internet.protocol.Protocol.dataReceived
Method process_notifications Processes unsolicited notifications in _buffer
Method handle_idle See the method comments
Method handle_waiting Undocumented

Inherited from WCDMADeviceConnection:

Method __init__ Undocumented
Method delete_all_contacts Deletes all the contacts in SIM card, function useful for tests
Method delete_all_sms Deletes all the messages in SIM card, function useful for tests
Method get_card_model Returns the SIM card model
Method get_card_version Returns the SIM card version
Method get_manufacturer_name Returns the manufacturer name of the SIM card
Method get_next_contact_id Returns the next free contact id
Method register_with_network Registers with the given netid
Method send_puk Sends PUK and PIN to the SIM card
Method set_netreg_notification Sets CREG unsolicited notification
Method set_network_info_format Undocumented
Method set_sms_indication Sets the SMS indication mode

Inherited from BaseDeviceConnection (via WCDMADeviceConnection):

Method disable_echo Disables echo of AT cmds
Method enable_echo Enables echo of AT cmds
Method get_signal_level Returns a tuple with the RSSI and BER of the connection
Method send_at Send an arbitrary AT string to the SIM card
Method reset_settings Resets the settings to factory settings

Inherited from SIMProtocol (via WCDMADeviceConnection, BaseDeviceConnection):

Method transition_to_idle Transitions to idle and processes next queued ATCmd
Method send_splitcmd Used to send the second part of a split command after prompt appears
Method _process_at_cmd Undocumented
Method _check_queue Undocumented
Method queue_at_cmd Queues an ATCmd and returns a deferred

Inherited from BufferingStateMachine (via WCDMADeviceConnection, BaseDeviceConnection, SIMProtocol):

Method _timeout_eb Executed when a command exceeds its timeout
Method cancel_current_delayed_call Cancels current ATCmd dellayed call if active
Method notify_success Notify success to current ATCmd callbacks
Method notify_failure Notify failure to current ATCmd errbacks
Method set_cmd Sets self.cmd to cmd
Method set_state Sets and logs the new state
Method emit_signal Emits a signal
Method dataReceived See twisted.internet.protocol.Protocol.dataReceived
Method process_notifications Processes unsolicited notifications in _buffer
Method handle_idle See the method comments
Method handle_waiting Undocumented
def add_contact(self, contact):
Adds contact to the SIM and returns the index where was stored
Returns (type: defer.Deferred )
def add_sms(self, sms):
Adds sms to the SIM archive
def change_pin(self, oldpin, newpin):
Changes PIN from oldpin to newpin
def check_pin(self):
Returns the SIM's auth state
Raisesex.CMEErrorSIMPINRequiredRaised if SIM PIN is required
ex.CMEErrorSIMPUKRequiredRaised if SIM PUK is required
ex.CMEErrorSIMPUK2RequiredRaised if SIM PUK2 is required
def delete_contact(self, index):
Deletes the contact specified by index
def delete_sms(self, index):
Deletes the message specified by index
def disable_pin(self, pin):
Disables the PIN auth with pin
Returns (type: defer.Deferred )
def enable_pin(self, pin):
Enables the PIN auth with pin
Returns (type: defer.Deferred )
def find_contacts(self, pattern):
Returns a list of Contact whose name matches pattern
def get_available_charset(self):
Returns a list with the available character sets
Returns (type: defer.Deferred )
def get_charset(self):
Returns the current charset
def get_contact_by_index(self, index):
Undocumented
def get_contacts(self):
Returns a list with all the contacts in the SIM
def get_free_contact_ids(self):
Returns a deque with the contact ids not used
def get_imei(self):
Returns the card's IMEI number
Returns (type: Deferred )
def get_imsi(self):
Returns the SIM's IMSI number
Returns (type: Deferred )
def get_netreg_status(self):

Returns a tuple with the network registration status

+CREG: 0,0 - Not registered and not scanning for a GSM network +CREG: 0,1 - Registered on the "HOME" network of the SIM +CREG: 0,2 - Not registered but is scanning for a GSM network +CREG: 0,3 - Registration is denied (Manual attempt failed) +CREG: 0,5 - Registered on to another network (roaming).
Returns (type: Deferred )
def get_network_info(self, process=True):

Returns the network info (a.k.a AT+COPS?)

The response will be a tuple as (OperatorName, ConnectionType) if it returns a (None, None) that means that some error occurred while obtaining the info. The class that requested the info should take care of insisting before this problem. This method will convert numeric network IDs to alphanumeric.
Returns (type: Deferred )
def get_network_names(self):
Returns a list of NetworkObjects (a.k.a AT+COPS=?)
Returns (type: Deferred )
def get_phonebook_size(self):
Returns the phonebook size of the SIM card
Returns (type: Deferred )
def get_pin_status(self):
Returns 1 if PIN auth is active and 0 if its not
Returns (type: Deferred )
def get_roaming_ids(self):
Returns the network ids stored in the SIM to roam (a.k.a AT+CPOL?)
Returns (type: Deferred )
def get_sms(self):
Returns a list of Message objects with all the SMS in the SIM card
def get_sms_by_index(self, index):
Returns a Message object representing the SMS at index
Returns (type: Deferred )
def get_sms_format(self):
Returns 1 if SMS format is text and 0 if SMS format is PDU
def get_smsc(self):
Returns the SMSC number stored in the SIM
Returns (type: Deferred )
def get_used_contact_ids(self):
Returns a list with the used contact ids
def get_used_sms_ids(self):
Returns a list with used SMS ids in the SIM card
def save_sms(self, sms):
Returns the index where sms was stored
def send_pin(self, pin):

Sends pin and returns the auth result

Most devices need some time to settle after a successful auth it is the caller's responsability to give at least 15 seconds to the device to settle, this time varies from device to device
def send_sms(self, sms):
Sends sms and returns the index
def send_sms_from_storage(self, index):
Sends the SMS stored at index and returns the new index
def set_charset(self, charset):
Sets the SIMs charset to charset
def set_sms_format(self, format=0):
Sets PDU mode or text mode in the SIM
def set_smsc(self, smsc):
Sets the SIMS's SMSC number to smsc
def _enable_device(self):
I check the auth state of a device and will try to initialize it
def _check_initted_device(self, result):
Upon successful auth over DBus I'll check if the device was initted
def _init_device(self, d2, result):
Undocumented
API Documentation for wader-core, generated by pydoctor at 2008-08-27 16:53:37.