diff --git a/.idea/misc.xml b/.idea/misc.xml new file mode 100644 index 0000000..cc395fe --- /dev/null +++ b/.idea/misc.xml @@ -0,0 +1,29 @@ + + + + + + + + + + + + + 1.8 + + + + + + + + \ No newline at end of file diff --git a/.idea/modules.xml b/.idea/modules.xml new file mode 100644 index 0000000..c554adf --- /dev/null +++ b/.idea/modules.xml @@ -0,0 +1,8 @@ + + + + + + + + \ No newline at end of file diff --git a/.idea/vcs.xml b/.idea/vcs.xml new file mode 100644 index 0000000..35eb1dd --- /dev/null +++ b/.idea/vcs.xml @@ -0,0 +1,6 @@ + + + + + + \ No newline at end of file diff --git a/Aliases.md b/Aliases.md index fa53db8..f318b84 100644 --- a/Aliases.md +++ b/Aliases.md @@ -1,2 +1,216 @@ -# Aliases +**Version:** 0.3.0 and newer +Aliases +--- +Aliases are a powerful feature in sdrtrunk that enable you to assign meaning to +many of the logical identifiers found in radio communication systems. An +alias can represent one or more radios, radio groups, people, vehicles, +network nodes, etc. An alias can have multiple associated identifiers that +allow you to link together each of the pieces of information that can be used +to identify something or someone. + +Aliases provide the ability to trigger actions whenever any of the identifiers +that are associated with the alias are active on the radio network. For +instance, you can assign an alias to beep, or popup a message dialog whenever +the alias is active. By assigning a script alias action, the possibilities +are unlimited for triggered actions. + +Aliases also allow you to define audio monitoring priority, recording, and +network audio streaming of audio associated with the alias when active. + +![Figure 1: Alias Table and Single Alias Editor](images/Aliases.png) + +Figure 1 presents the Alias tab showing the alias table and the single alias +editor. In this view, you can select an individual alias row in the table +and the alias editor allows you to change any of the details about the alias +and to add or delete alias identifiers and alias actions. + +Each column in the table provides a drop-down field in the column header +allowing multiple search and row filtering options. + +Each of the single alias editor options are described later in this document. + +![Figure 2: Alias Table and Multiple Alias Editor](images/Aliases.png) + +Figure 2 shows the multiple alias editor. By selecting multiple rows of +aliases, you can modify individual settings across a set of aliases with a +single action. + +Click on a check box for a setting that you want to change, type in a value +or select from the list, and click **Save** to change that setting for all +selected aliases. + +Each of the multiple alias editor options are described later in this document + +Single Alias Editor - Alias Tab +--- + +The following are settings that can be modified for each alias. The single +alias editor is shown in Figure 1. + +#### Name +The alias name is the textual value that will be displayed everywhere that the +alias is used. + +#### List +An alias list is a named group of aliases that you attach to one or more +channel configurations. Type in a new alias list name select an existing +alias list name from the list. + +Attach an alias list to a channel configuration and all aliases with the +alias list name will be used by any decoder(s) specified in the channel +configuration. + +#### Group +An alias group is a second grouping option that allows you to better organize +your alias lists and to quickly filter your larger alias lists into manageable +sizes convenient for editing. The alias group value is not used by any of the +decoders and is only provided as a means for you to organize your aliases. + +#### Color +Select a color by clicking on the color bar and choose a color from the +dialog. This color will be used when displaying the alias name or when +plotting the GPS locations and path of travel for an alias on the integrated +map display. NOTE: use caution when choosing a light color or white, because +the text will not be visible against most of the white background displays. + +#### Icon +Choose an icon from the dropdown list or click on the **Icon Manager** button +to import your own custom icon to attach to your alias. The icon will be +displayed next to your alias name and will be used on the integrated map +display when plotting GPS locations. + +#### Save Button +After editing any of the settings in the aliast, click the **Save** button +to save the settings. + +#### Reset Button +Click the reset button if you have made changes to the alias settings and +wish to revert all settings back to the previous saved state. + +Single Alias Editor - Audio/Identifier Tab +--- +This tab allows you to assign one or more identifiers to an alias and to +assign audio settings for priority, recording and streaming. Once you have +attached audio or identifier items to an alias, you can select each item +individually in the list and an editor will appear allowing you to change +the setting(s) for the item. + +#### New Button +Click the new button to choose a new audio or identifier item to attach to +the alias. The items that you can add or attach to an alias are detailed +immediately following the Delete button description. + +#### Clone Button +Select an existing item in the list and click the Clone button to create a +duplicate copy of the item. You can then change the settings for the cloned +copy of the audio or identifier. + +#### Delete Button +Select an existing item in the list that you want to remove from the alias +and click the Delete button. + +#### Audio and Identifier Items + +##### ESN +Electronic Serial Number (ESN) identifiers used in specific decoders like +LTR-Net. + +##### Fleetsync +Kenwood fleetsync radio or group identifier. This identifier only applies to +the Fleetsync decoder. + +##### LoJack +Lojack function and ID. This identifier only applies to the LoJack decoder. + +##### LTRNet UID +LTR-Net Unique ID. This identifier only applies to the LTR-Net decoder. + +##### MDC-1200 +MDC-1200 radio identifier. This identifier only applies to the MDC-1200 +decoder. + +##### MPT-1327 +MPT-1327 radio or group identifier. This identifier only applies to the +MPT-1327 decoder. + +##### Passport MIN +Passport Mobile ID Number (MIN). This identifier only applies to the Passport +decoder. + +##### Site +Radio network site identifier. This identifier is used in the LTR-Net, +MPT-1327 and P25 decoders to allow you to alias each network site with a +meaningful site descriptor label. + +##### Status +Status code identifier. This identifier is used by the Fleetsync and +MPT-1327 decoders. + +##### Talkgroup +Talkgroup or radio identifier. This identifer is used by the P25, LTR +Standard, and Tait 1200 decoders. + +##### Audio Broadcast Channel +This audio setting designates an audio broadcast (streaming) channel. Any +audio calls associated with the alias will be streamed across the specified +streaming channel. + +##### Audio Non-Recordable +This audio setting designates the alias as non-recordable. If you wish to +change the alias and make it recordable again, simply delete the non-recordable +item from the list. + +##### Audio Priority +Assigns an audio listening priority of 1 (highest) to 100 (lowest), or +designates the alias as **Do Not Monitor** when you slide the setting all the +way to the right. + + +Single Alias Editor - Action Tab +--- +(to be continued) + +Multiple Alias Editor +--- +The multiple alias editor allows you to modify one or more settings across a +selected set of aliases. Simply use your mouse in combination with the +**Alt** key to select a range of aliases. Use your mouse in combination with +the **Control** key to select multiple individual aliases. + +**NOTE:** The multiple alias editor will only modify those settings that you +have selected by clicking the check box to the left of each setting. You can +modify multiple settings at a time by checking the box next to each setting +that you want to modify. + +#### Save and Reset Buttons +Click the **Save** button to apply any settings that you have changed. Click +the **Reset** button to reset any changes that you have made to the editor +panel, without applying those changes to the selected aliases. + +#### List, Group, Color and Icon +These settings are the same as detailed above for the single alias editor. + +#### Record +Recording is turned on for each individual channel configuration. When +recording is turned on, all calls are recorded. You can designate specific +aliases or groups of aliases to not be recorded by adding the **Non-Recordable** +alias identifier to each alias. + +Choose the **Non-Recordable** option to add the non-recordable alias identifier +to each of the selected aliases. Choos the **Recordable** option to remove +the non-recordable alias identifier from each of the aliases. You can view +the recordable status of each alias the single aliase editor, Audio Identifier +tab. + +#### Priority +Each alias can have an audio monitoring priority. Assign a value of 1 to 100 +where 1 is the highest priority and 100 is the lowest priority. Slide the +audio priority all the way to the right to select the **Do Not Monitor** +priority. Audio from any alias with Do Not Monitor will not be played over +the local speakers. + +#### Streaming +Each alias can be streamed over one or more internet audio streaming +channels. Internet streaming channels can be configured in the **Streaming** +tab. \ No newline at end of file diff --git a/images/Aliases.png b/images/Aliases.png new file mode 100644 index 0000000..facf13a Binary files /dev/null and b/images/Aliases.png differ diff --git a/images/MultipleAliasEditor.png b/images/MultipleAliasEditor.png new file mode 100644 index 0000000..9849665 Binary files /dev/null and b/images/MultipleAliasEditor.png differ diff --git a/sdrtrunk.wiki.iml b/sdrtrunk.wiki.iml new file mode 100644 index 0000000..72b1d62 --- /dev/null +++ b/sdrtrunk.wiki.iml @@ -0,0 +1,9 @@ + + + + + + + + + \ No newline at end of file