doc/proximity-api.txt

   1 BlueZ D-Bus Proximity API description
   2 ***********************************
   3
   4 Copyright (C) 2011  Claudio Takahasi <claudio.takahasi@openbossa.org>
   5
   6
   7 Proximity Monitor hierarchy
   8 ===========================
   9
  10 Service         org.bluez
  11 Interface       org.bluez.ProximityMonitor
  12 Object path     [variable prefix]/{hci0,hci1,...}/dev_XX_XX_XX_XX_XX_XX
  13
  14 Methods         dict GetProperties()
  15
  16                         Returns all properties for the interface. See the
  17                         properties section for available properties.
  18
  19                 void SetProperty(string name, variant value)
  20
  21                         Changes the value of the specified property. Only
  22                         properties that are listed a read-write are changeable.
  23                         On success this will emit a PropertyChanged signal.
  24
  25                         Possible Errors: org.bluez.Error.InvalidArguments
  26
  27 Signals         PropertyChanged(string name, variant value)
  28
  29                         This signal indicates a changed value of a given
  30                         property.
  31
  32 Properties
  33
  34                 string SignalLevel[readonly]
  35
  36                         Alert indicating that a threshold has been reached.
  37                         Possible values: "unknown", "good", "regular", "weak"
  38
  39                 string LinkLossAlertLevel [readwrite]
  40
  41                         Persistent property. Sets the alert level in the
  42                         proximity reporter for link loss scenario. Values:
  43                         "none", "mild", "high".
  44
  45                 string ImmediateAlertLevel [readwrite]
  46
  47                         Alert level to be written in the Immediate Alert Level.
  48                         Property shared between Path Loss and Find Me.
  49                         Values: "none", "mild", "high". Default value is
  50                         "none". Applications can disable the alert setting
  51                         the value to "none". If the "Target" is not found,
  52                         "none" will be emitted after the configured timeout.
  53                         When changing the level, signal is the confirmation
  54                         that the value was written in the remote.
  55
  56 Proximity Reporter hierarchy
  57 ===========================
  58
  59 Shared service used by Proximity Path Loss and Find Me. Allows per device
  60 alert level handling.
  61
  62 Service         org.bluez
  63 Interface       org.bluez.ProximityReporter
  64 Object path     [variable prefix]/{hci0,hci1,...}/dev_XX_XX_XX_XX_XX_XX
  65
  66 Methods         dict GetProperties()
  67
  68                         Returns all properties for the interface. See the
  69                         properties section for available properties.
  70
  71 Signals         PropertyChanged(string name, variant value)
  72
  73                         This signal indicates a changed value of a given
  74                         property.
  75
  76 Properties
  77
  78                 string ImmediateAlertLevel [readonly]
  79
  80                         This property indicates that Immediate Alert Level
  81                         characteristic in the local Immediate Alert Service
  82                         was changed by the remote device. Property shared
  83                         between Path Loss and Find Me. Values: "none", "mild",
  84                         "high".
  85
  86                 string LinkLossAlertLevel [readonly]
  87
  88                         This property indicates that Alert Level characteristic
  89                         in the local Link Loss Service was changed by the
  90                         remote device. Values: "none", "mild", "high".