{"id":15500002,"url":"https://github.com/julusian/node-xencelabs-quick-keys","last_synced_at":"2025-04-12T05:12:46.283Z","repository":{"id":45201046,"uuid":"424765085","full_name":"Julusian/node-xencelabs-quick-keys","owner":"Julusian","description":"A Node.js library for interfacing with the Xencelabs Quick Keys https://julusian.github.io/node-xencelabs-quick-keys/","archived":false,"fork":false,"pushed_at":"2024-04-25T07:37:20.000Z","size":3371,"stargazers_count":33,"open_issues_count":3,"forks_count":4,"subscribers_count":5,"default_branch":"main","last_synced_at":"2024-10-30T02:36:30.462Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/org/xencelabs-quick-keys","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Julusian.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","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},"funding":{"github":["julusian"]}},"created_at":"2021-11-04T23:06:35.000Z","updated_at":"2024-09-21T16:56:12.000Z","dependencies_parsed_at":"2024-01-15T01:07:24.011Z","dependency_job_id":"ca8aca56-c16d-440c-87d1-e036535029d0","html_url":"https://github.com/Julusian/node-xencelabs-quick-keys","commit_stats":{"total_commits":57,"total_committers":3,"mean_commits":19.0,"dds":0.07017543859649122,"last_synced_commit":"d7fabf26d24bdd1ed1f2e7157f15f5749343b6e3"},"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Julusian%2Fnode-xencelabs-quick-keys","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Julusian%2Fnode-xencelabs-quick-keys/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Julusian%2Fnode-xencelabs-quick-keys/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Julusian%2Fnode-xencelabs-quick-keys/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Julusian","download_url":"https://codeload.github.com/Julusian/node-xencelabs-quick-keys/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247962414,"owners_count":21024860,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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":[],"created_at":"2024-10-02T08:57:23.573Z","updated_at":"2025-04-12T05:12:46.260Z","avatar_url":"https://github.com/Julusian.png","language":"TypeScript","funding_links":["https://github.com/sponsors/julusian"],"categories":[],"sub_categories":[],"readme":"# @xencelabs-quick-keys\n\n![Node CI](https://github.com/Julusian/node-xencelabs-quick-keys/workflows/Node%20CI/badge.svg)\n[![codecov](https://codecov.io/gh/Julusian/node-xencelabs-quick-keys/branch/master/graph/badge.svg?token=Hl4QXGZJMF)](https://codecov.io/gh/Julusian/node-xencelabs-quick-keys)\n\n[@xencelabs-quick-keys](https://www.npmjs.com/org/xencelabs-quick-keys) is a collection of libraries for interfacing with the [Xencelabs Quick Keys](https://www.xencelabs.com/product/xencelabs-quick-keys-remote/).  \nWith WebHID being made publicly available it is now possible to use the device directly in the browser.\n\n## Intended use\n\nThis library has nothing to do with the software produced by manufacturer. There is nothing here to install and run. This is a library to help developers make alternatives to that software\n\n## Installing \u0026 Usage\n\nCheck one of the installable packages for installation and usage instructions:\n\n-   [`@xencelabs-quick-keys/node`](https://npm.im/@xencelabs-quick-keys/node)\n-   [`@xencelabs-quick-keys/webhid`](https://npm.im/@xencelabs-quick-keys/webhid)\n\n### Have another hid target you wish to use?\n\nThe existing implementations are a light wrapper around the platform agnostic [`@xencelabs-quick-keys/core`](https://npm.im/@xencelabs-quick-keys/core). You can use your own HID implementation and device scanning/opening logic and reuse all the device logic.\n\n## Demo\n\nIf you are using a Chromium v89+ based browser, you can try out the [webhid demo](https://julusian.github.io/node-xencelabs-quick-keys/)\n\n## Linux\n\nOn linux, the udev subsystem blocks access to the usb device without some special configuration.\nSave the following to `/etc/udev/rules.d/50-xencelabs.rules` and reload the rules with `sudo udevadm control --reload-rules`\n\n```\nSUBSYSTEM==\"input\", GROUP=\"input\", MODE=\"0666\"\nSUBSYSTEM==\"usb\", ATTRS{idVendor}==\"28bd\", ATTRS{idProduct}==\"5202\", MODE:=\"666\", GROUP=\"plugdev\"\nSUBSYSTEM==\"usb\", ATTRS{idVendor}==\"28bd\", ATTRS{idProduct}==\"5203\", MODE:=\"666\", GROUP=\"plugdev\"\nKERNEL==\"hidraw*\", ATTRS{busnum}==\"1\", ATTRS{idVendor}==\"28bd\", ATTRS{idProduct}==\"5202\", MODE=\"0666\"\nKERNEL==\"hidraw*\", ATTRS{busnum}==\"1\", ATTRS{idVendor}==\"28bd\", ATTRS{idProduct}==\"5203\", MODE=\"0666\"\n```\n\n## Contributing\n\nThe xencelabs-quick-keys team enthusiastically welcomes contributions and project participation! There's a bunch of things you can do if you want to contribute! Please don't hesitate to jump in if you'd like to, or even ask us questions if something isn't clear.\n\nPlease refer to the [Changelog](CHANGELOG.md) for project history details, too.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjulusian%2Fnode-xencelabs-quick-keys","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjulusian%2Fnode-xencelabs-quick-keys","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjulusian%2Fnode-xencelabs-quick-keys/lists"}