Mototrbo Adk Overview
Mototrbo Adk Overview
Mototrbo Adk Overview
Version 01.04
11/4/2010
COPYRIGHTS
The enclosed documents and ideas embodied herein are the proprietary information of
Motorola. Any dissemination or disclosure of such violates Motorolas intellectual
property rights. Motorola reserves all rights to all actions arising there under.
Motorola disclaims any liability for any use of the specification. Motorola limits all
warranties to the extent allowed by law. Furthermore, Motorola reserves the right to
change this specification at any time without any prior notification. And there is no
guarantee that such changes will be backwards compatible with previous version of the
specification.
Version 01.04
MOTOTRBO
Application Development Kit
Overview
TABLE OF CONTENTS
Section 1 .................................................................................................................... 4
1.0 What is MOTOTRBO?................................................................................... 4
Section 2.................................................................................................................... 6
2.0 Extending the MOTOTRBO Product ............................................................. 6
2.1
MOTOTRBOOption Board ADK.......................................................... 7
2.2
MOTOTRBOXCMP-Based IP Capable Peripheral ADK ..................... 8
2.3
MOTOTRBONon-IP Capable Peripheral ADK.................................. 10
2.4
MOTOTRBOTelemetry ADK............................................................. 11
2.5
MOTOTRBOLocation Data ADK....................................................... 14
2.6
MOTOTRBOText Messaging ADK ................................................... 15
2.7
MOTOTRBOAutomatic Registration Service (ARS) ADK ................. 17
2.8
Presence Notifier.................................................................................. 18
2.9
Data Services....................................................................................... 19
2.10 MOTOTRBORepeater Application Interface ADK............................. 20
Section 3.................................................................................................................. 25
3.0 Professional Radio Application Developer Program ....................................... 25
Section 4.................................................................................................................. 27
4.0 Service & Support for Application Development ............................................. 27
Section 5.................................................................................................................. 28
5.0 Further Information and Contact ..................................................................... 28
Section 6.................................................................................................................. 29
6.0 Appendix: ADK Document Map ...................................................................... 29
Version 01.04
MOTOTRBO
Application Development Kit
Overview
Section 1
1.0
What is MOTOTRBO?
Version 01.04
MOTOTRBO
Application Development Kit
Overview
Version 01.04
MOTOTRBO
Application Development Kit
Overview
Section 2
2.0
Aside from the functionality embedded in the radio, the MOTOTRBO subscribers
capabilities can be extended through defined application programming interfaces for
third party developer use. The MOTOTRBO Application Development Kits (ADKs)
offer an opportunity to customize a solution specifically to a customers need.
The MOTOTRBO ADKs are comprised of protocol specifications and development
guidelines that are intended as technical references for the external vendor. These
ADKs not only include software specifications, but also include electrical and
mechanical specifications, where applicable. Each interfaces set of technical
references also detail the specific domain knowledge required to successfully
implement a 3rd party application for the MOTOTRBO product.
These are the primary ADKs for developer use:
The requirements for the Connect Plus trunking system feature are documented in
separate ADKs. The documents emphasize the changes that interfaces between
MOTOTRBO conventional and the Connect Plus system. The MOTOTRBO ADKs for
Connect Plus describe the applicable technical specifications for Location Data, Text
Messaging, Presence Notifier, and Data Services.
The following documents describe the deltas between conventional and the Connect
Plus trunking system. The Connect Plus ADKs are companion documents with the
MOTOTRBO guides and spec.
Version 01.04
MOTOTRBO
Application Development Kit
Overview
Please refer to the individual ADK sections for more information on the interface. Refer
also to the Appendix: ADK Document Map for more information on document
components for each ADK.
Version 01.04
MOTOTRBO
Application Development Kit
Overview
For more information about the other interfaces, please refer to the appropriate
sections contained within this overview.
Version 01.04
MOTOTRBO
Application Development Kit
Overview
logical interface. This interface allows the radio to function as a USB device
attached to an IP capable peripheral.
The MOTOTRBO radio is able to send/receive XCMP/XNL message from an
external IP capable device via a unique TCP port. The radio attached to the
external IP capable device executes the XCMP commands from the external
application and reports the status change.
Although it operates as a USB device when an external IP capable device
connects through the radio accessory connector, the MOTOTRBO subscriber
is still considered a master device within the XCMP/XNL architecture.
When communicating with the radios XCMP/XNL interface, the external IP
capable device becomes an XCMP device. Therefore it can even directly
communicate with other XCMP devices connected to the radio, for example, the
Option Board through XCMP/XNL message.
As an example, Figure 3 illustrates the interface architecture for the
MOTOTRBO IP capable peripheral with an XCMP-based application.
For more information about the XCMP IP capable peripheral and also its
operation with other applications offered by the MOTOTRBO radio, please see
the following references:
For more information about the other interfaces, please refer to the appropriate
sections contained within this overview.
Version 01.04
MOTOTRBO
Application Development Kit
Overview
Radio Network
CAI
MOTOTRBO
Radio
TM
XCMP
XNL
TCP
XCMP
XNL
TCP
IP
RNDIS
USB
IP
NDIS
USB
USB
Mic Audio
Speaker Audio
IP Capable
Device
Application
Accessory Connector
Version 01.04
10
MOTOTRBO
Application Development Kit
Overview
XCMP/XNL is used as the application communication protocol between the NonIP Capable Peripheral and the MOTOTRBO radio. The Non-IP Capable
Peripheral is considered a non-master device within the XCMP/XNL architecture.
The XCMP/XNL protocol provides a set of commands for an external device to
control and manage the MOTOTRBO radios.
The USB and XNL connections are independent of the analog/digital RF modes
of operation. The Non-IP Capable peripheral does not need to re-establish the
USB or XNL connections after mode change.
As an example, Figure 4 illustrates the interface architecture for the
MOTOTRBO Non-IP capable peripheral.
Application
Application
XCMP
XCMP
XNL (Slave)
XNL (Master)
CDC ACM
CDC ACM
USB Host
USB Device
USB Cable
MOTOTRBO Radio
For more information about the Non-IP capable peripheral and also its operation
with other applications offered by the MOTOTRBO radio, please see the
following references:
For more information about the other interfaces, please refer to the appropriate
sections contained within this overview.
Version 01.04
11
MOTOTRBO
Application Development Kit
Overview
A Telemetry Services PC application interoperates with a MOTOTRBO radio
via direct USB connection and can monitor or control the general purpose inputs
and outputs (GPIOs) of a radio. Telemetry operation is available while the
MOTOTRBO product is operating in digital mode only.
Telemetry operation is available on 3 GPIOs for the MOTOTRBO portable and
on 5 GPIOs for the MOTOTRBO mobile. The status of telemetry events can be
queried for inputs or outputs. The state transition of telemetry inputs can also be
announced and shown on a display-capable MOTOTRBO radio.
Routing of telemetry information in the radio network is accomplished using
UDP/IP. The destination of the telemetry data can be either to a Telemetry
Services PC application or to another device such as an option board. The
Telemetry interface can also broadcast telemetry status over-the-air to specific
MOTOTRBO subscribers within the radio network.
Version 01.04
12
MOTOTRBO
Application Development Kit
Overview
TP
UDP
IP
RNDIS
USB
Telemetry
Services
Application
MOTOTRBOTM
Radio
PC Environment
TP
UDP
IP
CAI
Radio Network
TP
UDP
IP
CAI
GPIO
MOTOTRBOTM
Radio
GPIO
Version 01.04
13
MOTOTRBO
Application Development Kit
Overview
For more information about the other interfaces, please refer to the appropriate
sections contained within this overview.
PC Environment
LBS
Application
Radio Network
LRRP
UDP
IP
CAI
LRRP
UDP
IP
RNDIS
USB
LRRP
UDP
IP
CAI
MOTOTRBOTM
Radio
LRRP
GPS
Component
MOTOTRBOTM
Radio
Messages for requests and responses for location data are handled through the
Location Request and Response Protocol (LRRP). LRRP is a location data
reporting protocol that is optimized for use within the MOTOTRBO Radio
Version 01.04
14
MOTOTRBO
Application Development Kit
Overview
Network. LRRP control and data messages are sent via the Radio Network within
UDP/IP packets that are transported over the Common Air Interface (CAI). The
LRRP messages are processed directly by the embedded GPS components
inside the MOTOTRBO radio as well as within the LBS PC application. The
Location Data interface can also interoperate with the MOTOTRBO Option
Board interface to route location data directly to a custom option board device.
The Location Data interface facilitates asset tracking via location-based services.
For example, a LBS application can provide an Automated Vehicle Location
(AVL) capability to track the position of delivery trucks in the coverage area of the
MOTOTRBO system.
For more information about the MOTOTRBO Location Data interface, please
see the following references:
For more information about the other interfaces, please refer to the appropriate
sections contained within this overview.
Version 01.04
15
MOTOTRBO
Application Development Kit
Overview
PC Environment
TMS
Application
Radio Network
TMP
UDP
IP
CAI
TMP
UDP
IP
RNDIS
USB
UDP
IP
CAI
TMP
TMP
TMS
Component
MOTOTRBOTM
Radio
TMS
Component
MOTOTRBOTM
Radio
Text messages are routed within the Radio Network as UDP/IP packets
transported over the MOTOTRBO Common Air Interface (CAI). The
destination of text messages is determined by the target IP address and port
number. This enables the routing of text messages to two logically different
devices that are physically connected together (e.g. PC attached to
MOTOTRBO radio via USB). In addition, the Text Message interface
interoperates with the MOTOTRBO Option Board interface to route text
messages directly to the option board for processing.
The Text Messaging Services interface provides alternate methods for sending
and receiving text messages within the MOTOTRBO system. A model
implementation of this interface would be a PC-based dispatch messaging
center. The messaging center contains a user interface for typing text messages
to be sent to an individual radio or a group of radios as well as an output screen
for displaying received messages.
Version 01.04
16
MOTOTRBO
Application Development Kit
Overview
For more information about the MOTOTRBO Text Messaging Services
Interface, please see the following references:
For more information about the other interfaces, please refer to the appropriate
sections contained within this overview.
Version 01.04
17
MOTOTRBO
Application Development Kit
Overview
For more information on the application of the ARS interface and its protocol,
please see the following references:
Service
(ARS)
Protocol
For more information about the other interfaces, please refer to the appropriate
sections contained within this overview.
Backend
Application
TM
MOTOTRBO
Radio
Automatic
Registration
Service
UDP
IP
CAI
Radio Network
Notification
UDP
IP
Subscription
Presence
Notifier
UDP
IP
Version 01.04
18
MOTOTRBO
Application Development Kit
Overview
The Presence Notifier tracks the state of each MOTOTRBO radio on the Radio
Network and reports each radios state to each Backend Application. Each
backend application must subscribe with the Presence Notifier in order to receive
notifications of each MOTOTRBO radio of interest. Information between each
Backend Application and the Presence Notifier is exchanged as UDP/IP packets.
For more information about the Presence Notifier, please see the following
references:
For more information about the other interfaces, please refer to the appropriate
sections contained within this overview.
Version 01.04
19
MOTOTRBO
Application Development Kit
Overview
UDP/IP
over USB
MOTOTRBO
Mobile
Radio Network
MOTOTRBO
Mobile
UDP/IP
over USB
The attached PCs are mapped to an IP space that is separate from the
MOTOTRBO radio IP address range. Therefore, data intended to the attached
IP-capable device or the MOTOTRBO radio can be routed to the appropriate
endpoint.
For more information about the Data Services capability, please see the following
reference:
For more information about the other interfaces, please refer to the appropriate
sections contained in this overview.
Version 01.04
20
MOTOTRBO
Application Development Kit
Overview
network provided by an Internet Service Provider (ISP). The same MOTOTRBO
IP Site Connect protocol is used in an IP Site Connect system or a Capacity Plus
system for communication between peers.
When the digital MOTOTRBO repeater operates in the IP Site Connect mode,
it supports two TDMA time slots or two logical channels. The channel can be a
Local Area Channel (LAC) to repeat the on-site traffic over the air or a Wide Area
Channel (WAC) to send the traffic to the peers. The traffic received over the air
in the WAC are sent out to all the peers by the MOTOTRBO repeater. ,
Therefore, the voice, data and control packets can be exchanged across
disperse locations and different radio frequency bands. The traffics received
over the air in the LAC are sent out to the third party application peers only.
At the WAC, the MOTOTRBO repeater transmits the IPSC voice, data and
control messages received at the network interface over the air regardless of
whether the message is sent by another MOTOTRBO repeater or a third party
application peer. However, at the LAC, the MOTOTRBO repeater only transmits
the IPSC control message from the third party application peer over the air in
MOTOTRBO 1.7 Release.
When the digital MOTOTRBO repeaters operate In the Capacity Plus mode,
they form a single site trunked system, where a pool of channels are shared to
support a large group of talkgroups and radio users. The traffics received over
the air in the trunked channel are sent out to the third party application peers.
The MOTOTRBO repeater only transmits the IPSC control message from the
third party application peer over the air in MOTOTRBO 1.7 Release.
Both the analog and digital MOTOTRBO repeater supports the Repeater
Diagnostics, Alarm and Control (RDAC) feature. The RDAC feature uses the
repeater to send alarm and diagnostic information to a remote application and
receive control command from a remote application. The remote application
which receives/sends RDAC message from/to the MOTOTRBO repeater is called
RDAC application.
To improve the network bandwidth efficiency for the application interested in
system traffic profile analysis or billing, the digital MOTOTRBO repeater supports
the Repeater Call Monitoring (RCM) feature since MOTOTRBO 1.7 Release.
The RCM feature uses the repeater to send call status, repeater repeating state
and repeater blocking state to a remote application.
To send/receive the IP Site Connect messages, which can be voice/data/control
messages and RDAC messages, in the IP Site Connect system or in the
Capacity Plus system, a third party application peer has to first join the system by
following the IP Site Connect Link Establishment protocol.
Version 01.04
21
MOTOTRBO
Application Development Kit
Overview
When a MOTOTRBO repeater peer receives a voice/data call over the air, it
encapsulates the Digital Mobile Radio (DMR) bursts as the Real-time Transport
Protocol (RTP) payload, adds the RTP packet as the payload of the IP Site
Connect Voice/Data Call message, and wraps the IP Site Connect message in
the UDP/IP message before sending to each peer. Therefore, a third party
application peer must have the knowledge of DMR burst, RTP protocol, IP Site
Connect protocol and UDP/IP to retrieve the user data from the IP Site Connect
message or to send message to other peers.
RDAC
Application
System Logger
Application
Figure 11 shows an example IP Site Connect system where the repeaters have
one LAC and one WAC. Instead of connecting the Application Server at each
site through a control station at the LAC, a centralized application server can
monitor the all the repeaters, logging the activities on both the WACs and LACs..
IP Network
Wide Area
Channel 1
(Slot 1)
Local Area
Channel 2
(Slot 2)
Site 1
Wide Area
Channel 1
(Slot 1)
Local Area
Channel 2
(Slot 2)
Site 2
Wide Area
Channel 1
(Slot 1)
Local Area
Channel 2
(Slot 2)
Site 3
Figure 11 - Wide and Local Area Systems with Distributed and Centralized Application Servers
Figure 12 shows a third party application joins both the IP Site Connect system
and the Capacity Plus system and logs activities in both systems.
Version 01.04
22
MOTOTRBO
Application Development Kit
Overview
Trunked
Channel 1
(Slot 1)
Trunked
Channel 3
(Slot 1)
Trunked
Channel 2
(Slot 2)
Trunked
Channel 4
(Slot 2)
Repeater 4
(Master Peer)
Repeater 3
Data Revert
Channel 1
(Slot 1)
Data Revert
Channel 2
(Slot 2)
Repeater 3
Router
IPv4 Network
RDAC
Application
Local Area
Channel 1
(Slot 1)
Wide Area
Channel 2
(Slot 2)
Repeater 1 at Site 1
(Master Peer)
Wide Area
Channel 1
(Slot 1)
Wide Area
Channel 2
(Slot 2)
System Logger
Application
Repeater 2 at Site 2
Third Party
Application
Figure 12: Centralized Server for IP Site Connect System and Capacity Plus System
Version 01.04
23
MOTOTRBO
Application Development Kit
Overview
For more information about the IP Site Connect interface and RDAC interface
offered by the MOTOTRBO repeater, please see the following references:
For more information about the other interfaces, please refer to the appropriate
sections contained within this overview.
Version 01.04
24
MOTOTRBO
Application Development Kit
Overview
Section 3
3.0
Registered User
Licensed Developer
Application Partner / Application Provider
Version 01.04
25
MOTOTRBO
Application Development Kit
Overview
Version 01.04
26
MOTOTRBO
Application Development Kit
Overview
Section 4
4.0
The MOTOTRBO Application Development Kits (ADKs) are only one component of
the service and support for third party developers. The Professional Radio Application
Developer Program for MOTOTRBO is staffed with full-time engineers whose primary
responsibility is to support third party application developers world-wide. Application
developers have direct access to Motorola resources to assist in the development and
certification of the third party application.
This service and support includes, but is not limited to, the following items:
Technical training on the use and capability of the developer interfaces on the
MOTOTRBO radio
Application notes and FAQs on relevant MOTOTRBO development topics
Technical consultation service during the design and development phases of the
third party product
Access to a MOTOTRBO system test environment with subscribers and
infrastructure for third party product verification (where supported by the local
business region)
Version 01.04
27
MOTOTRBO
Application Development Kit
Overview
Section 5
5.0
For further information about MOTOTRBO and MOTODEV, please visit the following
websites:
Version 01.04
28
MOTOTRBO
Application Development Kit
Overview
Section 6
Version 01.04
MOTOTRBO
XCMP-Based
Applications
X
X
X
X
X
X
MOTOTRBO
RDAC
Applications
MOTOTRBO
Text Messaging
MOTOTRBO
Location Data
Document
MOTOTRBO
Telemetry
6.0
X
X
X
X
X
X
X
X
X
X
X
X
X
X
X
X
X
X
X
X
X
X
X
X
X
X
X
X
X
X
X
X
X
X
X
29
6880309T32