Brandmeister API | Repeaterskolan

Repeaterskolan - Supplement #28

Halligan API

Brandmeister tillhandahåller ett API, Halligan.

Med relativt enkla anrop kan man fråga systemet samt utföra konfigurationer, t ex av sin egen nod.

SM5GXQ har implementerat en klient i Python 3. Länken finns i artikelns huvud. Välj "Spara som".

Följande huvudkommandon finns: kommandon kan förkortas

- tg

- cluster

- device

- master

- help

Installation

Spara scriptet på en plats där det kan exekveras.

- Under Linux, t ex i katalogen /usr/local/bin .

- Gör filen exekverbar: sudo chmod +x bm

Några beroenden behöver installeras.

- sudo apt install python3-pip

- pip3 install termcolor

- pip3 install requests

Vill du kunna konfigurera din nod, behöver du ha en API-nyckel.
- Den skaffar du på Brandmeisters webbplats.

- Klistra in den i scriptet:

# Put your own api key here.
auth = ''

Funktionerna kan anropas på två olika sätt.

1. Genom att skriva hela kommandot i en följd (t ex bm dev list sm5gxq)

2. Genom att först starta scriptet med bm .

Ge därefter kommandot (t ex dev list sm5gxq)

Kommandon

Lista talgrupper	tg list {<tg>}
Lista vilka noder som har en tg i passning	tg <tg> devices {-v\|-a\|-ls}
Lista Cluster med ID	cluster list {<cluster-id>}
Lista Cluster med Namn	cluster name {%}<cluster-namn>{%}
Lista alla Cluster på en Master	cluster master <master-id> {-v}
Lista vilka noder som har ett Cluster i passning	cluster <clu-id> device {-v\|-a\|-ls}
Visa information om ett Device	device {id} <dev-id>
Lista Device med ID eller Callsign	device list [<call> \| <id>] {-v\|-a\|-ls}
Lista Device med Callsign	device callsign {%}<call>{%} {-ls\|-a}
Lista alla Device på en Master	device master <master-id> {-ls\|-a}
Lista alla Device på en Master	master <master-id> devices {-ls\|-a}
Lista alla Cluster på en Master	master <master-id> cluster {-v}
Lägga till tg eller Cluster på en nod	device {id} <dev-id> [tg\|clu] add <tg> <slot>
Ta bort tg eller Cluster på en nod	device {id} <dev-id> [tg\|clu] del <tg> <slot>
Ta bort samtal på en nod	device {id} <dev-id> drop call <slot>
Ta bort dynamisk tg på en nod	device {id} <dev-id> drop dynamic <slot>

Växlar

-v Verbose

-a Endast aktiva noder

-ls Visar datum för "Last seen"

Hjälp

help

help <cmd>

<cmd> -help

<cmd> -?

Se även:

Repeater Flitiga Lisa – SK7RFL