diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 35 |
1 files changed, 35 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..5a6a8c4 --- /dev/null +++ b/README.md @@ -0,0 +1,35 @@ +# pistar-Scripts +A collection of scripts to manage various aspects of the Pi-Star system +from the command line. + +IMPORTANT: These scripts are NOT supported by Pi-Star. Do not request support +for them on the Pi-Star forums or the Pi-Star Facebook group. + +# System Requirements +- Pi-Star 3.4.n + +# Installation +Copy the contents of the repository somewhere useful. All scripts are +hardcoded to be called from the same directory where they reside. +This will be changed in the future to make them more portable. + +# Scripts +The following scripts are in this package. + +## bmcli +bmcli (and its associated bmcli-wapper) are command-line interfaces +to the DMR Brandmeister API. Uses all configuration from Pi-Star and +requires the Brandmeister API to configured in the web interface +before using. + +``` +usage: + bmcli-wrapper.php add TALKGROUP TIMESLOT + bmcli-wrapper.php del TALKGROUP TIMESLOT + bmcli-wrapper.php dropdyn + +``` + +This script has only rudimentary error checking so make sure you +call it correctly or you could have some interesting BM configurations +pointing to your repeater/hotspot. |