# Options

## Role

The Role of operations the plugin will perform when its measure is updated.

{% tabs %}
{% tab title="Role=0" %}
{% hint style="info" %}
This is the DEFAULT `Role`
{% endhint %}

**Description:** `Get/Update the Bluetooth status and Bluetooth devices`

**Plugin Measure:** `Returns 0`

**Available Bangs:**

* [#updatebluetoothstatus](https://droptop.gitbook.io/rainmeter-bluetooth-plugin/bangs#updatebluetoothstatus "mention")
* [#disablebluetooth](https://droptop.gitbook.io/rainmeter-bluetooth-plugin/bangs#disablebluetooth "mention")
* [#enablebluetooth](https://droptop.gitbook.io/rainmeter-bluetooth-plugin/bangs#enablebluetooth "mention")
* [#togglebluetooth](https://droptop.gitbook.io/rainmeter-bluetooth-plugin/bangs#togglebluetooth "mention")
* [#updatedevices](https://droptop.gitbook.io/rainmeter-bluetooth-plugin/bangs#updatedevices "mention")
  {% endtab %}

{% tab title="Role=1" %}
**Description:** `Get/Update the Bluetooth status.`

**Plugin Measure:** `Returns the Bluetooth Status`

**Available Bangs:**

* [#disablebluetooth](https://droptop.gitbook.io/rainmeter-bluetooth-plugin/bangs#disablebluetooth "mention")
* [#enablebluetooth](https://droptop.gitbook.io/rainmeter-bluetooth-plugin/bangs#enablebluetooth "mention")
* [#togglebluetooth](https://droptop.gitbook.io/rainmeter-bluetooth-plugin/bangs#togglebluetooth "mention")
* [#updatebluetoothstatus](https://droptop.gitbook.io/rainmeter-bluetooth-plugin/bangs#updatebluetoothstatus "mention")
  {% endtab %}

{% tab title="Role=2" %}
**Description:** `Get/Update the Bluetooth devices`

**Plugin Measure:** `Returns 0`

**Available Bangs:**

* [#updatedevices](https://droptop.gitbook.io/rainmeter-bluetooth-plugin/bangs#updatedevices "mention")
  {% endtab %}
  {% endtabs %}

{% code title="Example" lineNumbers="true" %}

```ini
[BluetoothMeasure]
Measure=Plugin
Plugin=Bluetooth
Role=[0/1/2]
```

{% endcode %}

## UpdateAction

The list of bangs that needs to be executed when the measure is updated.

{% code title="Example" lineNumbers="true" %}

```ini
[BluetoothMeasure]
Measure=Plugin
Plugin=Bluetooth
UpdateAction=[!Log "Bang1" Debug][!Log "Bang2" Debug]
UpdateDivider=30
```

{% endcode %}

## OutputFile

The path of an output file you want to save the devices list to.

The file will have this structure:

{% code title="@Resources/output.txt" lineNumbers="true" fullWidth="false" %}

```
device_name|device_address|device_id|connected[0,1]|paired[0,1]|can_pair[0,1]major_category|minor_category|has_battery_level[0,1]|battery|is_ble[0,1];
device_name|device_address|device_id|connected[0,1]|paired[0,1]|can_pair[0,1]major_category|minor_category|has_battery_level[0,1]|battery|is_ble[0,1];
...
```

{% endcode %}

{% code title="Example" lineNumbers="true" %}

```ini
[BluetoothMeasure]
Measure=Plugin
Plugin=Bluetooth
OutputFile=#CURRENTPATH#\Devices.txt
UpdateDivider=30
```

{% endcode %}

This example saves the list of devices in a file in `#CURRENTPATH#\Devices.txt`.

## ThumbnailsFolder

The path of the folder you want to save devices thumbnails to.

The thumbnails are managed by Windows, and are a visual representation of the [#major-category](https://droptop.gitbook.io/rainmeter-bluetooth-plugin/section-variables#major-category "mention") or of the [#minor-category](https://droptop.gitbook.io/rainmeter-bluetooth-plugin/section-variables#minor-category "mention") of the device if present.

```ini
[BluetoothDevicesMeasure]
Measure=Plugin
Plugin=Bluetooth
ThumbnailsFolder=#CURRENTPATH#\img
UpdateDivider=30
```

This example saves the images in the folder `#CURRENTPATH#\img`.

These are a couple of examples of thumbnails:

* mouse: <img src="https://684433344-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7tEmxXLqIc1gsumGxR7s%2Fuploads%2FnCrFDe6v6qaqtPqy53KM%2FDevice4_thumbnail.jpg?alt=media&#x26;token=725f46c0-9de7-43f3-aa9b-45bf0632cea8" alt="" data-size="line">
* phone: <img src="https://684433344-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7tEmxXLqIc1gsumGxR7s%2Fuploads%2F3KCUKrO6YM5MR6tYq26V%2FDevice1_thumbnail.jpg?alt=media&#x26;token=71d9f882-b7ef-4887-a106-710619802729" alt="" data-size="line">
* speaker: <img src="https://684433344-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7tEmxXLqIc1gsumGxR7s%2Fuploads%2FpxbkzMn0VDKY6ZZ3FjXj%2FDevice3_thumbnail.jpg?alt=media&#x26;token=1222b308-ca06-4bb8-b886-085447783d27" alt="" data-size="line">