<br />

Added: HEAD

## **ENUMS**

### GpioButtonId [flexible](https://fuchsia.dev/fuchsia-src/reference/fidl/language/language#strict-vs-flexible)

Type: `uint32`

*Defined in [fuchsia.buttons/gpio_buttons.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.buttons/gpio_buttons.fidl;l=30)*

All possible IDs of a button.

<br />

| Name | Value | Description |
|---|---|---|
| ### VOLUME_UP | `0` |   |
| ### VOLUME_DOWN | `1` |   |
| ### FDR | `2` |   |
| ### MIC_MUTE | `3` |   |
| ### PLAY_PAUSE | `4` |   |
| ### KEY_A | `5` |   |
| ### KEY_M | `6` |   |
| ### CAM_MUTE | `7` |   |
| ### MIC_AND_CAM_MUTE | `8` |   |
| ### FUNCTION | `9` |   |
| ### POWER | `10` |   |

## **TABLES**

### AdcButtonConfig

*Defined in [fuchsia.buttons/adc_buttons.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.buttons/adc_buttons.fidl;l=10)*

Analog-to-Digital Converter Buttons

<br />

| Ordinal | Field | Type | Description |
|---|---|---|---|
| ### 1 | `channel_idx` | `uint32` | ADC Channel Index to read button value on. |
| ### 2 | `release_threshold` | `uint32` | If press_threshold \<= value \<= release_threshold, button is pressed. Otherwise, not pressed. |
| ### 3 | `press_threshold` | `uint32` |   |

### AdcButtonsMetadata

*Defined in [fuchsia.buttons/adc_buttons.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.buttons/adc_buttons.fidl;l=35)*

| Ordinal | Field | Type | Description |
|---|---|---|---|
| ### 1 | `polling_rate_usec` | `uint32` | Polling Rate in usec if exists. |
| ### 2 | `buttons` | `vector<https://fuchsia.dev/reference/fidl/fuchsia.buttons#Button>` | Buttons. |

### Button

*Defined in [fuchsia.buttons/adc_buttons.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.buttons/adc_buttons.fidl;l=24)*

| Ordinal | Field | Type | Description |
|---|---|---|---|
| ### 1 | `types` | `vector<https://fuchsia.dev/reference/fuchsia.input//https://fuchsia.dev/reference/fuchsia.input#ConsumerControlButton>` | Button Types. A single button may affect multiple things and thus have multiple functionalities. For example, a privacy switch that mutes both the camera and mic may map to the combination of fuchsia.input.report.ConsumerControlButton.MIC_MUTE and CAMERA_DISABLE. |
| ### 2 | `button_config` | `https://fuchsia.dev/reference/fidl/fuchsia.buttons#ButtonConfig` | Button Config. |

### DirectGpioButton

*Defined in [fuchsia.buttons/gpio_buttons.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.buttons/gpio_buttons.fidl;l=10)*

Configuration for a direct gpio button where the state of the button is represented by the value
of a gpio.

<br />

| Ordinal | Field | Type | Description |
|---|---|---|---|

### GpioButtonConfig

*Defined in [fuchsia.buttons/gpio_buttons.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.buttons/gpio_buttons.fidl;l=75)*

Configuration information of a button that uses gpios to function.

<br />

| Ordinal | Field | Type | Description |
|---|---|---|---|
| ### 1 | `type` | `https://fuchsia.dev/reference/fidl/fuchsia.buttons#GpioButtonType` |   |
| ### 2 | `gpio_a_index` | `uint8` | Index of gpio A used. |
| ### 3 | `gpio_delay` | `https://fuchsia.dev/reference/zx//https://fuchsia.dev/reference/zx#Duration` | For settling during matrix scan. |
| ### 4 | `id` | `https://fuchsia.dev/reference/fidl/fuchsia.buttons#GpioButtonId` | ID of the button. |

### GpioButtonsMetadata

*Defined in [fuchsia.buttons/gpio_buttons.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.buttons/gpio_buttons.fidl;l=98)*

| Ordinal | Field | Type | Description |
|---|---|---|---|
| ### 1 | `buttons` | `vector<https://fuchsia.dev/reference/fidl/fuchsia.buttons#GpioButtonConfig>` | Configuration information for buttons that require gpio to function. |
| ### 2 | `gpios` | `vector<https://fuchsia.dev/reference/fidl/fuchsia.buttons#GpioConfig>` | Configuration information for the gpios used by \|buttons\|. |

### GpioConfig

*Defined in [fuchsia.buttons/gpio_buttons.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.buttons/gpio_buttons.fidl;l=89)*

Configuration information of a gpio used by a button.

<br />

| Ordinal | Field | Type | Description |
|---|---|---|---|
| ### 1 | `type` | `https://fuchsia.dev/reference/fidl/fuchsia.buttons#GpioType` | The type of the gpio pin. |
| ### 2 | `flags` | `https://fuchsia.dev/reference/fidl/fuchsia.buttons#GpioFlag` | The flags of the gpio pin. |

### InterruptGpio

*Defined in [fuchsia.buttons/gpio_buttons.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.buttons/gpio_buttons.fidl;l=45)*

Gpio pin will trigger an interrupt when its value has changed.

<br />

| Ordinal | Field | Type | Description |
|---|---|---|---|

### MatrixGpioButton

*Defined in [fuchsia.buttons/gpio_buttons.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.buttons/gpio_buttons.fidl;l=13)*

Configuration for a matrix gpio button.

<br />

| Ordinal | Field | Type | Description |
|---|---|---|---|
| ### 1 | `gpio_b_index` | `uint8` | Index of gpio B (column) used. Gpio type must be `GpioType::matrix_output` (is driven most of the time) and gpio A (row) must be `GpioType::interrupt` (triggers an interrupt most of the time). During matrix scans columns are floated and rows are read. |

### MatrixOutputGpio

*Defined in [fuchsia.buttons/gpio_buttons.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.buttons/gpio_buttons.fidl;l=49)*

Gpio pin's value continuously cycles through a row or column of a matrix of values that usually
represent a matrix of the states of buttons/components.

<br />

| Ordinal | Field | Type | Description |
|---|---|---|---|
| ### 1 | `output_value` | `uint8` | Determines the buffer mode of the gpio. A value of 0 is output-low and anything else is output-high. |

### PollGpio

*Defined in [fuchsia.buttons/gpio_buttons.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.buttons/gpio_buttons.fidl;l=56)*

Gpio pin is constantly polled for its value.

<br />

| Ordinal | Field | Type | Description |
|---|---|---|---|
| ### 1 | `period` | `https://fuchsia.dev/reference/zx//https://fuchsia.dev/reference/zx#Duration` | Time between each poll. |

## **UNIONS**

### ButtonConfig [flexible](https://fuchsia.dev/fuchsia-src/reference/fidl/language/language#strict-vs-flexible)

*Defined in [fuchsia.buttons/adc_buttons.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.buttons/adc_buttons.fidl;l=19)*

| Ordinal | Variant | Type | Description |
|---|---|---|---|
| ### 1 | `adc` | `https://fuchsia.dev/reference/fidl/fuchsia.buttons#AdcButtonConfig` | ADC Buttons. |

<br />

### GpioButtonType [flexible](https://fuchsia.dev/fuchsia-src/reference/fidl/language/language#strict-vs-flexible)

*Defined in [fuchsia.buttons/gpio_buttons.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.buttons/gpio_buttons.fidl;l=21)*

Type of button.

| Ordinal | Variant | Type | Description |
|---|---|---|---|
| ### 1 | `direct` | `https://fuchsia.dev/reference/fidl/fuchsia.buttons#DirectGpioButton` |   |
| ### 2 | `matrix` | `https://fuchsia.dev/reference/fidl/fuchsia.buttons#MatrixGpioButton` |   |

<br />

### GpioType [flexible](https://fuchsia.dev/fuchsia-src/reference/fidl/language/language#strict-vs-flexible)

*Defined in [fuchsia.buttons/gpio_buttons.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.buttons/gpio_buttons.fidl;l=62)*

The type of gpio.

| Ordinal | Variant | Type | Description |
|---|---|---|---|
| ### 1 | `interrupt` | `https://fuchsia.dev/reference/fidl/fuchsia.buttons#InterruptGpio` |   |
| ### 2 | `matrix_output` | `https://fuchsia.dev/reference/fidl/fuchsia.buttons#MatrixOutputGpio` |   |
| ### 3 | `poll` | `https://fuchsia.dev/reference/fidl/fuchsia.buttons#PollGpio` |   |

<br />

## **BITS**

### GpioFlag [flexible](https://fuchsia.dev/fuchsia-src/reference/fidl/language/language#strict-vs-flexible)

Type: `uint32`

*Defined in [fuchsia.buttons/gpio_buttons.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.buttons/gpio_buttons.fidl;l=69)*

Flags for configuriung gpio pin.

<br />

| Name | Value | Description |
|---|---|---|
| ### INVERTED | 128 | Invert the gpio's signal. |

## **CONSTANTS**

| Name | Value | Type | Description |
|---|---|---|---|
| [MAX_GPIO_BUTTON_ID_ORD](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.buttons/gpio_buttons.fidl;l=27) | `11` | `uint32` | Maximum ordinal that GpioButtonId can be. |