razer-battery-report/README.md

<h1 align="center">razer-battery-report</h1>

<p align="center">
  <b>Razer Battery Level Tray Indicator</b>
</p>

<p align="center">
  <img src="img/demo.png">
</p>

Show your wireless Razer devices battery levels in your system tray.

> This is a work in progress and currently support only **Razer DeathAdder V3 Pro**.

> Currently, this works only on **Windows**, should work on **Linux** if you _add udev rule to get access to usb devices_ (see [here](https://github.com/libusb/hidapi/blob/master/udev/69-hid.rules)) and remove/`cfg(windows)` some platform-specific code. But I haven't tested yet.

## Usage

### Downloading a Prebuilt Binary

> _Todo_

### Building from Source

To build, you must have [Rust](https://www.rust-lang.org/) and
[Git](https://git-scm.com/) installed on your system.

1. Clone this repository: `git clone https://github.com/xzeldon/razer-battery-report.git`
2. Navigate into your local repository: `cd razer-battery-report`
3. Build: `cargo build --release`
4. Executable will be located at `target/release/razer-battery-report.exe`

## Adding new devices yourself

- add device with `name`, `pid`, `interface`, `usage_page`, `usage` to [devices.rs](/src/devices.rs)
- add `transaction_id` to switch statement in `DeviceInfo` in [devices.rs](/src/devices.rs)

> You can grab `pid` and other data from the [openrazer](https://github.com/openrazer/openrazer/blob/352d13c416f42e572016c02fd10a52fc9848644a/driver/razermouse_driver.h#L9)

## Todo

- [x] Tray Applet
  - [ ] Force update devices button in tray menu
  - [ ] Colored tray icons for different battery levels
  - [x] Show log window button in tray menu
  - [x] Further reduce CPU usage by using Event Loop Proxy events (more info [here](https://github.com/tauri-apps/tray-icon/issues/83#issuecomment-1697773065))
- [ ] Prebuilt Binary
- [ ] Command Line Arguments for update frequency
- [ ] Support for other Razer Devices (I only have DeathAdder V3 Pro, so I won't be able to test it with other devices)

## Acknowledgments

- Linux Drivers for Razer devices: https://github.com/openrazer/openrazer
- This python script: https://github.com/spozer/razer-battery-checker
- 🖱️ Logitech Battery Level Tray Indicator (Elem): https://github.com/Fuwn/elem
init 2024-08-27 18:08:03 +00:00			`<h1 align="center">razer-battery-report</h1>`

			`<p align="center">`
feature: tray applet 2024-09-03 22:46:04 +00:00			`<b>Razer Battery Level Tray Indicator</b>`
init 2024-08-27 18:08:03 +00:00			`</p>`

feature: tray applet 2024-09-03 22:46:04 +00:00			`<p align="center">`
			`<img src="img/demo.png">`
			`</p>`
init 2024-08-27 18:08:03 +00:00
feature: tray applet 2024-09-03 22:46:04 +00:00			`Show your wireless Razer devices battery levels in your system tray.`
init 2024-08-27 18:08:03 +00:00
			`> This is a work in progress and currently support only Razer DeathAdder V3 Pro.`

docs: update support statement for Linux compatibility 2024-09-06 00:02:08 +00:00			> Currently, this works only on Windows, should work on Linux if you _add udev rule to get access to usb devices_ (see [here](https://github.com/libusb/hidapi/blob/master/udev/69-hid.rules)) and remove/`cfg(windows)` some platform-specific code. But I haven't tested yet.
init 2024-08-27 18:08:03 +00:00
			`## Usage`

			`### Downloading a Prebuilt Binary`
feat: add console window toggling 2024-09-05 22:55:10 +00:00
			`> _Todo_`
init 2024-08-27 18:08:03 +00:00
			`### Building from Source`

			`To build, you must have [Rust](https://www.rust-lang.org/) and`
			`[Git](https://git-scm.com/) installed on your system.`

			1. Clone this repository: `git clone https://github.com/xzeldon/razer-battery-report.git`
			2. Navigate into your local repository: `cd razer-battery-report`
chore: update build instructions 2024-09-04 09:39:00 +00:00			3. Build: `cargo build --release`
			4. Executable will be located at `target/release/razer-battery-report.exe`
init 2024-08-27 18:08:03 +00:00
			`## Adding new devices yourself`
feat: add console window toggling 2024-09-05 22:55:10 +00:00
			- add device with `name`, `pid`, `interface`, `usage_page`, `usage` to [devices.rs](/src/devices.rs)
			- add `transaction_id` to switch statement in `DeviceInfo` in [devices.rs](/src/devices.rs)
init 2024-08-27 18:08:03 +00:00
			> You can grab `pid` and other data from the [openrazer](https://github.com/openrazer/openrazer/blob/352d13c416f42e572016c02fd10a52fc9848644a/driver/razermouse_driver.h#L9)

			`## Todo`
feat: add console window toggling 2024-09-05 22:55:10 +00:00
feature: tray applet 2024-09-03 22:46:04 +00:00			`- [x] Tray Applet`
			`- [ ] Force update devices button in tray menu`
			`- [ ] Colored tray icons for different battery levels`
feat: add console window toggling 2024-09-05 22:55:10 +00:00			`- [x] Show log window button in tray menu`
refactor: reduce CPU usage with Event Loop Proxy events 2024-09-14 19:08:52 +00:00			`- [x] Further reduce CPU usage by using Event Loop Proxy events (more info [here](https://github.com/tauri-apps/tray-icon/issues/83#issuecomment-1697773065))`
init 2024-08-27 18:08:03 +00:00			`- [ ] Prebuilt Binary`
			`- [ ] Command Line Arguments for update frequency`
			`- [ ] Support for other Razer Devices (I only have DeathAdder V3 Pro, so I won't be able to test it with other devices)`

			`## Acknowledgments`
feat: add console window toggling 2024-09-05 22:55:10 +00:00
			`- Linux Drivers for Razer devices: https://github.com/openrazer/openrazer`
			`- This python script: https://github.com/spozer/razer-battery-checker`
			`- 🖱️ Logitech Battery Level Tray Indicator (Elem): https://github.com/Fuwn/elem`