summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorSamuel Ortiz <sameo@linux.intel.com>2012-08-07 12:45:34 +0200
committerSamuel Ortiz <sameo@linux.intel.com>2012-08-07 12:49:10 +0200
commitc393f82922f3c64b4ecb5a97acf78af4e7cd4f63 (patch)
tree43307847004af9aa5d42214d4f27b6ba24a60da8 /doc
parent8a50e3f8277acb13200d678e71d800699ff89008 (diff)
downloadneard-c393f82922f3c64b4ecb5a97acf78af4e7cd4f63.tar.gz
neard-c393f82922f3c64b4ecb5a97acf78af4e7cd4f63.tar.bz2
neard-c393f82922f3c64b4ecb5a97acf78af4e7cd4f63.zip
doc: Document the Dual polling loop mode
Dual means the polling loop will alternate between initiator and target modes.
Diffstat (limited to 'doc')
-rw-r--r--doc/adapter-api.txt7
1 files changed, 4 insertions, 3 deletions
diff --git a/doc/adapter-api.txt b/doc/adapter-api.txt
index cf905d1..fe01b3a 100644
--- a/doc/adapter-api.txt
+++ b/doc/adapter-api.txt
@@ -27,9 +27,10 @@ Methods: dict GetProperties()
the adapter will start polling for targets, listening
for NFC devices or both.
The mode parameter can have the following values:
- "Initiator", "Target". For any other value, the adapter
- will start the polling loop in both target and initiator
- mode.
+ "Initiator", "Target" or "Dual". For any other value, the
+ adapter will fall back to initiator mode.
+ Dual mode will have the adapter alternate between target
+ and initiator modes during the polling loop.
This process will start emitting TagFound and
PropertyChanged "Polling" signals.