rainmeter-bluetooth

A rainmeter plugin to implement bluetooth functionality.

Getting Started

rainmeter-bluetooth is not a usual rainmeter plugin. the bluetooth functionality uses some batch files to toggle, turn on/off and check the bluetooth status. To use in your skin you need to @include 2 .inc files, one with some Variables, and one with the Measures used to run the batch files and get their output.

Installing

1. Clone or download this repository and unzip it.
2. Go to the Plugin folder
3. Copy the bluetooth folder
4. Paste it in your Skin's @Resources folder (You must paste it there).

Adding to a skin

After pasting the plugin's folder in your skin's @Resources folder. Open your skin.ini file with your favorite Text editor.

Create a Variables Section if you don't already have one.

Inside the Variables section include the first .inc file.

@include=#@#\bluetooth\bluetoothVariables.inc

Doing that gives us access to important Variables, that later we will be able to use as actions to do some bluetooth things.

#@# refers to our @Resources folder and the rest of the path is our .inc file.

Below the Variables section we need to include another .inc file.

@include2=#@#\bluetooth\bluetooth.inc

This file contains some Measures that the actions from the first file will trigger.

Great! Now you can use the plugin from your skin.

Usage

To use the plugin's functions we just need to call a function whenever we want to use it and handle the output.

Example:

New skin

Adding the plugin to the skin

[Variables]
@include=#@#\bluetooth\bluetoothVariables.inc

@include2=#@#\bluetooth\bluetooth.inc

This will create a nice blue circle. that will call the BT_TurnOnBluetooth function on click (More about the BT_TurnOnBluetooth function and other functions can be found under the function section).

[MeterBluetoothOn]
Meter=Roundline
W=100
H=100
StartAngle=(Rad(270))
RotationAngle=(Rad(360))
LineStart=0
LineLength=50
LineColor=66,107,244
Solid=1
AntiAlias=1
LeftMouseUpAction=#BT_TurnOnBluetooth#

Now if bluetooth is off we can click our circle to turn it on.

We need to let our user know what's going on.

Lets add a string that will be used to update the user.

[MeterStringStatus]
Meter=String
Text=Nothing to see here
FontColor=237,249,62
FontSize=12
AntiAlias=1
Y=10R

the first time we want to change the status, is when the circle is pressed.

This simple action will set the text option for the MeterStringStatus to Bluetooth is turnning on. and then update the meter.

[!SetOption MeterStringStatus Text "Bluetooth is turnning on"][!UpdateMeter MeterStringStatus]

Lets add it to the LeftMouseUpAction for our circle. it should look something like this.

LeftMouseUpAction=#BT_TurnOnBluetooth#[!SetOption MeterStringStatus Text "Bluetooth is turnning on"][!UpdateMeter MeterStringStatus]

Then we want to let the user know when the bluetooth is on (takes about 0.5 seconds most of the times).

This is where functions handlers come in handy.

Lets define a new variable in our variables section.

BT_AfterBluetoothTurnedOn=

The plugin knows to run this variable after the bluetooth is turned on, same thing goes for the rest of the functions.

Lets give it this value:

[!SetOption MeterStringStatus Text "Bluetooth was turned on"][!UpdateMeter MeterStringStatus][!Delay 2000][!SetOption MeterStringStatus Text "Nothing to see here"][!UpdateMeter MeterStringStatus]

We are doing the same as last time but this time we are changing the status to:

"bluetooth was turned on"

We want the message to display for 2 seconds and then reset the message to the default message. To achive this result we use !Delay.

You can find this example skin under the Skins folder, it's called firstExample.ini

Functions

Most functions need to be handled after they are done executing. For that we can define specific actions as Variables that will be executed when our functions are done. Just like we did in the first example.

Each function will have a small example, demonstrating the usage and the handlers.

With every example we are going to talk about this meter:

[MeterStringStatus]
Meter=String
Text=Nothing to see here
FontColor=237,249,62
FontSize=12
AntiAlias=1

When you see MeterStringStatus.

We will use it to demonstrate the use of function handelers.

You can find this example skin under the Skins folder, it's called firstExample.ini

Function List

BT_CheckBluetooth

• Will check if bluetooth is ON or OFF
• Handelers:
  • BT_OnBluetoothCheck_On: this variable will be called when bluetooth was checked and found on.
  • BT_OnBluetoothCheck_Off: this variable will be called when bluetooth was checked and found off.
• Example:

  [Variables]
  BT_OnBluetoothCheck_On=[!SetOption MeterStringStatus Text "Bluetooth was checked and found on"][!UpdateMeter MeterStringStatus]
  BT_OnBluetoothCheck_Off=[!SetOption MeterStringStatus Text "Bluetooth was checked and found off"][!UpdateMeter MeterStringStatus]
  
  [ButtonBluetoothCheck]
  Meter=String
  Text=Check Bluetooth
  FontColor=0,0,0
  FontSize=16
  AntiAlias=1
  SolidColor=189,195,204
  LeftMouseUpAction=#BT_CheckBluetooth#

• Note: you can run this once every skin refresh by adding: OnRefreshAction=#BT_CheckBluetooth# To the rainmeter section of your skin.

BT_ToggleBluetooth

• Will toggle bluetooth ON or OFF depends on the current bluetooth status.
• Handelers:
  • BT_OnBluetoothToggle_On: this variable will be called when bluetooth was found off and then toggled on.
  • BT_OnBluetoothCheck_Off: this variable will be called when bluetooth was found on and then toggled off.
  • BT_AfterBluetoothToggle: this variable will be called regardless of the bluetooth status, after the bluetooth was toggled.
• Example:

  [Variables]
  BT_OnBluetoothToggle_On=[!SetOption MeterStringStatus Text "Bluetooth was found off, now it's on, it was toggled by the toggle function"][!UpdateMeter MeterStringStatus]
  BT_OnBluetoothToggle_Off=[!SetOption MeterStringStatus Text "Bluetooth was found on, now it's off, it was toggled by the toggle function"][!UpdateMeter MeterStringStatus]
  ;every time after the bluetooth is toggled regardless of the bluetooth status the background color will turn blue for a second.
  BT_AfterBluetoothToggle=[!SetOption MeterStringStatus SolidColor 66,107,244][!UpdateMeter MeterStringStatus][!Delay 1000][!SetOption MeterStringStatus SolidColor 189,195,204][!UpdateMeter MeterStringStatus]
  [ButtonBluetoothToggle]
  Meter=String
  Text=Toggle Bluetooth
  FontColor=0,0,0
  FontSize=16
  AntiAlias=1
  SolidColor=189,195,204
  LeftMouseUpAction=#BT_ToggleBluetooth#

BT_TurnOnBluetooth

• Will turn on the bluetooth if it's off, if it's on nothing will happen.
• Handelers:
  • BT_AfterBluetoothTurnedOn: this variable will be called after bluetooth is turned on.
• Example:

  [Variables]
  BT_AfterBluetoothTurnedOn=[!SetOption MeterStringStatus Text "Bluetooth turned on"][!UpdateMeter MeterStringStatus]
  
  [ButtonBluetoothTurnOn]
  Meter=String
  Text=Turn On Bluetooth
  FontColor=0,0,0
  FontSize=16
  AntiAlias=1
  SolidColor=189,195,204
  LeftMouseUpAction=#BT_TurnOnBluetooth#

• Note: The BT_AfterBluetoothTurnedOn will be called even if bluetooth is already on. which is why should always keep a global reference of the bluetooth status, by using BT_CheckBluetooth on skins load/refresh.

BT_TurnOffBluetooth

• Will turn off the bluetooth if it's on, if it's off nothing will happen.
• Handelers:
  • BT_AfterBluetoothTurnedOff: this variable will be called after bluetooth is turned off.
• Example:

  [Variables]
  BT_AfterBluetoothTurnedOff=[!SetOption MeterStringStatus Text "Bluetooth turned off"][!UpdateMeter MeterStringStatus]
  
  [ButtonBluetoothTurnOff]
  Meter=String
  Text=Turn Off Bluetooth
  FontColor=0,0,0
  FontSize=16
  AntiAlias=1
  SolidColor=189,195,204
  LeftMouseUpAction=#BT_TurnOffBluetooth#

• Note: The BT_AfterBluetoothTurnedOff will be called even if bluetooth is already off. which is why should always keep a global reference of the bluetooth status, by using BT_CheckBluetooth on skins load/refresh.

BT_OpenBluetoothDevices

• Will open the bluetooth settings page.
• Example:

  [ButtonOpenBluetoothSettings]
  Meter=String
  Text=Open Bluetooth settings
  FontColor=0,0,0
  FontSize=16
  AntiAlias=1
  SolidColor=189,195,204
  LeftMouseUpAction=#BT_OpenBluetoothDevices#

• Note: this function has no handelers.

Speciel Thanks

To Ben N which i shamelessly stole the powershell script from.