[PATCH] Document the SS control string API

[PATCH] Document the SS control string API

[Alexander Kanavin]

[-- Attachment #1: Type: text/plain, Size: 3981 bytes --]

---
 doc/supplementaryservices-api.txt |   95 +++++++++++++++++++++++++++++++++++-
 1 files changed, 92 insertions(+), 3 deletions(-)

diff --git a/doc/supplementaryservices-api.txt b/doc/supplementaryservices-api.txt
index 5ef123e..d80770a 100644
--- a/doc/supplementaryservices-api.txt
+++ b/doc/supplementaryservices-api.txt
@@ -7,15 +7,104 @@ Object path	[variable prefix]/{modem0,modem1,...}
 
 Methods		string, variant Initiate(string command)
 
-			Sends a USSD command string to the network
-			initiating a session.  When the request is handled
+			If the command is a recognized supplementary service 
+			control string, the corresponding SS request is made and
+			the result is returned.
+
+			Otherwise the command is sent to the network initiating a 
+			USSD session. When the request is handled
 			by the appropriate node of the network, the
 			method returns the response or an appropriate
-			error.  The network may be awaiting further response
+			error. The network may be awaiting further response
 			from the ME after returning from this method and no
 			new command can be initiated until this one is
 			cancelled or ended.
 
+			The first return argument and the corresponding 
+			second return argument are:
+
+			"USSD"				string ussd_response
+			"CallBarring"			(string ss_op, string cb_service, dict cb_dict)
+			"CallForwarding"		(string ss_op, string cf_service, dict cf_dict)
+			"CallWaiting"			(string ss_op, dict cw_dict)
+			"CallingLinePresentation"	(string ss_op, string status)
+			"CalledLinePresentation"	(string ss_op, string status)
+			"CallingLineRestriction"	(string ss_op, string clir_status)
+			"CalledLineRestriction"		(string ss_op, string status)
+
+			ss_op contains the supplementary service operation:
+
+			"activation"
+			"registration"
+			"interrogation"
+			"deactivation"
+			"erasure"
+			
+			cb_service contains the call barring service for 
+			which the operation was requested:
+			
+			"AllOutgoing"
+			"InternationalOutgoing"
+			"InternationalOutgoingExceptHome"
+			"AllIncoming"
+			"IncomingWhenRoaming"
+			"AllBarringServices"
+			"AllOutgoingServices"
+			"AllIncomingServices"
+			
+			cf_service contains the call forwarding service for 
+			which the operation was requested:
+
+			"Unconditional"
+			"Busy"
+			"NoReply"
+			"NotReachable"
+			"All"
+			"AllConditional"
+			
+			cb_dict contains basic service/call barring 
+			service combinations that were affected by SS operation and 
+			their current status ("enabled" or "disabled"). The basic services are:
+
+			"Voice"
+			"Data"
+			"Fax"
+			"Sms"
+			"DataSync"
+			"DataAsync"
+			"DataPad"
+			"DataPacket"
+			
+			To those the name of call barring service is appended, so the property and value
+			is for example:
+			
+			"FaxIncomingWhenRoaming" : "disabled"
+			
+			cf_dict contains call forwarding properties affected by the operation. 
+			Propery names are formed from basic service name and call forwarding 
+			service name, for example:
+			
+			"VoiceNoReply" : "+12345678"
+			
+			The property value is the phone number to which the call is forwarded.
+			
+			For "NoReply" service, there is also a timeout property, holding the timeout
+			in seconds, for example:
+			
+			"VoiceNoReplyTimeout" : 20
+
+			cw_dict contains basic services with "CallWaiting" suffix that were affected 
+			by call waiting operation and their current status ("enabled" or "disabled"), 
+			for example:
+			
+			"VoiceCallWaiting" : "enabled"
+			
+			status can be "disabled" or "enabled".
+			clir_status can be "disabled", "permanent", "on" or "off".
+
+			More information about supplementary services is provided in 
+			call-barring-api.txt, call-forwarding-api.txt and call-settings-api.txt
+
 			Possible Errors: [service].Error.Timedout
 			Possible Errors: [service].Error.Canceled
 
-- 
1.7.1

Re: [PATCH] Document the SS control string API

[Denis Kenzior]

[-- Attachment #1: Type: text/plain, Size: 1857 bytes --]

Hi Alexander,

On 10/13/2010 06:33 AM, Alexander Kanavin wrote:
> ---
>  doc/supplementaryservices-api.txt |   95 +++++++++++++++++++++++++++++++++++-
>  1 files changed, 92 insertions(+), 3 deletions(-)
> 
> +			The first return argument and the corresponding 
> +			second return argument are:
> +
> +			"USSD"				string ussd_response
> +			"CallBarring"			(string ss_op, string cb_service, dict cb_dict)
> +			"CallForwarding"		(string ss_op, string cf_service, dict cf_dict)
> +			"CallWaiting"			(string ss_op, dict cw_dict)
> +			"CallingLinePresentation"	(string ss_op, string status)
> +			"CalledLinePresentation"	(string ss_op, string status)
> +			"CallingLineRestriction"	(string ss_op, string clir_status)
> +			"CalledLineRestriction"		(string ss_op, string status)

Please try to keep the lines to under 80 characters.  This might need to
be moved to a separate section.

We also have pretty strict git am settings, so your patch does not apply:

Applying: Document the SS control string API
/home/denkenz/ofono-master/.git/rebase-apply/patch:15: trailing whitespace.
			If the command is a recognized supplementary service
/home/denkenz/ofono-master/.git/rebase-apply/patch:19: trailing whitespace.
			Otherwise the command is sent to the network initiating a
/home/denkenz/ofono-master/.git/rebase-apply/patch:29: trailing whitespace.
			The first return argument and the corresponding
/home/denkenz/ofono-master/.git/rebase-apply/patch:48: trailing whitespace.
			
/home/denkenz/ofono-master/.git/rebase-apply/patch:49: trailing whitespace.
			cb_service contains the call barring service for
warning: squelched 20 whitespace errors
fatal: 25 lines add whitespace errors.

Please fix all occurrences of trailing whitespace damage.  Otherwise the
content of the patch looks great.

Thanks,
-Denis

Re: [PATCH] Document the SS control string API

[Denis Kenzior]

[-- Attachment #1: Type: text/plain, Size: 266 bytes --]

Hi Alexander,

On 10/15/2010 06:53 AM, Alexander Kanavin wrote:
> ---
>  doc/supplementaryservices-api.txt |  103 +++++++++++++++++++++++++++++++++++-
>  1 files changed, 100 insertions(+), 3 deletions(-)

Patch has been applied, thanks.

Regards,
-Denis

[PATCH] Document the SS control string API

[Alexander Kanavin]

[-- Attachment #1: Type: text/plain, Size: 4136 bytes --]

---
 doc/supplementaryservices-api.txt |  103 +++++++++++++++++++++++++++++++++++-
 1 files changed, 100 insertions(+), 3 deletions(-)

diff --git a/doc/supplementaryservices-api.txt b/doc/supplementaryservices-api.txt
index 5ef123e..0857412 100644
--- a/doc/supplementaryservices-api.txt
+++ b/doc/supplementaryservices-api.txt
@@ -7,15 +7,22 @@ Object path	[variable prefix]/{modem0,modem1,...}
 
 Methods		string, variant Initiate(string command)
 
-			Sends a USSD command string to the network
-			initiating a session.  When the request is handled
+			If the command is a recognized supplementary service
+			control string, the corresponding SS request is made
+			and the result is returned.
+
+			Otherwise the command is sent to the network
+			initiating a USSD session. When the request is handled
 			by the appropriate node of the network, the
 			method returns the response or an appropriate
-			error.  The network may be awaiting further response
+			error. The network may be awaiting further response
 			from the ME after returning from this method and no
 			new command can be initiated until this one is
 			cancelled or ended.
 
+			The output arguments are described in section
+			"Initiate method outptut arguments" below.
+
 			Possible Errors: [service].Error.Timedout
 			Possible Errors: [service].Error.Canceled
 
@@ -68,3 +75,93 @@ Properties	string State [readonly]
 			"user-response"		The network is waiting for the
 						user's response, client must
 						call Respond().
+
+
+Initiate method output arguments
+================================
+
+The first return argument and the corresponding second return argument are:
+
+	"USSD"				string ussd_response
+	"CallBarring"			(string ss_op, string cb_service,
+					dict cb_dict)
+	"CallForwarding"		(string ss_op, string cf_service,
+					dict cf_dict)
+	"CallWaiting"			(string ss_op, dict cw_dict)
+	"CallingLinePresentation"	(string ss_op, string status)
+	"CalledLinePresentation"	(string ss_op, string status)
+	"CallingLineRestriction"	(string ss_op, string clir_status)
+	"CalledLineRestriction"		(string ss_op, string status)
+
+ss_op contains the supplementary service operation:
+
+	"activation"
+	"registration"
+	"interrogation"
+	"deactivation"
+	"erasure"
+
+cb_service contains the call barring service for which the operation was
+requested:
+
+	"AllOutgoing"
+	"InternationalOutgoing"
+	"InternationalOutgoingExceptHome"
+	"AllIncoming"
+	"IncomingWhenRoaming"
+	"AllBarringServices"
+	"AllOutgoingServices"
+	"AllIncomingServices"
+
+cf_service contains the call forwarding service for which the operation was
+requested:
+
+	"Unconditional"
+	"Busy"
+	"NoReply"
+	"NotReachable"
+	"All"
+	"AllConditional"
+
+cb_dict contains basic service/call barring service combinations that were
+affected by SS operation and their current status ("enabled" or "disabled").
+The basic services are:
+
+	"Voice"
+	"Data"
+	"Fax"
+	"Sms"
+	"DataSync"
+	"DataAsync"
+	"DataPad"
+	"DataPacket"
+
+To those the name of call barring service is appended, so the property and
+value is for example:
+
+	"FaxIncomingWhenRoaming" : "disabled"
+
+cf_dict contains call forwarding properties affected by the operation.
+Propery names are formed from basic service name and call forwarding
+service name, for example:
+
+	"VoiceNoReply" : "+12345678"
+
+The property value is the phone number to which the call is forwarded.
+
+For "NoReply" service, there is also a timeout property, holding the timeout
+in seconds, for example:
+
+	"VoiceNoReplyTimeout" : 20
+
+cw_dict contains basic services with "CallWaiting" suffix that were affected
+by call waiting operation and their current status ("enabled" or "disabled"),
+for example:
+
+	"VoiceCallWaiting" : "enabled"
+
+status can be "disabled" or "enabled".
+clir_status can be "disabled", "permanent", "on" or "off".
+
+More information about supplementary services is provided in
+call-barring-api.txt, call-forwarding-api.txt and call-settings-api.txt
-- 
1.7.1

Re: [PATCH] Document the SS control string API

[Alexander Kanavin]

[-- Attachment #1: Type: text/plain, Size: 552 bytes --]

On 15.10.2010 14:47, Alexander Kanavin wrote:
> ---
>   doc/supplementaryservices-api.txt |   95 +++++++++++++++++++++++++++++++++++-
>   1 files changed, 92 insertions(+), 3 deletions(-)
>
> diff --git a/doc/supplementaryservices-api.txt b/doc/supplementaryservices-api.txt
> index 5ef123e..d80770a 100644
> --- a/doc/supplementaryservices-api.txt
> +++ b/doc/supplementaryservices-api.txt
> @@ -7,15 +7,104 @@ Object path	[variable prefix]/{modem0,modem1,...}

Please ignore, messup on my part. New patch will follow in a second.

Alex

[PATCH] Document the SS control string API

[Alexander Kanavin]

[-- Attachment #1: Type: text/plain, Size: 3981 bytes --]

---
 doc/supplementaryservices-api.txt |   95 +++++++++++++++++++++++++++++++++++-
 1 files changed, 92 insertions(+), 3 deletions(-)

diff --git a/doc/supplementaryservices-api.txt b/doc/supplementaryservices-api.txt
index 5ef123e..d80770a 100644
--- a/doc/supplementaryservices-api.txt
+++ b/doc/supplementaryservices-api.txt
@@ -7,15 +7,104 @@ Object path	[variable prefix]/{modem0,modem1,...}
 
 Methods		string, variant Initiate(string command)
 
-			Sends a USSD command string to the network
-			initiating a session.  When the request is handled
+			If the command is a recognized supplementary service 
+			control string, the corresponding SS request is made and
+			the result is returned.
+
+			Otherwise the command is sent to the network initiating a 
+			USSD session. When the request is handled
 			by the appropriate node of the network, the
 			method returns the response or an appropriate
-			error.  The network may be awaiting further response
+			error. The network may be awaiting further response
 			from the ME after returning from this method and no
 			new command can be initiated until this one is
 			cancelled or ended.
 
+			The first return argument and the corresponding 
+			second return argument are:
+
+			"USSD"				string ussd_response
+			"CallBarring"			(string ss_op, string cb_service, dict cb_dict)
+			"CallForwarding"		(string ss_op, string cf_service, dict cf_dict)
+			"CallWaiting"			(string ss_op, dict cw_dict)
+			"CallingLinePresentation"	(string ss_op, string status)
+			"CalledLinePresentation"	(string ss_op, string status)
+			"CallingLineRestriction"	(string ss_op, string clir_status)
+			"CalledLineRestriction"		(string ss_op, string status)
+
+			ss_op contains the supplementary service operation:
+
+			"activation"
+			"registration"
+			"interrogation"
+			"deactivation"
+			"erasure"
+			
+			cb_service contains the call barring service for 
+			which the operation was requested:
+			
+			"AllOutgoing"
+			"InternationalOutgoing"
+			"InternationalOutgoingExceptHome"
+			"AllIncoming"
+			"IncomingWhenRoaming"
+			"AllBarringServices"
+			"AllOutgoingServices"
+			"AllIncomingServices"
+			
+			cf_service contains the call forwarding service for 
+			which the operation was requested:
+
+			"Unconditional"
+			"Busy"
+			"NoReply"
+			"NotReachable"
+			"All"
+			"AllConditional"
+			
+			cb_dict contains basic service/call barring 
+			service combinations that were affected by SS operation and 
+			their current status ("enabled" or "disabled"). The basic services are:
+
+			"Voice"
+			"Data"
+			"Fax"
+			"Sms"
+			"DataSync"
+			"DataAsync"
+			"DataPad"
+			"DataPacket"
+			
+			To those the name of call barring service is appended, so the property and value
+			is for example:
+			
+			"FaxIncomingWhenRoaming" : "disabled"
+			
+			cf_dict contains call forwarding properties affected by the operation. 
+			Propery names are formed from basic service name and call forwarding 
+			service name, for example:
+			
+			"VoiceNoReply" : "+12345678"
+			
+			The property value is the phone number to which the call is forwarded.
+			
+			For "NoReply" service, there is also a timeout property, holding the timeout
+			in seconds, for example:
+			
+			"VoiceNoReplyTimeout" : 20
+
+			cw_dict contains basic services with "CallWaiting" suffix that were affected 
+			by call waiting operation and their current status ("enabled" or "disabled"), 
+			for example:
+			
+			"VoiceCallWaiting" : "enabled"
+			
+			status can be "disabled" or "enabled".
+			clir_status can be "disabled", "permanent", "on" or "off".
+
+			More information about supplementary services is provided in 
+			call-barring-api.txt, call-forwarding-api.txt and call-settings-api.txt
+
 			Possible Errors: [service].Error.Timedout
 			Possible Errors: [service].Error.Canceled
 
-- 
1.7.1