From 3da1459ba6de8070b0794dac47341f92835c695f Mon Sep 17 00:00:00 2001 From: Dermot Duffy Date: Fri, 29 Aug 2025 20:19:26 -0700 Subject: [PATCH] docs: Improve documentation related to microphone toggle (#2165) - Related: #2161 --- docs/configuration/menu.md | 15 +++++++++++++-- 1 file changed, 13 insertions(+), 2 deletions(-) diff --git a/docs/configuration/menu.md b/docs/configuration/menu.md index 958ecb45..fbfbb46b 100644 --- a/docs/configuration/menu.md +++ b/docs/configuration/menu.md @@ -17,8 +17,6 @@ menu: ## `buttons` -All configuration is under: - ```yaml menu: buttons: @@ -60,6 +58,19 @@ menu: | `permanent` | `false` | If `false` the menu item is hidden when the menu has the `hidden` style and the menu is closed, otherwise it is shown (and sorted to the front). | | `priority` | `50` | The menu item priority. Higher priority items are ordered closer to the start of the menu alignment (i.e. a button with priority `70` will order further to the left than a button with priority `60`). Priority applies separately to `matching` and `opposing` groups (see `alignment` above). Minimum `0`, maximum `100`. | +### Additional options: `microphone` + +```yaml +menu: + buttons: + microphone: + # [...] +``` + +| Option | Default | Description | +| ------ | ----------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `type` | `momentary` | When `momentary` the button must be continually held down to talk, when `toggle` pressing the button will enable the microphone and it must be pressed again to disable it. | + ## `style` This card supports several menu styles.