View source for D-BUS API ← D-BUS API


* Interface name: me.burnaway.BrandMeister
* Service path: /me/burnaway/BrandMeister
* Service name: me.burnaway.BrandMeister.N<Network ID>


== List of methods ==

* getContextList
* getContextData
* removeContext
* invokeCommand
* dropCallRoute
* setStoredValue
* getStoredValue
* getStationData
* getRepeaterData
* getTerminalData
* setSpecificValue
* getDiagnosticData
* getLockInformation
* getSubscriptionList
* getObjectInformation
* getSystemInformation
* publishExternalEvent

Full list and descriptions can be retrieved using [https://dbus.freedesktop.org/doc/dbus-specification.html#standard-interfaces-introspectable D-BUS Introspection]

== Examples ==
Keep in mind these examples are for master id 2501 if used please change N2501 to NXXX for you master.
=== Command line ===

==== Connect to C-Bridge ====

<pre>
dbus-send --system --dest=me.burnaway.BrandMeister.N2501 --type=method_call --print-reply /me/burnaway/BrandMeister \
  me.burnaway.BrandMeister.invokeCommand string:'CBridge CC-CC Link' string:'connect 87.106.84.53'
#                                                                                    |-C-Bridge Address
</pre>

==== Connect to D-STAR D-Extra reflector ====

<pre>
dbus-send --system --dest=me.burnaway.BrandMeister.N2501 --type=method_call --print-reply /me/burnaway/BrandMeister \
  me.burnaway.BrandMeister.invokeCommand string:'D-Extra Link' string:'connect 250 D XRF250 D xrf250.dstar.su'
#                                                                      Group ID-|  | |-XRF--| |-XRF Address-|
#                                                                     Local Module-+
</pre>

==== Connect to WIRES-X Room ====

<pre>
dbus-send --system --dest=me.burnaway.BrandMeister.N2501 --type=method_call --print-reply /me/burnaway/BrandMeister \
  me.burnaway.BrandMeister.invokeCommand string:'WIRES-X Link' string:'connect 250 44.11.22.33'
#                                                                       Talkgoup-| |-room
</pre>

==== Connect to YSF Reflector ====

<pre>
dbus-send --system --dest=me.burnaway.BrandMeister.N2501 --type=method_call --print-reply /me/burnaway/BrandMeister \
  me.burnaway.BrandMeister.invokeCommand string:'YSF Client' string:'connect 250 44.11.22.33 42000'
#                                                                     Group ID-| |-Address   |-Port
</pre>

==== Register RP2C gateway ====

<pre>
dbus-send --system --dest=me.burnaway.BrandMeister.N2501 --type=method_call --print-reply /me/burnaway/BrandMeister \
  me.burnaway.BrandMeister.invokeCommand string:'RP2C Link' string:'register 2509 gate.dstar.su'
#                                                                    Network ID-| |-Gateway Address
</pre>

==== Connect to XLX Reflector ====

<pre>
dbus-send --system --dest=me.burnaway.BrandMeister.N2501 --type=method_call --print-reply /me/burnaway/BrandMeister \
  me.burnaway.BrandMeister.invokeCommand string:'XLX Interlink' string:'connect 192.0.2.1 1'
#                                                                          XLX Address -| |-options
</pre>

==== Get list of contexts ====

<pre>
dbus-send --system --dest=me.burnaway.BrandMeister.N2501 --type=method_call --print-reply /me/burnaway/BrandMeister \
  me.burnaway.BrandMeister.getContextList

  Optional parameters:
    #1 (optional) string:<name> - specific name
    #1 (optional) uint32:<mask> - specific type, where bit 0 - applications, bit 1 - repeaters, bit 2 - networks
    #2 (optional) uint32:<number> - identifier of link

dbus-send --system --dest=me.burnaway.BrandMeister.N2501 --type=method_call --print-reply /me/burnaway/BrandMeister \
  me.burnaway.BrandMeister.getContextList uint32:2
  
dbus-send --system --dest=me.burnaway.BrandMeister.N2501 --type=method_call --print-reply /me/burnaway/BrandMeister \
  me.burnaway.BrandMeister.getContextList uint32:2 uint32:250301

dbus-send --system --dest=me.burnaway.BrandMeister.N2501 --type=method_call --print-reply /me/burnaway/BrandMeister \
  me.burnaway.BrandMeister.getContextList string:'XLX Interlink'
</pre>

==== Get context information ====
  
<pre>
dbus-send --system --dest=me.burnaway.BrandMeister.N2501 --type=method_call --print-reply /me/burnaway/BrandMeister \
  me.burnaway.BrandMeister.getContextData string:'15bb100a-a08e-11e4-9ef2-52540089c90b'
#                                                 |- Context UUID                   -|
</pre>

==== Get repeater information ====
  
<pre>
dbus-send --system --dest=me.burnaway.BrandMeister.N2501 --type=method_call --print-reply /me/burnaway/BrandMeister \
  me.burnaway.BrandMeister.getRepeaterData string:'15bb100a-a08e-11e4-9ef2-52540089c90b'
#                                                  |- Context UUID                   -|
</pre>

==== Clear repeater alarms (IP Site Connect) ====

<pre>
dbus-send --system --dest=me.burnaway.BrandMeister.N2501 --type=method_call --print-reply /me/burnaway/BrandMeister \
  me.burnaway.BrandMeister.invokeCommand string:'15bb100a-a08e-11e4-9ef2-52540089c90b' string:'clear alarms'
#                                                |- Context UUID                   -|
</pre>

==== Turn repeating on (IP Site Connect) ====

<pre>
dbus-send --system --dest=me.burnaway.BrandMeister.N2501 --type=method_call --print-reply /me/burnaway/BrandMeister \
  me.burnaway.BrandMeister.invokeCommand string:'15bb100a-a08e-11e4-9ef2-52540089c90b' string:'turn repeater on'
#                                                |- Context UUID                   -|
</pre>

==== Turn repeating off (IP Site Connect) ====

<pre>
dbus-send --system --dest=me.burnaway.BrandMeister.N2501 --type=method_call --print-reply /me/burnaway/BrandMeister \
  me.burnaway.BrandMeister.invokeCommand string:'15bb100a-a08e-11e4-9ef2-52540089c90b' string:'turn repeater off'
#                                                |- Context UUID                   -|
</pre>

==== Subscribe to C-Bridge talking group ====

<pre>
dbus-send --system --dest=me.burnaway.BrandMeister.N2501 --type=method_call --print-reply /me/burnaway/BrandMeister \
  me.burnaway.BrandMeister.invokeCommand string:'15bb100a-a08e-11e4-9ef2-52540089c90b' string:'subscribe 1 1'
#                                                |- Context UUID                   -|            Link ID-| |-Group ID

dbus-send --system --dest=me.burnaway.BrandMeister.N2501 --type=method_call --print-reply /me/burnaway/BrandMeister \
  me.burnaway.BrandMeister.invokeCommand string:'15bb100a-a08e-11e4-9ef2-52540089c90b' string:'transmit configuration'
#                                                |- Context UUID                   -|
</pre>

==== Remove context (disconnect from server / repeater) ====

<pre>
dbus-send --system --dest=me.burnaway.BrandMeister.N2501 --type=method_call --print-reply /me/burnaway/BrandMeister \
  me.burnaway.BrandMeister.removeContext string:'15bb100a-a08e-11e4-9ef2-52540089c90b'
#                                                |- Context UUID                   -|
</pre>

==== Drop call route ====
  
<pre>
dbus-send --system --dest=me.burnaway.BrandMeister.N2501 --type=method_call --print-reply /me/burnaway/BrandMeister \
  me.burnaway.BrandMeister.dropCallRoute string:'15bb100a-a08e-11e4-9ef2-52540089c90b' uint32:1
#                                                |- Context UUID                   -|   Slot -|
</pre>

Please note: this method can be applied to channels having channel lock such as repeaters, SmartPTT, etc.

==== Get subscription list (embedded database) ====
  
<pre>
dbus-send --system --dest=me.burnaway.BrandMeister.N2501 --type=method_call --print-reply /me/burnaway/BrandMeister \
  me.burnaway.BrandMeister.getSubscriptionList string:'15bb100a-a08e-11e4-9ef2-52540089c90b'
#                                                      |- Context UUID                   -|
</pre>

List contains four numbers per record:
* slot number
* call type (e.g. 5 - private voice call, 7 - group voice call)
* destination ID
* tag (least significant 32-bits)

==== Publish (handle) external event ====

<pre>
dbus-send --system --dest=me.burnaway.BrandMeister.N2501 --type=method_call --print-reply /me/burnaway/BrandMeister \
  me.burnaway.BrandMeister.publishExternalEvent string:'configuration changed'
</pre>

=== PHP ===


<syntaxhighlight lang="php">
<?php

  $array = array();

  $connection = new DBus(DBus::BUS_SYSTEM, true);
  $proxy = $connection->createProxy("me.burnaway.BrandMeister.N2501", "/me/burnaway/BrandMeister", "me.burnaway.BrandMeister");

  $result = $proxy->getContextList();
  if ((is_object($result)) &&
      (get_class($result) == "DbusArray"))
  {
    $list = $result->getData();
    foreach ($list as $banner)
    {
      $result = $proxy->getContextData($banner);
      if ((is_object($result)) &&
          (get_class($result) == "DbusSet"))
      {
        $set = $result->getData();
        $values = $set[6]->getData();
        $address = $set[4];

        $array[] = array(
          "banner" => $set[0],
          "name" => $set[1],
          "type" => $set[2],
          "number" => $set[3],
          "state" => $set[5],
          "values" => $values);
      }
    }
  }

  $data = json_encode($array);

  if (array_key_exists("callback", $_GET))
  {
    header("Content-Type: application/javascript");
    print($_GET["callback"] . "(" . $data . ")");
  }
  else
  {
    header("Content-Type: application/json");
    print($data);
  }

?>
</syntaxhighlight>