WikiStart
Version 189 (Adrian Georgescu, 10/19/2008 12:07 pm)
1 | 133 | Adrian Georgescu | [[Image(htdocs:SIPUA-design-70.png, align=right, link=wiki:SIPUADesign)]] |
---|---|---|---|
2 | 96 | Ruud Klaver | |
3 | 189 | Adrian Georgescu | == Description == |
4 | 95 | Ruud Klaver | |
5 | 187 | Adrian Georgescu | SipClient is Python software library built on top of PJSIP that together |
6 | 187 | Adrian Georgescu | with an elegant middleware allows for easy development of real-time |
7 | 187 | Adrian Georgescu | communications Internet end-points based on SIP protocol with rich Presence, |
8 | 187 | Adrian Georgescu | Interactive Messaging (IM) and File Transfer capabilities. |
9 | 1 | ||
10 | 1 | ||
11 | 1 | == Deliverables == |
|
12 | 1 | ||
13 | 187 | Adrian Georgescu | The goal of this project is to deliver the best Python based Open Source |
14 | 187 | Adrian Georgescu | development kit for rich featured SIP User Agents, while hiding the complex |
15 | 187 | Adrian Georgescu | underlying functionality behind an easy to use high-level application |
16 | 187 | Adrian Georgescu | programming interface. Compared to other available SIP libraries, this |
17 | 187 | Adrian Georgescu | project provides session based Interactive Messaging (IM) using MSRP |
18 | 187 | Adrian Georgescu | protocol, multiple streams support and 'the missing' SIP-SIMPLE features for |
19 | 187 | Adrian Georgescu | rich presence: presence rules, resource lists, RLS services, rich PIDF and |
20 | 187 | Adrian Georgescu | XCAP policy. |
21 | 1 | ||
22 | 187 | Adrian Georgescu | The software library is tested against the most popular SIP server software available today: [http://opensips.org OpenSIPs], [http://asterisk.org Asterisk], [http://openxcap.org OpenXCAP], [http://msrprelay.org MSRPRelay] and [http://mediaproxy-ng.org MediaProxy]. |
23 | 187 | Adrian Georgescu | |
24 | 187 | Adrian Georgescu | Several [wiki:testscripts command line tools] are available for setting up real time voice, IM |
25 | 187 | Adrian Georgescu | and file transfer sessions, publish and subscribe to presence or other type |
26 | 187 | Adrian Georgescu | of events: |
27 | 187 | Adrian Georgescu | |
28 | 188 | Adrian Georgescu | * sip_register - REGISTER a SIP end-point with a SIP REGISTRAR |
29 | 188 | Adrian Georgescu | * sip_rtp_audio_session - Setup a voice audio session (VoIP) |
30 | 188 | Adrian Georgescu | * sip_msrp_im_session - Setup an IM session using MSRP protocol |
31 | 188 | Adrian Georgescu | * sip_msrp_file_transfer - File Transfer session using MSRP protocol |
32 | 188 | Adrian Georgescu | * sip_message - Send text message in page mode using MESSAGE method |
33 | 188 | Adrian Georgescu | * sip_publish_presence - PUBLISH presence to a SIP Presence Agent |
34 | 188 | Adrian Georgescu | * sip_subscribe_presence - SUBSCRIBE to presence information |
35 | 188 | Adrian Georgescu | * sip_subscribe_winfo - SUBSCRIBE to watcher list on a SIP Presence Agent |
36 | 188 | Adrian Georgescu | * sip_subscribe_rls - SUBSCRIBE to lists managed by Resource List Server |
37 | 1 | ||
38 | 182 | Adrian Georgescu | == INSTALL procedure == |
39 | 182 | Adrian Georgescu | |
40 | 182 | Adrian Georgescu | The software has been tested on Linux Debian and MacOSX 10.5 (Leopard). |
41 | 123 | Adrian Georgescu | |
42 | 180 | Adrian Georgescu | For people running Debian testing or unstable on an i386 architecture there is an official public repository provided by AG Projects. Install the AG Projects debian software signing key: |
43 | 1 | ||
44 | 180 | Adrian Georgescu | {{{ |
45 | 180 | Adrian Georgescu | wget http://download.ag-projects.com/agp-debian-gpg.key |
46 | 180 | Adrian Georgescu | apt-key add agp-debian-gpg.key |
47 | 180 | Adrian Georgescu | }}} |
48 | 180 | Adrian Georgescu | |
49 | 180 | Adrian Georgescu | Add the following lines to /etc/apt/sources.list |
50 | 180 | Adrian Georgescu | |
51 | 180 | Adrian Georgescu | {{{ |
52 | 180 | Adrian Georgescu | # AG Projects software |
53 | 180 | Adrian Georgescu | deb http://ag-projects.com/debian unstable main |
54 | 180 | Adrian Georgescu | deb-src http://ag-projects.com/debian unstable main |
55 | 180 | Adrian Georgescu | }}} |
56 | 180 | Adrian Georgescu | |
57 | 184 | Adrian Georgescu | Update the list of available software and install the software: |
58 | 180 | Adrian Georgescu | |
59 | 180 | Adrian Georgescu | {{{ |
60 | 181 | Adrian Georgescu | apt-get update |
61 | 181 | Adrian Georgescu | apt-get install sipclient |
62 | 181 | Adrian Georgescu | }}} |
63 | 181 | Adrian Georgescu | |
64 | 184 | Adrian Georgescu | For other distributions or to obtain the source code go to: |
65 | 180 | Adrian Georgescu | |
66 | 183 | Adrian Georgescu | [http://download.ag-projects.com/SipClient/ http://download.ag-projects.com/SipClient/] |
67 | 180 | Adrian Georgescu | |
68 | 181 | Adrian Georgescu | To obtain access to the version controlled software repository: |
69 | 181 | Adrian Georgescu | |
70 | 181 | Adrian Georgescu | darcs get http://devel.ag-projects.com/repositories/pypjua |
71 | 123 | Adrian Georgescu | |
72 | 111 | Adrian Georgescu | == End-user experiences == |
73 | 1 | ||
74 | 179 | Adrian Georgescu | The software allows you to create elegant real-time communications applications without having to read [http://www.rfc3261.net the +1200 RFC documents] behind it. |
75 | 1 | ||
76 | 157 | Adrian Georgescu | ''If you read them all, some antidepressant and desintoxication is recommended after this effort.'' |
77 | 123 | Adrian Georgescu | |
78 | 123 | Adrian Georgescu | As a library with a high-level API, the toolkit can also be used to add SIP and Presence functionality to network devices without a display (like TV set-up boxes), as long as Python environment is supported by such platform. You may collapse the whole telecom industry into a simple ''Call me'' button or expand the presence buddy list to display the mood or blood pressure of your buddies (if they want to share this information with you). Some of the things possible with this library are listed here: |
79 | 123 | Adrian Georgescu | |
80 | 147 | Adrian Georgescu | * VoIP calls using Internet codecs (wide-band Speex, iLBC) and G.711 |
81 | 1 | * Zero configuration server-less communication over LAN (Bonjour) |
|
82 | 169 | Adrian Georgescu | * Parallel forking to multiple SIP devices |
83 | 1 | * Presence using SIP SIMPLE (PUBLISH, SUBSCRIBE, NOTIFY and XCAP policy) |
|
84 | 111 | Adrian Georgescu | * Interactive Messaging (IM) and File transfer using MSRP protocol |
85 | 169 | Adrian Georgescu | * Desktop sharing |
86 | 169 | Adrian Georgescu | * Video calls |
87 | 1 | ||
88 | 147 | Adrian Georgescu | == Testing the library == |
89 | 34 | Adrian Georgescu | |
90 | 176 | Adrian Georgescu | Besides the Python software library itself, the repository contains ready to use fully featured [wiki:testscripts command-line examples scripts] that can be used to: |
91 | 1 | ||
92 | 176 | Adrian Georgescu | * Register SIP end-points |
93 | 176 | Adrian Georgescu | * Setup up VoIP sessions |
94 | 176 | Adrian Georgescu | * Setup Interactive Messaging (IM) and file-transfer ([http://tools.ietf.org/html/rfc4975 MSRP sessions]) with or without support from a [http://tools.ietf.org/html/rfc4976 MSRP relay] |
95 | 177 | Adrian Georgescu | * Simulate SIP SIMPLE end-points: [http://tools.ietf.org/html/rfc3903 PUBLISH], SUBSCRIBE, NOTIFY for [http://tools.ietf.org/html/rfc3265 SIP events], presence data model and format ([http://tools.ietf.org/html/rfc3856 RFC3856], [http://tools.ietf.org/html/rfc3863 RFC3863 ], [http://tools.ietf.org/html/rfc4479 RFC4479]), [http://www.ietf.org/internet-drafts/draft-ietf-simple-xcap-diff-09.txt xcap-diff], watcher-info ([http://tools.ietf.org/html/rfc3857 RFC3857],[http://tools.ietf.org/html/rfc3858 RFC3858] ), [http://tools.ietf.org/html/rfc4575 conference], [http://tools.ietf.org/html/rfc3842 message-summary] |
96 | 147 | Adrian Georgescu | * Manage [http://www.tools.ietf.org/html/rfc4825 XCAP] documents [http://www.tools.ietf.org/html/rfc5025 pres-rules], [http://www.tools.ietf.org/html/rfc4826 resource-lists, rls-services] and [http://www.tools.ietf.org/html/rfc4827 pidf-manipulation] |
97 | 148 | Adrian Georgescu | * Lookup of SIP buddies using [http://www.tech-invite.com/SIPWGs/01-WG-SIP/Idrafts/draft-lee-sip-dns-sd-uri-02.txt Bonjour] (LAN broadcast), [http://tools.ietf.org/html/rfc3263 RFC 3263] (Locating SIP Services) |
98 | 151 | Adrian Georgescu | * Setup up [http://tools.ietf.org/html/draft-ietf-simple-chat-02 ad-hoc multi-party chat sessions] with an MSRP chat server (under construction) |
99 | 33 | Adrian Georgescu | |
100 | 162 | Adrian Georgescu | For testing, you can use your own infrastructure or register a free SIP SIMPLE account on [http://sip2sip.info http://SIP2SIP.info] |
101 | 103 | Adrian Georgescu | |
102 | 93 | Adrian Georgescu | == License == |
103 | 82 | Adrian Georgescu | |
104 | 62 | Adrian Georgescu | The software is provided under the [source:LICENSE GPL LICENSE] |
105 | 62 | Adrian Georgescu | |
106 | 62 | Adrian Georgescu | |
107 | 166 | Adrian Georgescu | == Contributing == |
108 | 1 | ||
109 | 170 | Adrian Georgescu | We are looking for contributions related to DHT overlay (P2PSIP), desktop sharing, video sessions and real time text using RTP [http://www.ietf.org/rfc/rfc4103.txt ToIP (RFC 4103)]. |
110 | 103 | Adrian Georgescu | |
111 | 170 | Adrian Georgescu | If you wish to become an active developer of this project, send your request by email to [mailto:pypjua-devel@ag-projects.com pypjua-devel@ag-projects.com]. |