Skip to content

Commit

Permalink
#1274 document the new assistant trigger
Browse files Browse the repository at this point in the history
  • Loading branch information
sds100 committed Nov 24, 2024
1 parent 58500e6 commit 102fc95
Show file tree
Hide file tree
Showing 6 changed files with 49 additions and 6 deletions.
Binary file added docs/images/advanced-triggers-paywall.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/images/trigger-page.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

Feature development has stopped.

[Key Mapper](http://code.keymapper.club) is a free and open source Android app that can map single or multiple key events to a custom action.
[Key Mapper](https://github.com/keymapperorg/KeyMapper) is a free and open source Android app that can map single or multiple buttons to a custom action.

![GitHub code size in bytes](https://img.shields.io/github/languages/code-size/keymapperorg/KeyMapper.svg)
![GitHub Releases Downloads](https://img.shields.io/github/downloads/keymapperorg/keymapper/total.svg?label=GitHub%20Releases%20Downloads)
Expand Down
2 changes: 1 addition & 1 deletion docs/quick-start.md
Original file line number Diff line number Diff line change
Expand Up @@ -182,7 +182,7 @@ You can see explanations of more options [here](../user-guide/keymaps/#special-o

## Managing key maps

To save your key map and return to the home screen, tap the save :fontawesome-solid-save: icon in the bottom right of the screen.
To save your key map and return to the home screen, tap the save :material-content-save: icon in the bottom right of the screen.

Now your key map should already be working. To pause/unpause all of your key maps, pull down the notification tray and tap the Key Mapper notification to toggle between Paused and Running.

Expand Down
4 changes: 2 additions & 2 deletions docs/user-guide/fingerprint-gestures.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,9 +24,9 @@ From the Key Mapper home screen, tab the 'Fingerprint' tab.

Here you can set actions for the 4 directional gestures. Tapping any one of them will bring you to the action assignment screen for that gesture and by tapping 'Add action' at the bottom of the screen you can assign the action. [Click here for an explanation of all the actions you can choose from.](actions.md)

After choosing an action (or actions) you can press the save :fontawesome-solid-save: icon in the bottom right to save the mapping.
After choosing an action (or actions) you can press the save :material-content-save: icon in the bottom right to save the mapping.

Make sure to save :fontawesome-solid-save: your fingerprint gesture map after applying these changes.
Make sure to save :material-content-save: your fingerprint gesture map after applying these changes.

## Customising actions

Expand Down
47 changes: 45 additions & 2 deletions docs/user-guide/keymaps.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
Refer to the [Quick Start Guide](../quick-start.md) for help with creating key maps. This page gives more detail about every option.

Make sure to save :fontawesome-solid-save: your key map after applying these changes.
Make sure to save :material-content-save: your key map after applying these changes.

## Trigger

A trigger is a combination of keys that must be pressed in a certain way to 'trigger' the key map. A key map can only have one trigger. You can change the order of the keys by holding down on one and then dragging it into a new position.

This is the page to create a trigger for a key map.
This is the page to create a trigger for a key map. You will usually want to 'record' a custom trigger that is a combination of physical buttons/keys. There are also ['advanced triggers'](#advanced-triggers) that need to be set up slightly differently.

![](../images/trigger-page.png)

Expand Down Expand Up @@ -65,6 +65,49 @@ This will change the click type for a key in a sequence trigger. A parallel trig
option because all the keys have the same click type. You will find the buttons to change a parallel trigger's click
type above the trigger mode buttons as shown in the image at the top of this Trigger section.

## Advanced triggers

These triggers can be purchased so that the Key Mapper project has a little financial support and the developer is able to invest time maintaining and working on the project. You can see the list of advanced triggers below by tapping 'advanced triggers' on the trigger page.

![](../images/advanced-triggers-paywall.png)

### Assistant trigger

This trigger allows you to remap the various ways that your devices trigger the 'assistant' such as Google Assistant, Bixby, Alexa etc.

There are 3 assistant options you can choose:

- **Device assistant** = This is the assistant usually triggered from a long press of a power button or a dedicated button.
- **Voice assistant** = This is the assistant launched from the hands-free voice button on keyboards/headsets.
- **Any assistant** = This will trigger the key map when any of the above are triggered.

!!! note
It is not possible to create long-press key maps with this trigger! But you can do double press. You also can not use multiple assistant triggers in a parallel trigger because there is no way to detect them being pressed at exactly the same time.

### Setting up

There are multiple ways of triggering the assistant on different devices.

**Long press power button, Pixel squeeze**

This works on most Android devices. Android devices now have the option for remapping a long press of the power button to the assistant app. Older Pixels, such as the Pixel 2, also had a feature called "Active Edge" that allowed you to _squeeze_ the bottom half of the phone to trigger the assistant. If you select Key Mapper as the 'device assistant' app then your key map will be triggered with both of these methods.

You can set up the long-press of the power button by going to Android Settings :material-arrow-right-thin: System :material-arrow-right-thin: Gestures :material-arrow-right-thin: Press and hold power button. Then choose the digital assistant instead of showing power menu when you long press the power button. Key Mapper will prompt you to select it as the default digital assistant app.

**Bixby button**

This *should* work on Samsung devices that have a dedicated Bixby button but also devices that have the option of remapping the power button to another app when you double press it. You can use the assistant trigger for double pressing the Bixby or power button by picking the 'Assistant trigger' app/activity that shows in your list of apps.

!!! note
The developer does not have a Samsung device with a Bixby button so there is no guarantee that it works. If it does, please let the developer know so we can be more confident about support in the future 😄.

**Voice assistant button on keyboards and Bluetooth headphones**

Many external devices such as headsets, keyboards have a button for launching the voice assistant so you can control your phone hands-free. This also works with Key Mapper. If you

!!! warning
Some headphones have hardcoded the assistant apps that they will launch and will not work with Key Mapper. The developer has Sony WH1000XM3 headphones that support either Alexa or Google Assistant and refuse to launch Key Mapper when it is selected as the default assistant app.

## Customising actions

You can tap the pencil icon :material-pencil-outline: to the right of the action's name to bring up the following menu.
Expand Down

0 comments on commit 102fc95

Please sign in to comment.