aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorLuke Berndt <luke@robotastic.com>2021-03-10 21:22:31 -0500
committerLuke Berndt <luke@robotastic.com>2021-03-10 21:22:31 -0500
commit6e89e63d6599995207f1ba5f72211116b4581e24 (patch)
treea630185d019c9f00d3c15ad86d36acc9d754bab2 /README.md
parenta68a7dacfa043f2c2a3779dabd53f26f3e508565 (diff)
updated readme, added example
Diffstat (limited to 'README.md')
-rw-r--r--README.md1
1 files changed, 1 insertions, 0 deletions
diff --git a/README.md b/README.md
index 9a48c1d3..ae225119 100644
--- a/README.md
+++ b/README.md
@@ -122,6 +122,7 @@ Here are the different arguments:
- **recordUnknown** - record talkgroups if they are not listed in the Talkgroups File. The options are *true* and *false* (without quotes). The default is *true*.
- **shortName** - this is a nickname for the system. It is used to help name and organize the recordings from this system. It should be 4-6 letters with no spaces.
- **uploadScript** - this script is called after each recording has finished. Checkout *encode-upload.sh.sample* as an example. The script should be located in the same directory as the trunk-recorder executable.
+ - **unitScript** - this script is called when radio join or leave a system. Checkout *unit-script.sh* in the example direcotry. The script should be located in the same directory as the trunk-recorder executable. The script will be passed 4 parameters: System ShortName, Radio ID, Action, and Talkgroup.
- **apiKey** - *(Optional, only if uploadServer set)* System-specific API key for uploading calls to OpenMHz.com. See the Config tab for your system in OpenMHz to find what the value should be.
- **broadcastifyApiKey** - *(Optional)* System-specific API key for Broadcastify Calls
- **broadcastifySystemId** - *(Optional)* System ID for Broadcastify Calls (this is an integer, and different from the RadioReference system ID)