Skip to content

fix: read the Simple preset values of the Secondary role from default user configuration #2930

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
ert78gb wants to merge 1 commit into
base: master
Choose a base branch
from
Open

fix: read the Simple preset values of the Secondary role from default user configuration #2930

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion packages/uhk-common/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
"build:generate-versions": "node ./scripts/generate-versions.mjs",
"build:tsc": "tsc --project src/tsconfig.build.json",
"build:user-config": "tsx ./scripts/generate-user-configs.ts",
"clean": "rimraf ./node_modules ./dist user-config.json",
"clean": "rimraf ./node_modules ./dist user-config.json ./src/user-config-60.ts ./src/user-config-80.ts",
"test": "node --loader=ts-node/esm --test \"**/*.test.ts\"",
"lint": "eslint"
},
Expand Down
108 changes: 108 additions & 0 deletions ...common/src/config-serializer/config-items/advanced-secondary-role-configuration-values.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,108 @@
import { UHK_80_USER_CONFIG } from '../../user-config-80.js';

import { AdvancedSecondaryRoleConfiguration } from './advanced-secondary-role-configuration';
import { SecondaryRoleAdvancedStrategyTimeoutAction } from './secondary-role-advanced-strategy-timeout-action.js';
import { SecondaryRoleAdvancedStrategyTimeoutType } from './secondary-role-advanced-strategy-timeout-type.js';
import { SecondaryRoleAdvancedStrategyTriggeringEvent } from './secondary-role-advanced-strategy-triggering-event.js';
import { SecondaryRoleStrategy } from './secondary-role-strategy.js';

export const ADVANCED_SECONDARY_ROLE_CONFIGURATION_FIELD_NAMES: Array<keyof AdvancedSecondaryRoleConfiguration> = [
'secondaryRoleAdvancedStrategyTimeout',
'secondaryRoleAdvancedStrategyMinimumHoldTime',
'secondaryRoleAdvancedStrategyTrigger',
'secondaryRoleAdvancedStrategyTimeoutAction',
'secondaryRoleAdvancedStrategyTimeoutType',
'secondaryRoleAdvancedStrategySafetyMargin',
'secondaryRoleAdvancedStrategyDoubletapToPrimary',
'secondaryRoleAdvancedStrategyTriggerByMouse',
'secondaryRoleAdvancedStrategyTriggerFromSameHalf'
]

export const ADVANCED_SECONDARY_ROLE_CONFIGURATION_FIELD_SET = new Set<keyof AdvancedSecondaryRoleConfiguration>(ADVANCED_SECONDARY_ROLE_CONFIGURATION_FIELD_NAMES)

export interface AdvancedSecondaryRoleConfigurationPreset {
name: string;
strategy: SecondaryRoleStrategy;
tooltip: string;
configuration: AdvancedSecondaryRoleConfiguration;
}

export const CUSTOM_ADVANCED_SECONDARY_ROLE_CONFIGURATION_PRESET_NAME = 'Custom';
export const CUSTOM_ADVANCED_SECONDARY_ROLE_TOOLTIP = 'your individual settings';
export const TIMEOUT_ADVANCED_SECONDARY_ROLE_CONFIGURATION_PRESET_NAME = 'Timeout';
export const SIMPLE_ADVANCED_SECONDARY_ROLE_CONFIGURATION_PRESET_NAME = 'Simple';

export const SIMPLE_ADVANCED_SECONDARY_ROLE_CONFIGURATION_PRESET: AdvancedSecondaryRoleConfigurationPreset = {
name: SIMPLE_ADVANCED_SECONDARY_ROLE_CONFIGURATION_PRESET_NAME,
strategy: SecondaryRoleStrategy.Simple,
tooltip: 'hold while tapping another key for secondary, tap for primary',
configuration: {
secondaryRoleAdvancedStrategyTimeout: UHK_80_USER_CONFIG.secondaryRoleAdvancedStrategyTimeout, // TODO: Firngrod, can the timeout be disabled with the new implementation?
secondaryRoleAdvancedStrategyMinimumHoldTime: UHK_80_USER_CONFIG.secondaryRoleAdvancedStrategyMinimumHoldTime,
secondaryRoleAdvancedStrategyTimeoutAction: SecondaryRoleAdvancedStrategyTimeoutAction[UHK_80_USER_CONFIG.secondaryRoleAdvancedStrategyTimeoutAction],
secondaryRoleAdvancedStrategyTimeoutType: SecondaryRoleAdvancedStrategyTimeoutType[UHK_80_USER_CONFIG.secondaryRoleAdvancedStrategyTimeoutType],
secondaryRoleAdvancedStrategyTrigger: SecondaryRoleAdvancedStrategyTriggeringEvent[UHK_80_USER_CONFIG.secondaryRoleAdvancedStrategyTrigger],
secondaryRoleAdvancedStrategySafetyMargin: UHK_80_USER_CONFIG.secondaryRoleAdvancedStrategySafetyMargin,
secondaryRoleAdvancedStrategyDoubletapToPrimary: UHK_80_USER_CONFIG.secondaryRoleAdvancedStrategyDoubletapToPrimary,
secondaryRoleAdvancedStrategyTriggerByMouse: UHK_80_USER_CONFIG.secondaryRoleAdvancedStrategyTriggerByMouse,
secondaryRoleAdvancedStrategyTriggerFromSameHalf: UHK_80_USER_CONFIG.secondaryRoleAdvancedStrategyTriggerFromSameHalf,
}
}

export const HRM_TIMEOUT_CANCEL_ADVANCED_SECONDARY_ROLE_CONFIGURATION_PRESET: AdvancedSecondaryRoleConfigurationPreset = {
name: 'HRM-timeout-cancel',
strategy: SecondaryRoleStrategy.Advanced,
tooltip: 'hold while tapping another key for secondary, tap for primary, hold past timeout for no action',
configuration: {
secondaryRoleAdvancedStrategyTimeout: 300,
secondaryRoleAdvancedStrategyMinimumHoldTime: 150,
secondaryRoleAdvancedStrategyTimeoutAction: SecondaryRoleAdvancedStrategyTimeoutAction.None,
secondaryRoleAdvancedStrategyTimeoutType: SecondaryRoleAdvancedStrategyTimeoutType.Passive,
secondaryRoleAdvancedStrategyTrigger: SecondaryRoleAdvancedStrategyTriggeringEvent.Release,
secondaryRoleAdvancedStrategySafetyMargin: -40,
secondaryRoleAdvancedStrategyDoubletapToPrimary: false,
secondaryRoleAdvancedStrategyTriggerByMouse: true,
secondaryRoleAdvancedStrategyTriggerFromSameHalf: false,
}
}

export const HRM_TIMEOUT_SECONDARY_ADVANCED_SECONDARY_ROLE_CONFIGURATION_PRESET: AdvancedSecondaryRoleConfigurationPreset = {
name: 'HRM-timeout-secondary',
strategy: SecondaryRoleStrategy.Advanced,
tooltip: 'hold while tapping another key or hold past timeout for secondary, tap for primary',
configuration: {
secondaryRoleAdvancedStrategyTimeout: 350,
secondaryRoleAdvancedStrategyMinimumHoldTime: 100,
secondaryRoleAdvancedStrategyTimeoutAction: SecondaryRoleAdvancedStrategyTimeoutAction.Secondary,
secondaryRoleAdvancedStrategyTimeoutType: SecondaryRoleAdvancedStrategyTimeoutType.Active,
secondaryRoleAdvancedStrategyTrigger: SecondaryRoleAdvancedStrategyTriggeringEvent.Release,
secondaryRoleAdvancedStrategySafetyMargin: 1,
secondaryRoleAdvancedStrategyDoubletapToPrimary: true,
secondaryRoleAdvancedStrategyTriggerByMouse: false,
secondaryRoleAdvancedStrategyTriggerFromSameHalf: false,
}
}

export const TIMEOUT_ADVANCED_SECONDARY_ROLE_CONFIGURATION_PRESET: AdvancedSecondaryRoleConfigurationPreset = {
name: TIMEOUT_ADVANCED_SECONDARY_ROLE_CONFIGURATION_PRESET_NAME,
strategy: SecondaryRoleStrategy.Advanced,
tooltip: 'hold until timeout for secondary, briefly tap for primary',
configuration: {
secondaryRoleAdvancedStrategyTimeout: 200,
secondaryRoleAdvancedStrategyMinimumHoldTime: 150,
secondaryRoleAdvancedStrategyTimeoutAction: SecondaryRoleAdvancedStrategyTimeoutAction.Secondary,
secondaryRoleAdvancedStrategyTimeoutType: SecondaryRoleAdvancedStrategyTimeoutType.Active,
secondaryRoleAdvancedStrategyTrigger: SecondaryRoleAdvancedStrategyTriggeringEvent.None,
secondaryRoleAdvancedStrategySafetyMargin: 0,
secondaryRoleAdvancedStrategyDoubletapToPrimary: true,
secondaryRoleAdvancedStrategyTriggerByMouse: true,
secondaryRoleAdvancedStrategyTriggerFromSameHalf: true,
}
}

export const BUILTIN_ADVANCED_SECONDARY_ROLE_CONFIGURATION_PRESETS: AdvancedSecondaryRoleConfigurationPreset[] = [
SIMPLE_ADVANCED_SECONDARY_ROLE_CONFIGURATION_PRESET,
HRM_TIMEOUT_CANCEL_ADVANCED_SECONDARY_ROLE_CONFIGURATION_PRESET,
HRM_TIMEOUT_SECONDARY_ADVANCED_SECONDARY_ROLE_CONFIGURATION_PRESET,
TIMEOUT_ADVANCED_SECONDARY_ROLE_CONFIGURATION_PRESET,
];
102 changes: 0 additions & 102 deletions ...es/uhk-common/src/config-serializer/config-items/advanced-secondary-role-configuration.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
import { SecondaryRoleAdvancedStrategyTimeoutAction } from './secondary-role-advanced-strategy-timeout-action.js';
import { SecondaryRoleAdvancedStrategyTimeoutType } from './secondary-role-advanced-strategy-timeout-type.js';
import { SecondaryRoleAdvancedStrategyTriggeringEvent } from './secondary-role-advanced-strategy-triggering-event.js';
import { SecondaryRoleStrategy } from './secondary-role-strategy.js';

export interface AdvancedSecondaryRoleConfiguration {
secondaryRoleAdvancedStrategyTimeout: number;
Expand All @@ -14,104 +13,3 @@ export interface AdvancedSecondaryRoleConfiguration {
secondaryRoleAdvancedStrategyTriggerByMouse: boolean;
secondaryRoleAdvancedStrategyTriggerFromSameHalf: boolean;
}

export const ADVANCED_SECONDARY_ROLE_CONFIGURATION_FIELD_NAMES: Array<keyof AdvancedSecondaryRoleConfiguration> = [
'secondaryRoleAdvancedStrategyTimeout',
'secondaryRoleAdvancedStrategyMinimumHoldTime',
'secondaryRoleAdvancedStrategyTrigger',
'secondaryRoleAdvancedStrategyTimeoutAction',
'secondaryRoleAdvancedStrategyTimeoutType',
'secondaryRoleAdvancedStrategySafetyMargin',
'secondaryRoleAdvancedStrategyDoubletapToPrimary',
'secondaryRoleAdvancedStrategyTriggerByMouse',
'secondaryRoleAdvancedStrategyTriggerFromSameHalf'
]

export const ADVANCED_SECONDARY_ROLE_CONFIGURATION_FIELD_SET = new Set<keyof AdvancedSecondaryRoleConfiguration>(ADVANCED_SECONDARY_ROLE_CONFIGURATION_FIELD_NAMES)

export interface AdvancedSecondaryRoleConfigurationPreset {
name: string;
strategy: SecondaryRoleStrategy;
tooltip: string;
configuration: AdvancedSecondaryRoleConfiguration;
}

export const CUSTOM_ADVANCED_SECONDARY_ROLE_CONFIGURATION_PRESET_NAME = 'Custom';
export const CUSTOM_ADVANCED_SECONDARY_ROLE_TOOLTIP = 'your individual settings';
export const TIMEOUT_ADVANCED_SECONDARY_ROLE_CONFIGURATION_PRESET_NAME = 'Timeout';
export const SIMPLE_ADVANCED_SECONDARY_ROLE_CONFIGURATION_PRESET_NAME = 'Simple';

export const SIMPLE_ADVANCED_SECONDARY_ROLE_CONFIGURATION_PRESET: AdvancedSecondaryRoleConfigurationPreset = {
name: SIMPLE_ADVANCED_SECONDARY_ROLE_CONFIGURATION_PRESET_NAME,
strategy: SecondaryRoleStrategy.Simple,
tooltip: 'hold while tapping another key for secondary, tap for primary',
configuration: {
secondaryRoleAdvancedStrategyTimeout: 1000, // TODO: Firngrod, can the timeout be disabled with the new implementation?
secondaryRoleAdvancedStrategyMinimumHoldTime: 0,
secondaryRoleAdvancedStrategyTimeoutAction: SecondaryRoleAdvancedStrategyTimeoutAction.Secondary,
secondaryRoleAdvancedStrategyTimeoutType: SecondaryRoleAdvancedStrategyTimeoutType.Active,
secondaryRoleAdvancedStrategyTrigger: SecondaryRoleAdvancedStrategyTriggeringEvent.Press,
secondaryRoleAdvancedStrategySafetyMargin: 0,
secondaryRoleAdvancedStrategyDoubletapToPrimary: false,
secondaryRoleAdvancedStrategyTriggerByMouse: true,
secondaryRoleAdvancedStrategyTriggerFromSameHalf: true,
}
}

export const HRM_TIMEOUT_CANCEL_ADVANCED_SECONDARY_ROLE_CONFIGURATION_PRESET: AdvancedSecondaryRoleConfigurationPreset = {
name: 'HRM-timeout-cancel',
strategy: SecondaryRoleStrategy.Advanced,
tooltip: 'hold while tapping another key for secondary, tap for primary, hold past timeout for no action',
configuration: {
secondaryRoleAdvancedStrategyTimeout: 300,
secondaryRoleAdvancedStrategyMinimumHoldTime: 150,
secondaryRoleAdvancedStrategyTimeoutAction: SecondaryRoleAdvancedStrategyTimeoutAction.None,
secondaryRoleAdvancedStrategyTimeoutType: SecondaryRoleAdvancedStrategyTimeoutType.Passive,
secondaryRoleAdvancedStrategyTrigger: SecondaryRoleAdvancedStrategyTriggeringEvent.Release,
secondaryRoleAdvancedStrategySafetyMargin: -40,
secondaryRoleAdvancedStrategyDoubletapToPrimary: false,
secondaryRoleAdvancedStrategyTriggerByMouse: true,
secondaryRoleAdvancedStrategyTriggerFromSameHalf: false,
}
}

export const HRM_TIMEOUT_SECONDARY_ADVANCED_SECONDARY_ROLE_CONFIGURATION_PRESET: AdvancedSecondaryRoleConfigurationPreset = {
name: 'HRM-timeout-secondary',
strategy: SecondaryRoleStrategy.Advanced,
tooltip: 'hold while tapping another key or hold past timeout for secondary, tap for primary',
configuration: {
secondaryRoleAdvancedStrategyTimeout: 350,
secondaryRoleAdvancedStrategyMinimumHoldTime: 100,
secondaryRoleAdvancedStrategyTimeoutAction: SecondaryRoleAdvancedStrategyTimeoutAction.Secondary,
secondaryRoleAdvancedStrategyTimeoutType: SecondaryRoleAdvancedStrategyTimeoutType.Active,
secondaryRoleAdvancedStrategyTrigger: SecondaryRoleAdvancedStrategyTriggeringEvent.Release,
secondaryRoleAdvancedStrategySafetyMargin: 1,
secondaryRoleAdvancedStrategyDoubletapToPrimary: true,
secondaryRoleAdvancedStrategyTriggerByMouse: false,
secondaryRoleAdvancedStrategyTriggerFromSameHalf: false,
}
}

export const TIMEOUT_ADVANCED_SECONDARY_ROLE_CONFIGURATION_PRESET: AdvancedSecondaryRoleConfigurationPreset = {
name: TIMEOUT_ADVANCED_SECONDARY_ROLE_CONFIGURATION_PRESET_NAME,
strategy: SecondaryRoleStrategy.Advanced,
tooltip: 'hold until timeout for secondary, briefly tap for primary',
configuration: {
secondaryRoleAdvancedStrategyTimeout: 200,
secondaryRoleAdvancedStrategyMinimumHoldTime: 150,
secondaryRoleAdvancedStrategyTimeoutAction: SecondaryRoleAdvancedStrategyTimeoutAction.Secondary,
secondaryRoleAdvancedStrategyTimeoutType: SecondaryRoleAdvancedStrategyTimeoutType.Active,
secondaryRoleAdvancedStrategyTrigger: SecondaryRoleAdvancedStrategyTriggeringEvent.None,
secondaryRoleAdvancedStrategySafetyMargin: 0,
secondaryRoleAdvancedStrategyDoubletapToPrimary: true,
secondaryRoleAdvancedStrategyTriggerByMouse: true,
secondaryRoleAdvancedStrategyTriggerFromSameHalf: true,
}
}

export const BUILTIN_ADVANCED_SECONDARY_ROLE_CONFIGURATION_PRESETS: AdvancedSecondaryRoleConfigurationPreset[] = [
SIMPLE_ADVANCED_SECONDARY_ROLE_CONFIGURATION_PRESET,
HRM_TIMEOUT_CANCEL_ADVANCED_SECONDARY_ROLE_CONFIGURATION_PRESET,
HRM_TIMEOUT_SECONDARY_ADVANCED_SECONDARY_ROLE_CONFIGURATION_PRESET,
TIMEOUT_ADVANCED_SECONDARY_ROLE_CONFIGURATION_PRESET,
];
1 change: 1 addition & 0 deletions packages/uhk-common/src/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
export { Buffer } from './buffer.js';
export * from './config-serializer/config-items/advanced-secondary-role-configuration-values.js';
export * from './config-serializer/index.js';
export * from './log/index.js';
export * from './models/index.js';
Expand Down
10 changes: 5 additions & 5 deletions packages/uhk-common/user-config-80.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,12 +65,12 @@
"mouseScrollAcceleratedSpeed": 50,
"secondaryRoleStrategy": "Simple",
"secondaryRoleAdvancedStrategyDoubletapTimeout": 200,
"secondaryRoleAdvancedStrategyTimeout": 350,
"secondaryRoleAdvancedStrategySafetyMargin": 50,
"secondaryRoleAdvancedStrategyTrigger": "Release",
"secondaryRoleAdvancedStrategyDoubletapToPrimary": true,
"secondaryRoleAdvancedStrategyTimeout": 1000,
"secondaryRoleAdvancedStrategySafetyMargin": 0,
"secondaryRoleAdvancedStrategyTrigger": "Press",
"secondaryRoleAdvancedStrategyDoubletapToPrimary": false,
"secondaryRoleAdvancedStrategyTimeoutAction": "Secondary",
"secondaryRoleAdvancedStrategyTriggerByMouse": false,
"secondaryRoleAdvancedStrategyTriggerByMouse": true,
"secondaryRoleAdvancedStrategyTriggerFromSameHalf": true,
"secondaryRoleAdvancedStrategyMinimumHoldTime": 0,
"secondaryRoleAdvancedStrategyTimeoutType": "Active",
Expand Down
Loading
Loading