GetButton(handle)

Description

The GetButton Lua function returns a key-value pairs table indicating, with a boolean value, whether a button is pressed on an MA3Module.

Below the example is a table listing all the grandMA3 hardware modules and which index number matches which button on the hardware module.

Arguments

• Handle:
  The handle for the MA3 module.

Return

• Table:
  The returned table is a key-value pairs table with a set of 512 pairs with a boolean value. A true boolean value indicates that the button is pressed or the fader is touched. The table key is 1-indexed. 

Example

This example requests the buttons states on the master module on a grandMA3 full-size console:

return function()
    --- grandMA3 full-size modules are:
    --- Fader Module Encoder (MFE): "UsbDeviceMA3 2"
    --- Fader Module Crossfader (MFX): "UsbDeviceMA3 2"
    --- Master Module (MM): "UsbDeviceMA3 4"
    
    -- Get a handle to the Master Module on a grandMA3 full-size.
    local usbDeviceHandle = Root().UsbNotifier.MA3Modules["UsbDeviceMA3 4"]
    -- Create a table with the button status.
    local buttonTable = GetButton(usbDeviceHandle)
    -- Check if the table is nil and then print an error.
    if buttonTable == nil then
        ErrPrintf("nil")
        return
    end
    -- If the table is not nil, then print a useful feedback.
    for key,value in pairs(buttonTable) do
        if tostring(value) == "true" then
            Printf("The button with the index " .. key .. " is pressed.")
        end
    end
end

Hardware Modules Button Table

This table provides a list of index numbers (0-indexed and 1-indexed). The numbers are matched with elements on the three different kinds of hardware modules. Notice that the naming here comes from the internal hardware definition and might not match exactly the print on the keys or the official name.