<?xml version="1.0" encoding="UTF-8"?>

<section xml:id="extOpenGD77Channel"
         xmlns="http://docbook.org/ns/docbook"
         xmlns:xlink="http://www.w3.org/1999/xlink"
         xmlns:xi="http://www.w3.org/2001/XInclude">


<info>
  <title>Channel extension</title>
</info>

<para>
  This extension allows to specify some channel settings specific for devices running the 
  OpenGD77 firmware. This extension can be added to any channel, analog and digital.
  For now, this extension only allows to specify the power for the channel in more detail.
</para>

<example>
  <title></title>
  <programlisting><![CDATA[channels:
  - digital:
      id: ch1
      name: Example channel 
      # all the other channel settings
      openGD77:
        scanZoneSkip: false
        scanAllSkip: false
        beep: true
        powerSave: true
        location: JO62jl
        talkerAliasTS1: APRS
        talkerAliasTS2: Both
]]></programlisting>
</example>

<para> 
  The OpenGD77 channel extension is a mapping named <token>openGD77</token>. It contains the 
  device specific settings for that channel. 
</para>


<section>
<info>
  <title>Channel attributes</title>
</info>

<para>
  For now, there are only few attributes specifying scan behavior for the channel.
</para>

<variablelist>
  <title>Channel extension fields</title>
  <varlistentry>
    <term>
      <token>scanZoneSkip</token>
      <token>scanAllSkip</token>
    </term>
    <listitem>
      <para>
        In contrast to the original GD-77 firmware, OpenGD77 does not implement scanning by scan 
        lists. Instead, either all channels defined in the radio or all channels within the current
        zone can be scanned. To exclude some channels from these scans, the 
        <token>scanZoneSkip</token> and <token>scanAllSkip</token> flags can be used. When enabled,
        the channel will be excluded from the respective scan.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term>
      <token>beep</token>
    </term>
    <listitem>
      <para>
        If enabled (default), the channel beeps are played.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term>
      <token>powerSave</token>
    </term>
    <listitem>
      <para>
        Enables the power save featrue for this channel (default).
      </para>
    </listitem>
  </varlistentry>
    <varlistentry>
    <term>
      <token>location</token>
    </term>
    <listitem>
      <para>
        Allows to specify a fixed location to be used for this channel and the associated APRS system.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term>
      <token>talkerAliasTS1</token>
      <token>talkerAliasTS2</token>
    </term>
    <listitem>
      <para>
        Specifies what to be send as the talker alias, depending on the current timeslot. This must
        be one of <token>None</token>, <token>APRS</token>, <token>Text</token> or
        <token>Both</token>.
      </para>
    </listitem>
  </varlistentry>
</variablelist>

</section>
</section>
        
