WikiStart

Version 353 (Adrian Georgescu, 01/10/2009 11:06 am)

1 298 Adrian Georgescu
= Description =
2 95 Ruud Klaver
3 292 Adrian Georgescu
[[Image(htdocs:SIPSIMPLE-client.png, align=right, nolink)]]
4 346 Adrian Georgescu
SIP SIMPLE client is Python software library built on top of PJSIP that
5 346 Adrian Georgescu
together with middleware allows for easy development of Client/Server and
6 346 Adrian Georgescu
Peer-to-Peer Internet communications end-points based on SIP SIMPLE family
7 346 Adrian Georgescu
of protocols for voice, video, presence, instant messaging (IM) and file
8 346 Adrian Georgescu
transfer capabilities.
9 1
10 347 Adrian Georgescu
The software is provided under the [source:LICENSE GPL LICENSE] 
11 347 Adrian Georgescu
12 346 Adrian Georgescu
The goal of this project is to deliver the best open source Python library
13 346 Adrian Georgescu
for rich featured SIP end-points, while hiding the complex underlying
14 346 Adrian Georgescu
functionality behind an easy to use high-level application-programming
15 346 Adrian Georgescu
interface. This package supports to the SDP negotiation, audio codecs and
16 346 Adrian Georgescu
NAT traversal functionality provided by PJSIP and will thus deliver rich
17 346 Adrian Georgescu
communications combining instant messaging (IM), voice and video streams. It
18 346 Adrian Georgescu
also supports file transfer and multi-party chat sessions using MSRP
19 346 Adrian Georgescu
protocol, publication and subscription for rich presence information such as
20 346 Adrian Georgescu
availability, moods, activities and geo-location, management for presence
21 346 Adrian Georgescu
rules, resource lists, RLS services using XCAP protocol.
22 1
23 346 Adrian Georgescu
== Background ==
24 346 Adrian Georgescu
25 346 Adrian Georgescu
SIP stands for 'Sessions Initiation Protocol', an IETF standard described by
26 348 Adrian Georgescu
[http://tools.ietf.org/html/rfc3261 RFC 3261]. SIP is an application-layer control protocol that can establish,
27 346 Adrian Georgescu
modify and terminate multimedia sessions such as Internet telephony calls
28 346 Adrian Georgescu
(VoIP). Media can be added to (and removed from) an existing session.
29 346 Adrian Georgescu
30 346 Adrian Georgescu
SIP transparently supports name mapping and redirection services, which
31 346 Adrian Georgescu
supports personal mobility, users can maintain a single externally visible
32 346 Adrian Georgescu
address identifier, which can be in the form of a standard email address or
33 346 Adrian Georgescu
E.164 telephone number regardless of their physical network location.
34 346 Adrian Georgescu
35 346 Adrian Georgescu
SIP allows the endpoints to negotiate and combine any type of session they
36 346 Adrian Georgescu
mutually understand like video, instant messaging (IM), file transfer,
37 346 Adrian Georgescu
desktop sharing and provides a generic event notification system with
38 346 Adrian Georgescu
real-time publications and subscriptions about state changes that can be
39 346 Adrian Georgescu
used for asynchronous services like presence, message waiting indicator and
40 346 Adrian Georgescu
busy line appearance.
41 331 Adrian Georgescu
42 1
== Features ==
43 1
44 350 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. 
45 350 Adrian Georgescu
46 345 Adrian Georgescu
As a library with a high-level [wiki:PyPJUADesign API], the toolkit can be used to add voice, IM
47 344 Adrian Georgescu
and Presence functionality to any network devices as long as Python/C
48 344 Adrian Georgescu
environment is supported by such platform.
49 344 Adrian Georgescu
50 344 Adrian Georgescu
Additional to the SIP standards implemented by the underlying PJSIP library,
51 344 Adrian Georgescu
this project implements:
52 344 Adrian Georgescu
53 344 Adrian Georgescu
 * XCAP protocol [http://www.tools.ietf.org/html/rfc4825 RFC4825]
54 344 Adrian Georgescu
 * MSRP protocol [http://tools.ietf.org/html/rfc4975 RFC4975]
55 344 Adrian Georgescu
 * MSRP protocol relay extension [http://tools.ietf.org/html/rfc4976 RFC4976]
56 344 Adrian Georgescu
 * Rich Presence Information Data model and Format (RPIDF) [http://tools.ietf.org/html/rfc3856 RFC3856], [http://tools.ietf.org/html/rfc3863 RFC3863 ], [http://tools.ietf.org/html/rfc4479 RFC4479]
57 344 Adrian Georgescu
 * XCAP-diff event package [http://www.ietf.org/internet-drafts/draft-ietf-simple-xcap-diff-09.txt draft-ietf-simple-xcap-diff-09]
58 344 Adrian Georgescu
 * Watcher-info [http://tools.ietf.org/html/rfc3857 RFC3857], [http://tools.ietf.org/html/rfc3858 RFC3858]
59 344 Adrian Georgescu
 * Conference [http://tools.ietf.org/html/rfc4575 RFC4575]
60 344 Adrian Georgescu
 * Message summary [http://tools.ietf.org/html/rfc3842 RFC3842]
61 344 Adrian Georgescu
 * Presence rules [http://www.tools.ietf.org/html/rfc5025 RFC5025]
62 344 Adrian Georgescu
 * Resource-lists and RLS-services [http://www.tools.ietf.org/html/rfc4826 RFC4826]
63 344 Adrian Georgescu
 * PIDF manipulation [http://www.tools.ietf.org/html/rfc4827 RFC4827]
64 344 Adrian Georgescu
 * Bonjour multicast DNS [http://www.ietf.org/internet-drafts/draft-lee-sip-dns-sd-uri-03.txt draft-lee-sip-dns-sd-uri-03]
65 344 Adrian Georgescu
 * Locating SIP services [http://tools.ietf.org/html/rfc3263 RFC3263]
66 344 Adrian Georgescu
 * MSRP ad-hoc multi-party chat sessions [http://tools.ietf.org/html/draft-ietf-simple-chat-03 draft-ietf-simple-chat-03]
67 344 Adrian Georgescu
68 299 Adrian Georgescu
== Installation ==
69 1
70 352 Adrian Georgescu
SIP SIMPLE client [wiki:Installation installation guide].
71 1
72 353 Adrian Georgescu
== Documentation ==
73 353 Adrian Georgescu
74 353 Adrian Georgescu
 * SIP library [wiki:PyPJUADesign API] documentation
75 353 Adrian Georgescu
 * [wiki:MiddlewareDesign Middleware design]
76 353 Adrian Georgescu
77 349 Adrian Georgescu
== Testing ==
78 349 Adrian Georgescu
 
79 299 Adrian Georgescu
SIP SIMPLE client is closely developed together with and tested against the most popular SIP SIMPLE server software available today: [http://opensips.org OpenSIPS], [http://openxcap.org OpenXCAP] and [http://msrprelay.org MSRPRelay]. Included with the library, a set of command line tools are available for setting up audio, Instant Messaging and file transfer sessions, publish and subscribe to presence or other type of events. 
80 1
81 329 Adrian Georgescu
 * [wiki:sip_register sip_register] - REGISTER a SIP end-point with a SIP Registrar
82 329 Adrian Georgescu
 * [wiki:sip_rtp_audio_session sip_audio_session] - Setup a voice audio session (Voice over IP)
83 339 Adrian Georgescu
 * [wiki:sip_msrp_im_session sip_im_session] - Setup IM session and File transfer using MSRP protocol
84 235 Adrian Georgescu
 * [wiki:sip_message sip_message] - Send/receive text in page mode using SIP MESSAGE method
85 317 Adrian Georgescu
 * [wiki:sip_publish_presence sip_publish_presence] - PUBLISH presence to a SIP Presence Agent
86 235 Adrian Georgescu
 * [wiki:sip_subscribe_presence sip_subscribe_presence]  - SUBSCRIBE to presence information
87 311 Adrian Georgescu
 * [wiki:sip_subscribe_winfo sip_subscribe_winfo] - SUBSCRIBE to watcher list on a SIP Presence Agent
88 235 Adrian Georgescu
 * [wiki:sip_subscribe_rls sip_subscribe_rls] - SUBSCRIBE to lists managed by Resource List Server
89 235 Adrian Georgescu
 * [wiki:xcapclient xcapclient] - PUT/GET/DELETE full or partial documents on an XCAP server
90 338 Adrian Georgescu
 * [wiki:xcap_pres_rules xcap_pres_rules] - Manage content of pres-rules XCAP document
91 235 Adrian Georgescu
 * [wiki:xcap_rls_services] - Manage content of RLS services XCAP document
92 311 Adrian Georgescu
93 235 Adrian Georgescu
== Support ==
94 235 Adrian Georgescu
95 351 Adrian Georgescu
The project is developed and supported by [http://ag-projects.com AG Projects] via the wiki collaboration system available at http://sipsimpleclient.com. To request support you must open a ticket. To open ticket please [/register Register] first. The source browser and ticketing system are available only for registered users. 
96 191 Adrian Georgescu
97 202 Adrian Georgescu
If you wish to contribute and become an active developer of this project, send your request by email to pypjua-devel@ag-projects.com.