diff --git a/Primary-Application.md b/Primary-Application.md index 251f92d..5459494 100644 --- a/Primary-Application.md +++ b/Primary-Application.md @@ -65,9 +65,10 @@ The spectral display overlays the frequency spectrum with channel overlays for e the playlist manager as well as dynamically allocated traffic channels when decoding trunked radio systems. The cursor also displays the frequency value and current zoom levels when you hover your mouse over the spectral display areas. -### Spectral Display - Context Menus ![Image of the context menu that appears when you right-click on the spectral display panel](images/spectral_display_context_menu.png "Spectral Display Context MenuA") +### Spectral Display - Context Menus + * **Channels** Menu - displays a list of channels currently under the cursor area and presents menu option(s) to display each channel in the [Playlist Editor](Playlist-Editor) @@ -127,9 +128,10 @@ after you have disabled the spectral and waterfall displays. ## Waterfall Display Panel The waterfall panel displays a running history of the frequency content from the spectral display. -### Waterfall - Context Menus ![Image of the context menu that appears when you right-click on the waterfall panel](images/waterfall_context_menu.png "Waterfall Context MenuA") +### Waterfall - Context Menus + * **Pause** Menu - toggles on/off pausing of the waterfall display. This allows you to pause the display to inspect the frequency values for signals that have appeared in the recent past history so that you can configure a decoding channel for the correct frequency. @@ -154,6 +156,7 @@ channels (stereo) with separate call audio in each of the left and right audio c * **Mute Button** - the speaker icon controls muting of audio playback. Green indicates the audio is unmuted. Red indicates the audio is muted. Click the speaker icon to toggle between muted and unmuted. + * **MONO Panel** - displays the current call audio information when configured for a single playback channel. @@ -162,9 +165,10 @@ indicates the audio is muted. Click the speaker icon to toggle between muted an * **RIGHT Panel** - displays call audio details for the right audio channel when configured for stereo playback channels. +![Image of the context menu that appears when you right-click on the audio playback panel](images/audio_playback_context_menu.png "Audio Playback Panel - Context Menu") + ## Audio Playback Panel - Context Menus Right-click anywhere along the audio playback panel to access the context menu. -![Image of the context menu that appears when you right-click on the audio playback panel](images/audio_playback_context_menu.png "Audio Playback Panel - Context Menu") * **Configure** - button to open the [User Preferences](User-Preferences) editor and configure the mixer or sound card to use for audio playback. Each sound card or mixer device can be selected and configured for mono or stereo @@ -183,14 +187,182 @@ Volume submenu options. * **Channel: RIGHT** Menu - presents submenu options for configuring the RIGHT playback channel with the same Mute and Volume submenu options. +![Image of the tabbed views in the primary application window](images/now_playing_tabbed_views.png "Now Playing - Tabbed Views") + # Tabbed Views +At the middle of the application window are a collection of tabbed views that provide access to the Now Playing view, +Map view, Tuners view and Playlist Editor access button. ## Now Playing +The **Now Playing** tabbed view displays a table of channels currently decoding in the application. Each channel row +can be selected and you can access details about the channel in the Selected Channel tabbed views below. + +![Image of the active decoding channels table in the primary application window](images/now_playing_decoding_channels.png "Now Playing - Decoding Channels Table") + +### Decoding Channels Table +The decoding channels table lists the channels currently enabled for decoding. The following is a description of the +column contents. + +* **Status** - indicates the status or state of the decoder assigned to the channel. User-activated channels will +normally decode until the user stops the channel. Traffic channels that are dynamically created by the decoders will +exist in a sequence of states until the decoder decides to stop the channel when the activity on that traffic channel +has ceased. + * **ACTIVE** - the decoder is actively decoding information from the channel. + * **CALL** - unencrypted call audio is active on the channel. + * **CONTROL** - the decoder is actively decoding control messaging. + * **DATA** - the decoder is decoding a data packet. + * **ENCRYPTED** - channel messages are encrypted, normally associated with an encrypted call. + * **FADE** - the decoder has not decoded any messages or audio in at least the preceding two seconds. + * **IDLE** - channel is idle and the decoder is not decoding any messages or audio activity. + * **RESET** - channel is being reset to be reused. + * **TEARDOWN** - traffic channel activity has ceased and the channel is being torn down and stopped. + +* **Decoder** - the radio protocol decoder selected for the channel. +* **From** - one or more identifiers for the calling or sending entity. +* **Alias** - alias(es) for the identifiers listed in the **From** column +* **To** - one or more identifiers for the called or receiving entity. +* **Alias** - alias(es) for the identifiers listed in the **To** column +* **Channel** - logical channel identifier +* **Frequency** - center tuned frequency for the channel +* **Channel Name** - name assigned to the channel by the user in the channel configuration. Dynamically created traffic +channels will display **TRAFFIC** in this column. + +![Image of the selected channel tabbed views in the Now Playing tab](images/selected_channel_tabbed_view.png "Selected Channel - Tabbed and Details View") + +### Selected Channel - Tabbed Views +You can select individual channel rows in the decoding channels table and see channel and decoder status information in +the tabbed views below the table. + +### Selected Channel - Details View +The selected channel details view displays summary information about the channel or radio system produced by the channel +decoder. For certain radio protocols like the APCO25, the decoder assembles summary details about the radio +network and individual radio sites and channels. For other radio protocols, the decoder assembles a list of +observed entities active on the radio channel. + +* **System** - the user-assigned system label specified in the channel configuration. +* **Site** - the user-assigned site label specified in the channel configuration. +* **Channel Name** - the user-assigned channel name specified in the channel configuration. +* **Refresh** Button - refreshes the details panel with the latest summary information from the decoder. + +![Image of the selected channel events view in the Now Playing tab](images/selected_channel_events_view.png "Selected Channel - Events View") + +### Selected Channel - Events View +The events view displays a list of events occurring on the currently selected channel. You can enable logging of +these events in the [Playlist Editor](Playlist-Editor) channel configuration in the **Logging** tab. + +* **Filter** Button - provides options for filtering the contents of the events view. The set of filters are +specific to each decoder protocol. + + +* **Clear** Button - clears the contents of the events table. This button also has a down-click arrow submenu where you can +specify the quantity of events to keep in the table view. The default history value is 500. + +The following describes the columns of the events table. +* **Time** - timestamp for the event. You can configure the timestamp format in the [User Preferences](User-Preferences) editor. +* **Duration** - duration for events like audio calls that are not discrete time events. +* **Event** - description of the event type +* **From** - one or more entity identifiers that initiated the event. +* **Alias** - alias(es) for the from identifiers. +* **To** - one or more entity identifiers involved in the event. +* **Alias** - alias(es) for the to identifiers. +* **Channel** - logical channel ID where the event occurred. +* **Frequency** - of the channel for the event. +* **Details** - of the event. + +![Image of the selected channel messages view in the Now Playing tab](images/selected_channel_messages_view.png "Selected Channel - Messages View") + +### Selected Channel - Messages View +This view displays a table of messages decoded from the channel. You can enable logging of these messages in the +[Playlist Editor](Playlist-Editor) channel configuration in the **Logging** tab. + +The following describes the columns of this table: + +* **Time** - timestamp of the message +* **Protocol** - decoded radio protocol for the message +* **Timeslot** - timeslot where the message occurred. This will always be zero for non-TDMA radio protocols. +* **Message** - a description of the decoded message. + +![Image of the channel view tab for the selected channel in the Now Playing tab](images/selected_channel_channel_view.png "Selected Channel - Channel View") + +### Selected Channel - Channel View +The channel view provides details about the signal quality for the decoding channel and access to adjusting squelch +control when the channel uses the NBFM decoder. Each decoding channel produces occasional signal strength measurements +and those measurement details are displayed in the **Power(dB)** meter. This meter is not calibrated and the power +readings are as measured from the digitized channel sample stream. + +**Note:** the power meter details will be empty until you select a channel in the Decoding Channels table. + +* **Power (dB)** - meter that displays squelch and power measurement details for the currently selected channel. + * **Grey Bar** - current power level + * **Blue Line** - current squelch threshold (when supported by the decoder) + * **Pink LIne** - peak power level observed on the channel. This value is reset each time you refresh the channel +view by switching to another tab in the selected channel tabs and then revisiting the channel tab. + + +* **Peak** - peak observed channel power (dB) + + +* **Power** - current channel power (dB) + + +* **Squelch** - current squelch threshold (dB), Displays **Not Available** when squelch is not supported by the decoder. + + +* **Up Arrow** - increases the squelch threshold + + +* **Down Arrow** - decreases the squelch threshold + +![Image of the map view tab](images/map_view_tab.png "Selected Channel - Messages View") ## Map +Displays an Open Street Maps view for displaying geo-registered events produced by the channel decoders. Certain protocols +like APCO25, DMR and Fleetsync can produce radio GPS position reports and display those reports on the map. + +### Map Controls +* **Zoom** - use your mouse scroll wheel to zoom in/out of the map +* **Drag** - use your mouse left-click and hold to drag and reposition the map view. +* **Context Menu** - user your mouse to right-click anywhere in the map area to access the context menu. + * **Set Default Location & Zoom** Menu - stores the map's current center point and zoom level as the default map view +used when the application starts. ## Tuners ## Playlist Editor -# Streaming Status Panel \ No newline at end of file +The playlist editor button in the tabbed views provides quick access to launch the [Playlist Editor](Playlist-Editor) + +![Image of the streaming status panel](images/streaming_status_panel.png "Streaming Status Panel") +# Streaming Status Panel +The streaming status panel displays a status table for the enabled audio streaming configurations. Streaming is +configured in the [Playlist Editor](Playlist-Editor) and aliases are assigned to one or more streaming configuration. +This status panel displays the status of audio call streaming for each streaming configuration. The following +describes the columns of the status table: + +You can control display of the streaming status panel via the **View >> Show Streaming Status** menu option in the +primary application window. + +* **Streaming** - icon to indicate the stream format + + +* **Name** - of the streaming configuration + + +* **Status** - connection status for the stream + + +* **Queued** - number of completed audio calls that have not yet been streamed. + + +* **Streamed/Uploaded** - number of audio calls that have been streamed. + + +* **Aged Off** - number of completed audio calls that could not be streamed or uploaded because the call audio is too +old. This can happen when the call volume for the number of aliases assigned to the channel exceeds capacity of +the streaming channel and calls are aged off so that more current call audio can be streamed instead. + + +* **Upload Error** - number of calls that were rejected for streaming. This can happen with broadcastify +when multiple users are streaming for the same system. Broadcastify accepts the first stream request and will +reject subsequent and duplicate requests, based on call talkgroup and call timestamp. Broadcastify can also reject call +audio streaming requests when the service detects that your local computer system clock is not correct. diff --git a/images/map_view_tab.png b/images/map_view_tab.png new file mode 100644 index 0000000..c3f3920 Binary files /dev/null and b/images/map_view_tab.png differ diff --git a/images/now_playing_decoding_channels.png b/images/now_playing_decoding_channels.png new file mode 100644 index 0000000..a2b93de Binary files /dev/null and b/images/now_playing_decoding_channels.png differ diff --git a/images/now_playing_tabbed_views.png b/images/now_playing_tabbed_views.png new file mode 100644 index 0000000..4923256 Binary files /dev/null and b/images/now_playing_tabbed_views.png differ diff --git a/images/selected_channel_channel_view.png b/images/selected_channel_channel_view.png new file mode 100644 index 0000000..4b7a931 Binary files /dev/null and b/images/selected_channel_channel_view.png differ diff --git a/images/selected_channel_events_view.png b/images/selected_channel_events_view.png new file mode 100644 index 0000000..7b31c95 Binary files /dev/null and b/images/selected_channel_events_view.png differ diff --git a/images/selected_channel_messages_view.png b/images/selected_channel_messages_view.png new file mode 100644 index 0000000..e465b5b Binary files /dev/null and b/images/selected_channel_messages_view.png differ diff --git a/images/selected_channel_tabbed_view.png b/images/selected_channel_tabbed_view.png new file mode 100644 index 0000000..d56da16 Binary files /dev/null and b/images/selected_channel_tabbed_view.png differ diff --git a/images/streaming_status_panel.png b/images/streaming_status_panel.png new file mode 100644 index 0000000..e70a6a4 Binary files /dev/null and b/images/streaming_status_panel.png differ