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

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


<info>
  <title>Button settings extension</title>  
</info>

<para>
  This extension to the codeplug allows to specify the function for each of the programmable 
  buttons on the radio. Please note that not all <trademark>TyT</trademark> radios have all 
  buttons described 
  here. 
</para>

<example>
  <title></title>
  <programlisting><![CDATA[tytExtension:
  buttonSettings:
    longPressDuration: 1000 
    sideButton1Short: Disabled
    sideButton1Long: Tone1750Hz
    sideButton2Short: MonitorToggle
    sideButton2Long: Disabled
    sideButton3Short: Disabled
    sideButton3Long: Disabled
    progButton1Short: Disabled
    progButton1Long: Disabled
    progButton2Short: Disabled
    progButton2Long: Disabled
]]></programlisting>
</example>

<variablelist>
  <title>Button settings fields</title>
  <varlistentry>
    <term><token>sideButton1Short</token></term>
    <term><token>sideButton1Long</token></term>
    <term><token>sideButton2Short</token></term>
    <term><token>sideButton2Long</token></term>
    <term><token>sideButton3Short</token> (Retevis RT84, Baofeng DM-1701)</term>
    <term><token>sideButton3Long</token> (Retevis RT84, Baofeng DM-1701)</term>
    <term><token>progButton1Short</token> (Retevis RT84, Baofeng DM-1701)</term>
    <term><token>progButton1Long</token> (Retevis RT84, Baofeng DM-1701)</term>
    <term><token>progButton2Short</token> (Retevis RT84, Baofeng DM-1701)</term>
    <term><token>progButton2Long</token> (Retevis RT84, Baofeng DM-1701)</term>
    <listitem>
      <para>Specifies the different functions for each button press. Must be one of:
        <token>Disabled</token>, <token>ToggleAllAlertTones</token>, <token>EmergencyOn</token>, 
        <token>EmergencyOff</token>, <token>PowerSelect</token>, <token>MonitorToggle</token>, 
        <token>OneTouch1</token>-<token>OneTouch6</token>, <token>RepeaterTalkaroundToggle</token>, 
        <token>ScanToggle</token>, <token>SquelchToggle</token>, <token>PrivacyToggle</token>,
        <token>VoxToggle</token>, <token>ZoneIncrement</token>, <token>BatteryIndicator</token>,
        <token>LoneWorkerToggle</token>, <token>RecordToggle</token>, <token>RecordPlayback</token>,
        <token>RecordDeleteAll</token>, <token>Tone1750Hz</token>, <token>SwitchUpDown</token>,
        <token>RightKey</token>, <token>LeftKey</token> or <token>ZoneDecrement</token>.</para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><token>longPressDuration</token></term>
    <listitem>
      <para>Specifies the long-press duration in milliseconds.</para>
    </listitem>
  </varlistentry>
</variablelist>

</section>
