[PATCH] SetProperty method and Powered property missing from modem-api doc.

[PATCH] SetProperty method and Powered property missing from modem-api doc.

[Marko Saukko]

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

Hi,

SetProperty method and Powered Property where missing from modem-api.txt

Question:

I'm not sure if the "On success a PropertyChanged signal will be emitted."
message is valid, as the PropertyChanged signal is sent only once when doing
for example the following:

$ dbus-send --print-reply --system --dest=org.ofono /atgen0
org.ofono.Modem.SetProperty string:Powered variant:boolean:true
method return sender=:1.160 -> dest=:1.227 reply_serial=2
$ dbus-send --print-reply --system --dest=org.ofono /atgen0
org.ofono.Modem.SetProperty string:Powered variant:boolean:true
method return sender=:1.160 -> dest=:1.228 reply_serial=2

If I understood correctly the second method call is also successfull
eventhough no PropertyChanged signal is emitted.

Regards,
Marko

---
 doc/modem-api.txt |   17 ++++++++++++++++-
 1 files changed, 16 insertions(+), 1 deletions(-)

diff --git a/doc/modem-api.txt b/doc/modem-api.txt
index 3058880..06a4ada 100644
--- a/doc/modem-api.txt
+++ b/doc/modem-api.txt
@@ -12,12 +12,27 @@ Methods             dict GetProperties()

                        Possible Errors: [service].Error.InvalidArguments

+               void SetProperty(string property, variant value)
+
+                       Changes the value of the specified property. Only
+                       properties that are listed as read-write are
+                       changeable. On success a PropertyChanged signal
+                       will be emitted.
+
+                       Possible Errors: [service].Error.InvalidArguments
+                                        [service].Error.DoesNotExist
+
 Signals                PropertyChanged(string name, variant value)

                        This signal indicates a changed value of the given
                        property.

-Properties     string Manufacturer [readonly, optional]
+Properties     boolean Powered [readwrite]
+
+                       Boolean representing the power state of the modem
+                       device.
+
+               string Manufacturer [readonly, optional]

                        String representing the manufacturer of the modem
                        device.
--
1.6.0.4

[-- Attachment #2: attachment.html --]
[-- Type: text/html, Size: 2515 bytes --]

Re: [PATCH] SetProperty method and Powered property missing from modem-api doc.

[Denis Kenzior]

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

Hi Marko,

> SetProperty method and Powered Property where missing from modem-api.txt

I'm having trouble applying this patch.  Are you using a private repository by 
any chance?

git am --3way ~/merge/\[PATCH\]\ SetProperty\ method\ and\ Powered\ property\ 
missing\ from\ modem-api\ doc 
Applying: SetProperty method and Powered property missing from modem-api doc.
error: patch failed: doc/modem-api.txt:12
error: doc/modem-api.txt: patch does not apply
Using index info to reconstruct a base tree...
error: patch failed: doc/modem-api.txt:12
error: doc/modem-api.txt: patch does not apply
Did you hand edit your patch?
It does not apply to blobs recorded in its index.
Cannot fall back to three-way merge.
Patch failed at 0001 SetProperty method and Powered property missing from 
modem-api doc.
When you have resolved this problem run "git am -3 --resolved".
If you would prefer to skip this patch, instead run "git am -3 --skip".
To restore the original branch and stop patching run "git am -3 --abort".

>
> Question:
>
> I'm not sure if the "On success a PropertyChanged signal will be emitted."
> message is valid, as the PropertyChanged signal is sent only once when
> doing for example the following:

To be pedantic: a successful method invocation does mean that a 
PropertyChanged will be emitted.  PropertyChanged is emitted only when the 
property has actually changed.  Thus if the property is being set to its 
current value, oFono will not emit the signal (but return success to the 
caller)  However, the wording is probably OK since you generally set the 
property to something that is different.

Regards,
-Denis

Re: [PATCH] SetProperty method and Powered property missing from modem-api doc.

[Marko Saukko]

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

Hi,

Not sure what went wrong with the previous one. Here is a new patch (attached).

Regards,
Marko

[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: 0001--Added-SetProperty-method-and-Powered-property-to-m.patch --]
[-- Type: text/x-patch, Size: 1314 bytes --]

>From 9d2cee93324bd762e60211aa525653c47cc984a4 Mon Sep 17 00:00:00 2001
From: Marko Saukko <marko.saukko@gmail.com>
Date: Tue, 20 Oct 2009 09:25:38 +0300
Subject: [PATCH] - Added SetProperty method and Powered property to modem-api doc.

---
 doc/modem-api.txt |   17 ++++++++++++++++-
 1 files changed, 16 insertions(+), 1 deletions(-)

diff --git a/doc/modem-api.txt b/doc/modem-api.txt
index 3058880..06a4ada 100644
--- a/doc/modem-api.txt
+++ b/doc/modem-api.txt
@@ -12,12 +12,27 @@ Methods		dict GetProperties()
 
 			Possible Errors: [service].Error.InvalidArguments
 
+		void SetProperty(string property, variant value)
+
+			Changes the value of the specified property. Only
+			properties that are listed as read-write are
+			changeable. On success a PropertyChanged signal
+			will be emitted.
+
+			Possible Errors: [service].Error.InvalidArguments
+					 [service].Error.DoesNotExist
+
 Signals		PropertyChanged(string name, variant value)
 
 			This signal indicates a changed value of the given
 			property.
 
-Properties	string Manufacturer [readonly, optional]
+Properties	boolean Powered [readwrite]
+
+			Boolean representing the power state of the modem
+			device.
+
+		string Manufacturer [readonly, optional]
 
 			String representing the manufacturer of the modem
 			device.
-- 
1.6.0.4

Re: [PATCH] SetProperty method and Powered property missing from modem-api doc.

[Denis Kenzior]

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

Hi Marko,

> Not sure what went wrong with the previous one. Here is a new patch
> (attached).

This patch has been applied.  Thanks!

Regards,
-Denis