This module wraps all python-gammu functionality.
StateMachine object, that is used for communication with phone.
Parameters: | Locale (string) – What locales to use for gammu error messages, default is auto which does autodetection according to user locales |
---|
Adds calendar entry.
Parameters: | Value (dict) – Calendar entry data, see Calendar Object |
---|---|
Returns: | Location of newly created entry |
Return type: | int |
Adds category to phone.
Parameters: |
|
---|---|
Returns: | Location of created category |
Return type: | int |
Adds file part to filesystem.
Parameters: | File (dict) – File data, see File Object |
---|---|
Returns: | File data for subsequent calls (Finished indicates transfer has been completed) |
Return type: | dict |
Adds folder to filesystem.
Parameters: |
|
---|---|
Returns: | New folder ID. |
Return type: | string |
Adds memory (phonebooks or calls) entry.
Parameters: | Value (dict) – Memory entry, see Phonebook Object |
---|---|
Returns: | Location of created entry |
Return type: | int |
Adds SMS to specified folder.
Parameters: | Value (dict) – SMS data, see SMS Object |
---|---|
Returns: | Tuple for location and folder. |
Return type: | tuple |
Creates SMS folder.
Parameters: | Name (string) – Name of new folder |
---|---|
Returns: | None |
Return type: | None |
Adds ToDo in phone.
Parameters: | Value (dict) – ToDo data, see Todo Object |
---|---|
Returns: | Location of created entry |
Return type: | int |
Accept current incoming call.
Parameters: |
|
---|---|
Returns: | None |
Return type: | None |
New in version 1.31.90.
Cancels all call diverts.
Returns: | None |
---|---|
Return type: | None |
Deny current incoming call.
Parameters: |
|
---|---|
Returns: | None |
Return type: | None |
Initiates conference call.
Parameters: | ID (integer) – ID of call |
---|---|
Returns: | None |
Return type: | None |
Deletes all calendar entries.
Returns: | None |
---|---|
Return type: | None |
Deletes all memory (phonebooks or calls) entries of specified type.
Parameters: | Type (string) – Memory type, one of ME, SM, ON, DC, RC, MC, MT, FD, VM |
---|---|
Returns: | None |
Return type: | None |
Deletes all todo entries in phone.
Returns: | None |
---|---|
Return type: | None |
Deletes calendar entry.
Parameters: | Location (int) – Calendar entry to delete |
---|---|
Returns: | None |
Return type: | None |
Deletes file from filesystem.
Parameters: | FileID (string) – File to delete |
---|---|
Returns: | None |
Return type: | None |
Deletes folder on filesystem.
Parameters: | FolderID (string) – Folder to delete |
---|---|
Returns: | None |
Return type: | None |
Deletes memory (phonebooks or calls) entry.
Parameters: |
|
---|---|
Returns: | None |
Return type: | None |
Deletes SMS.
Parameters: |
|
---|---|
Returns: | None |
Return type: | None |
Note
In most cases you want to use Folder=0 as in this mode it will accept locations as GetNextSMS returns them.
Deletes SMS folder.
Parameters: | ID (int) – Index of folder to delete |
---|---|
Returns: | None |
Return type: | None |
Deletes ToDo entry in phone.
Parameters: | Location (int) – Location of entry to delete |
---|---|
Returns: | None |
Return type: | None |
Dials number and starts voice call.
Parameters: | Number (string) – Number to dial |
---|---|
Returns: | None |
Return type: | None |
Dials number and starts voice call.
Parameters: |
|
---|---|
Returns: | None |
Return type: | None |
Entres security code.
Parameters: |
|
---|---|
Returns: | None |
Return type: | None |
Reads alarm set in phone.
Parameters: | Location (int) – Which alarm to read. Many phone support only one alarm. Default is 1. |
---|---|
Returns: | Alarm dict |
Return type: | dict |
Gets information about battery charge and phone charging state.
Returns: | Dictionary containing information about battery state (BatteryPercent and ChargeState) |
---|---|
Return type: | dict |
Retrieves calendar entry.
Parameters: | Location (int) – Calendar entry to read |
---|---|
Returns: | Dictionary with calendar values, see Calendar Object |
Return type: | dict |
Retrieves calendar status (number of used entries).
Returns: | Dictionary with calendar status (Used) |
---|---|
Return type: | dict |
New in version 1.31.90.
Gets call diverts.
Parameters: |
|
---|---|
Returns: | List of call diverts. |
Return type: |
Reads category from phone.
Parameters: |
|
---|---|
Returns: | Category name as string |
Return type: | string |
Reads category status (number of used entries) from phone.
Parameters: | Type (string) – Type of category to read, one of ToDo, Phonebook |
---|---|
Returns: | Dictionary containing information about category status (Used) |
Return type: | dict |
Parameters: | Section (int) – Index of config section to read. Defaults to 0. |
---|---|
Returns: | Dictionary containing configuration |
Return type: | dict |
Reads date and time from phone.
Returns: | Date and time from phone as datetime.datetime object. |
---|---|
Return type: | datetime.datetime |
Acquired display status. :return: List of indicators displayed on display :rtype: list
Gets file part from filesystem.
Parameters: | File (dict) – File data, see File Object |
---|---|
Returns: | File data for subsequent calls (Finished indicates transfer has been completed), see File Object |
Return type: | dict |
Acquires filesystem status.
Returns: | Dictionary containing filesystem status (Used and Free) |
---|---|
Return type: | dict |
Reads firmware information from phone.
Returns: | Tuple from version, date and numeric version. |
---|---|
Return type: | tuple |
Gets next filename from filesystem folder.
Parameters: |
|
---|---|
Returns: | File data as dict, see File Object |
Return type: | dict |
Gets hardware information about device.
Returns: | Hardware information as string. |
---|---|
Return type: | string |
Reads IMEI/serial number from phone.
Returns: | IMEI of phone as string. |
---|---|
Return type: | string |
Gets locale information from phone.
Returns: | Dictionary of locale settings. SetLocale() lists them all. |
---|---|
Return type: | dict |
Gets month when device was manufactured.
Returns: | Month of manufacture as string. |
---|---|
Return type: | string |
Reads manufacturer from phone.
Returns: | String with manufacturer name |
---|---|
Return type: | string |
Reads entry from memory (phonebooks or calls). Which entry shouldbe read is defined in entry.
Parameters: | Type (string) – Memory type, one of ME, SM, ON, DC, RC, MC, MT, FD, VM |
---|---|
Returns: | Memory entry as dict, see Phonebook Object |
Return type: | dict |
Gets memory (phonebooks or calls) status (eg. number of used andfree entries).
Parameters: | Type (string) – Memory type, one of ME, SM, ON, DC, RC, MC, MT, FD, VM |
---|---|
Returns: | Dictionary with information about memory (Used and Free) |
Return type: | dict |
Reads model from phone.
Returns: | Tuple containing gammu identification and real model returned by phone. |
---|---|
Return type: | tuple |
Gets network information.
Returns: | Dictionary with information about network (NetworkName, State, NetworkCode, CID and LAC) |
---|---|
Return type: | dict |
Retrieves calendar entry. This is useful for continuous reading of all calendar entries.
Parameters: |
|
---|---|
Returns: | Dictionary with calendar values, see Calendar Object |
Return type: | dict |
Gets next filename from filesystem.
Parameters: | Start (boolean) – Whether we’re starting listing. Defaults to False. |
---|---|
Returns: | File data as dict, see File Object |
Return type: | dict |
Reads entry from memory (phonebooks or calls). Which entry shouldbe read is defined in entry. This can be easily used for reading all entries.
Parameters: |
|
---|---|
Returns: | Memory entry as dict, see Phonebook Object |
Return type: | dict |
Gets next root folder from filesystem. Start with empty folder name.
Parameters: | Folder (string) – Previous read fodlder. Start with empty folder name. |
---|---|
Returns: | Structure with folder information |
Reads next (or first if start set) SMS message. This might befaster for some phones than using GetSMS() for each message.
Parameters: |
|
---|---|
Returns: | Dictionary with SMS data, see SMS Object |
Return type: | dict |
Reads ToDo from phone.
Parameters: |
|
---|---|
Returns: | Dictionary with ToDo values, see Todo Object |
Return type: | dict |
Gets original IMEI from phone.
Returns: | Original IMEI of phone as string. |
---|---|
Return type: | string |
Gets PPM (Post Programmable Memory) from phone.
Returns: | PPM as string |
---|---|
Return type: | string |
Gets product code of device. :return: Product code as string. :rtype: string
Gets SIM IMSI from phone.
Returns: | SIM IMSI as string |
---|---|
Return type: | string |
Reads SMS message.
Parameters: |
|
---|---|
Returns: | Dictionary with SMS data, see SMS Object |
Return type: | dict |
Gets SMS Service Center number and SMS settings.
Parameters: | Location (int) – Location of entry to read. Defaults to 1 |
---|---|
Returns: | Dictionary with SMSC information, see SMSC Object |
Return type: | dict |
Returns SMS folders information.
Returns: | List of SMS folders. |
---|---|
Return type: | list |
Gets information about SMS memory (read/unread/size of memory for both SIM and phone).
Returns: | Dictionary with information about phone memory (SIMUnRead, SIMUsed, SIMSize, PhoneUnRead, PhoneUsed, PhoneSize and TemplatesUsed) |
---|---|
Return type: | dict |
Queries whether some security code needs to be entered.
Returns: | String indicating which code needs to be entered or None if none is needed |
---|---|
Return type: | string |
Reads signal quality (strength and error rate).
Returns: | Dictionary containing information about signal state (SignalStrength, SignalPercent and BitErrorRate) |
---|---|
Return type: | dict |
Gets speed dial.
Parameters: | Location (int) – Location of entry to read |
---|---|
Returns: | Dictionary with speed dial (Location, MemoryLocation, MemoryNumberID, MemoryType) |
Return type: | dict |
Reads ToDo from phone.
Parameters: | Location (int) – Location of entry to read |
---|---|
Returns: | Dictionary with ToDo values, see Todo Object |
Return type: | dict |
Gets status of ToDos (count of used entries).
Returns: | Dictionary of status (Used) |
---|---|
Return type: | dict |
Holds call.
Parameters: | ID (integer) – ID of call |
---|---|
Returns: | None |
Return type: | None |
Initialises the connection with phone.
Parameters: | Replies (int) – Number of replies to wait for on each request. Defaults to 1. Higher value makes sense only on unreliable links. |
---|---|
Returns: | None |
Return type: | None |
Emulates key press.
Parameters: |
|
---|---|
Returns: | None |
Return type: | None |
Reads specified section of gammurc
Parameters: |
|
---|---|
Returns: | None |
Return type: | None |
Reads data from device.
Parameters: | Wait (boolean) – Whether to wait, default is not to wait. |
---|---|
Returns: | Number of bytes read |
Return type: | int |
Performs phone reset.
Parameters: | Hard (boolean) – Whether to make hard reset |
---|---|
Returns: | None |
Return type: | None |
Resets phone settings.
Parameters: | Type (string) – What to reset, one of PHONE, UIF, ALL, DEV, FACTORY |
---|---|
Returns: | None |
Return type: | None |
Sends DTMF (Dual Tone Multi Frequency) tone.
Parameters: | Number (string) – Number to dial |
---|---|
Returns: | None |
Return type: | None |
Sends file part to phone.
Parameters: | File (dict) – File data, see File Object |
---|---|
Returns: | File data for subsequent calls (Finished indicates transfer has been completed), see File Object |
Return type: | dict |
Sends SMS.
Parameters: | Value (dict) – SMS data, see SMS Object |
---|---|
Returns: | Message reference as integer |
Return type: | int |
Sends SMS saved in phone.
Parameters: |
|
---|---|
Returns: | Message reference as integer |
Return type: | int |
Sets alarm in phone.
Parameters: |
|
---|---|
Returns: | None |
Return type: | None |
Enables network auto login.
Returns: | None |
---|---|
Return type: | None |
Sets calendar entry
Parameters: | Value (dict) – Calendar entry data, see Calendar Object |
---|---|
Returns: | Location of set entry |
Return type: | int |
Sets specified config section.
Parameters: |
|
---|---|
Returns: | None |
Return type: | None |
New in version 1.31.90.
Sets call divert.
Parameters: |
|
---|---|
Returns: | None |
Return type: | None |
Sets date and time in phone.
Parameters: | Date (datetime.datetime) – Date to set |
---|---|
Returns: | None |
Return type: | None |
Sets state machine debug file.
Parameters: |
|
---|---|
Returns: | None |
Return type: | None |
Sets state machine debug level accorting to passed string. You need to configure output file using SetDebugFile() to activate it.
Parameters: | Level (string) – name of debug level to use, currently one of: - nothing - text - textall - binary - errors - textdate - textalldate - errorsdate |
---|---|
Returns: | None |
Return type: | None |
Sets file attributes.
Parameters: |
|
---|---|
Returns: | None |
Return type: | None |
Gets network information from phone.
Parameters: | Enable (boolean) – Whether to enable notifications, default is True |
---|---|
Returns: | None |
Return type: | None |
Activates/deactivates noticing about incoming calls.
Parameters: | Enable (boolean) – Whether to enable notifications, default is True |
---|---|
Returns: | None |
Return type: | None |
Sets callback function which is called whenever any (enabled) incoming event appears. Please note that you have to enable each event type by calling SetIncoming* functions.
The callback function needs to accept three parameters: StateMachine object, event type and it’s data in dictionary.
Parameters: | Callback (function) – callback function or None for disabling |
---|---|
Returns: | None |
Return type: | None |
Enable/disable notification on incoming SMS.
Parameters: | Enable (boolean) – Whether to enable notifications, default is True |
---|---|
Returns: | None |
Return type: | None |
Activates/deactivates noticing about incoming USSDs (UnStructured Supplementary Services).
Parameters: | Enable (boolean) – Whether to enable notifications, default is True |
---|---|
Returns: | None |
Return type: | None |
Sets locale of phone.
Parameters: |
|
---|---|
Returns: | None |
Return type: | None |
Sets memory (phonebooks or calls) entry.
Parameters: | Value (dict) – Memory entry, see Phonebook Object |
---|---|
Returns: | Location of created entry |
Return type: | int |
Sets SMS.
Parameters: | Value (dict) – SMS data, see SMS Object |
---|---|
Returns: | Tuple for location and folder. |
Return type: | tuple |
Sets SMS Service Center number and SMS settings.
Parameters: | Value (dict) – SMSC information, see SMSC Object |
---|---|
Returns: | None |
Return type: | None |
Sets speed dial.
Parameters: | Value (dict) – Speed dial data, see GetSpeedDial() for listing. |
---|---|
Returns: | None |
Return type: | None |
Sets ToDo in phone.
Parameters: | Value (dict) – ToDo data, see Todo Object |
---|---|
Returns: | Location of created entry |
Return type: | int |
Splits call.
Parameters: | ID (integer) – ID of call |
---|---|
Returns: | None |
Return type: | None |
Switches call.
Parameters: | ID (integer) – ID of call |
---|---|
Returns: | None |
Return type: | None |
Terminates the connection with phone.
Returns: | None |
---|---|
Return type: | None |
Aborts current operation.
Returns: | None |
---|---|
Return type: | None |
Transfers call.
Parameters: | ID (integer) – ID of call |
---|---|
Returns: | None |
Return type: | None |
Unholds call.
Parameters: | ID (integer) – ID of call |
---|---|
Returns: | None |
Return type: | None |
Get version information.
Returns: | Tuple of version information - Gammu runtime version, python-gammu version, build time Gammu version. |
---|---|
Return type: | tuple |
Sets global debug file.
Parameters: | File (mixed) – File where to write debug stuff (as configured by SetDebugLevel()). Can be either None for no file, Python file object or filename. |
---|---|
Returns: | None |
Return type: | None |
Sets global debug level accorting to passed string. You need to configure output file using SetDebugFile() to activate it.
Parameters: | Level (string) – name of debug level to use, currently one of:
|
---|---|
Returns: | None |
Return type: | None |
Links multi part SMS messages.
Parameters: |
|
---|---|
Returns: | List of linked messages, see SMS Object |
Return type: | list |
Calculates number of SMS and free chars in SMS.
Parameters: |
|
---|---|
Returns: | Number of messages and number of free chars |
Return type: | tuple |
New in version 1.29.90.
Decodes multi part SMS message.
Parameters: |
|
---|---|
Returns: | Multi part message information, see SMS Info Object |
Return type: | dict |
Encodes multi part SMS message.
Parameters: | MessageInfo (dict) – Description of message, see SMS Info Object |
---|---|
Returns: | List of dictionaries with raw message, see SMS Object |
Return type: | dict |
Parses PDU packet.
Parameters: |
|
---|---|
Returns: | Message data, see SMS Object |
Return type: | dict |
Creates PDU packet.
Parameters: |
|
---|---|
Returns: | Message data |
Return type: | string |
New in version 1.27.93.
Decodes memory entry v from a string.
Parameters: | Text (string) – String to decode |
---|---|
Returns: | Memory entry, see Phonebook Object |
Return type: | dict |
Encodes memory entry to a vCard.
Parameters: | Entry (dict) – Memory entry, see Phonebook Object |
---|---|
Returns: | String with vCard |
Return type: | string |
Decodes todo/calendar entry v from a string.
Parameters: | Text (string) – String to decode |
---|---|
Returns: | Calendar or todo entry (whatever one was included in string), see Calendar Object, Todo Object |
Return type: | dict |
Decodes todo/calendar entry v from a string.
Parameters: | Text (string) – String to decode |
---|---|
Returns: | Calendar or todo entry (whatever one was included in string), see Calendar Object, Todo Object |
Return type: | dict |
Encodes calendar entry to a vCalendar.
Parameters: | Entry (dict) – Calendar entry, see Calendar Object |
---|---|
Returns: | String with vCalendar |
Return type: | string |
Encodes calendar entry to a iCalendar.
Parameters: | Entry (dict) – Calendar entry, see Calendar Object |
---|---|
Returns: | String with iCalendar |
Return type: | string |
Encodes todo entry to a vTodo.
Parameters: | Entry (dict) – Todo entry, see Todo Object |
---|---|
Returns: | String with vTodo |
Return type: | string |
Encodes todo entry to a iTodo.
Parameters: | Entry (dict) – Todo entry, see Todo Object |
---|---|
Returns: | String with vCard |
Return type: | string |
Saves ringtone into file.
Parameters: |
|
---|---|
Returns: | None |
Return type: | None |
Saves backup into file.
Parameters: |
|
---|---|
Returns: | None |
Return type: | None |
Reads backup into file.
Parameters: |
|
---|---|
Returns: | Dictionary of read entries, it contains following keys, each might be empty:
|
Return type: | dict |
Saves SMS backup into file.
Parameters: |
|
---|---|
Returns: | None |
Return type: | None |
Reads SMS backup into file.
Parameters: | Filename (string) – Name of file where SMS backup is stored |
---|---|
Returns: | List of messages read from file |
Return type: | list |