{"id":47262831,"url":"https://github.com/vrgb-dev/vrgb","last_synced_at":"2026-04-08T22:01:43.479Z","repository":{"id":344478884,"uuid":"1181831724","full_name":"vrgb-dev/vrgb","owner":"vrgb-dev","description":"RGB control for ASUS HID LampArray Vivobook keyboards on Linux","archived":false,"fork":false,"pushed_at":"2026-03-23T21:41:18.000Z","size":448,"stargazers_count":0,"open_issues_count":1,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2026-03-24T16:34:51.654Z","etag":null,"topics":["asus","cli","fedora","hardware","hid","hidraw","kde","keyboard","lamp-array","laptop","linux","linux-tools","rgb"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/vrgb-dev.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,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2026-03-14T17:25:32.000Z","updated_at":"2026-03-23T21:41:21.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/vrgb-dev/vrgb","commit_stats":null,"previous_names":["vrgb-dev/vrgb"],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/vrgb-dev/vrgb","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vrgb-dev%2Fvrgb","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vrgb-dev%2Fvrgb/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vrgb-dev%2Fvrgb/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vrgb-dev%2Fvrgb/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/vrgb-dev","download_url":"https://codeload.github.com/vrgb-dev/vrgb/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vrgb-dev%2Fvrgb/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31575755,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-08T14:31:17.711Z","status":"ssl_error","status_checked_at":"2026-04-08T14:31:17.202Z","response_time":54,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5: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":["asus","cli","fedora","hardware","hid","hidraw","kde","keyboard","lamp-array","laptop","linux","linux-tools","rgb"],"created_at":"2026-03-15T00:25:24.816Z","updated_at":"2026-04-08T22:01:43.473Z","avatar_url":"https://github.com/vrgb-dev.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n  \u003cimg src=\"assets/vrgblogodark.png\" width=\"500\"\u003e\u003cbr\u003e\n  \u003cbr\u003e\n  RGB control for ASUS Vivobook HID LampArray keyboards on Linux\u003cbr\u003e\n\u003c/p\u003e\n\n\n\n## Overview\n\nVRGB is a lightweight Linux CLI utility for controlling RGB keyboards on\nVivobook ASUS laptops that expose the HID LampArray interface.\n\n\n**Why this exists:**\n\nI bought a Vivobook S14 and put Fedora on it for school and work. Fn brightness worked, but the keyboard was stuck on white and none of the usual ASUS RGB tools did anything. After digging into it, I found the keyboard wasn’t using the typical ASUS control path at all.\n\nVRGB is just a tool built around that discovery to get simple RGB control working on Linux without touching the kernel or running a daemon.\n\n\u003cbr\u003e\n\n**The project was developed and validated on:**\n\nITE5570 (HID_ID: 0018:00000B05:000019B6)  \n- ASUS Vivobook S14 (S5406SA-WH79)  \n- firmware: 0x0B  \n- color: 0x05  \n\n**Community validated:**\n\nITE5570 (HID_ID: 0018:00000B05:00005570)  \n- ASUS Vivobook S16 series (M5606K / M5606WA)  \n- firmware: 0x46  \n- color: 0x45  \n- note: OEM rainbow may not function on all models  \n\n\u003cbr\u003e\n\nUnlike some RGB tools, VRGB does not rely on kernel patches, vendor utilities, background daemons, controller hacks, or reverse-engineered Windows drivers. VRGB simply communicates with the keyboard controller through the Linux HID subsystem. \n\n\u003cbr\u003e\n\n\n**Control path:**\n\n    vrgb.py\n       ↓\n    /dev/hidrawX\n       ↓\n    ITE5570 keyboard controller\n       ↓\n    RGB lighting\n\nCurrent Stable Release: v.0.3.1\n    \n\n## Example Usage\n\n\u003cp align=\"center\"\u003e\n  \u003cimg src=\"assets/vrgb-demo.png\" width=\"400\"\u003e\n\u003c/p\u003e\n\n\n## Features\n\n-   Static RGB color control\n-   Fine brightness scaling (0–100%)\n-   Custom profiles\n-   Firmware autonomous mode toggle\n-   OEM rainbow toggle (sudo required)\n-   Debug diagnostics\n-   Persistent configuration\n-   Installer and uninstaller included\n-   Non-root daily usage via udev permissions\n-   Optional KDE autostart restore\n\n\n\n## Supported Hardware\n\nVRGB supports ASUS laptops that expose the **ITE5570 HID LampArray controller**.\n\nSupport is based on **verified device mappings**, not specific laptop models.\n\n### Verified mappings\n\n**ITE5570 (HID_ID: 0018:00000B05:000019B6)**  \n- confirmed on: ASUS Vivobook S14 (S5406SA)  \n- firmware report: `0x0B`  \n- color report: `0x05`\n\n**ITE5570 (HID_ID: 0018:00000B05:00005570)**  \n- confirmed on: ASUS Vivobook S16 series (M5606K / M5606WA)  \n- firmware report: `0x46`  \n- color report: `0x45`  \n- note: OEM rainbow mode may not function on all models\n\n### Example device identifiers\n\n    HID_NAME=ITE5570:00 0B05:19B6\n    HID_ID=0018:00000B05:000019B6\n\n\n## Compatibility\n\nVRGB scans available `hidraw` devices and selects compatible ASUS keyboard controllers automatically.\n\nMultiple ASUS laptops appear to share the same ITE5570 controller and HID LampArray protocol. If your system exposes a similar device, there is a strong chance VRGB will work.\n\nSupport expands through **verified device mappings** as new hardware is tested. Stability and correctness are prioritized over broad but unreliable compatibility.\n\nIf VRGB works (or does not work) on your system, please submit a compatibility report including:\n\n    vrgb --debug status\n\nCommunity reports help identify new supported devices quickly.\n\nSee reports here:  \nhttps://github.com/vrgb-dev/vrgb/issues/1\n\n\n## Quick Install\n\nClone the repository and run the installer.\n\n    git clone https://github.com/vrgb-dev/vrgb.git\n    cd vrgb\n    chmod +x install.sh\n    ./install.sh\n\nAfter installation log out and log back in so group permissions apply.\n\n\n**Note:**\nKeyboard color persists on reboot, but may reset to firmware default after a full power cycle.\nUse the KDE autostart option in the installer (or set it manually) to reapply your configuration automatically.\n\n\n\n## Command List\n\nShow Current Status\n\n    vrgb status\n\nSet RGB Color\n\n    vrgb set RRGGBB [brightness %]\n\n*Example:*\n\n    vrgb set 00aa55 65\n\nChange Brightness\n\n    vrgb brightness 80\n    \nSave Profile (Current State)\n\n    vrgb profile save fedorablue\n    \nLoad Profile\n\n    vrgb profile load fedorablue\n    \nDelete Profile\n\n    vrgb profile delete fedorablue\n    \nList Saved Profiles\n\n    vrgb profile list\n\nTurn Lighting Off\n\n    vrgb off\n\nRestore Saved State\n\n    vrgb restore\n\nEnable firmware lighting (Firmware Autonomous Mode)\n\n    vrgb auto on\n\nReturn control to VRGB:\n\n    vrgb auto off\n\nOEM Rainbow Mode (requires sudo)\n\n    sudo vrgb rainbow on\n    sudo vrgb rainbow off\n\nDebug Mode\n\n    vrgb --debug status\n\nAbout\n\n    vrgb about\n\n\n## Manual Installation\n\nInstall Binary\n\n    sudo install -m 755 vrgb.py /usr/local/bin/vrgb\n\nCreate Access Group\n\n    sudo groupadd -f vrgb\n    sudo usermod -aG vrgb $USER\n\nInstall udev Rule\n\nCreate:\n\n    /etc/udev/rules.d/99-vrgb.rules\n\nContents:\n\n    SUBSYSTEM==\"hidraw\", KERNELS==\"i2c-ITE5570*\", MODE=\"0660\", GROUP=\"vrgb\"\n\nReload udev\n\n    sudo udevadm control --reload-rules\n    sudo udevadm trigger\n\nLog out and log back in afterward.\n\n\n\n## Optional KDE Autostart Restore\n\nCreate:\n\n    ~/.config/autostart/vrgb.desktop\n\nContents:\n\n    [Desktop Entry]\n    Type=Application\n    Exec=/usr/local/bin/vrgb restore\n    Hidden=false\n    NoDisplay=false\n    X-GNOME-Autostart-enabled=true\n    Name=VRGB Restore\n    Comment=Restore keyboard RGB state\n\n\n\n## Uninstall\n\n    ./uninstall.sh\n\nRemoves:\n\n-   /usr/local/bin/vrgb\n-   the udev rule\n-   optional autostart entry\n\n\n\n## Future Development\n\n- expanded ASUS hardware compatibility\n- GUI frontend\n- breathing / fade effects\n- effect profiles\n\nWith future updates in mind, this project will aim to continue to be as efficient and lightweight as possible.\n\n\n\n## Changelog\n\nv0.3.1\n\n- introduced multi-device support architecture\n- replaced hardcoded HID targeting with device mappings\n- added support for ITE5570 (0x5570) devices\n- confirmed working on additional Vivobook S16 hardware (community tested)\n- refactored device detection to return structured device info\n- eliminated global report ID assumptions\n- no behavioral changes for existing supported devices\n\nv0.3\n\n-    added named profile support\n-    profile save/load/list/delete commands\n-    profile data stored in config.json\n-    profile load applies immediately to hardware\n-    non-HID commands no longer require device detection\n\nv0.2.2\n\n-   improved CLI help output\n-   installer/Uninstaller validation\n-   confirmed non-root HID access\n-   release packaging\n\nv0.2.0\n\n-   automatic hidraw detection\n-   debug mode\n-   persistent config\n-   installer script\n\nv0.1\n\nInitial prototype with static RGB and brightness control.\n\n\n\n## License\n\nMIT License\n\n## Repository\n\nhttps://github.com/vrgb-dev/vrgb\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvrgb-dev%2Fvrgb","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fvrgb-dev%2Fvrgb","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvrgb-dev%2Fvrgb/lists"}