Generic Devices: Report repeated events even if monitored bytes don't change

little-big-h · January 31, 2023, 4:30pm

Generic Devices are a great addition to the feature set. I used to use MacDial to monitor events of my SurfaceDial knob (a neat piece of hardware). From my experience hacking MacDial, I know that if I turn the knob right, it reports the same state for every "click" (a rotation of "n" degrees). Unfortunately, BTT only reports a single event, no matter how far right I turn the knob. Could you make that optional? That would make rotary knobs like the SurfaceDial actually useful for macOS.

thanks so much

Andreas_Hegenberg · January 31, 2023, 4:47pm

ah yes I will add a function that you can call to make it recognize again. Will upload a version that includes this later!

Andreas_Hegenberg · January 31, 2023, 6:48pm

In 4.005 you can now just call
bttGetNextEvenWithoutChange(targetDevice, reportID)
from your analyzer function, then it will get the next report even if there hasn't been a change in the data itself.

little-big-h · January 31, 2023, 10:39pm

Works like a charm -- very nice, and thanks so much.

As soon as you get around to Support sending "Key Repeat" events for keyboard shortcut action, it will turn my SurfaceDial into a nice shuttle for Final Cut Pro

Andreas_Hegenberg · January 31, 2023, 10:45pm

Nice, would be great if you could share your script!

The key repeat thing is on my TODO list and I should get to it soon.

little-big-h · January 31, 2023, 11:07pm

Sure, very simple, though:

function analyzeDeviceInput(targetDevice, reportID, reportDataHex) {
    let reportBuffer = buffer.Buffer.from(reportDataHex, 'hex');
    if(reportBuffer.readUInt8(1) === 0x03) {
        bttTriggerDeviceTrigger(targetDevice, 'button');
    } else if(reportBuffer.readUInt8(2) === 0x01) {
        bttTriggerDeviceTrigger(targetDevice, 'right');
    } else if(reportBuffer.readUInt8(2) === 0xff) {
        bttTriggerDeviceTrigger(targetDevice, 'left');
    }
    bttGetNextEvenWithoutChange(targetDevice, reportID)
}

The Dial actually has some other nice features, like haptic feedback and configurable sensitivity. I might try using the executeBTTCommand feature to enable those at some point.

Andreas_Hegenberg · January 31, 2023, 11:20pm

Thanks for sharing! Things like the Surface Dial are exactly the type of device I thought about when adding this generic device functionality. It's pretty nice being able to revive a small device with a few lines of code.

toph · May 4, 2023, 3:57am

Hi! did you ever get "button" working correctly? It seems to fire twice for me (e.g. I have it mapped to "play/pause" and pressing down and releasing causes media to play and then immediately pause again.

Andreas_Hegenberg · May 4, 2023, 7:43am

Maybe it's triggering for "press" and "release"? Does the data look exactly the same for both?

toph · May 4, 2023, 4:43pm

I think it has something to do with the next event listener:

If i remove that line, the "button" behaves as expected but the left/right rotation only triggers once (also as expected without that listener)

Andreas_Hegenberg · May 4, 2023, 6:02pm

You could call this only for the dial:

function analyzeDeviceInput(targetDevice, reportID, reportDataHex) {
    let reportBuffer = buffer.Buffer.from(reportDataHex, 'hex');
    if(reportBuffer.readUInt8(1) === 0x03) {
        bttTriggerDeviceTrigger(targetDevice, 'button');
    } else if(reportBuffer.readUInt8(2) === 0x01) {
        bttTriggerDeviceTrigger(targetDevice, 'right');
        bttGetNextEvenWithoutChange(targetDevice, reportID)
    } else if(reportBuffer.readUInt8(2) === 0xff) {
        bttTriggerDeviceTrigger(targetDevice, 'left');
        bttGetNextEvenWithoutChange(targetDevice, reportID)
    }
}

Back-To-Topic · May 4, 2023, 6:13pm

If the button is being pressed while the wheel is still being turned, you'll want to act on both and you'll also want to be sure to call bttGetNextEvenWithoutChange() as you want to keep being notified about the wheel. So using if .. else ... else ... is generally a bad idea for buttons which aren't mutually exclusive, as multiple things could be happening at the same time and events would get lost.

The solution is to store the previous report and, in case of buttons, only act on changes. See Generic Devices: Philips Footcontrol ACC2330 for an example.

Richard · August 29, 2023, 1:53pm

Just replying to thank all involved in this thread. I don't need the Mac Dial app anymore and am now able to create my own dial workflow. Right now I have only one trigger for a turn of the wheel, but I'm going to try and create something that does this:

button: swich between modes
mode1 = zoom
mode2 = volume
mode3 = app switcher

Talal · March 4, 2024, 1:45pm

Thanks for this.. implemented same here.
For mode switching.. it would be good to reclaim the button press and add an additional command.

Would it be possible to enact something like key sequences for generic device button presses?
In particular I'd like to add double/triple press commands to the surface dial button press.

I've tried by mapping a keyboard shortcut to the surface dial button press, and then having a key sequence triggered upon multiple presses of that keyboard shortcut, but that doesn't seem to work.. perhaps Key Sequences only register real keyboard commands and not virtual keyboard shortcuts enacted by Better Touch Tool?

If so.. can this be done by scripting? Will appreciate help here please.

Andreas_Hegenberg · March 4, 2024, 2:07pm

In your scripts you can keep state by defining variables outside of your analyzeDeviceInputMethod.

Maybe something like this

var lastPressTime = -1;
function analyzeDeviceInput(targetDevice, reportID, reportDataHex) {
    let reportBuffer = buffer.Buffer.from(reportDataHex, 'hex');
    if(reportBuffer.readUInt8(1) === 0x03) {
        lastPressTime = Date.now();

        setTimeout(()) => {
               if(lastPressTime - Date.now() < 0.3 ) {
                   bttTriggerDeviceTrigger(targetDevice, 'button-double-press');
                   lastPressTime = -1;
               } else {
                   bttTriggerDeviceTrigger(targetDevice, 'button-single-press');

               }
         }, 400);
        

    } else if(reportBuffer.readUInt8(2) === 0x01) {
        bttTriggerDeviceTrigger(targetDevice, 'right');
        bttGetNextEvenWithoutChange(targetDevice, reportID)
    } else if(reportBuffer.readUInt8(2) === 0xff) {
        bttTriggerDeviceTrigger(targetDevice, 'left');
        bttGetNextEvenWithoutChange(targetDevice, reportID)
    }
}

Talal · March 4, 2024, 11:48pm

Thank you and for your fantastic work on BTT which is an integral part of my productivity! much appreciated.

Unfortunately I couldn't get this to work (I'm not a coder, but took a crack at it).

Initially no button presses were logging. I deleted a closing bracket from setTimeout and that fixed it.
right and left now log correctly, but all button presses are registered as 'button-double-press' rather than distinguishing between a single and double press.
I assume this is because the code above doesn't save a second button press to compare it to the time elapsed since the first button press. and so lastPressTime - Date.now will always be 0. which is smaller than 0.3 - hence triggering button-double-press.
So feel there needs to be a register of a second press and comparison to the time of the first to see if enough time has elapsed to register it as a single press, or to register as a double press.

In short, I have little idea, but I hope you take this attempt to understand from a mere mortal as sufficient sacrifice to warrant a pity code fix/ explanation of what I'm doing wrong to suit my request

Thanks

Talal · March 5, 2024, 1:18pm

Took another shot and getting there

Now registers double press, and single press. Problem is that when the double press is registered, it also logs a single press.. should fix this soon, think it's just a matter of nesting the else statement of the single press.

var lastPressTime = -1;
function analyzeDeviceInput(targetDevice, reportID, reportDataHex) {
let reportBuffer = buffer.Buffer.from(reportDataHex, 'hex');
if(reportBuffer.readUInt8(1) === 0x03) {
lastPressTime = Date.now();

    setTimeout(() => {
           if(reportBuffer.readUInt8(1) === 0x03) {
               secondPressTime = Date.now();
           } if(secondPressTime - lastPressTime < 300 ) {
               log('button-double-press!');
               bttTriggerDeviceTrigger(targetDevice, 'button-double-press');
               lastPressTime = -1;
           } else {
               log('button-single-press!');
               bttTriggerDeviceTrigger(targetDevice, 'button-single-press');
               lastPressTime = -1;

           }
     }, 400);
    

} else if(reportBuffer.readUInt8(2) === 0x01) {
    log('right!');
    bttTriggerDeviceTrigger(targetDevice, 'right');
    bttGetNextEvenWithoutChange(targetDevice, reportID)
} else if(reportBuffer.readUInt8(2) === 0xff) {
    log('left!');
    bttTriggerDeviceTrigger(targetDevice, 'left');
    bttGetNextEvenWithoutChange(targetDevice, reportID)
}

}

Talal · March 11, 2024, 1:10am

Posting here in case it's useful to anyone..
I ended up finding a workaround in BTT settings rather than fixing the script.

Microsoft Surface Dial.bttpreset (35.0 KB)

The script under Generic Devices > Surface Dial provides for double press, single press, right jog, left jog, hold press and jog right (nextTrack trigger), and hold press and jog left (previousTrack trigger).

Double press is also a top level trigger. By default it async delays next action by 0.3 seconds. This is as the script is flawed and recognises a double press followed by a single press whenever there is a double press.. so the delay allows the single press to be registered before opening Roon where it would pause/play (can configure whatever app you want to open).

I then have Roon specific triggers. When Roon is open, these map Roon keyboard to the triggers:
single press = play/pause
right = volume up keyboard shortcut - rotation linked to volume, left = volume down, press and hold whilst turning right = next track, press and hold whilst turning left = previous track.

The press and hold actions have a delay next action by 1.5 seconds.. again this is a work around for the broken script, as otherwise pressing is recognised as multiple button presses, and triggers unwanted actions. so you have 1.5 seconds to release the button when changing track, during which other actions won't be recognised. seems to work ok though.

A Double Press when Roon is opens the Menu Bar Controller for Sonos app. Here double pressing returns to Roon.

So basically the Double Press rotates between applications, starting with Roon.

This works well for my old Mac that is used specifically for Roon server, but may be problematic for your use case due to the script limitations.

Hope it's beneficial to someone, and please post any improvements you may make

Victor_Taborda · January 20, 2025, 3:42pm

i didt this

let lastShortPressTime = null; // Tempo do último "short-press"
const doubleClickInterval = 400; // Intervalo máximo para um clique duplo (ms)
let isDoubleClickInProgress = false; // Flag para rastrear double-click
let pressTimeout = null; // Timeout para long-press
let shortPressTimeout = null; // Timeout para validar short-press
let isPressActive = false; // Indica se o botão está pressionado
let pressStartTime = null; // Marca o início da pressão do botão

function analyzeDeviceInput(targetDevice, reportID, reportDataHex) {
    let reportBuffer = buffer.Buffer.from(reportDataHex, 'hex');
    let currentAction = null;

    // Girar para a direita
    if (reportBuffer.readUInt8(2) === 0x01) {
        if (isPressActive) {
            currentAction = 'press-right';
        } else {
            currentAction = 'right';
        }
        log(currentAction);
        bttTriggerDeviceTrigger(targetDevice, currentAction);
        bttGetNextEvenWithoutChange(targetDevice, reportID);

        // Cancela short-press pendente
        clearTimeout(shortPressTimeout);
        isDoubleClickInProgress = false;

    // Girar para a esquerda
    } else if (reportBuffer.readUInt8(2) === 0xff) {
        if (isPressActive) {
            currentAction = 'press-left';
        } else {
            currentAction = 'left';
        }
        log(currentAction);
        bttTriggerDeviceTrigger(targetDevice, currentAction);
        bttGetNextEvenWithoutChange(targetDevice, reportID);

        // Cancela short-press pendente
        clearTimeout(shortPressTimeout);
        isDoubleClickInProgress = false;

    // Botão pressionado
    } else if (reportBuffer.readUInt8(1) === 0x03) {
        isPressActive = true;
        pressStartTime = Date.now(); // Marca o início da pressão do botão

        // Timeout para long-press
        pressTimeout = setTimeout(() => {
            if (pressStartTime !== null) {
                log('long-press!');
                bttTriggerDeviceTrigger(targetDevice, 'long-press');
                pressStartTime = null; // Reseta o estado
            }
        }, 1000); // 1 segundo para long press

        // Cancela short-press
        clearTimeout(shortPressTimeout);
        isDoubleClickInProgress = false;

    // Botão liberado
    } else if (reportBuffer.readUInt8(1) === 0x00) {
        isPressActive = false;

        // Calcula a duração do botão pressionado
        const pressDuration = pressStartTime ? Date.now() - pressStartTime : 0;

        // Limpa o timeout para long-press
        if (pressTimeout) {
            clearTimeout(pressTimeout);
            pressTimeout = null;
        }

        // Identifica o tipo de press
        if (pressDuration > 250 && pressDuration < 1000) {
            log('not-so-long-press!');
            bttTriggerDeviceTrigger(targetDevice, 'not-so-long-press');
        } else if (pressDuration <= 200) {
            const now = Date.now();

            // Verifica double-click
            if (lastShortPressTime && (now - lastShortPressTime) <= doubleClickInterval) {
                log('double-click!');
                bttTriggerDeviceTrigger(targetDevice, 'double-click');
                lastShortPressTime = null;
                isDoubleClickInProgress = true;

                // Cancela short-press pendente
                clearTimeout(shortPressTimeout);
                return;
            }

            lastShortPressTime = now;

            // Configura timeout para short-press
            shortPressTimeout = setTimeout(() => {
                if (!isDoubleClickInProgress) {
                    log('short-press!');
                    bttTriggerDeviceTrigger(targetDevice, 'short-press');
                }
                isDoubleClickInProgress = false;
            }, doubleClickInterval);
        }

        // Reseta o estado de pressão
        pressStartTime = null;
    }
}

Now i hv now

"not-so-long-press
right
left
long-press
short-press
double-click
press-left
press-right"

options

Victor_Taborda · February 7, 2025, 4:39pm

Chat GPT helped me to make it better

let lastShortPressTime = null;
const doubleClickInterval = 400;
let isDoubleClickInProgress = false;
let pressTimeout = null;
let shortPressTimeout = null;
let isPressActive = false;
let pressStartTime = null;
let isRotating = false;
let longPressTriggered = false; // Flag para evitar short-press após long-press

function analyzeDeviceInput(targetDevice, reportID, reportDataHex) {
    let reportBuffer = buffer.Buffer.from(reportDataHex, 'hex');
    let currentAction = null;

    // Girar para a direita
    if (reportBuffer.readUInt8(2) === 0x01) {
        if (isPressActive) {
            currentAction = 'press-right';
        } else {
            currentAction = 'right';
        }
        log(currentAction);
        bttTriggerDeviceTrigger(targetDevice, currentAction);
        bttGetNextEvenWithoutChange(targetDevice, reportID);

        clearTimeout(shortPressTimeout);
        isDoubleClickInProgress = false;

        if (isPressActive) {
            isRotating = true;
            clearTimeout(pressTimeout);
            pressTimeout = null;
        }

    // Girar para a esquerda
    } else if (reportBuffer.readUInt8(2) === 0xff) {
        if (isPressActive) {
            currentAction = 'press-left';
        } else {
            currentAction = 'left';
        }
        log(currentAction);
        bttTriggerDeviceTrigger(targetDevice, currentAction);
        bttGetNextEvenWithoutChange(targetDevice, reportID);

        clearTimeout(shortPressTimeout);
        isDoubleClickInProgress = false;

        if (isPressActive) {
            isRotating = true;
            clearTimeout(pressTimeout);
            pressTimeout = null;
        }

    // Botão pressionado
    } else if (reportBuffer.readUInt8(1) === 0x03) {
        isPressActive = true;
        pressStartTime = Date.now();
        isRotating = false;
        longPressTriggered = false; // Reseta flag de long-press

        if (!isRotating) {
            pressTimeout = setTimeout(() => {
                if (!isRotating && pressStartTime !== null) {
                    log('long-press!');
                    bttTriggerDeviceTrigger(targetDevice, 'long-press');
                    longPressTriggered = true; // Marca que o long-press foi acionado
                    pressStartTime = null;
                }
            }, 1000);
        }

        clearTimeout(shortPressTimeout);
        isDoubleClickInProgress = false;

    // Botão liberado
    } else if (reportBuffer.readUInt8(1) === 0x00) {
        isPressActive = false;

        const pressDuration = pressStartTime ? Date.now() - pressStartTime : 0;

        if (pressTimeout) {
            clearTimeout(pressTimeout);
            pressTimeout = null;
        }

        // Se um long-press foi acionado, NÃO executa short-press
        if (longPressTriggered) {
            pressStartTime = null;
            return;
        }

        if (pressDuration > 250 && pressDuration < 1000) {
            log('not-so-long-press!');
            bttTriggerDeviceTrigger(targetDevice, 'not-so-long-press');
        } else if (pressDuration <= 200) {
            const now = Date.now();

            if (lastShortPressTime && (now - lastShortPressTime) <= doubleClickInterval) {
                log('double-click!');
                bttTriggerDeviceTrigger(targetDevice, 'double-click');
                lastShortPressTime = null;
                isDoubleClickInProgress = true;
                clearTimeout(shortPressTimeout);
                return;
            }

            lastShortPressTime = now;

            shortPressTimeout = setTimeout(() => {
                if (!isDoubleClickInProgress) {
                    log('short-press!');
                    bttTriggerDeviceTrigger(targetDevice, 'short-press');
                }
                isDoubleClickInProgress = false;
            }, doubleClickInterval);
        }

        pressStartTime = null;
        isRotating = false;
    }
}