Difference between revisions of "D-BUS API"

(→‎Connect to YSF Reflector)
(→‎Connect to NXDN Reflector)
Line 79: Line 79:
 
<pre>
 
<pre>
 
dbus-send --system --dest=me.burnaway.BrandMeister.N2501 --type=method_call --print-reply /me/burnaway/BrandMeister \
 
dbus-send --system --dest=me.burnaway.BrandMeister.N2501 --type=method_call --print-reply /me/burnaway/BrandMeister \
−
   me.burnaway.BrandMeister.invokeCommand string:'NXDN Client' string:'connect 25001 192.0.2.1 41400'
+
   me.burnaway.BrandMeister.invokeCommand string:'NXDN Client' string:'connect 25001 192.0.2.1 41400 1'
−
#                                                                      talkgroup-| |         |-port
+
#                                                                      talkgroup-| |       port-| |- mode
 
#                                                                          address +
 
#                                                                          address +
 
</pre>
 
</pre>

Revision as of 16:16, 14 February 2021

  • 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 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

  1. dbus-send --system --dest=me.burnaway.BrandMeister.N2501 --type=method_call --print-reply /me/burnaway/BrandMeister \
  2.   me.burnaway.BrandMeister.invokeCommand string:'CBridge CC-CC Link' string:'connect 87.106.84.53 2502 0 1'
  3. #                                                                              C-Bridge Address-| |    | |- Location ID
  4. #                                                                                      Network ID-|    |- mode

Connect to D-STAR D-Extra reflector

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

Connect to D-STAR DCS reflector

  1. dbus-send --system --dest=me.burnaway.BrandMeister.N2501 --type=method_call --print-reply /me/burnaway/BrandMeister \
  2.   me.burnaway.BrandMeister.invokeCommand string:'DCS Link' string:'connect 250 D XRF250 D xrf250.dstar.su example.com 1'
  3. #                                                                   Group ID-| | |-DCS--| |-DCS Address-| |           |- mode
  4. #                                                                 Local Module-+                          + CCS Address


Connect to WIRES-X Room

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

Connect to YSF Reflector

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

Connect to NXDN Reflector

  1. dbus-send --system --dest=me.burnaway.BrandMeister.N2501 --type=method_call --print-reply /me/burnaway/BrandMeister \
  2.   me.burnaway.BrandMeister.invokeCommand string:'NXDN Client' string:'connect 25001 192.0.2.1 41400 1'
  3. #                                                                       talkgroup-| |        port-| |- mode
  4. #                                                                           address +

Connect to NXCore

  1. dbus-send --system --dest=me.burnaway.BrandMeister.N2501 --type=method_call --print-reply /me/burnaway/BrandMeister \
  2.   me.burnaway.BrandMeister.invokeCommand string:'NXCore' string:'connect 25001 192.0.2.1 41300'
  3. #                                                                     number-| |         |-port
  4. #                                                                      address +

Connect to an OpenBridge peer

  1. dbus-send --system --dest=me.burnaway.BrandMeister.N2501 --type=method_call --print-reply /me/burnaway/BrandMeister \
  2.   me.burnaway.BrandMeister.invokeCommand string:'OpenBridge' string:'connect 250000050 192.0.2.1 62035'
  3. #                                                                             number-| |         |-port
  4. #                                                                              address +

Register RP2C gateway

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

Connect to XLX Reflector

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

Get list of contexts

  1. dbus-send --system --dest=me.burnaway.BrandMeister.N2501 --type=method_call --print-reply /me/burnaway/BrandMeister \
  2.   me.burnaway.BrandMeister.getContextList
  3.  
  4.   Optional parameters:
  5.     #1 (optional) string:<name> - specific name
  6.     #1 (optional) uint32:<mask> - specific type, where bit 0 - applications, bit 1 - repeaters, bit 2 - networks
  7.     #2 (optional) uint32:<number> - identifier of link
  8.  
  9. dbus-send --system --dest=me.burnaway.BrandMeister.N2501 --type=method_call --print-reply /me/burnaway/BrandMeister \
  10.   me.burnaway.BrandMeister.getContextList uint32:2
  11.   
  12. dbus-send --system --dest=me.burnaway.BrandMeister.N2501 --type=method_call --print-reply /me/burnaway/BrandMeister \
  13.   me.burnaway.BrandMeister.getContextList uint32:2 uint32:250301
  14.  
  15. dbus-send --system --dest=me.burnaway.BrandMeister.N2501 --type=method_call --print-reply /me/burnaway/BrandMeister \
  16.   me.burnaway.BrandMeister.getContextList string:'XLX Interlink'

Get context information

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

Get repeater information

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

Clear repeater alarms (IP Site Connect)

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

Turn repeating on (IP Site Connect)

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

Turn repeating off (IP Site Connect)

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

Subscribe to C-Bridge talking group

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

Subscribe to XLX Module

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

Remove context (disconnect from server / repeater)

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

Drop call route

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

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

Get subscription list (embedded database)

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

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

  1. dbus-send --system --dest=me.burnaway.BrandMeister.N2501 --type=method_call --print-reply /me/burnaway/BrandMeister \
  2.   me.burnaway.BrandMeister.publishExternalEvent string:'configuration changed'
Retrieved from "https://wiki.brandmeister.network/index.php?title=D-BUS_API&oldid=16299"


List of methods[edit]

Full list and descriptions can be retrieved using D-BUS Introspection

Examples[edit]

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

Command line[edit]

Connect to C-Bridge[edit]

  1. dbus-send --system --dest=me.burnaway.BrandMeister.N2501 --type=method_call --print-reply /me/burnaway/BrandMeister \
  2.   me.burnaway.BrandMeister.invokeCommand string:'CBridge CC-CC Link' string:'connect 87.106.84.53 2502 0 1'
  3. #                                                                              C-Bridge Address-| |    | |- Location ID
  4. #                                                                                      Network ID-|    |- mode

Connect to D-STAR D-Extra reflector[edit]

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

Connect to D-STAR DCS reflector[edit]

  1. dbus-send --system --dest=me.burnaway.BrandMeister.N2501 --type=method_call --print-reply /me/burnaway/BrandMeister \
  2.   me.burnaway.BrandMeister.invokeCommand string:'DCS Link' string:'connect 250 D XRF250 D xrf250.dstar.su example.com 1'
  3. #                                                                   Group ID-| | |-DCS--| |-DCS Address-| |           |- mode
  4. #                                                                 Local Module-+                          + CCS Address


Connect to WIRES-X Room[edit]

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

Connect to YSF Reflector[edit]

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

Connect to NXDN Reflector[edit]

  1. dbus-send --system --dest=me.burnaway.BrandMeister.N2501 --type=method_call --print-reply /me/burnaway/BrandMeister \
  2.   me.burnaway.BrandMeister.invokeCommand string:'NXDN Client' string:'connect 25001 192.0.2.1 41400'
  3. #                                                                       talkgroup-| |         |-port
  4. #                                                                           address +

Connect to NXCore[edit]

  1. dbus-send --system --dest=me.burnaway.BrandMeister.N2501 --type=method_call --print-reply /me/burnaway/BrandMeister \
  2.   me.burnaway.BrandMeister.invokeCommand string:'NXCore' string:'connect 25001 192.0.2.1 41300'
  3. #                                                                     number-| |         |-port
  4. #                                                                      address +

Connect to an OpenBridge peer[edit]

  1. dbus-send --system --dest=me.burnaway.BrandMeister.N2501 --type=method_call --print-reply /me/burnaway/BrandMeister \
  2.   me.burnaway.BrandMeister.invokeCommand string:'OpenBridge' string:'connect 250000050 192.0.2.1 62035'
  3. #                                                                             number-| |         |-port
  4. #                                                                              address +

Register RP2C gateway[edit]

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

Connect to XLX Reflector[edit]

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

Get list of contexts[edit]

  1. dbus-send --system --dest=me.burnaway.BrandMeister.N2501 --type=method_call --print-reply /me/burnaway/BrandMeister \
  2.   me.burnaway.BrandMeister.getContextList
  3.  
  4.   Optional parameters:
  5.     #1 (optional) string:<name> - specific name
  6.     #1 (optional) uint32:<mask> - specific type, where bit 0 - applications, bit 1 - repeaters, bit 2 - networks
  7.     #2 (optional) uint32:<number> - identifier of link
  8.  
  9. dbus-send --system --dest=me.burnaway.BrandMeister.N2501 --type=method_call --print-reply /me/burnaway/BrandMeister \
  10.   me.burnaway.BrandMeister.getContextList uint32:2
  11.   
  12. dbus-send --system --dest=me.burnaway.BrandMeister.N2501 --type=method_call --print-reply /me/burnaway/BrandMeister \
  13.   me.burnaway.BrandMeister.getContextList uint32:2 uint32:250301
  14.  
  15. dbus-send --system --dest=me.burnaway.BrandMeister.N2501 --type=method_call --print-reply /me/burnaway/BrandMeister \
  16.   me.burnaway.BrandMeister.getContextList string:'XLX Interlink'

Get context information[edit]

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

Get repeater information[edit]

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

Clear repeater alarms (IP Site Connect)[edit]

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

Turn repeating on (IP Site Connect)[edit]

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

Turn repeating off (IP Site Connect)[edit]

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

Subscribe to C-Bridge talking group[edit]

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

Subscribe to XLX Module[edit]

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

Remove context (disconnect from server / repeater)[edit]

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

Drop call route[edit]

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

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

Get subscription list (embedded database)[edit]

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

List contains four numbers per record:

Publish (handle) external event[edit]

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