example-plugin-item.xml

<?xml version="1.0"?>
<TcMenuPlugin name="Control menu with analog joystick" id="20409bb8-b8a1-4d1d-b632-2cf9b57353e3" subsystem="INPUT"
              xmlns="https://www.thecoderscorner.com/libraries/tcmenuPluginItem"
>
    <SupportedPlatforms>
        <Platform>ARDUINO_UNO</Platform>
        <Platform>ARDUINO_AVR</Platform>
        <Platform>ARDUINO_32</Platform>
        <Platform>ARDUINO_ESP8266</Platform>
        <Platform>ARDUINO_ESP32</Platform>
    </SupportedPlatforms>
    <Description>Use an analog joystick connected to one of the Arduino inbuilt analog pins along with a switch also connected to an Arduino pin.</Description>
    <Documentation link="https://tcmenu.github.io/documentation/arduino-libraries/tc-menu/tcmenu-plugins/encoder-switches-input-plugin/"/>
    <RequiredLibraries>
        <Library>Library1</Library>
        <Library>Library2</Library>
    </RequiredLibraries>
    <ImageFile>joystick.jpg</ImageFile>

    <Properties>
        <Property id="INT_PROP" name="Int Prop" initial="10" desc="int value" type="int" min="0" max="100"/>
        <Property id="INTERRUPT_SWITCHES" name="Interrupt Switches" initial="false" desc="Enable switches" type="boolean"/>
        <Property id="SWITCH_IODEVICE" name="IoAbstractionRef" initial="" desc="Advanced" type="variable"/>
        <Property id="JOYSTICK_PIN" name="Up Pin" initial="2" desc="button connected" type="pin"/>
        <Property id="TEST_CHOICE" name="Choices" initial="Choice1" desc="Test choices" type="choice">
            <Choices>
                <Choice>Choice1</Choice>
                <Choice>Choice2</Choice>
            </Choices>
        </Property>
    </Properties>

    <ApplicabilityDefs>
        <ApplicabilityDef key="applicabilityDef" mode="and">
            <Applicability whenProperty="INTERRUPT_SWITCHES" isValue="true"/>
            <ApplicabilityDef mode="or">
                <Applicability whenProperty="INT_PROP" isValue="10"/>
                <ApplicabilityDef>
                    <Applicability whenProperty="ROOT" isValue="test"/>
                    <Applicability whenProperty="INT_PROP" isValue="20"/>
                </ApplicabilityDef>
            </ApplicabilityDef>
        </ApplicabilityDef>
    </ApplicabilityDefs>

    <SourceFiles>
        <Replacement find="someKey" replace="${INT_PROP}"/>
        <Replacement find="otherKey" replace="abc"/>
        <SourceFile name="src/source.h" />
        <SourceFile name="src/source.cpp" whenProperty="${INT_PROP}" isValue="5"/>
    </SourceFiles>

    <IncludeFiles>
        <Header name="JoystickSwitchInput.h" inSource="false"/>
        <Header name="Scramble.h" inSource="true" priority="high"/>
    </IncludeFiles>

    <GlobalVariables>
        <Variable name="analogDevice" type="ArduinoAnalogDevice" export="true">
            <Param value="42"/>
        </Variable>
        <Variable name="anotherVar" type="int" export="false" progmem="true" />
        <Variable name="expOnly" type="char[]" export="only" whenProperty="INTERRUPT_SWITCHES" isValue="true"/>
    </GlobalVariables>

    <SetupFunctions>
        <Function name="initialiseInterrupt" object="switches" whenProperty="INTERRUPT_SWITCHES" isValue="true">
            <Param value="${SWITCH_IODEVICE}" default="internalDigitalIo()"/>
            <Param value="${PULLUP_LOGIC"/>
        </Function>
        <Function name="initialise" object="switches" whenProperty="INTERRUPT_SWITCHES" isValue="false">
            <Param value="${SWITCH_IODEVICE}" default="internalDigitalIo()"/>
            <Param value="${PULLUP_LOGIC}"/>
        </Function>

        <Lambda name="onReleaseFn">
            <Param type="uint8_t" name="key" used="false"/>
            <Param type="bool" name="held"/>
            <Function name="onMenuSelect" object="menuMgr">
                <Param value="held"/>
            </Function>
        </Lambda>
        <Function name="addSwitch" object="switches" applicabilityRef="applicabilityDef">
            <Param value="BUTTON_PIN"/>
            <Param ref="null"/>
        </Function>
        <Function name="onRelease" object="switches" pointer="true">
            <Param value="BUTTON_PIN"/>
            <Param lambda="onReleaseFn"/>
        </Function>
    </SetupFunctions>
</TcMenuPlugin>