Skip to content

Commit

Permalink
readme update
Browse files Browse the repository at this point in the history
  • Loading branch information
maniacx committed Mar 1, 2024
1 parent fbe8b20 commit 6bbf9ce
Show file tree
Hide file tree
Showing 3 changed files with 49 additions and 5 deletions.
2 changes: 1 addition & 1 deletion docs/Bugs-Feature-Request.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ gsettings --schemadir /home/$USER/.local/share/gnome-shell/extensions/Airpod-Bat
* Operating system (e.g., Ubuntu 23.10)
* Bluetooth device make, model and type

# Script for getting ManufactorerData
# Script for getting Manufacturer Data
This script can be helpful to get raw data in case you Airpod/Beats model is not detecting or is different model that is not yet supported by this extension. The script starts discovery and prints manufacturer data and other details of all airpod found nearby.
* Download the [test.js](./resources/test.js){:download="test.js"}
* Disable Airpod-Battery-Monitor extension and close the Gnome Settings App > Bluetooth if opened.
Expand Down
21 changes: 17 additions & 4 deletions docs/Installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,12 +13,20 @@ permalink: /installation

* The extension is available on the Gnome Extension Website https://extensions.gnome.org/, where it undergoes a review process upon submission.
* Therefore, it's recommended to install this extension from the website.
* This will require installing an Extensions or Extension Manager app to manage the Gnome extension.


### Using Apps

[<img src="./assets/images/installation/extension.png" width="45%">](https://flathub.org/apps/org.gnome.Extensions)[<img src="./assets/images/installation/extension-manager.png" width="45%" class="float-right">](https://flathub.org/apps/com.mattjakeman.ExtensionManager)

* Either search for the extension by its name, "Airpod Battery Monitor" or use the website link below<br><https://extensions.gnome.org/extension/6778/airpod-battery-monitor/>
* This will require installing an Extensions or Extension Manager app to manage the Gnome extension.
* Either search for the extension by its name, "Bluetooth Battery Meter" or use the website link below<br><https://extensions.gnome.org/extension/6778/airpod-battery-monitor/>

### Using dbus command

```bash
busctl --user call org.gnome.Shell.Extensions /org/gnome/Shell/Extensions org.gnome.Shell.Extensions InstallRemoteExtension s Airpod-Battery-Monitor@maniacx.github.com
```
* Running this in console/terminal will download and install extension from Gnome Extension Website.

## From Github

Expand All @@ -28,14 +36,19 @@ permalink: /installation
* A prerequisite is that gettext needs to be installed.
* Run `./install.sh` from terminal to install.
* Open terminal and
```

## Uninstallation

To uninstall this extension, use the `Extensions` or `Extension Manager` app.
<br>
<br>
Or
<br>
<br>
Using commandline to uninstall
```bash
gnome-extensions uninstall Airpod-Battery-Monitor@maniacx.github.com
```
Although not neccesary, to take a step further and remove all gsettings saved by this extension, you can use the following terminal command:
```bash
gsettings --schemadir /home/$USER/.local/share/gnome-shell/extensions/Airpod-Battery-Monitor@maniacx.github.com/schemas reset-recursively org.gnome.shell.extensions.Airpod-Battery-Monitor
Expand Down
31 changes: 31 additions & 0 deletions index.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,15 @@ permalink: /
<br>
<br>

{: .note }
>
> * This extension is not compatible with Bluetooth configurations in BR/EDR-only mode. Dual mode is required.
> * As this extension initiates the discovery mode, it may lead to audio distortion on Broadcom Bluetooth adapters when the extension is running. If audio distortion occurs while playing audio and opening Gnome Settings > Bluetooth, the same issue may arise when using this program, as both involve starting the discovery process.

<br>
<br>

<img src="./assets/images/home/main.png" width="100%">

---
Expand Down Expand Up @@ -67,4 +76,26 @@ permalink: /
* The information is persistently stored, even after the Airpod is unpaired, for future reference.
* If you wish to discontinue the use of an Airpod, you can remove it from the list using the `Delete` button. This button is accessible only when the Airpod is unpaired from the system.

---

# Verify Bluetooth Adapter Controller Mode

If the extension is continuously scanning and unable to detect AirPods, examine the contents of a system file.

```
/etc/bluetooth/main.conf
```

If `ControllerMode = bredr`, the extension will not function correctly since it relies on `le` mode to retrieve AirPods battery information.

To resolve this, switch the adapter to Dual mode by executing the following command:
Locate the line `ControllerMode = bredr` and modify it to `ControllerMode = dual`

Restart Bluetooth Service

```
sudo systemctl restart bluetooth
```

Disable and Enable the extension.

0 comments on commit 6bbf9ce

Please sign in to comment.