Skip to content

Commit

Permalink
Fixed manual. Addresses hmatuschek#251.
Browse files Browse the repository at this point in the history
  • Loading branch information
hmatuschek committed Sep 17, 2022
1 parent 0756047 commit 8ded452
Show file tree
Hide file tree
Showing 3 changed files with 45 additions and 3 deletions.
44 changes: 43 additions & 1 deletion doc/manual/codeplug/contacts.xml
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
<para>
The <token>contacts</token> element specifies a list of all contacts. Each contact is a map
that contains a single entry to specify the contact type. The key specifies the type name and
the value specifies the actual contact definition. Currently there are two possible contact
the value specifies the actual contact definition. Currently there are three possible contact
types.
</para>

Expand Down Expand Up @@ -85,6 +85,48 @@
</section>


<section>
<info>
<title>M17 Contacts (<token>m17</token>)</title>
</info>

<para>
An M17 contact is a simple object and is usually defined in one line. Each contact contains
an optional <token>id</token> that will be used to reference this contact throughout the
codeplug (e.g., in M17 channels). For now, M17 is only supported by radios running the
<ulink url="https://openrtx.org"><citetitle>OpenRTX firmware</citetitle></ulink>.
</para>

<variablelist>
<title>M17 Contact Fields</title>
<varlistentry>
<term><token>id</token></term>
<listitem>
<para>Specifies the identifier of the contact. This identifier can later be used to
reference the contact. Any unique string is valid.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><token>call</token></term>
<listitem>
<para>Specifies the call (M17 ID) of the contact. This must be a string of not more than 9
chars, containing only <token>A-Z</token>, <token>0-9</token>, <token>.</token>,
<token>/</token> &amp; <token>-</token>. See <ulink
url="https://m17-protocol-specification.readthedocs.io/en/latest/address_encoding.html">
<citetitle>M17 specification</citetitle></ulink></para> for details.
</listitem>
</varlistentry>
<varlistentry>
<term><token>broadcast</token></term>
<listitem>
<para>Specifies whether the contact is the M17 broadcast destination. Default is
<token>false</token>. If <token>true</token>, the <token>call</token> is ignored.</para>
</listitem>
</varlistentry>
</variablelist>
</section>


<section>
<info>
<title>Analog DMTF Contacts (<token>dtmf</token>)</title>
Expand Down
2 changes: 1 addition & 1 deletion doc/manual/manual.xml
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@

<releaseinfo>
<para>
This document covers <application>qdmr</application> version 0.10.3.
This document covers <application>qdmr</application> version 0.11.0.
</para>
</releaseinfo>

Expand Down
2 changes: 1 addition & 1 deletion lib/codeplug.cc
Original file line number Diff line number Diff line change
Expand Up @@ -587,7 +587,7 @@ Codeplug::Context::Context(Config *config)
{
// Add tables for common elements
addTable(&DMRRadioID::staticMetaObject);
addTable(&DMRContact::staticMetaObject);
addTable(&DigitalContact::staticMetaObject);
addTable(&DTMFContact::staticMetaObject);
addTable(&RXGroupList::staticMetaObject);
addTable(&Channel::staticMetaObject);
Expand Down

0 comments on commit 8ded452

Please sign in to comment.