WF - Telemetry - Application Notes - R1.0
WF - Telemetry - Application Notes - R1.0
Telemetry
Application Notes
Version 1.0
Hytera is the trademark or registered trademark of Hytera Communications Co., Ltd. (the
Company) in PRC and/or other countries or areas. The Company retains the ownership of
its trademarks and product names. All other trademarks and/or product names that may
The product described in this document may include the Company’s computer programs
stored in memory or other media. Laws in PRC and/or other countries or areas protect the
exclusive rights of the Company with respect to its computer programs. The purchase of
this product shall not be deemed to grant, either directly or by implication, any rights to the
purchaser regarding the Company’s computer programs. Any of the Company’s computer
Disclaimer
The Company endeavors to achieve the accuracy and completeness of this document,
but no warranty of accuracy or reliability is given. All the specifications and designs are
this document may be copied, modified, translated, or distributed in any manner without
If you have any suggestions or would like to learn more details, please visit our website at:
http://www.hytera.com.
Revision History
1
Contents
1. Overview ....................................................................................................................... 4
1.2 Application............................................................................................................ 4
2. References.................................................................................................................... 9
3. Requirements.............................................................................................................. 10
4. Configurations ..............................................................................................................11
4.1 Tools....................................................................................................................11
4.3.4 Setting the Query Status Command for Target Terminal .......................... 17
5.2 Scenario............................................................................................................. 20
2
6.2 GPIO Interface of Mobile Terminal ..................................................................... 25
7. FAQ............................................................................................................................. 27
3
1. Overview
1.1 Definition
Telemetry is a function, which allows you to stay in control of your device remotely. In
other words, it enables you to control and monitor the GPIO Pins of a mobile terminal
attached to the external device, which in turn can monitor this device via another mobile
terminal remotely.
1.2 Application
The telemetry feature is mainly used to monitor and control the device remotely all the
time.
At present, both the portable terminal and mobile terminal support this feature.
1.3 Principle
The telemetry feature allows you to monitor and control the status of GPIO pins for a
mobile terminal attached to the external device, which in turn can monitor this device
When a remote terminal connects with an external device, it is capable of taking an action
upon receiving the command from the current terminal according to the predefined
telemetry function. For example, when the target terminal connects with the external
device, the source terminal will get the operating status of this device or control this device
4
feature to a programmable key and to associate the physical GPIO pins with virtual
telemetry VIO for the terminal. In addition, all above configurations must be identical for
The transmission of the telemetry command is similar to the way that other transmissions
in digital mode. Also, it conforms to the transmission admittance of the terminal, that is,
this transmission is inhibited if the channel is busy or the color code is not available. You
can select the Private Call or Group Call from the Contact to send the telemetry command.
However, the specific transmission mode varies with the different commands.
The telemetry has ten commands including Send Pulse Command, Send Toggle Voltage
Command, Send Voltage Inactive Command, Send Query Status Command, Send Status
Command, Send Status w/Text, On pulse command, On Toggle Voltage Command, and
On Active/Inactive Voltage Command. All commands are classified into output command
5
and input command. The former can be transmitted directly in case of satisfying certain
conditions, and the latter only can take an action to the received command.
This is an output command. When the source terminal sends this command to the target
terminal, the target terminal will respond to it by outputting a pulse via the designated
GPIO pin. This command can be transmitted by the programmable key or the status of
GPIO Pin.
This is an output command. When the source terminal sends this command to the target
terminal, the target terminal will respond to it by toggling the voltage via the corresponding
GPIO Pin. This command can be transmitted by the programmable key or the status of
GPIO pin.
This is an output command. When the source terminal sends this command to the target
terminal, the target terminal will respond to it by outputting the active voltage via the
corresponding GPIO Pin. This command can be transmitted by the programmable key or
This is an output command. When the source terminal sends this command to the target
terminal, the target terminal will respond to it by outputting the inactive voltage via the
corresponding GPIO pin. This command can be transmitted by the programmable key or
This is an output command. When the source terminal sends this command to the target
terminal, the target terminal will acknowledge its status of GPIO pin to it. Finally the
voltage information will appear on the source terminal’s display. This command can be
6
Send Status Command
This is an output command. When the source terminal sends this command to the target
terminal, the target terminal will display the statuses information of the source terminal.
This is an output command. When the source terminal sends its status of GPIO pins and a
piece of text message to the target terminal, these statuses information will appear on the
target terminal’s display. In addition, the target terminal can display and save the received
test message. This command can be transmitted by the status of GPIO pin.
On Pulse Command
This is an input command. When the terminal receives this command, the pulse will be
output via the corresponding GPIO Pin. Here, the configuration of telemetry VIO must be
identical with that of the target VIO. This command can be transmitted by other terminals.
This is an input command. When the terminal receives this command, the voltage from
the designated GPIO Pin will toggle. Here, the configuration of telemetry VIO must be
identical with that of the target VIO. This command can be transmitted by other terminals.
This is an input command. When the terminal receives this command, the voltage will be
output via the corresponding GPIO Pin. Here, the configuration of telemetry VIO must be
identical with that of the target VIO. This command can be transmitted by other terminals.
1.4 Version
* This document (R1.0) is intended to give a rough description about the Telemetry
7
feature. More information will be available in later versions.
* Consult your dealer for more information on DMR conventional series software.
1.5 Restriction
8
2. References
N/A
9
3. Requirements
* Please refer to Hytera DMR Conventional & Trunking Series Device List. Contact your
10
4. Configurations
4.1 Tools
Before using the telemetry feature, telemetry command, telemetry button and telemetry
VIO must be programmed for the terminal via the programming software below:
*Please refer to Hytera DMR Conventional & Trunking Series Device List. Contact your
A terminal may be a portable radio or mobile radio. Please refer to Hytera DMR
Conventional & Trunking Series Device List. Contact your dealer for details.
Both the source terminal and target terminal shall be configured correctly. Otherwise, the
target terminal can not respond to the command from the source terminal.
2) Go to “Conventional -> General Setting -> Telemetry” for DMR trunking terminal or
“General Setting -> Telemetry” for DMR conventional terminal. See the figure below:
11
Figure 4.2-1 Setting Telemetry Feature
3.1) Configure the “Action” parameter. It allows the user to set the command to be
sent. As this parameter determines whether to enable the telemetry feature correctly,
A telemetry button can be mapped to a particular telemetry command. There are five
Command, Send Active Voltage Command, Send Inactive Command or Send Query
The telemetry VIO can be mapped to a particular command: There are nine
Command, Send Active Voltage Command, Send Inactive Command, Send Status
Note: Although different telemetry VIOs can be mapped to the same command, only
3.2) Configure the “Description” parameter. It allows the user to enter the description
regarding the telemetry function. This description will appear on the terminal’s display
3.3)Configure the “Pulse Time [ms]” parameter. It defines the width of the pulse at the
GPIO pin. When the terminal responds to the received Pulse Command, a pulse with
width predefined in this parameter will be output via the designated GPIO pin.
Note: This option is available only when the “Action” parameter is set to “On Pulse
Command”.
3.4) Configure the “Digital Call” parameter. It allows the user to select a Private Call or
3.5) Configure the “Target VIO” parameter. It defines the telemetry VIO port of the
12
target terminal, which is used to respond to the command.
3.6) Configure the “Quick Text” parameter. It allows the user to select the text
message predefined in “Conventional -> DMR Service -> Quick Text ” (for trunking
terminal) or “DMR Service -> Quick Text” (for conventional terminal) to be sent.
4) Go to “Conventional -> General Setting -> Buttons” (for trunking terminal) or “General
Setting -> Buttons” (for conventional terminal). See the figure below:
The programmable key can be paired with the telemetry button 1, telemetry button 2 or
telemetry button 3. Both portable terminal and mobile terminal can be set to support three
telemetry buttons.
“General Setting -> Accessories” (for conventional terminal) to set GPIO pins feature and
13
Figure 4.2-3 Setting Accessories for Mobile Terminal
The mobile terminal offers six pins (Pin3, Pin12, Pin 16, Pin20, Pin22 and Pin23) for
telemetry.
6) Finally write the new configuration data into the terminal via CPS.
14
4.3 Setting the Telemetry Commands
It is vital to correctly configure the telemetry command, telemetry buttons and telemetry
VIO for both the source terminal and the target terminal, in order to enable the telemetry
feature.
The Send Pulse Command shall work with the On Pulse Command, to enable the terminal
to receive or respond to the pulse command. When the source terminal sends a Pulse
Command to the target terminal, the target terminal will respond to this command by
Note: the target terminal shall be other terminals rather than the source terminal.
On the source terminal, it is necessary to set the Action to Send Pulse Command and
define the telemetry VIO. On the target terminal, it is required to set the Action to On Pulse
Command. In addition, the Telemetry VIO shall be configured to match the telemetry VIO
of the source terminal and be paired with the physical GPIO pin.
When the source terminal selects a Private Call from the Contact to send a Pulse
Command, the target terminal will respond to this command by outputting a pulse signal
via the GPIO Pin port and acknowledge the execution result to source terminal. However,
no reply about the execution result will be given for group call.
The Send Active Voltage Command shall work with the On Active/Inactive Voltage
Command to enable the terminal to receive or respond to the voltage command. When
15
the source terminal send a voltage command to the target terminal, the target terminal will
respond to this command by outputting a voltage via the designated GPIO pin.
Note: the target terminal shall be other terminals rather than the source terminal.
On the source terminal, it is necessary to set the Action to Send Active Voltage Command
and define the telemetry VIO. On the target terminal, it is required to set the Action to On
match the telemetry VIO of the source terminal and be paired with the physical GPIO pin.
Accordingly, the Send Inactive Voltage Command shall work with the On Active/Inactive
Voltage Command.
When the source terminal selects a Private Call from the Contact to send a voltage
command, the target terminal will respond to this command by outputting a voltage via the
GPIO Pin port and acknowledge the execution result to source terminal. However, no
reply about the execution result will be given for group call.
This feature involves two parts: command sending and command responding. If the target
terminal makes response upon receiving this command, the voltage at the predefined port
will toggle.
At transmitting end, you need to set “Send Toggle Voltage Command” and specify
Telemetry VIO properly, but no need to associate the VIO and physical GPIO; At target
end, you need to set the response to “Send Toggle Voltage Command” and specify the
same Telemetry VIO as that of transmitting end. Additionally, the Telemetry VIO must be
16
This command can be sent to the target terminal via private call or group call. The target
terminal will give an acknowledgement after it implements the command. However, if the
In order for this command to be implemented properly, do follow the above instructions.
This feature allows you to check the GPIO status of target terminal. When the target
terminal receives this command, it will send the query result to the terminal requesting the
status.
Note:
3. The status is unavailable when the Telemetry VIO and physical GPIO of target
This command is sent to the target terminal via private call. After receiving the command,
the target terminal will check its GPIO status immediately, and send the result to the
terminal giving the query request. In order to get the right result, this command shall be
set at the source terminal properly, and the Telemetry VIO and physical GPIO Pin of target
must be associated.
The terminal sending “Query Status Command” sends its GPIO status to the target
terminal. Accordingly, the target terminal will make an appropriate response after receiving
the command.
Note:
17
1. The target terminal shall not be the local one.
3. The status is unavailable when the Telemetry VIO and physical GPIO of source
The GPIO status of source terminal can be sent to the target terminal via private call or
group call. After receiving the command, the target will make an acknowledgement for
private call. However, no acknowledgement will be given for group call. In order to get the
right result, this command shall be set at the source terminal properly, and the Telemetry
The terminal sending “Status Command” sends its GPIO status with text message to the
target terminal. Accordingly, the target terminal will make an appropriate response after
receiving the command. As shown in figure 4-3, you can choose to view text message by
pressing Text button. In text view mode, you can also change GPIO information to Status
Note:
18
3. The status is unavailable when the Telemetry VIO and physical GPIO of source
This command can be sent to the target terminal via private call or group call. After
receiving the command, the target terminal will display the GPIO status with text message
and save it. In order to get the right information, this command shall be set at the source
terminal properly, and the Telemetry VIO and physical GPIO Pin must be associated.
19
5. Instructions of Use
There are three ways to activate the feature: pressing the programmed Telemetry key,
GPIO status change and receiving the appropriate command from other terminals.
To activate this feature by a programmable key, you need to perform related operations
with the terminal and assign it to the programmable key. For example, you can associate
the “Send Pulse Command” with “Telemetry Button 1”, and assign “Send Pulse
Command” to TK key. Then you can press the TK key to send pulse command.
When the terminal is connected with a telemetry device, any change in device status
would result in GPIO status change. In case that there any command associated with
GPIO status change, the terminal will implement the command when GPIO status
changes. For example, when the GPIO status changes as a result of the change in the
status of connected telemetry device, the terminal will implement the predefined
command, namely, it will send its GPIO status to the target terminal. In this way, you can
When a terminal receives the command from another terminal, it will perform an
appropriate operation associated with the command. For example, it receives “Toggle
Voltage Command”, and it will toggle the voltage of specified GPIO Pin as configured
previously.
5.2 Scenario
20
Figure 5.2.1-1 Querying the status of remote telemetry device
Source terminal:
1) Send a query command to the target terminal to check the GPIO status of remote
terminal, so as to get the status of telemetry device. Note that the query command shall
2) Receive the query result and get the status of telemetry device.
Target terminal:
3) Send GPIO status to the source terminal sending the query command.
You can also use this feature to check the status of your desired device remotely such as
the door.
21
Source terminal:
1) Send the control command to a terminal or a group of terminals. This command can
cause the specified GPIO Pin to output active/inactive voltage, to toggle the voltage or to
2) Receive the control response from target terminal to get the control result.
Target terminal:
3) Send operation result to the source terminal. However, no reply will be given if the
This feature allows you to control a device remotely such as opening an automatic door
remotely.
Telemetry
equipment Source Terminal Target Terminal
Source terminal:
1) Change in telemetry device status would cause the terminal GPIO status to change,
which will trigger the source terminal to upload its GPIO status.
2) Send Status w/Text Command to send its GPIO status to the target terminal.
Target terminal:
22
1) Receive Status w/Text Command to get the status of telemetry device, and display and
2) Send operation result to the source terminal. However, no reply will be given if the
You can also use this feature to get the status of your desired device remotely such as the
door. In addition, you can use the related telemetry command to control the device
connected with the target terminal. For example, you can connect the target terminal with
an automatic door. Then send a telemetry command to the target terminal to trigger an
TX=f1
RX=f2
Slot=1
O
PI
G
TX=f1
RX=f2
Slot=1 GPIO
f1
1
Sl
ot
Source Target
ot
Sl
f2
terminal
f2
terminal
Sl
TX=f2
ot
ot
Sl
1
f1
RX=f1
Slot=1
TX=f2
f2
2
Sl
RX=f1
ot
ot
f1
Sl
2
Sl
Slot=2
f1
ot
ot
2
Sl
TX=f1
f2
RX=f2 TX=f1
Slot=2 RX=f2
Slot=2
GPIO GPIO
Telemetry Telemetry
equipment Source terminal Target terminal equipment
Telemetry can be used in Repeat mode. The telemetry settings in this mode are the same
23
as those in Direct mode, but please note that the source terminal and the target terminal
1) Querying the status of remote telemetry device. The source terminal and the target
terminal share the same frequency, and use the same slot (slot1) to transmit or and
receive. In Repeat mode, the source terminal sends Query Status Command to the target
terminal via the repeater. After receiving the command, the target terminal will send its
GPIO status to the source terminal so that users can get the current status of telemetry
device remotely.
2) Controlling a remote device. In figure 5.2.2-1, the source terminal and the target
terminal share the same frequency, and use the same slot (slot1) to communicate. In
Repeat mode, the source terminal sends the telemetry command to the target terminal via
the repeater. After receiving the command, the target terminal will change the GPIO status
to control the telemetry device, and send the result to the source terminal. However, no
reply will be given if the control command is sent via group call.
3) Uploading the GPIO status. In figure 5.2.2-1, the source terminal and the target terminal
share the same frequency, and use the same slot (slot2) to communicate. When the
status of connected external device changes, the GPIO status will change as well, which
would trigger the source terminal to send the predefined telemetry command to the target
terminal. In this way, you can get the status of foregoing device and perform related
control operations.
24
6. GPIO Interface
The portable terminal supports 1 telemetry VIO, which is associated with GPIO Pin11. See
figure 6.1-1.
The mobile terminal supports 6 telemetry VIOs. GPIO Pin3, Pin12, Pin 16, Pin20, Pin22
and Pin23 can be set to the telemetry VIO. See figure 6.2-1.
25
Figure 6.2-1 GPIO interface of mobile terminal
26
7. FAQ
This feature is available in digital mode with DMR terminals. It does not need to be
activated or deactivated manually. However, you shall configure related commands to use
this feature properly. If you do not need this feature, do not configure any
Yes, telemetry command is also subject to the TX rules-the same as other TX operations
with the terminal in digital mode. To send the telemetry command properly, it shall satisfy
these conditions: the telemetry command is configured correctly, the channel is free, the
color code is free, the source terminal and target terminal use the same frequency and
use the same slot (in Repeat mode). Additionally, the source terminal shall not be set to
“Receive only”.
In the following conditions, the telemetry command can not be sent either: not associating
the feature with a programmable key (if sent via the programmable key); not associating
VIO with GPIO (if sent via GPIO status change). Therefore, be sure to configure the
Error message will be given if no reply is given after the telemetry command is sent. The
reason may be that the target terminal does not receive the command, or that the channel
If the target terminal fails to reply to the source terminal after receiving the command, the
27
reason may be that the telemetry command is not configured properly at the source
terminal, no telemetry VIO is specified or mapped, the target terminal is not configured
properly or other reasons (such as failed to get GPIO status). Please note that no reply
For a terminal in TX mode, it can not receive any telemetry command; when it is in RX
mode, it can receive the telemetry command, but the precondition is that the signal
strength of source terminal is stronger than that of the one transmitting to it.
The portable terminal supports one telemetry VIO (GPIO Pin11); The mobile terminal
supports 6 telemetry VIOs. GPIO Pin3, Pin12, Pin 16, Pin20, Pin22 and Pin23 can be set
28