D-BUS API
From BrandMeister Wiki
More actions
- 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
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 2502 0 1' # C-Bridge Address-| | | |- Location ID # Network ID-| |- mode
Connect to D-STAR D-Extra reflector
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 1' # Group ID-| | |-XRF--| |-XRF Address-| |- mode # Local Module-+
Connect to D-STAR DCS reflector
dbus-send --system --dest=me.burnaway.BrandMeister.N2501 --type=method_call --print-reply /me/burnaway/BrandMeister \ me.burnaway.BrandMeister.invokeCommand string:'DCS Link' string:'connect 250 D XRF250 D xrf250.dstar.su example.com 1' # Group ID-| | |-DCS--| |-DCS Address-| | |- mode # Local Module-+ + CCS Address
Connect to WIRES-X Room
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 250 44.11.22.33' # Talkgoup-| | |-room # +Application ID
Connect to YSF Reflector
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 1' # Group ID-| | Port-| |-mode # address +
Connect to NXDN Reflector
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 1' # talkgroup-| | port-| |- mode # address +
Connect to NXCore
dbus-send --system --dest=me.burnaway.BrandMeister.N2501 --type=method_call --print-reply /me/burnaway/BrandMeister \ me.burnaway.BrandMeister.invokeCommand string:'NXCore' string:'connect 25001 192.0.2.1 41300' # number-| | |-port # address +
Connect to an OpenBridge peer
dbus-send --system --dest=me.burnaway.BrandMeister.N2501 --type=method_call --print-reply /me/burnaway/BrandMeister \ me.burnaway.BrandMeister.invokeCommand string:'OpenBridge' string:'connect 250000050 192.0.2.1 62035' # number-| | |-port # address +
Register RP2C gateway
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
Connect to XLX Reflector
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
Get list of contexts
# returns first 4096 contexts
# use getCustomList if your server has more.
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'
Get context information
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 -|
Get repeater information
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 -|
Clear repeater alarms (IP Site Connect)
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 -|
Turn repeating on (IP Site Connect)
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 -|
Turn repeating off (IP Site Connect)
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 -|
Subscribe to C-Bridge talking group
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
Subscribe to XLX Module
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 4001 2501' # |- Context UUID -| Module -| |-Group ID
Remove context (disconnect from server / repeater)
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 -|
Drop call route
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 -|
Please note: this method can be applied to channels having channel lock such as repeaters, SmartPTT, etc.
Get subscription list (embedded database)
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 -|
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
dbus-send --system --dest=me.burnaway.BrandMeister.N2501 --type=method_call --print-reply /me/burnaway/BrandMeister \ me.burnaway.BrandMeister.publishExternalEvent string:'configuration changed'