{"id":48395477,"url":"https://github.com/mee7ya/wlmouse-cli","last_synced_at":"2026-04-06T01:21:05.530Z","repository":{"id":245745035,"uuid":"816989875","full_name":"mee7ya/wlmouse-cli","owner":"mee7ya","description":"CLI for WLMouse to fetch various info about the device","archived":false,"fork":false,"pushed_at":"2024-07-14T18:17:27.000Z","size":12,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2024-07-14T19:38:49.350Z","etag":null,"topics":["hidapi","wlmouse"],"latest_commit_sha":null,"homepage":"","language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/mee7ya.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-06-18T19:41:31.000Z","updated_at":"2024-07-14T18:17:30.000Z","dependencies_parsed_at":"2024-06-27T00:21:21.359Z","dependency_job_id":null,"html_url":"https://github.com/mee7ya/wlmouse-cli","commit_stats":null,"previous_names":["mee7ya/wlmouse-cli"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/mee7ya/wlmouse-cli","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mee7ya%2Fwlmouse-cli","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mee7ya%2Fwlmouse-cli/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mee7ya%2Fwlmouse-cli/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mee7ya%2Fwlmouse-cli/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mee7ya","download_url":"https://codeload.github.com/mee7ya/wlmouse-cli/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mee7ya%2Fwlmouse-cli/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31455762,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-05T21:22:52.476Z","status":"ssl_error","status_checked_at":"2026-04-05T21:22:51.943Z","response_time":75,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["hidapi","wlmouse"],"created_at":"2026-04-06T01:21:05.479Z","updated_at":"2026-04-06T01:21:05.526Z","avatar_url":"https://github.com/mee7ya.png","language":"Rust","readme":"# wlmouse-cli\nCLI for diplaying information about wlmouse using `hidapi`\n\n## Supported Devices\n* [❔] **Beast X Mini** - I don't own it. There is a good chance it also uses feature reports and potentially compatible with Max/BeastX 8K\n* [✔️/❌] **Beast X** - requires direct reading from interrupt endpoint. Battery only right now, still don't know how to poll for other stuff\n* [✔️] **Beast X 8K** - originally developed with it in mind. Done through feature reports\n* [❔] **Beast X Max** - I don't own it. There is a good chance it also uses feature reports and potentially compatible with Mini/BeastX 8K\n\n## Vendor and Product IDs\n| WLMouse product | Vendor ID | Product ID |\n| :------------- | :-------: | :--------: |\n| Beast X Mini Receiver                |`0x36A7`|? |\n| Beast X Mini | `0x36A7`|? |\n| Beast X | `0x36A7` | `0xA888` |\n| Beast X Receiver | `0x36A7` | `0xA887` |\n| Beast X 8K | `0x36A7` | `0xA884` |\n| Beast X 8K Receiver | `0x36A7` | `0xA883` |\n| Beast X Max | `0x36A7` | ? |\n| Beast X Max Receiver | `0x36A7` | ? |\n\n## Packets Disclaimer\nAll bytes sent and read from feature reports were sniffed using [**Wireshark**](https://www.wireshark.org/) and [**usbpcap**](https://desowin.org/usbpcap/) between actual device and official WLMouse software. Since there is no official structure of all the bytes sent/read, I had to guess what they do mean. This means it MAY NOT be 100% accurate\n\n## Feature Reports\nSummary of how to set/get feature reports\n### Windows\n1. List all devices ([GetRawInputDeviceList](https://learn.microsoft.com/en-us/windows/win32/api/winuser/nf-winuser-getrawinputdevicelist))\n2. Get device info for each one ([GetRawInputDeviceInfoW](https://learn.microsoft.com/en-us/windows/win32/api/winuser/nf-winuser-getrawinputdeviceinfow) with `uiCommand == RIDI_DEVICEINFO`)\n3. Get the one with required Vendor and Product ID\n4. Get device virtual file ([GetRawInputDeviceInfoW](https://learn.microsoft.com/en-us/windows/win32/api/winuser/nf-winuser-getrawinputdeviceinfow) with `uiCommand == RIDI_DEVICENAME`)\n5. Open virtual file ([CreateFileW](https://learn.microsoft.com/en-us/windows/win32/api/fileapi/nf-fileapi-createfilew))\n6. Set required feature to poll from device ([HidD_SetFeature](https://learn.microsoft.com/en-us/windows-hardware/drivers/ddi/hidsdi/nf-hidsdi-hidd_setfeature))\n7. Wait for a small delay for device to process your request\n8. Grab result of your request ([HidD_GetFeature](https://learn.microsoft.com/en-us/windows-hardware/drivers/ddi/hidsdi/nf-hidsdi-hidd_getfeature))\n\n## Interrupts\nSummary of how to read/write using interrupt endpoint\n### Windows\n1. List all devices ([GetRawInputDeviceList](https://learn.microsoft.com/en-us/windows/win32/api/winuser/nf-winuser-getrawinputdevicelist))\n2. Get device info for each one ([GetRawInputDeviceInfoW](https://learn.microsoft.com/en-us/windows/win32/api/winuser/nf-winuser-getrawinputdeviceinfow) with `uiCommand == RIDI_DEVICEINFO`)\n3. Get the one with required Vendor, Product ID\n4. Check device usage, should be control (`0x06`), otherwise Windows won't allow read/write operation. If no, repeat step 3\n5. Get device virtual file ([GetRawInputDeviceInfoW](https://learn.microsoft.com/en-us/windows/win32/api/winuser/nf-winuser-getrawinputdeviceinfow) with `uiCommand == RIDI_DEVICENAME`)\n6. Open virtual file ([CreateFileW](https://learn.microsoft.com/en-us/windows/win32/api/fileapi/nf-fileapi-createfilew))\n7. Write to virtual file ([WriteFile](https://learn.microsoft.com/en-us/windows/win32/api/fileapi/nf-fileapi-writefile))\n8. Read from virtual file ([ReadFile](https://learn.microsoft.com/en-us/windows/win32/api/fileapi/nf-fileapi-readfile))","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmee7ya%2Fwlmouse-cli","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmee7ya%2Fwlmouse-cli","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmee7ya%2Fwlmouse-cli/lists"}