openrazer-win 1.0.0__tar.gz

openrazer_win-1.0.0/LICENSE

@@ -0,0 +1,117 @@
+GNU GENERAL PUBLIC LICENSE
+Version 2, June 1991
+
+Copyright (C) 1989, 1991 Free Software Foundation, Inc.
+51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA
+
+Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed.
+
+Preamble
+
+The licenses for most software are designed to take away your freedom to share and change it. By contrast, the GNU General Public License is intended to guarantee your freedom to share and change free software--to make sure the software is free for all its users. This General Public License applies to most of the Free Software Foundation's software and to any other program whose authors commit to using it. (Some other Free Software Foundation software is covered by the GNU Lesser General Public License instead.) You can apply it to your programs, too.
+
+When we speak of free software, we are referring to freedom, not price. Our General Public Licenses are designed to make sure that you have the freedom to distribute copies of free software (and charge for this service if you wish), that you receive source code or can get it if you want it, that you can change the software or use pieces of it in new free programs; and that you know you can do these things.
+
+To protect your rights, we need to make restrictions that forbid anyone to deny you these rights or to ask you to surrender the rights. These restrictions translate to certain responsibilities for you if you distribute copies of the software, or if you modify it.
+
+For example, if you distribute copies of such a program, whether gratis or for a fee, you must give the recipients all the rights that you have. You must make sure that they, too, receive or can get the source code. And you must show them these terms so they know their rights.
+
+We protect your rights with two steps: (1) copyright the software, and (2) offer you this license which gives you legal permission to copy, distribute and/or modify the software.
+
+Also, for each author's protection and ours, we want to make certain that everyone understands that there is no warranty for this free software. If the software is modified by someone else and passed on, we want its recipients to know that what they have is not the original, so that any problems introduced by others will not reflect on the original authors' reputations.
+
+Finally, any free program is threatened constantly by software patents. We wish to avoid the danger that redistributors of a free program will individually obtain patent licenses, in effect making the program proprietary. To prevent this, we have made it clear that any patent must be licensed for everyone's free use or not licensed at all.
+
+The precise terms and conditions for copying, distribution and modification follow.
+
+TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+
+0. This License applies to any program or other work which contains a notice placed by the copyright holder saying it may be distributed under the terms of this General Public License. The "Program", below, refers to any such program or work, and a "work based on the Program" means either the Program or any derivative work under copyright law: that is to say, a work containing the Program or a portion of it, either verbatim or with modifications and/or translated into another language. (Hereinafter, translation is included without limitation in the term "modification".) Each licensee is addressed as "you".
+
+Activities other than copying, distribution and modification are not covered by this License; they are outside its scope. The act of running the Program is not restricted, and the output from the Program is covered only if its contents constitute a work based on the Program (independent of having been made by running the Program). Whether that is true depends on what the Program does.
+
+1. You may copy and distribute verbatim copies of the Program's source code as you receive it, in any medium, provided that you conspicuously and appropriately publish on each copy an appropriate copyright notice and disclaimer of warranty; keep intact all the notices that refer to this License and to the absence of any warranty; and give any other recipients of the Program a copy of this License along with the Program.
+
+You may charge a fee for the physical act of transferring a copy, and you may at your option offer warranty protection in exchange for a fee.
+
+2. You may modify your copy or copies of the Program or any portion of it, thus forming a work based on the Program, and copy and distribute such modifications or work under the terms of Section 1 above, provided that you also meet all of these conditions:
+
+     a) You must cause the modified files to carry prominent notices stating that you changed the files and the date of any change.
+
+     b) You must cause any work that you distribute or publish, that in whole or in part contains or is derived from the Program or any part thereof, to be licensed as a whole at no charge to all third parties under the terms of this License.
+
+     c) If the modified program normally reads commands interactively when run, you must cause it, when started running for such interactive use in the most ordinary way, to print or display an announcement including an appropriate copyright notice and a notice that there is no warranty (or else, saying that you provide a warranty) and that users may redistribute the program under these conditions, and telling the user how to view a copy of this License. (Exception: if the Program itself is interactive but does not normally print such an announcement, your work based on the Program is not required to print an announcement.)
+
+These requirements apply to the modified work as a whole. If identifiable sections of that work are not derived from the Program, and can be reasonably considered independent and separate works in themselves, then this License, and its terms, do not apply to those sections when you distribute them as separate works. But when you distribute the same sections as part of a whole which is a work based on the Program, the distribution of the whole must be on the terms of this License, whose permissions for other licensees extend to the entire whole, and thus to each and every part regardless of who wrote it.
+
+Thus, it is not the intent of this section to claim rights or contest your rights to work written entirely by you; rather, the intent is to exercise the right to control the distribution of derivative or collective works based on the Program.
+
+In addition, mere aggregation of another work not based on the Program with the Program (or with a work based on the Program) on a volume of a storage or distribution medium does not bring the other work under the scope of this License.
+
+3. You may copy and distribute the Program (or a work based on it, under Section 2) in object code or executable form under the terms of Sections 1 and 2 above provided that you also do one of the following:
+
+     a) Accompany it with the complete corresponding machine-readable source code, which must be distributed under the terms of Sections 1 and 2 above on a medium customarily used for software interchange; or,
+
+     b) Accompany it with a written offer, valid for at least three years, to give any third party, for a charge no more than your cost of physically performing source distribution, a complete machine-readable copy of the corresponding source code, to be distributed under the terms of Sections 1 and 2 above on a medium customarily used for software interchange; or,
+
+     c) Accompany it with the information you received as to the offer to distribute corresponding source code. (This alternative is allowed only for noncommercial distribution and only if you received the program in object code or executable form with such an offer, in accord with Subsection b above.)
+
+The source code for a work means the preferred form of the work for making modifications to it. For an executable work, complete source code means all the source code for all modules it contains, plus any associated interface definition files, plus the scripts used to control compilation and installation of the executable. However, as a special exception, the source code distributed need not include anything that is normally distributed (in either source or binary form) with the major components (compiler, kernel, and so on) of the operating system on which the executable runs, unless that component itself accompanies the executable.
+
+If distribution of executable or object code is made by offering access to copy from a designated place, then offering equivalent access to copy the source code from the same place counts as distribution of the source code, even though third parties are not compelled to copy the source along with the object code.
+
+4. You may not copy, modify, sublicense, or distribute the Program except as expressly provided under this License. Any attempt otherwise to copy, modify, sublicense or distribute the Program is void, and will automatically terminate your rights under this License. However, parties who have received copies, or rights, from you under this License will not have their licenses terminated so long as such parties remain in full compliance.
+
+5. You are not required to accept this License, since you have not signed it. However, nothing else grants you permission to modify or distribute the Program or its derivative works. These actions are prohibited by law if you do not accept this License. Therefore, by modifying or distributing the Program (or any work based on the Program), you indicate your acceptance of this License to do so, and all its terms and conditions for copying, distributing or modifying the Program or works based on it.
+
+6. Each time you redistribute the Program (or any work based on the Program), the recipient automatically receives a license from the original licensor to copy, distribute or modify the Program subject to these terms and conditions. You may not impose any further restrictions on the recipients' exercise of the rights granted herein. You are not responsible for enforcing compliance by third parties to this License.
+
+7. If, as a consequence of a court judgment or allegation of patent infringement or for any other reason (not limited to patent issues), conditions are imposed on you (whether by court order, agreement or otherwise) that contradict the conditions of this License, they do not excuse you from the conditions of this License. If you cannot distribute so as to satisfy simultaneously your obligations under this License and any other pertinent obligations, then as a consequence you may not distribute the Program at all. For example, if a patent license would not permit royalty-free redistribution of the Program by all those who receive copies directly or indirectly through you, then the only way you could satisfy both it and this License would be to refrain entirely from distribution of the Program.
+
+If any portion of this section is held invalid or unenforceable under any particular circumstance, the balance of the section is intended to apply and the section as a whole is intended to apply in other circumstances.
+
+It is not the purpose of this section to induce you to infringe any patents or other property right claims or to contest validity of any such claims; this section has the sole purpose of protecting the integrity of the free software distribution system, which is implemented by public license practices. Many people have made generous contributions to the wide range of software distributed through that system in reliance on consistent application of that system; it is up to the author/donor to decide if he or she is willing to distribute software through any other system and a licensee cannot impose that choice.
+
+This section is intended to make thoroughly clear what is believed to be a consequence of the rest of this License.
+
+8. If the distribution and/or use of the Program is restricted in certain countries either by patents or by copyrighted interfaces, the original copyright holder who places the Program under this License may add an explicit geographical distribution limitation excluding those countries, so that distribution is permitted only in or among countries not thus excluded. In such case, this License incorporates the limitation as if written in the body of this License.
+
+9. The Free Software Foundation may publish revised and/or new versions of the General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns.
+
+Each version is given a distinguishing version number. If the Program specifies a version number of this License which applies to it and "any later version", you have the option of following the terms and conditions either of that version or of any later version published by the Free Software Foundation. If the Program does not specify a version number of this License, you may choose any version ever published by the Free Software Foundation.
+
+10. If you wish to incorporate parts of the Program into other free programs whose distribution conditions are different, write to the author to ask for permission. For software which is copyrighted by the Free Software Foundation, write to the Free Software Foundation; we sometimes make exceptions for this. Our decision will be guided by the two goals of preserving the free status of all derivatives of our free software and of promoting the sharing and reuse of software generally.
+
+NO WARRANTY
+
+11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
+
+12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
+
+END OF TERMS AND CONDITIONS
+
+How to Apply These Terms to Your New Programs
+
+If you develop a new program, and you want it to be of the greatest possible use to the public, the best way to achieve this is to make it free software which everyone can redistribute and change under these terms.
+
+To do so, attach the following notices to the program. It is safest to attach them to the start of each source file to most effectively convey the exclusion of warranty; and each file should have at least the "copyright" line and a pointer to where the full notice is found.
+
+     one line to give the program's name and an idea of what it does. Copyright (C) yyyy name of author
+
+     This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.
+
+     This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
+
+     You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. Also add information on how to contact you by electronic and paper mail.
+
+If the program is interactive, make it output a short notice like this when it starts in an interactive mode:
+
+     Gnomovision version 69, Copyright (C) year name of author Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. This is free software, and you are welcome to redistribute it under certain conditions; type `show c' for details.
+
+The hypothetical commands `show w' and `show c' should show the appropriate parts of the General Public License. Of course, the commands you use may be called something other than `show w' and `show c'; they could even be mouse-clicks or menu items--whatever suits your program.
+
+You should also get your employer (if you work as a programmer) or your school, if any, to sign a "copyright disclaimer" for the program, if necessary. Here is a sample; alter the names:
+
+     Yoyodyne, Inc., hereby disclaims all copyright interest in the program `Gnomovision' (which makes passes at compilers) written by James Hacker.
+
+signature of Ty Coon, 1 April 1989 Ty Coon, President of Vice

openrazer_win-1.0.0/PKG-INFO

@@ -0,0 +1,330 @@
+Metadata-Version: 2.4
+Name: openrazer-win
+Version: 1.0.0
+Summary: OpenRazer for Windows: Razer device control in user space, no kernel driver required
+Author: Nikita Davidchuk
+Maintainer: Nikita Davidchuk
+License: GPL-2.0-or-later
+Project-URL: Homepage, https://ar4ikov.github.io/openrazer-win/
+Project-URL: Documentation, https://ar4ikov.github.io/openrazer-win/
+Project-URL: Source, https://github.com/Ar4ikov/openrazer-win
+Project-URL: Issues, https://github.com/Ar4ikov/openrazer-win/issues
+Project-URL: Upstream, https://github.com/openrazer/openrazer
+Keywords: razer,chroma,rgb,hid,windows,openrazer,keyboard,mouse
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Environment :: Console
+Classifier: Environment :: Win32 (MS Windows)
+Classifier: Intended Audience :: End Users/Desktop
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: GNU General Public License v2 or later (GPLv2+)
+Classifier: Operating System :: Microsoft :: Windows :: Windows 10
+Classifier: Operating System :: Microsoft :: Windows :: Windows 11
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: System :: Hardware :: Hardware Drivers
+Classifier: Topic :: System :: Hardware :: Universal Serial Bus (USB) :: Human Interface Device (HID)
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0; extra == "dev"
+Requires-Dist: pytest-cov>=4.0; extra == "dev"
+Requires-Dist: ruff<1.0,>=0.5; extra == "dev"
+Provides-Extra: build
+Requires-Dist: pyinstaller>=6.0; extra == "build"
+Dynamic: license-file
+
+<div align="center">
+
+# OpenRazer for Windows
+
+**Control your Razer keyboard, mouse and mousepad on Windows 10 / 11 — without Synapse, without a kernel driver, without a single third-party package.**
+
+[![CI](https://github.com/Ar4ikov/openrazer-win/actions/workflows/ci.yml/badge.svg)](https://github.com/Ar4ikov/openrazer-win/actions/workflows/ci.yml)
+[![Python 3.9+](https://img.shields.io/badge/python-3.9%2B-blue)](https://www.python.org/downloads/)
+[![License: GPL-2.0-or-later](https://img.shields.io/badge/license-GPL--2.0--or--later-green)](LICENSE)
+[![Devices: 267](https://img.shields.io/badge/devices-267-orange)](https://ar4ikov.github.io/openrazer-win/#devices)
+
+[Documentation](https://ar4ikov.github.io/openrazer-win/) ·
+[Supported devices](https://ar4ikov.github.io/openrazer-win/#devices) ·
+[Upstream OpenRazer](https://github.com/openrazer/openrazer)
+
+</div>
+
+---
+
+[OpenRazer](https://github.com/openrazer/openrazer) is the free Razer driver for Linux: a kernel
+module that speaks Razer's vendor USB protocol, plus a D-Bus daemon on top of it. Neither half runs
+on Windows.
+
+This is a full port. The protocol layer moves into user space on top of the Windows HID class driver,
+D-Bus is replaced by a loopback JSON-RPC daemon, and **every device quirk is transpiled directly from
+the upstream C sources** — so all 267 devices OpenRazer knows about behave the same way here as they
+do on Linux.
+
+```console
+$ openrazer-win list
+Razer BlackWidow Chroma  keyboard   PM1523E01801234     v1.10
+Razer Viper              mouse      PM1948H09500666     v1.3
+
+$ openrazer-win effect breath_dual "#ff0080" --colour2 cyan
+Razer BlackWidow Chroma: breath_dual on backlight
+
+$ openrazer-win dpi 3200
+Razer Viper: dpi (3200, 3200)
+```
+
+## Why this exists
+
+| | Synapse | openrazer-win |
+|---|---|---|
+| Account required | Yes | No |
+| Runs in the background | ~200 MB, several services | ~25 MB, one process you start |
+| Telemetry | Yes | None — no network access at all |
+| Scriptable | No | CLI + Python API + JSON-RPC |
+| Works offline / on a locked-down machine | Partially | Fully |
+| Source available | No | GPL-2.0-or-later |
+
+## Install
+
+```bash
+pip install git+https://github.com/Ar4ikov/openrazer-win
+```
+
+There is no dependency list to speak of — the port runs on the Python standard library alone. No
+compiler, no `hidapi` wheel, no driver signing, no administrator rights, no reboot.
+
+Prefer a single file? Grab `openrazer-win.exe` from the
+[latest release](https://github.com/Ar4ikov/openrazer-win/releases/latest) and run it directly; it
+needs no Python at all.
+
+> Not on PyPI yet, so `pip install openrazer-win` will not find it — use the git URL above.
+
+> **Close Razer Synapse before using this.** Synapse holds the device open and will fight you for
+> control of the LEDs. `openrazer-win doctor` tells you if that is happening.
+
+## Quick start
+
+### Command line
+
+```bash
+openrazer-win daemon start          # start the background service
+openrazer-win list                  # what is plugged in
+openrazer-win info                  # everything about it
+
+openrazer-win effect static red
+openrazer-win effect spectrum
+openrazer-win effect wave --direction 2
+openrazer-win effect breath_dual "#ff0080" --colour2 "#00ffff"
+openrazer-win effect ripple green   # host-rendered, follows your typing
+
+openrazer-win brightness 60
+openrazer-win dpi 1800
+openrazer-win poll-rate 1000
+openrazer-win battery
+```
+
+Every command takes `--device` (serial, product id or a fragment of the name), `--zone`
+(`backlight`, `logo`, `scroll`, `left`, `right`, …) and `--json`.
+
+To have the daemon come up with Windows:
+
+```bash
+openrazer-win autostart enable      # per-user, no admin rights
+openrazer-win autostart status
+openrazer-win autostart disable
+```
+
+This writes one entry under `HKCU\...\CurrentVersion\Run`, so it also appears in Task Manager's
+Startup tab and can be removed from there.
+
+### Python
+
+The API mirrors upstream's `openrazer.client`, so scripts written for Linux usually port by changing
+one import:
+
+```python
+from openrazer_win.client import DeviceManager
+
+for device in DeviceManager().devices:
+    print(device.name, device.serial, device.firmware_version)
+
+    device.fx.static(0, 255, 0)
+    device.brightness = 75
+
+    if device.has('dpi'):
+        device.dpi = (1800, 1800)
+```
+
+Per-key lighting works the same way as upstream's `fx.advanced`:
+
+```python
+keyboard = DeviceManager().by_name('BlackWidow')[0]
+matrix = keyboard.fx.advanced
+for row in range(matrix.rows):
+    for column in range(matrix.columns):
+        matrix[row, column] = (255, 0, 128)
+matrix.draw()
+```
+
+No daemon running? Pass `direct=True` and the library opens the HID handles itself:
+
+```python
+DeviceManager(direct=True)
+```
+
+### Graphical control panel
+
+```bash
+openrazer-win-gui
+```
+
+A small Tk window — device list, zone and effect pickers, colour swatches, brightness, DPI and
+polling rate. Tk ships with Python on Windows, so this needs no extra install either.
+
+## How it works
+
+The Linux stack is a kernel module plus a D-Bus daemon. Neither is available on Windows, so each
+layer has a direct replacement:
+
+```
+                Linux                                   Windows
+    ┌────────────────────────────┐        ┌────────────────────────────────┐
+    │ openrazer.client (D-Bus)   │        │ openrazer_win.client (JSON-RPC)│
+    ├────────────────────────────┤        ├────────────────────────────────┤
+    │ openrazer-daemon           │        │ openrazer_win.daemon           │
+    │   D-Bus session bus        │        │   loopback TCP + bearer token  │
+    ├────────────────────────────┤        ├────────────────────────────────┤
+    │ razer*.ko  (kernel module) │        │ openrazer_win.devices          │
+    │   sysfs attributes         │        │   recipes transpiled from the  │
+    │   usb_control_msg()        │        │   same C sources               │
+    ├────────────────────────────┤        ├────────────────────────────────┤
+    │ usbhid / usbcore           │        │ hid.dll + setupapi.dll (ctypes)│
+    └────────────────────────────┘        └────────────────────────────────┘
+```
+
+**The protocol.** Every Razer peripheral speaks the same vendor protocol: a fixed 90-byte structure
+delivered as HID feature report `0x00`, with an XOR checksum over bytes 2–87.
+`openrazer_win/protocol/` is a line-by-line port of `razercommon.c` and `razerchromacommon.c`.
+
+**Reaching the device.** The kernel driver sends `usb_control_msg` to a specific USB interface.
+Windows exposes each interface as its own HID collection, so the port opens the one whose path
+carries the matching `&mi_XX` *and* whose report descriptor declares a 90-byte feature report. When
+Windows denies read/write access to a keyboard or mouse collection, the port falls back to a
+zero-access handle — feature-report IOCTLs are `FILE_ANY_ACCESS`, so they still work.
+
+**The device quirks — the interesting part.** OpenRazer's drivers encode ~20 000 lines of
+per-device behaviour as `switch (device->usb_pid)` statements: which report builder to call, which
+LED id, which transaction id. Hand-porting that would be a guaranteed source of drift.
+
+Instead, [`tools/transpile_recipes.py`](tools/transpile_recipes.py) parses the C, folds each switch
+against every known product id, and emits a small program per (attribute, device):
+
+```json
+[{"op": "build", "fn": "razer_chroma_extended_matrix_effect_static",
+  "args": [{"k": "const", "value": 1}, {"k": "var", "name": "led_id"},
+           {"k": "rgb", "offset": 0}]},
+ {"op": "txid", "value": {"k": "const", "value": 63}},
+ {"op": "send"}]
+```
+
+565 distinct recipes cover all 267 devices. `openrazer_win/devices/recipes.py` interprets them at
+runtime. Tracking a new upstream release means re-running the transpiler, not rewriting Python.
+
+**The device database** comes from the same place: `tools/extract_device_db.py` imports upstream's
+`openrazer_daemon.hardware` package with the Linux-only dependencies stubbed out, and dumps every
+device class to JSON — names, matrix dimensions, DPI limits, and the exact method list each device
+advertises. Capability reporting intersects that list with the recipe table, so a mouse never claims
+to have a backlight it does not have.
+
+## What is supported
+
+| Category | Devices |
+|---|---:|
+| Mice | 113 |
+| Keyboards & laptops | 112 |
+| Accessories (docks, stands, ARGB controllers) | 17 |
+| Headsets | 8 |
+| Mousepads | 8 |
+| Keypads | 7 |
+| eGPU enclosures | 2 |
+| **Total** | **267** |
+
+165 have addressable matrices; 76 report battery level. The full searchable list is
+[on the documentation site](https://ar4ikov.github.io/openrazer-win/#devices), or run
+`openrazer-win supported`.
+
+**Features:** all hardware effects (static, spectrum, wave, wheel, reactive, blinking, breathing ×3,
+starlight ×3), per-key custom frames, per-zone brightness, DPI and DPI stages, polling rate up to
+8000 Hz, battery level and charging state, idle timeout, low-battery threshold, game mode, macro LED,
+scroll mode and acceleration, keyboard layout, addressable-RGB channels, a host-rendered ripple
+effect driven by a low-level keyboard hook, and autostart at logon.
+
+**Not ported:** macro recording and playback (upstream reads Linux input events for this), and the
+Kraken headset family's separate protocol.
+
+## Troubleshooting
+
+Start with:
+
+```bash
+openrazer-win doctor
+```
+
+It lists every Razer HID collection Windows can see, marks the control interface, and says whether
+each product id is in the database.
+
+| Symptom | Cause |
+|---|---|
+| `no Razer control interface` | Synapse is running, or another program holds the device. Close it. |
+| Device listed as `NOT IN DATABASE` | Newer than the bundled data. [Open an issue](https://github.com/Ar4ikov/openrazer-win/issues) with the product id. |
+| `device replied not supported` | The firmware refused that command; the device genuinely lacks the feature. |
+| Effects reset after sleep | Windows cuts USB power. The daemon replays the stored state when the device reappears. |
+| Nothing at all listed | Only Razer devices (vendor `1532`) are handled. |
+
+## Development
+
+```bash
+git clone https://github.com/Ar4ikov/openrazer-win
+cd openrazer-win
+pip install -e ".[dev]"
+
+pytest                              # 160 tests, no hardware needed
+ruff check .
+python tools/simulate_devices.py    # every capability of all 267 devices
+```
+
+The test suite runs against a built-in device emulator that validates CRCs and answers the protocol,
+so the whole stack — transport, recipes, daemon, client, CLI — is exercised without plugging anything
+in. `--emulate` does the same for the daemon:
+
+```bash
+openrazer-win-daemon --emulate
+```
+
+### Re-syncing with upstream
+
+```bash
+git clone --depth 1 https://github.com/openrazer/openrazer /tmp/openrazer
+python tools/extract_device_db.py  /tmp/openrazer openrazer_win/devices/data/devices.json
+python tools/transpile_recipes.py  /tmp/openrazer openrazer_win/devices/data/recipes.json
+pytest && python tools/simulate_devices.py
+```
+
+New devices and changed quirks are picked up automatically.
+
+## Credits
+
+All protocol knowledge here is [OpenRazer](https://github.com/openrazer/openrazer)'s work —
+years of reverse engineering by Terri Cain, Tim Theede and a long list of contributors. This project
+adds a Windows transport and a translation layer; it does not add a single byte of new protocol
+research.
+
+Licensed **GPL-2.0-or-later**, the same as upstream, because the device database and the transpiled
+recipes are derived from OpenRazer's GPL sources.
+
+Not affiliated with or endorsed by Razer Inc. Razer, Chroma and Synapse are trademarks of Razer Inc.