diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/config/gammurc | 58 | ||||
| -rw-r--r-- | docs/config/smsdrc | 2 | ||||
| -rw-r--r-- | docs/develop/c/index.rst | 2 | ||||
| -rw-r--r-- | docs/develop/index.rst | 1 | ||||
| -rw-r--r-- | docs/develop/protocol/index.rst | 1 | ||||
| -rw-r--r-- | docs/develop/protocol/samsung-gt.rst | 9 | ||||
| -rw-r--r-- | docs/develop/protocol/sonim.rst | 37 | ||||
| -rw-r--r-- | docs/develop/python/gammu.rst | 236 | ||||
| -rw-r--r-- | docs/develop/python/index.rst | 1 | ||||
| -rw-r--r-- | docs/develop/python/objects.rst | 809 | ||||
| -rw-r--r-- | docs/develop/smsd/index.rst | 40 | ||||
| -rw-r--r-- | docs/develop/smsd/smsd-interactions.dia | 949 | ||||
| -rw-r--r-- | docs/develop/smsd/smsd-interactions.png | bin | 0 -> 29711 bytes | |||
| -rw-r--r-- | docs/user/cs/gammu-smsd.1 | 24 | ||||
| -rw-r--r-- | docs/user/cs/gammu-smsdrc.5 | 17 | ||||
| -rw-r--r-- | docs/user/cs/gammu.1 | 79 | ||||
| -rw-r--r-- | docs/user/cs/gammurc.5 | 28 | ||||
| -rw-r--r-- | docs/user/gammu-smsdrc.5 | 11 | ||||
| -rw-r--r-- | docs/user/gammurc.5 | 21 |
19 files changed, 2102 insertions, 223 deletions
diff --git a/docs/config/gammurc b/docs/config/gammurc index 43c9857..f2b9cb1 100644 --- a/docs/config/gammurc +++ b/docs/config/gammurc @@ -8,7 +8,7 @@ [gammu] -port = com8: +device = com8: connection = irdaphonet ; Do not use model configuration unless you really need it ;model = 6110 @@ -23,7 +23,7 @@ connection = irdaphonet [gammu1] -port = com8: +device = com8: ;model = 6110 connection = fbusblue ;synchronizetime = yes @@ -35,25 +35,25 @@ connection = fbusblue ;gammucoding = utf8 ; Step 1. Please find required Connection parameter and look into assigned -; with it port type. With some Connection you must set concrete model +; with it device type. With some Connection you must set concrete model ; ================================================================ cables ===== ; New Nokia protocol for FBUS/DAU9P -; Connection "fbus", port type serial +; Connection "fbus", device type serial ; New Nokia protocol for DLR3/DLR3P -; Connection "fbusdlr3"/"dlr3", port type serial +; Connection "fbusdlr3"/"dlr3", device type serial ; New Nokia protocol for DKU2 (and phone with USB converter on phone mainboard ; like 6230) -; Connection "dku2phonet"/"dku2", port type dku2 on Windows +; Connection "dku2phonet"/"dku2", device type dku2 on Windows ; Connection "fbususb" on Linux ; New Nokia protocol for DKU5 (and phone without USB converter on phone ; mainboard like 5100) -; Connection "dku5fbus"/"dku5", port type dku5 +; Connection "dku5fbus"/"dku5", device type dku5 ; New Nokia protocol for PL2303 USB cable (and phone without USB converter ; on phone mainboard like 5100) -; Connection "fbuspl2303", port type usb +; Connection "fbuspl2303", device type usb ; Old Nokia protocol for MBUS/DAU9P -; Connection "mbus", port type serial +; Connection "mbus", device type serial ; Variants: ; You can modify a bit behaviour of connection using additional flags ; specified just after connection name like connection-variant. @@ -64,53 +64,53 @@ connection = fbusblue ; ----------------------------------------------------------------------------- ; AT commands for DLR3, DKU5 or other AT compatible cable (8 bits, None ; parity, no flow control, 1 stop bit). Used with Nokia, Alcatel, Siemens, etc. -; Connection "at19200"/"at115200"/.., port type serial +; Connection "at19200"/"at115200"/.., device type serial ; AT commands for DKU2 cable -; Connection "dku2at", port type dku2 +; Connection "dku2at", device type dku2 ; ============================================================== infrared ===== ; Nokia protocol for infrared with Nokia 6110/6130/6150 -; Connection "fbusirda"/"infrared", port type serial +; Connection "fbusirda"/"infrared", device type serial ; Nokia protocol for infrared with other Nokia models -; Connection "irdaphonet"/"irda", port type irda +; Connection "irdaphonet"/"irda", device type irda ; ----------------------------------------------------------------------------- ; AT commands for infrared. Used with Nokia, Alcatel, Siemens, etc. -; Connection "irdaat", port type irda +; Connection "irdaat", device type irda ; ----------------------------------------------------------------------------- ; OBEX for infrared -; Connection "irdaobex", port type irda. +; Connection "irdaobex", device type irda. ; ============================================================= Bluetooth ===== -; Nokia protocol with serial port set in BT stack (WidComm, other) from +; Nokia protocol with serial device set in BT stack (WidComm, other) from ; adequate service and Nokia 6210 -; Connection "fbusblue", port type serial -; Nokia protocol with serial port set in BT stack (WidComm, other) from +; Connection "fbusblue", device type serial +; Nokia protocol with serial device set in BT stack (WidComm, other) from ; adequate service and other Nokia models -; Connection "phonetblue", port type serial +; Connection "phonetblue", device type serial ; ----------------------------------------------------------------------------- ; Nokia protocol for Bluetooth stack with Nokia 6210 -; Connection "bluerffbus", port type BT +; Connection "bluerffbus", device type BT ; Nokia protocol for Bluetooth stack with DCT4 Nokia models, which don't inform ; about services correctly (6310, 6310i with firmware lower than 5.50, 8910,..) -; Connection "bluerfphonet", port type BT +; Connection "bluerfphonet", device type BT ; Nokia protocol for Bluetooth stack with other DCT4 Nokia models -; Connection "bluephonet", port type BT +; Connection "bluephonet", device type BT ; ----------------------------------------------------------------------------- ; AT commands for Bluetooth stack and 6210 / DCT4 Nokia models, which don't ; inform about BT services correctly (6310, 6310i with firmware lower ; than 5.50, 8910,..) -; Connection "bluerfat", port type BT +; Connection "bluerfat", device type BT ; AT commands for Bluetooth stack with other phones (Siemens, other Nokia,etc.) -; Connection "blueat", port type BT +; Connection "blueat", device type BT ; ----------------------------------------------------------------------------- ; OBEX for Bluetooth stack with DCT4 Nokia models, which don't inform about ; BT services correctly (6310, 6310i with firmware lower than 5.50, 8910,...) -; Connection "bluerfobex", port type BT +; Connection "bluerfobex", device type BT ; OBEX for Bluetooth stack with other phones (Siemens, other Nokia, etc.) -; Connection "blueobex", port type BT. +; Connection "blueobex", device type BT. ; ----------------------------------------------------------------------------- -; Connection "bluerfgnapbus", port type BT, model "gnap" -; Connection "irdagnapbus", port type irda, model "gnap" +; Connection "bluerfgnapbus", device type BT, model "gnap" +; Connection "irdagnapbus", device type irda, model "gnap" -; Step2. According to port type from Step1 and used OS set Port parameter +; Step2. According to device type from Step1 and used OS set Port parameter ; ----------------------------------------------------------------------------- ; Port type | "Port" parameter in Windows/DOS | "Port" parameter in Linux/Unix diff --git a/docs/config/smsdrc b/docs/config/smsdrc index 0084c71..0b93366 100644 --- a/docs/config/smsdrc +++ b/docs/config/smsdrc @@ -4,7 +4,7 @@ # Gammu configuration, this section is like section "gammu" in "gammurc" file, # see gammurc(5) for documentation. [gammu] -#port = /dev/ttyS1 +#device = /dev/ttyS1 #model = 6110 #connection = dlr3 #synchronizetime = yes diff --git a/docs/develop/c/index.rst b/docs/develop/c/index.rst index 3c40dd0..45e7208 100644 --- a/docs/develop/c/index.rst +++ b/docs/develop/c/index.rst @@ -1,3 +1,5 @@ +.. _libgammu: + libGammu ======== diff --git a/docs/develop/index.rst b/docs/develop/index.rst index fce96d3..8ff58ce 100644 --- a/docs/develop/index.rst +++ b/docs/develop/index.rst @@ -19,6 +19,7 @@ Contents python/index c/index internal/index + smsd/index testing/index protocol/index diff --git a/docs/develop/protocol/index.rst b/docs/develop/protocol/index.rst index d6c8f01..35a58c7 100644 --- a/docs/develop/protocol/index.rst +++ b/docs/develop/protocol/index.rst @@ -14,3 +14,4 @@ Phone Protocols tdma_5120 samsung samsung-gt + sonim diff --git a/docs/develop/protocol/samsung-gt.rst b/docs/develop/protocol/samsung-gt.rst index 795a8e7..10aea3e 100644 --- a/docs/develop/protocol/samsung-gt.rst +++ b/docs/develop/protocol/samsung-gt.rst @@ -35,6 +35,12 @@ Or just read a single item:: +SSHR:1,"9,Event 123","0,","0,",2010,6,7,2010,6,7,7,0,8,59,0,0,0,0,2010,5,30,, OK +Getting status (the last number appears to be number of notes):: + + AT+SSHR=? + +SSHR:100,15,100,15,"1000000",2008,2024,5 + OK + You can also add or modify an item:: AT+SSHW="7,event01","16,details of event","5,where",2010,06,03,2010,06,04,12,31,13,42,0,0,0,0,2010,05,31,,,0 @@ -60,6 +66,7 @@ creation? (year month day) - the meaning of this date is not sure for me yet. To delete entries:: + AT+SSHD=1 OK @@ -103,6 +110,7 @@ And modify:: OK To delete entries:: + AT+SSHT=3 OK AT+SSHR=0 @@ -148,6 +156,7 @@ You can modify it:: OK To delete entries:: + AT+OMMR=3 +OMMR:"Note number 3" OK diff --git a/docs/develop/protocol/sonim.rst b/docs/develop/protocol/sonim.rst new file mode 100644 index 0000000..60c2214 --- /dev/null +++ b/docs/develop/protocol/sonim.rst @@ -0,0 +1,37 @@ +Sonim AT Commands +================= + +Filesystem access:: + + at*list=<path> - list directory content + (0=file, 1=subdirectory) + at*mkdir=<path> - make directory + at*rmdir=<path> - remove directory + at*remove=<path> - remove file + at*move=<srcpath>,<dstpath> - ? copy (move?) files + at*startul=<srcpath> - prepare file to upload (from phone) + returned data: + *STARTUL: <filesize_in_bytes> + at*startdl=<dstpath>,<filesize> - prepare file to download (to phone) + at*get - get base64 coded data chunk + returned data: + *GET: <chunklen>,<data> + at*get - get base64 coded data chunk + returned data: + *GET: <chunklen>,<data> + at*put=<no>,<len>,<data>,<chck> - put base64 coded data chunk + (no is chunk number, starting from 0) + (len is chunk length) + (last 4 characters is checksum ?) + at*end - end/finish file transfer operation + ------------------- + at*syph=?,?.?,<path> - ? (add downloaded record to phonebook?) + at*syph=0,1,%d,%s + EXAMPLE: + AT*SYPH=0,1,74,/app/dir/tmp.dat + at*sysm=0,1,%d - ? SMS handling + + --- + Phone has at least two directories from root, /app and /app3 . + at*list=/ gives error. + diff --git a/docs/develop/python/gammu.rst b/docs/develop/python/gammu.rst index d5fe699..5179f98 100644 --- a/docs/develop/python/gammu.rst +++ b/docs/develop/python/gammu.rst @@ -13,7 +13,7 @@ This module wraps all python-gammu functionality. StateMachine object, that is used for communication with phone. - :param Locale: What locales to use for gammu error messages, default is 'auto' which does autodetection according to user locales + :param Locale: What locales to use for gammu error messages, default is ``auto`` which does autodetection according to user locales :type Locale: string @@ -21,8 +21,8 @@ This module wraps all python-gammu functionality. Adds calendar entry. - :param Value: Calendar entry data - :type Value: hash + :param Value: Calendar entry data, see :ref:`cal_obj` + :type Value: dict :return: Location of newly created entry :rtype: int @@ -31,7 +31,7 @@ This module wraps all python-gammu functionality. Adds category to phone. - :param Type: Type of category to read, one of 'ToDo', 'Phonebook' + :param Type: Type of category to read, one of ``ToDo``, ``Phonebook`` :type Type: string :param Name: Category name :type Name: string @@ -43,10 +43,10 @@ This module wraps all python-gammu functionality. Adds file part to filesystem. - :param File: File data - :type File: hash + :param File: File data, see :ref:`file_obj` + :type File: dict :return: File data for subsequent calls (Finished indicates transfer has been completed) - :rtype: hash + :rtype: dict .. method:: AddFolder(ParentFolderID, Name) @@ -65,8 +65,8 @@ This module wraps all python-gammu functionality. Adds memory (phonebooks or calls) entry. - :param Value: Memory entry - :type Value: hash + :param Value: Memory entry, see :ref:`pbk_obj` + :type Value: dict :return: Location of created entry :rtype: int @@ -75,8 +75,8 @@ This module wraps all python-gammu functionality. Adds SMS to specified folder. - :param Value: SMS data - :type Value: hash + :param Value: SMS data, see :ref:`sms_obj` + :type Value: dict :return: Tuple for location and folder. :rtype: tuple @@ -95,8 +95,8 @@ This module wraps all python-gammu functionality. Adds ToDo in phone. - :param Value: ToDo data - :type Value: hash + :param Value: ToDo data, see :ref:`todo_obj` + :type Value: dict :return: Location of created entry :rtype: int @@ -147,7 +147,7 @@ This module wraps all python-gammu functionality. Deletes all memory (phonebooks or calls) entries of specified type. - :param Type: Memory type, one of 'ME', 'SM', 'ON', 'DC', 'RC', 'MC', 'MT', 'FD', 'VM' + :param Type: Memory type, one of ``ME``, ``SM``, ``ON``, ``DC``, ``RC``, ``MC``, ``MT``, ``FD``, ``VM`` :type Type: string :return: None :rtype: None @@ -195,7 +195,7 @@ This module wraps all python-gammu functionality. Deletes memory (phonebooks or calls) entry. - :param Type: Memory type, one of 'ME', 'SM', 'ON', 'DC', 'RC', 'MC', 'MT', 'FD', 'VM' + :param Type: Memory type, one of ``ME``, ``SM``, ``ON``, ``DC``, ``RC``, ``MC``, ``MT``, ``FD``, ``VM`` :type Type: string :param Location: Location of entry to delete :type Location: int @@ -261,7 +261,7 @@ This module wraps all python-gammu functionality. Entres security code. - :param Type: What code to enter, one of 'PIN', 'PUK', 'PIN2', 'PUK2', 'Phone'. + :param Type: What code to enter, one of ``PIN``, ``PUK``, ``PIN2``, ``PUK2``, ``Phone``. :type Type: string :param Code: Code value :type Code: string @@ -275,16 +275,16 @@ This module wraps all python-gammu functionality. :param Location: Which alarm to read. Many phone support only one alarm. Default is 1. :type Location: int - :return: Alarm hash - :rtype: hash + :return: Alarm dict + :rtype: dict .. method:: GetBatteryCharge() Gets information about battery charge and phone charging state. - :return: Hash containing information about battery state (BatteryPercent and ChargeState) - :rtype: hash + :return: Dictionary containing information about battery state (BatteryPercent and ChargeState) + :rtype: dict .. method:: GetCalendar(Location) @@ -293,23 +293,23 @@ This module wraps all python-gammu functionality. :param Location: Calendar entry to read :type Location: int - :return: Hash with calendar values - :rtype: hash + :return: Dictionary with calendar values, see :ref:`cal_obj` + :rtype: dict .. method:: GetCalendarStatus() Retrieves calendar status (number of used entries). - :return: Hash with calendar status (Used) - :rtype: hash + :return: Dictionary with calendar status (Used) + :rtype: dict .. method:: GetCategory(Type, Location) Reads category from phone. - :param Type: Type of category to read, one of 'ToDo', 'Phonebook' + :param Type: Type of category to read, one of ``ToDo``, ``Phonebook`` :type Type: string :param Location: Location of category to read :type Location: int @@ -321,10 +321,10 @@ This module wraps all python-gammu functionality. Reads category status (number of used entries) from phone. - :param Type: Type of category to read, one of 'ToDo', 'Phonebook' + :param Type: Type of category to read, one of ``ToDo``, ``Phonebook`` :type Type: string - :return: Hash containing information about category status (Used) - :rtype: hash + :return: Dictionary containing information about category status (Used) + :rtype: dict .. method:: GetConfig(Section) @@ -342,8 +342,8 @@ This module wraps all python-gammu functionality. :param Section: Index of config section to read. Defaults to 0. :type Section: int - :return: Hash containing configuration - :rtype: hash + :return: Dictionary containing configuration + :rtype: dict .. method:: GetDateTime() @@ -365,18 +365,18 @@ This module wraps all python-gammu functionality. Gets file part from filesystem. - :param File: File data - :type File: hash - :return: File data for subsequent calls (Finished indicates transfer has been completed) - :rtype: hash + :param File: File data, see :ref:`file_obj` + :type File: dict + :return: File data for subsequent calls (Finished indicates transfer has been completed), see :ref:`file_obj` + :rtype: dict .. method:: GetFileSystemStatus() Acquires filesystem status. - :return: Hash containing filesystem status (Used and Free) - :rtype: hash + :return: Dictionary containing filesystem status (Used and Free) + :rtype: dict .. method:: GetFirmware() @@ -395,8 +395,8 @@ This module wraps all python-gammu functionality. :type Folder: string :param Start: Whether we're starting listing. Defaults to False. :type Start: boolean - :return: File data as hash - :rtype: hash + :return: File data as dict, see :ref:`file_obj` + :rtype: dict .. method:: GetHardware() @@ -419,8 +419,8 @@ This module wraps all python-gammu functionality. Gets locale information from phone. - :return: Hash of locale settings. :meth:`SetLocale` lists them all. - :rtype: hash + :return: Dictionary of locale settings. :meth:`SetLocale` lists them all. + :rtype: dict .. method:: GetManufactureMonth() @@ -443,20 +443,20 @@ This module wraps all python-gammu functionality. Reads entry from memory (phonebooks or calls). Which entry shouldbe read is defined in entry. - :param Type: Memory type, one of 'ME', 'SM', 'ON', 'DC', 'RC', 'MC', 'MT', 'FD', 'VM' + :param Type: Memory type, one of ``ME``, ``SM``, ``ON``, ``DC``, ``RC``, ``MC``, ``MT``, ``FD``, ``VM`` :type Type: string - :return: Memory entry as hash - :rtype: hash + :return: Memory entry as dict, see :ref:`pbk_obj` + :rtype: dict .. method:: GetMemoryStatus(Type) Gets memory (phonebooks or calls) status (eg. number of used andfree entries). - :param Type: Memory type, one of 'ME', 'SM', 'ON', 'DC', 'RC', 'MC', 'MT', 'FD', 'VM' + :param Type: Memory type, one of ``ME``, ``SM``, ``ON``, ``DC``, ``RC``, ``MC``, ``MT``, ``FD``, ``VM`` :type Type: string - :return: Hash with information about memory (Used and Free) - :rtype: hash + :return: Dictionary with information about memory (Used and Free) + :rtype: dict .. method:: GetModel() @@ -471,8 +471,8 @@ This module wraps all python-gammu functionality. Gets network information. - :return: Hash with information about network (NetworkName, State, NetworkCode, CID and LAC) - :rtype: hash + :return: Dictionary with information about network (NetworkName, State, NetworkCode, CID and LAC) + :rtype: dict .. method:: GetNextCalendar(Start, Location) @@ -483,8 +483,8 @@ This module wraps all python-gammu functionality. :type Start: boolean :param Location: Last read location. This can not be used together with Start :type Location: int - :return: Hash with calendar values - :rtype: hash + :return: Dictionary with calendar values, see :ref:`cal_obj` + :rtype: dict .. method:: GetNextFileFolder(Start) @@ -493,22 +493,22 @@ This module wraps all python-gammu functionality. :param Start: Whether we're starting listing. Defaults to False. :type Start: boolean - :return: File data as hash - :rtype: hash + :return: File data as dict, see :ref:`file_obj` + :rtype: dict .. method:: GetNextMemory(Type, Start, Location) Reads entry from memory (phonebooks or calls). Which entry shouldbe read is defined in entry. This can be easily used for reading all entries. - :param Type: Memory type, one of 'ME', 'SM', 'ON', 'DC', 'RC', 'MC', 'MT', 'FD', 'VM' + :param Type: Memory type, one of ``ME``, ``SM``, ``ON``, ``DC``, ``RC``, ``MC``, ``MT``, ``FD``, ``VM`` :type Type: string :param Start: Whether to start. This can not be used together with Location :type Start: boolean :param Location: Last read location. This can not be used together with Start :type Location: int - :return: Memory entry as hash - :rtype: hash + :return: Memory entry as dict, see :ref:`pbk_obj` + :rtype: dict .. method:: GetNextRootFolder(Folder) @@ -530,8 +530,8 @@ This module wraps all python-gammu functionality. :type Start: boolean :param Location: Location last read entry. This can not be used together with Start :type Location: int - :return: Hash with SMS data - :rtype: hash + :return: Dictionary with SMS data, see :ref:`sms_obj` + :rtype: dict .. method:: GetNextToDo(Start, Location) @@ -542,8 +542,8 @@ This module wraps all python-gammu functionality. :type Start: boolean :param Location: Last read location. This can not be used together with Start :type Location: int - :return: Hash with ToDo values - :rtype: hash + :return: Dictionary with ToDo values, see :ref:`todo_obj` + :rtype: dict .. method:: GetOriginalIMEI() @@ -585,8 +585,8 @@ This module wraps all python-gammu functionality. :type Folder: int :param Location: Location of entry to read :type Location: int - :return: Hash with SMS data - :rtype: hash + :return: Dictionary with SMS data, see :ref:`sms_obj` + :rtype: dict .. method:: GetSMSC(Location) @@ -595,8 +595,8 @@ This module wraps all python-gammu functionality. :param Location: Location of entry to read. Defaults to 1 :type Location: int - :return: Hash with SMSC information - :rtype: hash + :return: Dictionary with SMSC information, see :ref:`smsc_obj` + :rtype: dict .. method:: GetSMSFolders() @@ -611,8 +611,8 @@ This module wraps all python-gammu functionality. Gets information about SMS memory (read/unread/size of memory for both SIM and phone). - :return: Hash with information about phone memory (SIMUnRead, SIMUsed, SIMSize, PhoneUnRead, PhoneUsed, PhoneSize and TemplatesUsed) - :rtype: hash + :return: Dictionary with information about phone memory (SIMUnRead, SIMUsed, SIMSize, PhoneUnRead, PhoneUsed, PhoneSize and TemplatesUsed) + :rtype: dict .. method:: GetSecurityStatus() @@ -627,8 +627,8 @@ This module wraps all python-gammu functionality. Reads signal quality (strength and error rate). - :return: Hash containing information about signal state (SignalStrength, SignalPercent and BitErrorRate) - :rtype: hash + :return: Dictionary containing information about signal state (SignalStrength, SignalPercent and BitErrorRate) + :rtype: dict .. method:: GetSpeedDial(Location) @@ -637,8 +637,8 @@ This module wraps all python-gammu functionality. :param Location: Location of entry to read :type Location: int - :return: Hash with speed dial (Location, MemoryLocation, MemoryNumberID, MemoryType) - :rtype: hash + :return: Dictionary with speed dial (Location, MemoryLocation, MemoryNumberID, MemoryType) + :rtype: dict .. method:: GetToDo(Location) @@ -647,16 +647,16 @@ This module wraps all python-gammu functionality. :param Location: Location of entry to read :type Location: int - :return: Hash with ToDo values - :rtype: hash + :return: Dictionary with ToDo values, see :ref:`todo_obj` + :rtype: dict .. method:: GetToDoStatus() Gets status of ToDos (count of used entries). - :return: Hash of status (Used) - :rtype: hash + :return: Dictionary of status (Used) + :rtype: dict .. method:: HoldCall(ID) @@ -729,7 +729,7 @@ This module wraps all python-gammu functionality. Resets phone settings. - :param Type: What to reset, one of 'PHONE', 'UIF', 'ALL', 'DEV', 'FACTORY' + :param Type: What to reset, one of ``PHONE``, ``UIF``, ``ALL``, ``DEV``, ``FACTORY`` :type Type: string :return: None :rtype: None @@ -749,18 +749,18 @@ This module wraps all python-gammu functionality. Sends file part to phone. - :param File: File data - :type File: hash - :return: File data for subsequent calls (Finished indicates transfer has been completed) - :rtype: hash + :param File: File data, see :ref:`file_obj` + :type File: dict + :return: File data for subsequent calls (Finished indicates transfer has been completed), see :ref:`file_obj` + :rtype: dict .. method:: SendSMS(Value) Sends SMS. - :param Value: SMS data - :type Value: hash + :param Value: SMS data, see :ref:`sms_obj` + :type Value: dict :return: Message reference as integer :rtype: int @@ -805,8 +805,8 @@ This module wraps all python-gammu functionality. Sets calendar entry - :param Value: Calendar entry data - :type Value: hash + :param Value: Calendar entry data, see :ref:`cal_obj` + :type Value: dict :return: Location of set entry :rtype: int @@ -818,7 +818,7 @@ This module wraps all python-gammu functionality. :param Section: Index of config section to modify :type Section: int :param Values: Config values, see :meth:`GetConfig` for description of accepted - :type Values: hash + :type Values: dict :return: None :rtype: None @@ -937,7 +937,7 @@ This module wraps all python-gammu functionality. :param DateSeparator: Date separator. :type DateSeparator: string - :param DateFormat: Date format, one of 'DDMMYYYY', 'MMDDYYYY', 'YYYYMMDD' + :param DateFormat: Date format, one of ``DDMMYYYY``, ``MMDDYYYY``, ``YYYYMMDD`` :type DateFormat: string :param AMPMTime: Whether to use AM/PM time. :type AMPMTime: boolean @@ -949,8 +949,8 @@ This module wraps all python-gammu functionality. Sets memory (phonebooks or calls) entry. - :param Value: Memory entry - :type Value: hash + :param Value: Memory entry, see :ref:`pbk_obj` + :type Value: dict :return: Location of created entry :rtype: int @@ -959,8 +959,8 @@ This module wraps all python-gammu functionality. Sets SMS. - :param Value: SMS data - :type Value: hash + :param Value: SMS data, see :ref:`sms_obj` + :type Value: dict :return: Tuple for location and folder. :rtype: tuple @@ -969,8 +969,8 @@ This module wraps all python-gammu functionality. Sets SMS Service Center number and SMS settings. - :param Value: SMSC information - :type Value: hash + :param Value: SMSC information, see :ref:`smsc_obj` + :type Value: dict :return: None :rtype: None @@ -980,7 +980,7 @@ This module wraps all python-gammu functionality. Sets speed dial. :param Value: Speed dial data, see :meth:`GetSpeedDial` for listing. - :type Value: hash + :type Value: dict :return: None :rtype: None @@ -989,8 +989,8 @@ This module wraps all python-gammu functionality. Sets ToDo in phone. - :param Value: ToDo data - :type Value: hash + :param Value: ToDo data, see :ref:`todo_obj` + :type Value: dict :return: Location of created entry :rtype: int @@ -1093,29 +1093,29 @@ Message processing :type Messages: list :type EMS: boolean - :param Messages: List of messages to link + :param Messages: List of messages to link, see :ref:`sms_obj` :param EMS: Whether to detect ems, defauls to True - :return: List of linked messages + :return: List of linked messages, see :ref:`sms_obj` :rtype: list .. function:: DecodeSMS(Messages, EMS) Decodes multi part SMS message. - :param Messages: Nessages to decode + :param Messages: Nessages to decode, see :ref:`sms_obj` :type Messages: list :param EMS: Whether to use EMS, defalt to True :type EMS: boolean - :return: Multi part message information - :rtype: hash + :return: Multi part message information, see :ref:`sms_info_obj` + :rtype: dict .. function:: EncodeSMS(MessageInfo) Encodes multi part SMS message. - :param MessageInfo: Description of message + :param MessageInfo: Description of message, see :ref:`sms_info_obj` :type MessageInfo: dict - :return: Dictionary with raw message + :return: Dictionary with raw message, see :ref:`sms_obj` :rtype: dict .. function:: DecodePDU(Data, SMSC = False) @@ -1126,14 +1126,14 @@ Message processing :type Data: string :param SMSC: Whether PDU includes SMSC. :type SMSC: boolean - :return: Message data + :return: Message data, see :ref:`sms_obj` :rtype: dict .. function:: EncodePDU(SMS, Layout = Submit) Creates PDU packet. - :param SMS: SMS dictionary + :param SMS: SMS dictionary, see :ref:`sms_obj` :type SMS: dict :param Layout: Layout (one of Submit, Deliver, StatusReport), Submit is default :type Layout: string @@ -1151,14 +1151,14 @@ Encoding and decoding entries :param Text: String to decode :type Text: string - :return: Memory entry - :rtype: hash + :return: Memory entry, see :ref:`pbk_obj` + :rtype: dict .. function:: EncodeVCARD(Entry) Encodes memory entry to a vCard. - :param Entry: Memory entry + :param Entry: Memory entry, see :ref:`pbk_obj` :type Entry: dict :return: String with vCard :rtype: string @@ -1169,8 +1169,8 @@ Encoding and decoding entries :param Text: String to decode :type Text: string - :return: Calendar or todo entry (whatever one was included in string) - :rtype: hash + :return: Calendar or todo entry (whatever one was included in string), see :ref:`cal_obj`, :ref:`todo_obj` + :rtype: dict .. function:: DecodeICS(Text) @@ -1178,41 +1178,41 @@ Encoding and decoding entries :param Text: String to decode :type Text: string - :return: Calendar or todo entry (whatever one was included in string) - :rtype: hash + :return: Calendar or todo entry (whatever one was included in string), see :ref:`cal_obj`, :ref:`todo_obj` + :rtype: dict .. function:: EncodeVCALENDAR(Entry) - Encodes memory entry to a vCalendar. + Encodes calendar entry to a vCalendar. - :param Entry: Memory entry + :param Entry: Calendar entry, see :ref:`cal_obj` :type Entry: dict :return: String with vCalendar :rtype: string .. function:: EncodeICALENDAR(Entry) - Encodes memory entry to a iCalendar. + Encodes calendar entry to a iCalendar. - :param Entry: Memory entry + :param Entry: Calendar entry, see :ref:`cal_obj` :type Entry: dict :return: String with iCalendar :rtype: string .. function:: EncodeVTODO(Entry) - Encodes memory entry to a vTodo. + Encodes todo entry to a vTodo. - :param Entry: Memory entry + :param Entry: Todo entry, see :ref:`todo_obj` :type Entry: dict :return: String with vTodo :rtype: string .. function:: EncodeITODO(Entry) - Encodes memory entry to a iTodo. + Encodes todo entry to a iTodo. - :param Entry: Memory entry + :param Entry: Todo entry, see :ref:`todo_obj` :type Entry: dict :return: String with vCard :rtype: string @@ -1228,7 +1228,7 @@ Backup reading and writing :type Filename: string :param Ringtone: Ringtone to save :type Ringtone: dict - :param Format: One of 'ott', 'mid', 'rng', 'imy', 'wav', 'rttl' + :param Format: One of ``ott``, ``mid``, ``rng``, ``imy``, ``wav``, ``rttl`` :type Format: string :return: None :rtype: None diff --git a/docs/develop/python/index.rst b/docs/develop/python/index.rst index d49ae96..db9beb0 100644 --- a/docs/develop/python/index.rst +++ b/docs/develop/python/index.rst @@ -45,4 +45,5 @@ API documentation data worker exceptions + objects diff --git a/docs/develop/python/objects.rst b/docs/develop/python/objects.rst new file mode 100644 index 0000000..a0a33e8 --- /dev/null +++ b/docs/develop/python/objects.rst @@ -0,0 +1,809 @@ +Objects +======= + +For various (mostly historical) reasons, all objects you get from Gammu are +not real objects but rather a dictionaries. This has quite a big impact of +usability and will most likely change in the future. + +All the objects basically map to C structures, so you might also refer to +:ref:`libgammu` chapter. + +.. _sms_obj: + +SMS Object +---------- + +Message dictionary can consist of following fields: + +.. attribute:: SMSC + + SMSC information, see :ref:`smsc_obj`. + +.. attribute:: Number + + Recipient number, needs to be set for sending. + +.. attribute:: Name + + Name of the message, does not make any effect on sending, some phones might + store it. + +.. attribute:: UDH + + User defined headers for SMS, see :ref:`udh_obj`. + +.. attribute:: Text + + Message text + +.. attribute:: Folder + + Folder where the message is stored + +.. attribute:: Location + + Location where the message is stored + +.. attribute:: InboxFolder + + Indication whether folder is an inbox + +.. attribute:: DeliveryStatus + + Message delivery status, used only for received messages + +.. attribute:: ReplyViaSameSMSC + + Flag indicating whether reply using same SMSC is requested + +.. attribute:: Class + + Message class + +.. attribute:: MessageReference + + Message reference number, used mostly to identify delivery reports + +.. attribute:: ReplaceMessage + + Id of message which this message is supposed to replace + +.. attribute:: RejectDuplicates + + Whether to reject duplicates + +.. attribute:: Memory + + Memory where the message is stored + +.. attribute:: Type + + Message type, one of: + +* ``Submit`` - message to be send +* ``Deliver`` - delivered message +* ``Status_Report`` - when creating new message this will create submit message + with request for delivery report + +.. attribute:: Coding + + Message encoding, one of: + +* ``Unicode_No_Compression`` - unicode message which can contain any chars, + but can be only 70 chars long +* ``Unicode_Compression`` - not supported by Gammu and most phones +* ``Default_No_Compression`` - message with GSM alphabet only, up to 160 chars + long +* ``Default_Compression`` - not supported by Gammu and most phones +* ``8bit`` - for binary messages + +.. attribute:: DateTime + + Timestamp when the message was received or sent. + + Please note that most phones do no record timestamp of sent messages. + +.. attribute:: SMSCDateTime + + Timestamp when the message was at SMSC. + +.. attribute:: State + + Message state, one of: + +* ``Sent`` +* ``UnSent`` +* ``Read`` +* ``UnRead`` + +Examples:: + + # Simple message to send, using SMSC from phone + SMS_1 = { + 'Number': '123465', + 'SMSC': {'Location': 1}, + 'Text': 'Hello world!', + } + + # Class 0 (on display) message using custom SMSC number + SMS_2 = { + 'Number': '123465', + 'SMSC': {'Number': '+420987654321'}, + 'Text': 'Hello world!', + 'Class': 0, + } + + +.. _udh_obj: + +UDH Object +---------- + +UDH dictionary can consist of following fields: + +.. attribute:: ID8bit + + 8-bit ID of the message, not required + +.. attribute:: ID16bit + + 16-bit ID of the message, not required + +.. attribute:: PartNumber + + Number of current part + +.. attribute:: AllParts + + Count of all message parts + +.. attribute:: Type + + UDH type, one of predefined strings: + +* ``NoUDH`` +* ``ConcatenatedMessages`` +* ``ConcatenatedMessages16bit`` +* ``DisableVoice`` +* ``DisableFax`` +* ``DisableEmail`` +* ``EnableVoice`` +* ``EnableFax`` +* ``EnableEmail`` +* ``VoidSMS`` +* ``NokiaRingtone`` +* ``NokiaRingtoneLong`` +* ``NokiaOperatorLogoLong`` +* ``NokiaCallerLogo`` +* ``NokiaWAP`` +* ``NokiaWAPLong`` +* ``NokiaCalendarLong`` +* ``NokiaProfileLong`` +* ``NokiaPhonebookLong`` +* ``UserUDH`` + +.. attribute:: Text + + UDH content + +Example:: + + UDH = { + 'ID8bit': 0xcd, + 'PartNumber': 1, + 'AllParts': 2, + 'Type': 'ConcatenatedMessages', + } + +.. _smsc_obj: + +SMSC Object +----------- + +SMSC dictionary can consist of following fields: + +.. attribute:: Location + + Location where the SMSC is stored + +.. attribute:: Number + + SMSC number + +.. attribute:: Name + + Name of the SMSC configuration + +.. attribute:: DefaultNumber + + Default recipient number, ignored on most phones + +.. attribute:: Format + + Default message format, one of: + +* ``Text`` +* ``Pager`` +* ``Fax`` +* ``Email`` + +.. attribute:: Validity + + Default message validity as a string + +* ``NA`` - validity not available +* ``Max`` - maximal validity allowed by network +* ``nM``, ``nH``, ``nD``, ``nW`` - period defined in minutes, hours, days or + weeks, eg. ``3W`` + +Example:: + + SMSC = { + 'Location': 1, + 'Number': '+420987654321', + 'Format': 'Text', + 'Validity': 'Max', + } + +.. _sms_info_obj: + +SMS Info Object +--------------- + +Message info dictionary can consist of following fields: + +.. attribute:: Unicode + + Whether to use Unicode for the message. + +.. attribute:: ReplaceMessage + + Id of message which this message is supposed to replace + +.. attribute:: Unknown + + Boolean flag indicating there was some part which Gammu could not decode. + +.. attribute:: Class + + Message class + +.. attribute:: Entries + + Actual message data, see :ref:`sms_info_part_obj`. + +Example:: + + SMSINFO = { + 'Class': 1, + 'Entries': [ + {'ID': 'Text', 'Buffer': 'This is a '}, + {'ID': 'Text', 'Buffer': 'message', 'Italic': True}, + {'ID': 'Text', 'Buffer': ' from '}, + {'ID': 'Text', 'Buffer': 'Gammu', 'Bold': True}, + ], + } + +.. _sms_info_part_obj: + +SMS Info Part Object +-------------------- + +Message component can consist of following fields: + +.. attribute:: ID + + Identification of the part type: + +* ``Text`` +* ``ConcatenatedTextLong`` - Contacenated SMS, when longer than 1 SMS. +* ``ConcatenatedAutoTextLong`` - Contacenated SMS, auto Default/Unicode coding. +* ``ConcatenatedTextLong16bit`` +* ``ConcatenatedAutoTextLong16bit`` +* ``NokiaProfileLong`` - Nokia profile = Name`` Ringtone`` ScreenSaver +* ``NokiaPictureImageLong`` - Nokia Picture Image + (text) +* ``NokiaScreenSaverLong`` - Nokia screen saver + (text) +* ``NokiaRingtone`` - Nokia ringtone - old SM2.0 format`` 1 SMS +* ``NokiaRingtoneLong`` - Nokia ringtone contacenated`` when very long +* ``NokiaOperatorLogo`` - Nokia 72x14 operator logo`` 1 SMS +* ``NokiaOperatorLogoLong`` - Nokia 72x14 op logo or 78x21 in 2 SMS +* ``NokiaCallerLogo`` - Nokia 72x14 caller logo`` 1 SMS +* ``NokiaWAPBookmarkLong`` - Nokia WAP bookmark in 1 or 2 SMS +* ``NokiaWAPSettingsLong`` - Nokia WAP settings in 2 SMS +* ``NokiaMMSSettingsLong`` - Nokia MMS settings in 2 SMS +* ``NokiaVCARD10Long`` - Nokia VCARD 1.0 - only name and default number +* ``NokiaVCARD21Long`` - Nokia VCARD 2.1 - all numbers + text +* ``NokiaVCALENDAR10Long`` - Nokia VCALENDAR 1.0 - can be in few sms +* ``NokiaVTODOLong`` +* ``VCARD10Long`` +* ``VCARD21Long`` +* ``DisableVoice`` +* ``DisableFax`` +* ``DisableEmail`` +* ``EnableVoice`` +* ``EnableFax`` +* ``EnableEmail`` +* ``VoidSMS`` +* ``EMSSound10`` - IMelody 1.0 +* ``EMSSound12`` - IMelody 1.2 +* ``EMSSonyEricssonSound`` - IMelody without header - SonyEricsson extension +* ``EMSSound10Long`` - IMelody 1.0 with UPI. +* ``EMSSound12Long`` - IMelody 1.2 with UPI. +* ``EMSSonyEricssonSoundLong`` - IMelody without header with UPI. +* ``EMSPredefinedSound`` +* ``EMSPredefinedAnimation`` +* ``EMSAnimation`` +* ``EMSFixedBitmap`` - Fixed bitmap of size 16x16 or 32x32. +* ``EMSVariableBitmap`` +* ``EMSVariableBitmapLong`` +* ``MMSIndicatorLong`` - MMS message indicator. +* ``WAPIndicatorLong`` +* ``AlcatelMonoBitmapLong`` - Variable bitmap with black and white colors +* ``AlcatelMonoAnimationLong`` - Variable animation with black and white colors +* ``AlcatelSMSTemplateName`` +* ``SiemensFile`` - Siemens OTA + +.. attribute:: Left + + Text formatting + +.. attribute:: Right + + Text formatting + +.. attribute:: Center + + Text formatting + +.. attribute:: Large + + Text formatting + +.. attribute:: Small + + Text formatting + +.. attribute:: Bold + + Text formatting + +.. attribute:: Italic + + Text formatting + +.. attribute:: Underlined + + Text formatting + +.. attribute:: Strikethrough + + Text formatting + +.. attribute:: Protected + + Whether message part should be protected (DRM) + +.. attribute:: Number + + Number to encode in message. + +.. attribute:: Ringtone + + Ringtone to encode in message. + +.. attribute:: Bitmap + + Bitmap to encode in message. + +.. attribute:: Bookmark + + Bookmark to encode in message. + +.. attribute:: Settings + + Settings to encode in message. + +.. attribute:: MMSIndicator + + MMS indication to encode in message. + +.. attribute:: Phonebook + + Phonebook entry to encode in message, see :ref:`pbk_obj`. + +.. attribute:: Calendar + + Calendar entry to encode in message, see :ref:`cal_obj`. + +.. attribute:: ToDo + + Todo entry to encode in message, see :ref:`todo_obj`. + +.. attribute:: File + + File to encode in message, see :ref:`file_obj`. + +.. attribute:: Buffer + + String to encode in message. + +.. _todo_obj: + +Todo Object +----------- + +Todo entry is a dictionary consisting of following fields: + +.. attribute:: Location + + Location where the entry is stored + +.. attribute:: Type + + Type of entry, one of: + +* ``REMINDER`` - Reminder or Date +* ``CALL`` - Call +* ``MEETING`` - Meeting +* ``BIRTHDAY`` - Birthday or Anniversary or Special Occasion +* ``MEMO`` - Memo or Miscellaneous +* ``TRAVEL`` - Travel +* ``VACATION`` - Vacation +* ``T_ATHL`` - Training - Athletism +* ``T_BALL`` - Training - Ball Games +* ``T_CYCL`` - Training - Cycling +* ``T_BUDO`` - Training - Budo +* ``T_DANC`` - Training - Dance +* ``T_EXTR`` - Training - Extreme Sports +* ``T_FOOT`` - Training - Football +* ``T_GOLF`` - Training - Golf +* ``T_GYM`` - Training - Gym +* ``T_HORS`` - Training - Horse Race +* ``T_HOCK`` - Training - Hockey +* ``T_RACE`` - Training - Races +* ``T_RUGB`` - Training - Rugby +* ``T_SAIL`` - Training - Sailing +* ``T_STRE`` - Training - Street Games +* ``T_SWIM`` - Training - Swimming +* ``T_TENN`` - Training - Tennis +* ``T_TRAV`` - Training - Travels +* ``T_WINT`` - Training - Winter Games +* ``ALARM`` - Alarm +* ``DAILY_ALARM`` - Alarm repeating each day. + +.. attribute:: Priority + + Entry priority, one of: + +* ``High`` +* ``Medium`` +* ``Low`` +* ``None`` + +.. attribute:: Entries + + Actual entries, see :ref:`todo_entry_obj` + +Example:: + + TODO = { + 'Type': 'MEMO', + 'Entries': [ + {'Type': 'END_DATETIME', 'Value': datetime.datetime.now() + datetime.timedelta(days = 1)}, + {'Type': 'TEXT', 'Value': 'Buy some milk'}, + ], + } + +.. _todo_entry_obj: + +Todo Entries Object +------------------- + +.. attribute:: Type + + Type of entry, one of: + +* ``END_DATETIME`` - Due date (Date). +* ``COMPLETED`` - Whether is completed (Number). +* ``ALARM_DATETIME`` - When should alarm be fired (Date). +* ``SILENT_ALARM_DATETIME`` - When should silent alarm be fired (Date). +* ``TEXT`` - Text of to do (Text). +* ``DESCRIPTION`` - Description of to do (Text). +* ``LOCATION`` - Location of to do (Text). +* ``PRIVATE`` - Whether entry is private (Number). +* ``CATEGORY`` - Category of entry (Number). +* ``CONTACTID`` - Related contact ID (Number). +* ``PHONE`` - Number to call (Text). +* ``LUID`` - IrMC LUID which can be used for synchronisation (Text). +* ``LAST_MODIFIED`` - Date and time of last modification (Date). +* ``START_DATETIME`` - Start date (Date). + +.. attribute:: Value + + Actual value, corresponding type to Type field. + +.. _cal_obj: + +Calendar Object +--------------- + +Calendar entry is a dictionary consisting of following fields: + +.. attribute:: Location + + Location where the entry is stored + +.. attribute:: Type + + Type of entry, one of: + +* ``REMINDER`` - Reminder or Date +* ``CALL`` - Call +* ``MEETING`` - Meeting +* ``BIRTHDAY`` - Birthday or Anniversary or Special Occasion +* ``MEMO`` - Memo or Miscellaneous +* ``TRAVEL`` - Travel +* ``VACATION`` - Vacation +* ``T_ATHL`` - Training - Athletism +* ``T_BALL`` - Training - Ball Games +* ``T_CYCL`` - Training - Cycling +* ``T_BUDO`` - Training - Budo +* ``T_DANC`` - Training - Dance +* ``T_EXTR`` - Training - Extreme Sports +* ``T_FOOT`` - Training - Football +* ``T_GOLF`` - Training - Golf +* ``T_GYM`` - Training - Gym +* ``T_HORS`` - Training - Horse Race +* ``T_HOCK`` - Training - Hockey +* ``T_RACE`` - Training - Races +* ``T_RUGB`` - Training - Rugby +* ``T_SAIL`` - Training - Sailing +* ``T_STRE`` - Training - Street Games +* ``T_SWIM`` - Training - Swimming +* ``T_TENN`` - Training - Tennis +* ``T_TRAV`` - Training - Travels +* ``T_WINT`` - Training - Winter Games +* ``ALARM`` - Alarm +* ``DAILY_ALARM`` - Alarm repeating each day. + +.. attribute:: Entries + + Actual entries, see :ref:`cal_entry_obj` + +Example:: + + CAL = { + 'Type': 'MEMO', + 'Entries': [ + {'Type': 'START_DATETIME', 'Value': datetime.datetime.now()}, + {'Type': 'END_DATETIME', 'Value': datetime.datetime.now() + datetime.timedelta(days = 1)}, + {'Type': 'LOCATION', 'Value': 'Home'}, + {'Type': 'TEXT', 'Value': 'Relax for one day'}, + ], + } + +.. _cal_entry_obj: + +Calendar Entries Object +----------------------- + +.. attribute:: Type + + Type of entry, one of: + +* ``START_DATETIME`` - Date and time of event start. +* ``END_DATETIME`` - Date and time of event end. +* ``TONE_ALARM_DATETIME`` - Alarm date and time. +* ``SILENT_ALARM_DATETIME`` - Date and time of silent alarm. +* ``TEXT`` - Text. +* ``DESCRIPTION`` - Detailed description. +* ``LOCATION`` - Location. +* ``PHONE`` - Phone number. +* ``PRIVATE`` - Whether this entry is private. +* ``CONTACTID`` - Related contact id. +* ``REPEAT_DAYOFWEEK`` - Repeat each x'th day of week. +* ``REPEAT_DAY`` - Repeat each x'th day of month. +* ``REPEAT_DAYOFYEAR`` - Repeat each x'th day of year. +* ``REPEAT_WEEKOFMONTH`` - Repeat x'th week of month. +* ``REPEAT_MONTH`` - Repeat x'th month. +* ``REPEAT_FREQUENCY`` - Repeating frequency. +* ``REPEAT_STARTDATE`` - Repeating start. +* ``REPEAT_STOPDATE`` - Repeating end. +* ``REPEAT_COUNT`` - Number of repetitions. +* ``LUID`` - IrMC LUID which can be used for synchronisation. +* ``LAST_MODIFIED`` - Date and time of last modification. + +.. attribute:: Value + + Actual value, corresponding type to Type field. + +.. _pbk_obj: + +Phonebook Object +---------------- + +Phonebook entry is a dictionary consisting of following fields: + +.. attribute:: Location + + Location where the entry is stored + +.. attribute:: MemoryType + + Memory where the message is stored + +.. attribute:: Entries + + Actual entries, see :ref:`pbk_entry_obj` + +Example:: + + PBK = { + 'Location': 1000, + 'MemoryType': 'ME', + 'Entries': [ + {'Type': 'Number_General', 'Value': '+420123456789'}, + {'Type': 'Text_Name', 'Value': 'Stojan Jakotyc'}, + ], + } + +.. _pbk_entry_obj: + +Phonebook Entries Object +------------------------ + +.. attribute:: Type + + Type of entry, one of: + +* ``Number_General`` - General number. (Text) +* ``Number_Mobile`` - Mobile number. (Text) +* ``Number_Work`` - Work number. (Text) +* ``Number_Fax`` - Fax number. (Text) +* ``Number_Home`` - Home number. (Text) +* ``Number_Pager`` - Pager number. (Text) +* ``Number_Other`` - Other number. (Text) +* ``Text_Note`` - Note. (Text) +* ``Text_Postal`` - Complete postal address. (Text) +* ``Text_Email`` - Email. (Text) +* ``Text_Email2`` - Second email. (Text) +* ``Text_URL`` - URL (Text) +* ``Date`` - Date and time of last call. (Date) +* ``Caller_Group`` - Caller group. (Number) +* ``Text_Name`` - Name (Text) +* ``Text_LastName`` - Last name. (Text) +* ``Text_FirstName`` - First name. (Text) +* ``Text_Company`` - Company. (Text) +* ``Text_JobTitle`` - Job title. (Text) +* ``Category`` - Category. (Number, if -1 then text) +* ``Private`` - Whether entry is private. (Number) +* ``Text_StreetAddress`` - Street address. (Text) +* ``Text_City`` - City. (Text) +* ``Text_State`` - State. (Text) +* ``Text_Zip`` - Zip code. (Text) +* ``Text_Country`` - Country. (Text) +* ``Text_Custom1`` - Custom information 1. (Text) +* ``Text_Custom2`` - Custom information 2. (Text) +* ``Text_Custom3`` - Custom information 3. (Text) +* ``Text_Custom4`` - Custom information 4. (Text) +* ``RingtoneID`` - Ringtone ID. (Number) +* ``PictureID`` - Picture ID. (Number) +* ``Text_UserID`` - User ID. (Text) +* ``CallLength`` - Length of call (Number) +* ``Text_LUID`` - LUID - Unique Identifier used for synchronisation (Text) +* ``LastModified`` - Date of last modification (Date) +* ``Text_NickName`` - Nick name (Text) +* ``Text_FormalName`` - Formal name (Text) +* ``Text_WorkStreetAddress`` - Work street address. (Text) +* ``Text_WorkCity`` - Work city. (Text) +* ``Text_WorkState`` - Work state. (Text) +* ``Text_WorkZip`` - Work zip code. (Text) +* ``Text_WorkCountry`` - Work country. (Text) +* ``Text_WorkPostal`` - Complete work postal address. (Text) +* ``Text_PictureName`` - Picture name (on phone filesystem). (Text) +* ``PushToTalkID`` - Push-to-talk ID (Text) +* ``Number_Messaging`` - Favorite messaging number. (Text) +* ``Photo`` - Photo (Picture). +* ``Number_Mobile_Home`` - Home mobile number. (Text) +* ``Number_Mobile_Work`` - Work mobile number. (Text) + +.. attribute:: Value + + Actual value, corresponding type to Type field. + +.. attribute:: PictureType + + Type of picture which is stored in Value field (only for Picture fields). + +.. _file_obj: + +File Object +----------- + +File is a dictionary consisting of following fields: + +.. attribute:: Used + + Number of bytes used by this file. + +.. attribute:: Name + + File name. + +.. attribute:: Folder + + Boolean value indicating whether this is a folder. + +.. attribute:: Level + + Depth of file on the filesystem. + +.. attribute:: Type + + File type, one of: + +* ``Other`` +* ``Java_JAR`` +* ``Image_JPG`` +* ``Image_BMP`` +* ``Image_GIF`` +* ``Image_PNG`` +* ``Image_WBMP`` +* ``Video_3GP`` +* ``Sound_AMR`` +* ``Sound_NRT`` - DCT4 binary format +* ``Sound_MIDI`` +* ``MMS`` + +.. attribute:: ID_FullName + + Full file name including path. + +.. attribute:: Buffer + + Content of the file. + +.. attribute:: Modified + + Timestamp of last change + +.. attribute:: Protected + + Boolean value indicating whether file is protected (DRM). + +.. attribute:: ReadOnly + + Boolean value indicating whether file is read only. + +.. attribute:: Hidden + + Boolean value indicating whether file is hidden. + +.. attribute:: System + + Boolean value indicating whether file is system. + +.. attribute:: Pos + + Current poosition of file upload + +.. attribute:: Finished + + Boolean value indicating completed file transfer. + +Example:: + + FILE = { + 'ID_FullName': PATH, + 'Name': os.path.basename(PATH) + 'Buffer': data, + 'Protected': 0, + 'ReadOnly': 0, + 'Hidden': 0, + 'System': 0, + 'Folder': 0, + 'Level': 0, + 'Type': 'Other', + 'Finished': 0, + 'Pos': 0, + } diff --git a/docs/develop/smsd/index.rst b/docs/develop/smsd/index.rst new file mode 100644 index 0000000..b49906f --- /dev/null +++ b/docs/develop/smsd/index.rst @@ -0,0 +1,40 @@ +SMS Daemon +========== + +Gammu SMS Daemon is a program that periodically scans GSM modem for received +messages, stores them in defined storage and also sends messages enqueued in +this storage. + + +.. figure:: smsd-interactions.png + :alt: SMSD interactions + + Interaction of SMSD programs + +Backend services +---------------- + +The backend service is used to store messages (both incoming and queue of +outgoing ones). + +Files service ++++++++++++++ + +Files service stores all messages as files in folders defined by configuration. + + +Database based services ++++++++++++++++++++++++ + +All database based services share same (or similar) database schema. Currently +following databases are supported: + +* MySQL +* PostgreSQL +* libDBI driver, which can connect to various other databases + +Null service +++++++++++++ + +This service is there primarily for testing purposes, as it does not store +messages at all. diff --git a/docs/develop/smsd/smsd-interactions.dia b/docs/develop/smsd/smsd-interactions.dia new file mode 100644 index 0000000..87f2ef8 --- /dev/null +++ b/docs/develop/smsd/smsd-interactions.dia @@ -0,0 +1,949 @@ +<?xml version="1.0" encoding="UTF-8"?> +<dia:diagram xmlns:dia="http://www.lysator.liu.se/~alla/dia/"> + <dia:diagramdata> + <dia:attribute name="background"> + <dia:color val="#ffffff"/> + </dia:attribute> + <dia:attribute name="pagebreak"> + <dia:color val="#000099"/> + </dia:attribute> + <dia:attribute name="paper"> + <dia:composite type="paper"> + <dia:attribute name="name"> + <dia:string>#A4#</dia:string> + </dia:attribute> + <dia:attribute name="tmargin"> + <dia:real val="2.8222000598907471"/> + </dia:attribute> + <dia:attribute name="bmargin"> + <dia:real val="2.8222000598907471"/> + </dia:attribute> + <dia:attribute name="lmargin"> + <dia:real val="2.8222000598907471"/> + </dia:attribute> + <dia:attribute name="rmargin"> + <dia:real val="2.8222000598907471"/> + </dia:attribute> + <dia:attribute name="is_portrait"> + <dia:boolean val="true"/> + </dia:attribute> + <dia:attribute name="scaling"> + <dia:real val="1"/> + </dia:attribute> + <dia:attribute name="fitto"> + <dia:boolean val="false"/> + </dia:attribute> + </dia:composite> + </dia:attribute> + <dia:attribute name="grid"> + <dia:composite type="grid"> + <dia:attribute name="width_x"> + <dia:real val="1"/> + </dia:attribute> + <dia:attribute name="width_y"> + <dia:real val="1"/> + </dia:attribute> + <dia:attribute name="visible_x"> + <dia:int val="1"/> + </dia:attribute> + <dia:attribute name="visible_y"> + <dia:int val="1"/> + </dia:attribute> + <dia:composite type="color"/> + </dia:composite> + </dia:attribute> + <dia:attribute name="color"> + <dia:color val="#d8e5e5"/> + </dia:attribute> + <dia:attribute name="guides"> + <dia:composite type="guides"> + <dia:attribute name="hguides"/> + <dia:attribute name="vguides"/> + </dia:composite> + </dia:attribute> + </dia:diagramdata> + <dia:layer name="Pozadí" visible="true" active="true"> + <dia:object type="Sybase - Stable Queue" version="1" id="O0"> + <dia:attribute name="obj_pos"> + <dia:point val="20,15"/> + </dia:attribute> + <dia:attribute name="obj_bb"> + <dia:rectangle val="19.95,14.95;25.0955,20.8179"/> + </dia:attribute> + <dia:attribute name="meta"> + <dia:composite type="dict"/> + </dia:attribute> + <dia:attribute name="elem_corner"> + <dia:point val="20,15"/> + </dia:attribute> + <dia:attribute name="elem_width"> + <dia:real val="5.045454545454545"/> + </dia:attribute> + <dia:attribute name="elem_height"> + <dia:real val="3.9642857142857149"/> + </dia:attribute> + <dia:attribute name="line_width"> + <dia:real val="0.10000000000000001"/> + </dia:attribute> + <dia:attribute name="line_colour"> + <dia:color val="#000000"/> + </dia:attribute> + <dia:attribute name="fill_colour"> + <dia:color val="#ffffff"/> + </dia:attribute> + <dia:attribute name="show_background"> + <dia:boolean val="true"/> + </dia:attribute> + <dia:attribute name="line_style"> + <dia:enum val="0"/> + <dia:real val="1"/> + </dia:attribute> + <dia:attribute name="padding"> + <dia:real val="0.10000000000000001"/> + </dia:attribute> + <dia:attribute name="text"> + <dia:composite type="text"> + <dia:attribute name="string"> + <dia:string>#Service storage +(eg. database)#</dia:string> + </dia:attribute> + <dia:attribute name="font"> + <dia:font family="sans" style="0" name="Helvetica"/> + </dia:attribute> + <dia:attribute name="height"> + <dia:real val="0.80000000000000004"/> + </dia:attribute> + <dia:attribute name="pos"> + <dia:point val="22.5227,19.7445"/> + </dia:attribute> + <dia:attribute name="color"> + <dia:color val="#000000"/> + </dia:attribute> + <dia:attribute name="alignment"> + <dia:enum val="1"/> + </dia:attribute> + </dia:composite> + </dia:attribute> + <dia:attribute name="flip_horizontal"> + <dia:boolean val="false"/> + </dia:attribute> + <dia:attribute name="flip_vertical"> + <dia:boolean val="false"/> + </dia:attribute> + <dia:attribute name="subscale"> + <dia:real val="1"/> + </dia:attribute> + </dia:object> + <dia:object type="Flowchart - Box" version="0" id="O1"> + <dia:attribute name="obj_pos"> + <dia:point val="33,7"/> + </dia:attribute> + <dia:attribute name="obj_bb"> + <dia:rectangle val="32.95,6.95;41.05,11.05"/> + </dia:attribute> + <dia:attribute name="elem_corner"> + <dia:point val="33,7"/> + </dia:attribute> + <dia:attribute name="elem_width"> + <dia:real val="8"/> + </dia:attribute> + <dia:attribute name="elem_height"> + <dia:real val="4"/> + </dia:attribute> + <dia:attribute name="show_background"> + <dia:boolean val="true"/> + </dia:attribute> + <dia:attribute name="padding"> + <dia:real val="0.5"/> + </dia:attribute> + <dia:attribute name="text"> + <dia:composite type="text"> + <dia:attribute name="string"> + <dia:string>#gammu-smsd-inject#</dia:string> + </dia:attribute> + <dia:attribute name="font"> + <dia:font family="sans" style="0" name="Helvetica"/> + </dia:attribute> + <dia:attribute name="height"> + <dia:real val="0.80000000000000004"/> + </dia:attribute> + <dia:attribute name="pos"> + <dia:point val="37,9.18"/> + </dia:attribute> + <dia:attribute name="color"> + <dia:color val="#000000"/> + </dia:attribute> + <dia:attribute name="alignment"> + <dia:enum val="1"/> + </dia:attribute> + </dia:composite> + </dia:attribute> + </dia:object> + <dia:object type="Flowchart - Box" version="0" id="O2"> + <dia:attribute name="obj_pos"> + <dia:point val="4,15"/> + </dia:attribute> + <dia:attribute name="obj_bb"> + <dia:rectangle val="3.95,14.95;12.05,19.05"/> + </dia:attribute> + <dia:attribute name="elem_corner"> + <dia:point val="4,15"/> + </dia:attribute> + <dia:attribute name="elem_width"> + <dia:real val="8"/> + </dia:attribute> + <dia:attribute name="elem_height"> + <dia:real val="4"/> + </dia:attribute> + <dia:attribute name="show_background"> + <dia:boolean val="true"/> + </dia:attribute> + <dia:attribute name="padding"> + <dia:real val="0.5"/> + </dia:attribute> + <dia:attribute name="text"> + <dia:composite type="text"> + <dia:attribute name="string"> + <dia:string>#gammu-smsd#</dia:string> + </dia:attribute> + <dia:attribute name="font"> + <dia:font family="sans" style="0" name="Helvetica"/> + </dia:attribute> + <dia:attribute name="height"> + <dia:real val="0.80000000000000004"/> + </dia:attribute> + <dia:attribute name="pos"> + <dia:point val="8,17.18"/> + </dia:attribute> + <dia:attribute name="color"> + <dia:color val="#000000"/> + </dia:attribute> + <dia:attribute name="alignment"> + <dia:enum val="1"/> + </dia:attribute> + </dia:composite> + </dia:attribute> + </dia:object> + <dia:object type="Flowchart - Box" version="0" id="O3"> + <dia:attribute name="obj_pos"> + <dia:point val="4,7"/> + </dia:attribute> + <dia:attribute name="obj_bb"> + <dia:rectangle val="3.95,6.95;12.05,11.05"/> + </dia:attribute> + <dia:attribute name="elem_corner"> + <dia:point val="4,7"/> + </dia:attribute> + <dia:attribute name="elem_width"> + <dia:real val="8"/> + </dia:attribute> + <dia:attribute name="elem_height"> + <dia:real val="4"/> + </dia:attribute> + <dia:attribute name="show_background"> + <dia:boolean val="true"/> + </dia:attribute> + <dia:attribute name="padding"> + <dia:real val="0.5"/> + </dia:attribute> + <dia:attribute name="text"> + <dia:composite type="text"> + <dia:attribute name="string"> + <dia:string>#gammu-smsd-monitor#</dia:string> + </dia:attribute> + <dia:attribute name="font"> + <dia:font family="sans" style="0" name="Helvetica"/> + </dia:attribute> + <dia:attribute name="height"> + <dia:real val="0.80000000000000004"/> + </dia:attribute> + <dia:attribute name="pos"> + <dia:point val="8,9.18"/> + </dia:attribute> + <dia:attribute name="color"> + <dia:color val="#000000"/> + </dia:attribute> + <dia:attribute name="alignment"> + <dia:enum val="1"/> + </dia:attribute> + </dia:composite> + </dia:attribute> + </dia:object> + <dia:object type="Flowchart - Box" version="0" id="O4"> + <dia:attribute name="obj_pos"> + <dia:point val="33,15"/> + </dia:attribute> + <dia:attribute name="obj_bb"> + <dia:rectangle val="32.95,14.95;41.05,19.05"/> + </dia:attribute> + <dia:attribute name="elem_corner"> + <dia:point val="33,15"/> + </dia:attribute> + <dia:attribute name="elem_width"> + <dia:real val="8"/> + </dia:attribute> + <dia:attribute name="elem_height"> + <dia:real val="4"/> + </dia:attribute> + <dia:attribute name="border_width"> + <dia:real val="0.10000000149011612"/> + </dia:attribute> + <dia:attribute name="show_background"> + <dia:boolean val="true"/> + </dia:attribute> + <dia:attribute name="line_style"> + <dia:enum val="4"/> + </dia:attribute> + <dia:attribute name="padding"> + <dia:real val="0.5"/> + </dia:attribute> + <dia:attribute name="text"> + <dia:composite type="text"> + <dia:attribute name="string"> + <dia:string>#Kalkun +web frontend#</dia:string> + </dia:attribute> + <dia:attribute name="font"> + <dia:font family="sans" style="0" name="Helvetica"/> + </dia:attribute> + <dia:attribute name="height"> + <dia:real val="0.80000000000000004"/> + </dia:attribute> + <dia:attribute name="pos"> + <dia:point val="37,16.78"/> + </dia:attribute> + <dia:attribute name="color"> + <dia:color val="#000000"/> + </dia:attribute> + <dia:attribute name="alignment"> + <dia:enum val="1"/> + </dia:attribute> + </dia:composite> + </dia:attribute> + </dia:object> + <dia:object type="Standard - Line" version="0" id="O5"> + <dia:attribute name="obj_pos"> + <dia:point val="8,11"/> + </dia:attribute> + <dia:attribute name="obj_bb"> + <dia:rectangle val="7.6382,10.95;8.3618,15.05"/> + </dia:attribute> + <dia:attribute name="conn_endpoints"> + <dia:point val="8,11"/> + <dia:point val="8,15"/> + </dia:attribute> + <dia:attribute name="numcp"> + <dia:int val="1"/> + </dia:attribute> + <dia:attribute name="start_arrow"> + <dia:enum val="22"/> + </dia:attribute> + <dia:attribute name="start_arrow_length"> + <dia:real val="0.5"/> + </dia:attribute> + <dia:attribute name="start_arrow_width"> + <dia:real val="0.5"/> + </dia:attribute> + <dia:connections> + <dia:connection handle="0" to="O3" connection="13"/> + <dia:connection handle="1" to="O2" connection="2"/> + </dia:connections> + </dia:object> + <dia:object type="Standard - Line" version="0" id="O6"> + <dia:attribute name="obj_pos"> + <dia:point val="33,18"/> + </dia:attribute> + <dia:attribute name="obj_bb"> + <dia:rectangle val="24.95,17.6382;33.05,18.3618"/> + </dia:attribute> + <dia:attribute name="conn_endpoints"> + <dia:point val="33,18"/> + <dia:point val="25,18"/> + </dia:attribute> + <dia:attribute name="numcp"> + <dia:int val="1"/> + </dia:attribute> + <dia:attribute name="start_arrow"> + <dia:enum val="22"/> + </dia:attribute> + <dia:attribute name="start_arrow_length"> + <dia:real val="0.5"/> + </dia:attribute> + <dia:attribute name="start_arrow_width"> + <dia:real val="0.5"/> + </dia:attribute> + <dia:connections> + <dia:connection handle="0" to="O4" connection="9"/> + </dia:connections> + </dia:object> + <dia:object type="Standard - Line" version="0" id="O7"> + <dia:attribute name="obj_pos"> + <dia:point val="12,16"/> + </dia:attribute> + <dia:attribute name="obj_bb"> + <dia:rectangle val="11.95,15.6382;20.0637,16.3618"/> + </dia:attribute> + <dia:attribute name="conn_endpoints"> + <dia:point val="12,16"/> + <dia:point val="19.9519,16"/> + </dia:attribute> + <dia:attribute name="numcp"> + <dia:int val="1"/> + </dia:attribute> + <dia:attribute name="end_arrow"> + <dia:enum val="22"/> + </dia:attribute> + <dia:attribute name="end_arrow_length"> + <dia:real val="0.5"/> + </dia:attribute> + <dia:attribute name="end_arrow_width"> + <dia:real val="0.5"/> + </dia:attribute> + </dia:object> + <dia:object type="Standard - Line" version="0" id="O8"> + <dia:attribute name="obj_pos"> + <dia:point val="33,9"/> + </dia:attribute> + <dia:attribute name="obj_bb"> + <dia:rectangle val="23.907,8.93066;33.0693,15.0693"/> + </dia:attribute> + <dia:attribute name="conn_endpoints"> + <dia:point val="33,9"/> + <dia:point val="24,15"/> + </dia:attribute> + <dia:attribute name="numcp"> + <dia:int val="1"/> + </dia:attribute> + <dia:attribute name="end_arrow"> + <dia:enum val="22"/> + </dia:attribute> + <dia:attribute name="end_arrow_length"> + <dia:real val="0.5"/> + </dia:attribute> + <dia:attribute name="end_arrow_width"> + <dia:real val="0.5"/> + </dia:attribute> + <dia:connections> + <dia:connection handle="0" to="O1" connection="7"/> + </dia:connections> + </dia:object> + <dia:object type="Standard - Text" version="1" id="O9"> + <dia:attribute name="obj_pos"> + <dia:point val="25,15"/> + </dia:attribute> + <dia:attribute name="obj_bb"> + <dia:rectangle val="25,14.42;25,15.1375"/> + </dia:attribute> + <dia:attribute name="text"> + <dia:composite type="text"> + <dia:attribute name="string"> + <dia:string>##</dia:string> + </dia:attribute> + <dia:attribute name="font"> + <dia:font family="sans" style="0" name="Helvetica"/> + </dia:attribute> + <dia:attribute name="height"> + <dia:real val="0.80000000000000004"/> + </dia:attribute> + <dia:attribute name="pos"> + <dia:point val="25,15"/> + </dia:attribute> + <dia:attribute name="color"> + <dia:color val="#000000"/> + </dia:attribute> + <dia:attribute name="alignment"> + <dia:enum val="0"/> + </dia:attribute> + </dia:composite> + </dia:attribute> + <dia:attribute name="valign"> + <dia:enum val="3"/> + </dia:attribute> + </dia:object> + <dia:object type="Standard - Text" version="1" id="O10"> + <dia:attribute name="obj_pos"> + <dia:point val="27,11"/> + </dia:attribute> + <dia:attribute name="obj_bb"> + <dia:rectangle val="24.6887,10.2412;29.3113,11.7587"/> + </dia:attribute> + <dia:attribute name="text"> + <dia:composite type="text"> + <dia:attribute name="string"> + <dia:string>#Inject messages +to send#</dia:string> + </dia:attribute> + <dia:attribute name="font"> + <dia:font family="sans" style="0" name="Helvetica"/> + </dia:attribute> + <dia:attribute name="height"> + <dia:real val="0.80000000000000004"/> + </dia:attribute> + <dia:attribute name="pos"> + <dia:point val="27,10.8212"/> + </dia:attribute> + <dia:attribute name="color"> + <dia:color val="#000000"/> + </dia:attribute> + <dia:attribute name="alignment"> + <dia:enum val="1"/> + </dia:attribute> + </dia:composite> + </dia:attribute> + <dia:attribute name="valign"> + <dia:enum val="2"/> + </dia:attribute> + </dia:object> + <dia:object type="Standard - Text" version="1" id="O11"> + <dia:attribute name="obj_pos"> + <dia:point val="15.976,16"/> + </dia:attribute> + <dia:attribute name="obj_bb"> + <dia:rectangle val="13.9485,15.2412;18.0035,16.7587"/> + </dia:attribute> + <dia:attribute name="text"> + <dia:composite type="text"> + <dia:attribute name="string"> + <dia:string>#Save received +messages#</dia:string> + </dia:attribute> + <dia:attribute name="font"> + <dia:font family="sans" style="0" name="Helvetica"/> + </dia:attribute> + <dia:attribute name="height"> + <dia:real val="0.80000000000000004"/> + </dia:attribute> + <dia:attribute name="pos"> + <dia:point val="15.976,15.8212"/> + </dia:attribute> + <dia:attribute name="color"> + <dia:color val="#000000"/> + </dia:attribute> + <dia:attribute name="alignment"> + <dia:enum val="1"/> + </dia:attribute> + </dia:composite> + </dia:attribute> + <dia:attribute name="valign"> + <dia:enum val="2"/> + </dia:attribute> + <dia:connections> + <dia:connection handle="0" to="O7" connection="0"/> + </dia:connections> + </dia:object> + <dia:object type="Standard - Text" version="1" id="O12"> + <dia:attribute name="obj_pos"> + <dia:point val="15.976,18"/> + </dia:attribute> + <dia:attribute name="obj_bb"> + <dia:rectangle val="13.6648,17.2413;18.2873,18.7587"/> + </dia:attribute> + <dia:attribute name="text"> + <dia:composite type="text"> + <dia:attribute name="string"> + <dia:string>#Read messages +to send#</dia:string> + </dia:attribute> + <dia:attribute name="font"> + <dia:font family="sans" style="0" name="Helvetica"/> + </dia:attribute> + <dia:attribute name="height"> + <dia:real val="0.80000000000000004"/> + </dia:attribute> + <dia:attribute name="pos"> + <dia:point val="15.976,17.8212"/> + </dia:attribute> + <dia:attribute name="color"> + <dia:color val="#000000"/> + </dia:attribute> + <dia:attribute name="alignment"> + <dia:enum val="1"/> + </dia:attribute> + </dia:composite> + </dia:attribute> + <dia:attribute name="valign"> + <dia:enum val="2"/> + </dia:attribute> + <dia:connections> + <dia:connection handle="0" to="O16" connection="0"/> + </dia:connections> + </dia:object> + <dia:object type="Standard - Text" version="1" id="O13"> + <dia:attribute name="obj_pos"> + <dia:point val="9,13"/> + </dia:attribute> + <dia:attribute name="obj_bb"> + <dia:rectangle val="8.1475,12.2412;9.8525,13.7587"/> + </dia:attribute> + <dia:attribute name="text"> + <dia:composite type="text"> + <dia:attribute name="string"> + <dia:string>#Read +status#</dia:string> + </dia:attribute> + <dia:attribute name="font"> + <dia:font family="sans" style="0" name="Helvetica"/> + </dia:attribute> + <dia:attribute name="height"> + <dia:real val="0.80000000000000004"/> + </dia:attribute> + <dia:attribute name="pos"> + <dia:point val="9,12.8212"/> + </dia:attribute> + <dia:attribute name="color"> + <dia:color val="#000000"/> + </dia:attribute> + <dia:attribute name="alignment"> + <dia:enum val="1"/> + </dia:attribute> + </dia:composite> + </dia:attribute> + <dia:attribute name="valign"> + <dia:enum val="2"/> + </dia:attribute> + </dia:object> + <dia:object type="Standard - Text" version="1" id="O14"> + <dia:attribute name="obj_pos"> + <dia:point val="29,16"/> + </dia:attribute> + <dia:attribute name="obj_bb"> + <dia:rectangle val="26.6887,15.2412;31.3113,16.7587"/> + </dia:attribute> + <dia:attribute name="text"> + <dia:composite type="text"> + <dia:attribute name="string"> + <dia:string>#Inject messages +to send#</dia:string> + </dia:attribute> + <dia:attribute name="font"> + <dia:font family="sans" style="0" name="Helvetica"/> + </dia:attribute> + <dia:attribute name="height"> + <dia:real val="0.80000000000000004"/> + </dia:attribute> + <dia:attribute name="pos"> + <dia:point val="29,15.8212"/> + </dia:attribute> + <dia:attribute name="color"> + <dia:color val="#000000"/> + </dia:attribute> + <dia:attribute name="alignment"> + <dia:enum val="1"/> + </dia:attribute> + </dia:composite> + </dia:attribute> + <dia:attribute name="valign"> + <dia:enum val="2"/> + </dia:attribute> + <dia:connections> + <dia:connection handle="0" to="O17" connection="0"/> + </dia:connections> + </dia:object> + <dia:object type="Standard - Text" version="1" id="O15"> + <dia:attribute name="obj_pos"> + <dia:point val="29,18"/> + </dia:attribute> + <dia:attribute name="obj_bb"> + <dia:rectangle val="26.9387,17.2413;31.0613,18.7587"/> + </dia:attribute> + <dia:attribute name="text"> + <dia:composite type="text"> + <dia:attribute name="string"> + <dia:string>#Read received +messages#</dia:string> + </dia:attribute> + <dia:attribute name="font"> + <dia:font family="sans" style="0" name="Helvetica"/> + </dia:attribute> + <dia:attribute name="height"> + <dia:real val="0.80000000000000004"/> + </dia:attribute> + <dia:attribute name="pos"> + <dia:point val="29,17.8212"/> + </dia:attribute> + <dia:attribute name="color"> + <dia:color val="#000000"/> + </dia:attribute> + <dia:attribute name="alignment"> + <dia:enum val="1"/> + </dia:attribute> + </dia:composite> + </dia:attribute> + <dia:attribute name="valign"> + <dia:enum val="2"/> + </dia:attribute> + <dia:connections> + <dia:connection handle="0" to="O6" connection="0"/> + </dia:connections> + </dia:object> + <dia:object type="Standard - Line" version="0" id="O16"> + <dia:attribute name="obj_pos"> + <dia:point val="12,18"/> + </dia:attribute> + <dia:attribute name="obj_bb"> + <dia:rectangle val="11.95,17.6382;20.0019,18.3618"/> + </dia:attribute> + <dia:attribute name="conn_endpoints"> + <dia:point val="12,18"/> + <dia:point val="19.9519,18"/> + </dia:attribute> + <dia:attribute name="numcp"> + <dia:int val="1"/> + </dia:attribute> + <dia:attribute name="start_arrow"> + <dia:enum val="22"/> + </dia:attribute> + <dia:attribute name="start_arrow_length"> + <dia:real val="0.5"/> + </dia:attribute> + <dia:attribute name="start_arrow_width"> + <dia:real val="0.5"/> + </dia:attribute> + <dia:connections> + <dia:connection handle="0" to="O2" connection="10"/> + </dia:connections> + </dia:object> + <dia:object type="Standard - Line" version="0" id="O17"> + <dia:attribute name="obj_pos"> + <dia:point val="33,16"/> + </dia:attribute> + <dia:attribute name="obj_bb"> + <dia:rectangle val="24.8882,15.6382;33.05,16.3618"/> + </dia:attribute> + <dia:attribute name="conn_endpoints"> + <dia:point val="33,16"/> + <dia:point val="25,16"/> + </dia:attribute> + <dia:attribute name="numcp"> + <dia:int val="1"/> + </dia:attribute> + <dia:attribute name="end_arrow"> + <dia:enum val="22"/> + </dia:attribute> + <dia:attribute name="end_arrow_length"> + <dia:real val="0.5"/> + </dia:attribute> + <dia:attribute name="end_arrow_width"> + <dia:real val="0.5"/> + </dia:attribute> + <dia:connections> + <dia:connection handle="0" to="O4" connection="5"/> + </dia:connections> + </dia:object> + <dia:object type="Flowchart - Box" version="0" id="O18"> + <dia:attribute name="obj_pos"> + <dia:point val="4,23"/> + </dia:attribute> + <dia:attribute name="obj_bb"> + <dia:rectangle val="3.95,22.95;12.05,27.05"/> + </dia:attribute> + <dia:attribute name="elem_corner"> + <dia:point val="4,23"/> + </dia:attribute> + <dia:attribute name="elem_width"> + <dia:real val="8"/> + </dia:attribute> + <dia:attribute name="elem_height"> + <dia:real val="4"/> + </dia:attribute> + <dia:attribute name="border_width"> + <dia:real val="0.10000000149011612"/> + </dia:attribute> + <dia:attribute name="show_background"> + <dia:boolean val="true"/> + </dia:attribute> + <dia:attribute name="line_style"> + <dia:enum val="1"/> + </dia:attribute> + <dia:attribute name="dashlength"> + <dia:real val="0.29999999999999999"/> + </dia:attribute> + <dia:attribute name="padding"> + <dia:real val="0.5"/> + </dia:attribute> + <dia:attribute name="text"> + <dia:composite type="text"> + <dia:attribute name="string"> + <dia:string>#GSM +modem#</dia:string> + </dia:attribute> + <dia:attribute name="font"> + <dia:font family="sans" style="0" name="Helvetica"/> + </dia:attribute> + <dia:attribute name="height"> + <dia:real val="0.80000000000000004"/> + </dia:attribute> + <dia:attribute name="pos"> + <dia:point val="8,24.78"/> + </dia:attribute> + <dia:attribute name="color"> + <dia:color val="#000000"/> + </dia:attribute> + <dia:attribute name="alignment"> + <dia:enum val="1"/> + </dia:attribute> + </dia:composite> + </dia:attribute> + </dia:object> + <dia:object type="Standard - Line" version="0" id="O19"> + <dia:attribute name="obj_pos"> + <dia:point val="6,19"/> + </dia:attribute> + <dia:attribute name="obj_bb"> + <dia:rectangle val="5.6382,18.95;6.3618,23.1118"/> + </dia:attribute> + <dia:attribute name="conn_endpoints"> + <dia:point val="6,19"/> + <dia:point val="6,23"/> + </dia:attribute> + <dia:attribute name="numcp"> + <dia:int val="1"/> + </dia:attribute> + <dia:attribute name="end_arrow"> + <dia:enum val="22"/> + </dia:attribute> + <dia:attribute name="end_arrow_length"> + <dia:real val="0.5"/> + </dia:attribute> + <dia:attribute name="end_arrow_width"> + <dia:real val="0.5"/> + </dia:attribute> + <dia:connections> + <dia:connection handle="0" to="O2" connection="12"/> + <dia:connection handle="1" to="O18" connection="1"/> + </dia:connections> + </dia:object> + <dia:object type="Standard - Line" version="0" id="O20"> + <dia:attribute name="obj_pos"> + <dia:point val="10,23"/> + </dia:attribute> + <dia:attribute name="obj_bb"> + <dia:rectangle val="9.6382,18.8882;10.3618,23.05"/> + </dia:attribute> + <dia:attribute name="conn_endpoints"> + <dia:point val="10,23"/> + <dia:point val="10,19"/> + </dia:attribute> + <dia:attribute name="numcp"> + <dia:int val="1"/> + </dia:attribute> + <dia:attribute name="end_arrow"> + <dia:enum val="22"/> + </dia:attribute> + <dia:attribute name="end_arrow_length"> + <dia:real val="0.5"/> + </dia:attribute> + <dia:attribute name="end_arrow_width"> + <dia:real val="0.5"/> + </dia:attribute> + <dia:connections> + <dia:connection handle="0" to="O18" connection="3"/> + <dia:connection handle="1" to="O2" connection="14"/> + </dia:connections> + </dia:object> + <dia:object type="Standard - Text" version="1" id="O21"> + <dia:attribute name="obj_pos"> + <dia:point val="12,21"/> + </dia:attribute> + <dia:attribute name="obj_bb"> + <dia:rectangle val="10.5412,20.2143;13.4767,21.7857"/> + </dia:attribute> + <dia:attribute name="text"> + <dia:composite type="text"> + <dia:attribute name="string"> + <dia:string>#Incoming +messages#</dia:string> + </dia:attribute> + <dia:attribute name="font"> + <dia:font family="sans" style="0" name="Helvetica"/> + </dia:attribute> + <dia:attribute name="height"> + <dia:real val="0.80000000000000004"/> + </dia:attribute> + <dia:attribute name="pos"> + <dia:point val="12,20.8123"/> + </dia:attribute> + <dia:attribute name="color"> + <dia:color val="#000000"/> + </dia:attribute> + <dia:attribute name="alignment"> + <dia:enum val="1"/> + </dia:attribute> + </dia:composite> + </dia:attribute> + <dia:attribute name="valign"> + <dia:enum val="2"/> + </dia:attribute> + </dia:object> + <dia:object type="Standard - Text" version="1" id="O22"> + <dia:attribute name="obj_pos"> + <dia:point val="4,21"/> + </dia:attribute> + <dia:attribute name="obj_bb"> + <dia:rectangle val="2.54125,20.2143;5.47669,21.7857"/> + </dia:attribute> + <dia:attribute name="text"> + <dia:composite type="text"> + <dia:attribute name="string"> + <dia:string>#Outgoing +messages#</dia:string> + </dia:attribute> + <dia:attribute name="font"> + <dia:font family="sans" style="0" name="Helvetica"/> + </dia:attribute> + <dia:attribute name="height"> + <dia:real val="0.80000000000000004"/> + </dia:attribute> + <dia:attribute name="pos"> + <dia:point val="4,20.8123"/> + </dia:attribute> + <dia:attribute name="color"> + <dia:color val="#000000"/> + </dia:attribute> + <dia:attribute name="alignment"> + <dia:enum val="1"/> + </dia:attribute> + </dia:composite> + </dia:attribute> + <dia:attribute name="valign"> + <dia:enum val="2"/> + </dia:attribute> + </dia:object> + <dia:object type="Standard - Text" version="1" id="O23"> + <dia:attribute name="obj_pos"> + <dia:point val="37,17"/> + </dia:attribute> + <dia:attribute name="obj_bb"> + <dia:rectangle val="37,16.42;37,17.1375"/> + </dia:attribute> + <dia:attribute name="text"> + <dia:composite type="text"> + <dia:attribute name="string"> + <dia:string>##</dia:string> + </dia:attribute> + <dia:attribute name="font"> + <dia:font family="sans" style="0" name="Helvetica"/> + </dia:attribute> + <dia:attribute name="height"> + <dia:real val="0.80000000000000004"/> + </dia:attribute> + <dia:attribute name="pos"> + <dia:point val="37,17"/> + </dia:attribute> + <dia:attribute name="color"> + <dia:color val="#000000"/> + </dia:attribute> + <dia:attribute name="alignment"> + <dia:enum val="0"/> + </dia:attribute> + </dia:composite> + </dia:attribute> + <dia:attribute name="valign"> + <dia:enum val="3"/> + </dia:attribute> + <dia:connections> + <dia:connection handle="0" to="O4" connection="16"/> + </dia:connections> + </dia:object> + </dia:layer> +</dia:diagram> diff --git a/docs/develop/smsd/smsd-interactions.png b/docs/develop/smsd/smsd-interactions.png Binary files differnew file mode 100644 index 0000000..250af4a --- /dev/null +++ b/docs/develop/smsd/smsd-interactions.png diff --git a/docs/user/cs/gammu-smsd.1 b/docs/user/cs/gammu-smsd.1 index 10d90ae..604530b 100644 --- a/docs/user/cs/gammu-smsd.1 +++ b/docs/user/cs/gammu-smsd.1 @@ -32,9 +32,9 @@ Jaký konfigurační soubor se má použít, výchozí je /etc/gammu\-smsdrc, na systému Windows není žádná výchozí cesta a cesta ke konfiguračnímu souboru musí být zadána vždy. -If you run SMSD as a system daemon (or service), it is recommended to use -absolute path to log file as startup directory might be different than you -expect. +Pokud je SMSD spuštěn jako systémový démon (nebo služba), doporučujeme +používat absolutní cestu, protože adresář, kde bude program spuštěn se může +lišit od toho, co očekáváte. Dokumentace konfiguračního souboru je v gammu\-smsdrc(5). .TP @@ -190,14 +190,13 @@ služba. .SH "ZNÁMÁ OMEZENÍ" -You can not use same phone by more programs in same time. However in case -you did not enable locking in [gammu] section, it might be able to start the -communication with phone from more programs. In this case neither of the -programs will probably work. +Nemůžete použít telefon z více programů najednou. Nicméně pokud nezapnete +zamykání v sekci [gammu], může se stát, že se více programů pokusí s +telefonem komunikovat a žádný z nich nebude fungovat správně. -There is no way to detect that SMS message is reply to another by looking at -message headers. The only way to achieve this is to add some token to the -message and let the user include it in the message on reply. +Neexistuje žádný způsob jak poznat, že SMS zpráva je odpovědí na jinou podle +jejích hlaviček. Jediná spolehlivá metoda je přidat do zprávy nějaký text a +nechat ho uživatele opsat do odpovědi. .SH "DALŠÍ INFORMACE" gammu\-smsdrc(5), gammu(1), gammu\-smsd\-inject(1), gammu\-smsd\-monitor(1) @@ -208,8 +207,9 @@ gammu\-smsd\-files(7), gammu\-smsd\-mysql(7), gammu\-smsd\-pgsql(7), gammu\-smsd\-dbi(7), gammu\-smsd\-tables(7), gammu\-smsd\-null(7), gammu\-smsd\-run(7) -For web based frontend to SMSD database (currently only MySQL is being -supported), please check Kalkun \- <http://kalkun.sourceforge.net/>. +Pokud chcete spravovat databázi SMSD přes web (v současné době je +podporováno jen MySQL), mohl by vás zajímat projekt Kalkun \- +<http://kalkun.sourceforge.net/>. .SH AUTOR gammu\-smsd a tuto manuálovou stránku napsal Michal Čihař <michal@cihar.com>. diff --git a/docs/user/cs/gammu-smsdrc.5 b/docs/user/cs/gammu-smsdrc.5 index 620ba3a..d74ebc9 100644 --- a/docs/user/cs/gammu-smsdrc.5 +++ b/docs/user/cs/gammu-smsdrc.5 @@ -82,9 +82,9 @@ také použít speciální hodnotu "syslog", která zapne logování prostředni syslog démona. Na Windows je možné použít jinou speciální hodnotu "eventlog", při které budou záznamy posílány do Logu Událostí ve Windows. -If you run SMSD as a system daemon (or service), it is recommended to use -absolute path to log file as startup directory might be different than you -expect. +Pokud je SMSD spuštěn jako systémový démon (nebo služba), doporučujeme +používat absolutní cestu, protože adresář, kde bude program spuštěn se může +lišit od toho, co očekáváte. Výchozí stav je vypnuté logování. @@ -278,6 +278,17 @@ na každém řádku jedno číslo, prázdné řádky jsou ignorovány. Soubor je při startu a znovu načten je jen při znovunačtení konfigurace. Více podrobností v sekci Filtrování zpráv. +.TP +\fBBackendRetries\fP + +How many times will SMSD backend retry operation. + +The implementation on different backends is different, for database backends +it generally means how many times it will try to reconnect to the server. + +Default is 10. + + .SS "Parametry pro služby používající databázi" Všechny ze služeb DBI, MYSQL a PGSQL (viz gammu\-smsd\-mysql(7), diff --git a/docs/user/cs/gammu.1 b/docs/user/cs/gammu.1 index d1091e8..56cf329 100644 --- a/docs/user/cs/gammu.1 +++ b/docs/user/cs/gammu.1 @@ -199,19 +199,18 @@ formátování textu a další) \fBZprávy s logem pro Alcatel\fP -You need to ensure that the target phone supports message type you want to -send. Otherwise the phone will not be able to display it or will even crash, -because firmware of phone did not expect this possibility. +Je potřeba si předem zjistit, jestli telefon, kam zprávu posíláme, je +schopen ji zobrazit. Některé telefony obsahují chyby, že při přijetí +takovéto zprávy můžou havarovat. .TP \fBKódování znaků v textu SMS\fP Text v SMS zprávě může být zakódován dvěmi způsoby: -with \fBGSM Default Alphabet\fP \- in single SMS you can have maximally 160 -chars (Gammu doesn't support compressing such texts according to GSM -standards, but it isn't big limit, because there are no phones supporting -them), but they're from limited set: +při použití \fBGSM Default Alphabet\fP \- v jedné zprávě může být až 160 znaků +(Gammu nepodporuje kompresi podle GSM standardů, protože ji nepodporuje ani +většina telefonů), ale znaky jsou omezeny na: * všechny písmena latinky, malá i velká @@ -225,9 +224,9 @@ them), but they're from limited set: * pár dalších -with \fBUnicode\fP \- in single SMS you can save at most 70 chars, but these can -be any chars including all national and special ones. Please note, that some -older phones might have problems displaying such message. +při použití \fBUnicode\fP \- v jedné zprávě může být nejvýše 70 znaků, ale může +se jednat o libovolné Unicode znaky. Některé starší telefony můžou mít +problém se zobraznením takovéto zprávy. Gammu tries to do the best to handle non ASCII characters in your message. Everything is internally handled in Unicode (the input is converted @@ -418,8 +417,8 @@ jedné nebo více zpráv za tímto parametrem budou "chráběna" (v telefonech podporující standard ODI jako například SonyEricsson je nebude možné přeposlat) -\fB\-16bit\fP \- Gammu uses SMS headers with 16\-bit numbers for saving linking -info in SMS (it means less chars available for user in each SMS) +\fB\-16bit\fP \- Gammu použije 16\-bitová čísla pro identifikaci zpráv, což +znamená méně místa pro vlastní text ve zprávě \fB\-format\fP lcrasbiut \- poslední část textu bude naformátována. Můžete použít následující znaky: l \- zarovnané vlevo @@ -567,8 +566,8 @@ oznámí přijetí nové zprávy. Text bude zkrácen na 1 sms. \fB\-textutf8\fP \- načte text v UTF\-8 z příkazové řádky místo standardního vstupu. -\fB\-16bit\fP \- Gammu uses SMS headers with 16\-bit numbers for saving linking -info in SMS (it means less chars available for user in each SMS) +\fB\-16bit\fP \- Gammu použije 16\-bitová čísla pro identifikaci zpráv, což +znamená méně místa pro vlastní text ve zprávě \fITIP:\fP Soubor v Unicode můžete na Windows vytvořit například pomocí WordPadu (zvolte volbu "Uložit jako unicode text"). Na Linuxu můžete použít @@ -1114,8 +1113,8 @@ These options are mainly (there are few expections) for monochromatic logos and images available in older phones. Recognized file formats: xpm (only saving), 2\-colors bmp, nlm, nsl, ngg, nol, wbmp, gif (for Samsung). -In new models all bitmaps are saved in filesystem and should go into -filesystem section +V současných telefonech jsou obrázky ukládány jakou soubory a je potřeba k +nim i tak přistupovat. .TP \fBcopybitmap\fP\fI inputfile [outputfile [OPERATOR|PICTURE|STARTUP|CALLER]]\fP @@ -1684,8 +1683,8 @@ sendsms a savesms\fP. \fBgetallnotes\fP Zobrazí všechny poznámky z telefonu. -Note: Not all phones supports this function, especially most Sony Ericsson -phones even if they have notes inside phone. +Poznámka: Ne všechny telefony toto podporují, i když funkci poznámek +obsahují (například Sony\-Ericsson). .SS "Čas, datum a budíky" @@ -2005,25 +2004,25 @@ Získá ze zadané pozice v telefonu zvukovou nahrávku a uloží ji do souboru WAV. Soubor je komprimován pomocí kodeku GSM 6.10. Jeho jméno je stejné jako je v telefonu. -Created WAV files require GSM 6.10 codec to be played. In Win XP it's -included by Microsoft. If you deleted it by accident in this operating -system, make such steps: +Pro přehrání vytvořeného souboru WAV potřebujete kodek GSM 6.10. Ve Windows +XP je již obsažen, pokud jste ho omylem odstranili, použijte následující +postup:: -1. Control Panel +1. Ovládací panel .br -2. Add hardware +2. Přidat hardware .br -3. click Next +3. klikněte na Další .br -4. select "Yes. I have already connected the hardware" +4. zvolte "Ano, hardware už je připojený" .br -5. select "Add a new hardware device" +5. zvolte "Přidat nové zařízení" .br -6. select "Install the hardware that I manually select from a list" +6. zvolte "Instalovat ovladač který zvolím ze seznamu" .br -7. select "Sound, video and game controllers" +7. zvolte "Ovladače zvuku, videa a her" .br -8. select "Audio codecs" +8. zvolte "Kodeky zvuku" .br 9. select "windows\esystem32" directory and file "mmdriver.inf" .br @@ -2647,25 +2646,25 @@ Získá ze zadané pozice v telefonu zvukovou nahrávku a uloží ji do souboru WAV. Soubor je komprimován pomocí kodeku GSM 6.10. Jeho jméno je stejné jako je v telefonu. -Created WAV files require GSM 6.10 codec to be played. In Win XP it's -included by Microsoft. If you deleted it by accident in this operating -system, make such steps: +Pro přehrání vytvořeného souboru WAV potřebujete kodek GSM 6.10. Ve Windows +XP je již obsažen, pokud jste ho omylem odstranili, použijte následující +postup:: -1. Control Panel +1. Ovládací panel .br -2. Add hardware +2. Přidat hardware .br -3. click Next +3. klikněte na Další .br -4. select "Yes. I have already connected the hardware" +4. zvolte "Ano, hardware už je připojený" .br -5. select "Add a new hardware device" +5. zvolte "Přidat nové zařízení" .br -6. select "Install the hardware that I manually select from a list" +6. zvolte "Instalovat ovladač který zvolím ze seznamu" .br -7. select "Sound, video and game controllers" +7. zvolte "Ovladače zvuku, videa a her" .br -8. select "Audio codecs" +8. zvolte "Kodeky zvuku" .br 9. select "windows\esystem32" directory and file "mmdriver.inf" .br diff --git a/docs/user/cs/gammurc.5 b/docs/user/cs/gammurc.5 index 8f50aaa..9c25c59 100644 --- a/docs/user/cs/gammurc.5 +++ b/docs/user/cs/gammurc.5 @@ -95,7 +95,7 @@ použitelné pro většinu telefonů. \fBbluerfgnapbus\fP \- připojení k GNappletu běžícím na telefonech se Symbianem. .TP -\fBPort\fP +\fBDevice\fP Zařízení kde je přístupný telefon nebo adresa telefonu, záleží na typu připojení. @@ -123,6 +123,11 @@ zapnout objevování zařízení (tyto příkazy musíte spouštět jako root): sysctl net.irda.discovery=1 .TP +\fBPort\fP + +Stejné jako Device, zachováno kvůli zpětné kompatibilitě. + +.TP \fBModel\fP Nepoužívejte tento parametr, pokud to není opravdu nutné! Jediná situace, @@ -224,7 +229,7 @@ Konfigurace Gammu pro telefon Nokia připojený kabelem DLR\-3: .nf .ne 7 [gammu] -port = /dev/ttyACM0 +device = /dev/ttyACM0 connection = dlr3 .fi .sp @@ -239,7 +244,7 @@ příkazy) připojený pomocí USB kabelu: .nf .ne 7 [gammu] -port = /dev/ttyACM0 +device = /dev/ttyACM0 connection = at .fi .sp @@ -254,7 +259,7 @@ příkazy) připojený pomocí Bluetooth: .nf .ne 7 [gammu] -port = B0:0B:00:00:FA:CE +device = B0:0B:00:00:FA:CE connection = blueat .fi .sp @@ -269,7 +274,7 @@ kanálu 42: .nf .ne 7 [gammu] -port = B0:0B:00:00:FA:CE/42 +device = B0:0B:00:00:FA:CE/42 connection = blueat .fi .sp @@ -278,25 +283,24 @@ connection = blueat .SS "Práce s více telefony" -Gammu can be configured for multiple phones (however only one connection is -used at one time, you can choose which one to use with \-\-section -parameter). Configuration for phones on three serial ports would look like -following: +Gammu může být nastaveno pro práci s více telefony najedou (ale jen jedno +připojení v jeden okamžik, to zvolíte parametrem \-\-section). Nastavení +telefonů na třech sériových portech by vypadalo následovně: .RS .sp .nf .ne 7 [gammu] -port = /dev/ttyS0 +device = /dev/ttyS0 connection = at [gammmu1] -port = /dev/ttyS1 +device = /dev/ttyS1 connection = at [gammmu2] -port = /dev/ttyS2 +device = /dev/ttyS2 connection = at .fi .sp diff --git a/docs/user/gammu-smsdrc.5 b/docs/user/gammu-smsdrc.5 index 6e0ed60..f77efa7 100644 --- a/docs/user/gammu-smsdrc.5 +++ b/docs/user/gammu-smsdrc.5 @@ -274,6 +274,17 @@ contains one number per line, blank lines are ignored. The file is read at startup and is reread only when configuration is being reread. See Message filtering for details. +.TP +.BI BackendRetries + +How many times will SMSD backend retry operation. + +The implementation on different backends is different, for database backends +it generally means how many times it will try to reconnect to the server. + +Default is 10. + + .SS Database backends options All DBI, MYSQL and PGSQL backends (see gammu\-smsd\-mysql(7), diff --git a/docs/user/gammurc.5 b/docs/user/gammurc.5 index bcb0b21..12ff212 100644 --- a/docs/user/gammurc.5 +++ b/docs/user/gammurc.5 @@ -86,7 +86,7 @@ For Bluetooth connection use one of following: \fBbluerfgnapbus\fR - GNapplet based connection for Symbian phones .TP -.BI Port +.BI Device Device node or address of phone. It depends on used connection. @@ -113,6 +113,11 @@ enable discovery (you need to run these commands as root): sysctl net.irda.discovery=1 .TP +.BI Port + +Alias for Device, kept for backward compatibility. + +.TP .BI Model Do not use this parameter unless really needed! The only use case for this is @@ -214,7 +219,7 @@ Gammu configuration for Nokia phone using DLR-3 cable: .nf .ne 7 [gammu] -port = /dev/ttyACM0 +device = /dev/ttyACM0 connection = dlr3 .fi .sp @@ -229,7 +234,7 @@ phone) connected using USB cable: .nf .ne 7 [gammu] -port = /dev/ttyACM0 +device = /dev/ttyACM0 connection = at .fi .sp @@ -244,7 +249,7 @@ phone) connected using bluetooth: .nf .ne 7 [gammu] -port = B0:0B:00:00:FA:CE +device = B0:0B:00:00:FA:CE connection = blueat .fi .sp @@ -258,7 +263,7 @@ Gammu configuration for phone which needs to manually adjust Bluetooth channel t .nf .ne 7 [gammu] -port = B0:0B:00:00:FA:CE/42 +device = B0:0B:00:00:FA:CE/42 connection = blueat .fi .sp @@ -277,15 +282,15 @@ like following: .nf .ne 7 [gammu] -port = /dev/ttyS0 +device = /dev/ttyS0 connection = at [gammmu1] -port = /dev/ttyS1 +device = /dev/ttyS1 connection = at [gammmu2] -port = /dev/ttyS2 +device = /dev/ttyS2 connection = at .fi .sp |
