2024-05-30 02:02:10 +00:00
<!DOCTYPE html>
< html lang = "en-US" dir = "ltr" >
< head >
< meta charset = "utf-8" >
< meta name = "viewport" content = "width=device-width,initial-scale=1" >
< title > Raw HID | QMK Firmware< / title >
< meta name = "description" content = "Documentation for QMK Firmware" >
< meta name = "generator" content = "VitePress v1.1.3" >
2024-05-31 00:38:24 +00:00
< link rel = "preload stylesheet" href = "/assets/style.No8zk9aC.css" as = "style" >
2024-05-30 02:02:10 +00:00
2024-09-18 09:08:45 +00:00
< script type = "module" src = "/assets/app.27PKLiAG.js" > < / script >
2024-05-30 02:02:10 +00:00
< link rel = "preload" href = "/assets/inter-roman-latin.Di8DUHzh.woff2" as = "font" type = "font/woff2" crossorigin = "" >
2024-09-18 09:08:45 +00:00
< link rel = "modulepreload" href = "/assets/chunks/theme.C3XzTLSh.js" >
2024-09-18 08:58:07 +00:00
< link rel = "modulepreload" href = "/assets/chunks/framework.Clpp4x2N.js" >
< link rel = "modulepreload" href = "/assets/features_rawhid.md.a2O7n8yI.lean.js" >
2024-05-30 02:02:10 +00:00
< script id = "check-dark-mode" > ( ( ) => { const e = localStorage . getItem ( "vitepress-theme-appearance" ) || "auto" , a = window . matchMedia ( "(prefers-color-scheme: dark)" ) . matches ; ( ! e || e === "auto" ? a : e === "dark" ) && document . documentElement . classList . add ( "dark" ) } ) ( ) ; < / script >
< script id = "check-mac-os" > document . documentElement . classList . toggle ( "mac" , /Mac|iPhone|iPod|iPad/i . test ( navigator . platform ) ) ; < / script >
< / head >
< body >
2024-09-06 16:32:11 +00:00
< div id = "app" > < div class = "Layout" data-v-5d98c3a5 > <!-- [ --> <!-- ] --> <!-- [ --> < span tabindex = "-1" data-v-0f60ec36 > < / span > < a href = "#VPContent" class = "VPSkipLink visually-hidden" data-v-0f60ec36 > Skip to content < / a > <!-- ] --> <!-- --> < header class = "VPNav" data-v-5d98c3a5 data-v-ae24b3ad > < div class = "VPNavBar has-sidebar top" data-v-ae24b3ad data-v-ccf7ddec > < div class = "wrapper" data-v-ccf7ddec > < div class = "container" data-v-ccf7ddec > < div class = "title" data-v-ccf7ddec > < div class = "VPNavBarTitle has-sidebar" data-v-ccf7ddec data-v-ab179fa1 > < a class = "title" href = "/" data-v-ab179fa1 > <!-- [ --> <!-- ] --> <!-- [ --> <!-- [ --> <!-- [ --> < img class = "VPImage dark logo" src = "/qmk-logo-dark.svg" alt data-v-8426fc1a > <!-- ] --> <!-- [ --> < img class = "VPImage light logo" src = "/qmk-logo-light.svg" alt data-v-8426fc1a > <!-- ] --> <!-- ] --> <!-- ] --> < span data-v-ab179fa1 > QMK Firmware< / span > <!-- [ --> <!-- ] --> < / a > < / div > < / div > < div class = "content" data-v-ccf7ddec > < div class = "content-body" data-v-ccf7ddec > <!-- [ --> <!-- ] --> < div class = "VPNavBarSearch search" data-v-ccf7ddec > <!-- [ --> <!-- --> < div id = "local-search" > < button type = "button" class = "DocSearch DocSearch-Button" aria-label = "Search" > < span class = "DocSearch-Button-Container" > < span class = "vp-icon DocSearch-Search-Icon" > < / span > < span class = "DocSearch-Button-Placeholder" > Search< / span > < / span > < span class = "DocSearch-Button-Keys" > < kbd class = "DocSearch-Button-Key" > < / kbd > < kbd class = "DocSearch-Button-Key" > K< / kbd > < / span > < / button > < / div > <!-- ] --> < / div > < nav aria-labelledby = "main-nav-aria-label" class = "VPNavBarMenu menu" data-v-ccf7ddec data-v-7f418b0f > < span id = "main-nav-aria-label" class = "visually-hidden" data-v-7f418b0f > Main Navigation< / span > <!-- [ --> <!-- [ --> < a class = "VPLink link VPNavBarMenuLink" href = "/" tabindex = "0" data-v-7f418b0f data-v-9c663999 > <!-- [ --> < span data-v-9c663999 > Home< / span > <!-- ] --> < / a > <!-- ] --> <!-- ] --> < / nav > <!-- --> < div class = "VPNavBarAppearance appearance" data-v-ccf7ddec data-v-e6aabb21 > < button class = "VPSwitch VPSwitchAppearance" type = "button" role = "switch" title = "Switch to dark theme" aria-checked = "false" data-v-e6aabb21 data-v-d1f28634 data-v-1d5665e3 > < span class = "check" data-v-1d5665e3 > < span class = "icon" data-v-1d5665e3 > <!-- [ --> < span class = "vpi-sun sun" data-v-d1f28634 > < / span > < span class = "vpi-moon moon" data-v-d1f28634 > < / span > <!-- ] --> < / span > < / span > < / button > < / div > < div class = "VPSocialLinks VPNavBarSocialLinks social-links" data-v-ccf7ddec data-v-0394ad82 data-v-7bc22406 > <!-- [ --> < a class = "VPSocialLink no-icon" href = "https://reddit.com/r/olkb" aria-label target = "_blank" rel = "noopener" data-v-7bc22406 data-v-eee4e7cb > < svg xmlns = "http://www.w3.org/2000/svg" viewBox = "0 0 50 50" width = "50px" height = "50px" > < path d = "M 29 3 C 28 . 0625 3 27 . 164063 3 . 382813 26 . 5 4 C 25 . 835938 4 . 617188 25 . 363281 5 . 433594 25 6 . 40625 C 24 . 355469 8 . 140625 24 . 085938 10 . 394531 24 . 03125 13 . 03125 C 19 . 234375 13 . 179688 14 . 820313 14 . 421875 11 . 28125 16 . 46875 C 10 . 214844 15 . 46875 8 . 855469 14 . 96875 7 . 5 14 . 96875 C 6 . 089844 14 . 96875 4 . 675781 15 . 511719 3 . 59375 16 . 59375 C 1 . 425781 18 . 761719 1 . 425781 22 . 238281 3 . 59375 24 . 40625 L 3 . 84375 24 . 65625 C 3 . 3125 26 . 035156 3 27 . 488281 3 29 C 3 33 . 527344 5 . 566406 37 . 585938 9 . 5625 40 . 4375 C 13 . 558594 43 . 289063 19 . 007813 45 25 45 C 30 . 992188 45 36 . 441406 43 . 289063 40 . 4375 40 . 4375 C 44 . 433594 37 . 585938 47 33 . 527344 47 29 C 47 27 . 488281 46 . 6875 26 . 035156 46 . 15625 24 . 65625 L 46 . 40625 24 . 40625 C 48 . 574219 22 . 238281 48 . 574219 18 . 761719 46 . 40625 16 . 59375 C 45 . 324219 15 . 511719 43 . 910156 14 . 96875 42 . 5 14 . 96875 C 41 . 144531 14 . 96875 39 . 785156 15 . 46875 38 . 71875 16 . 46875 C 35 . 195313 14 . 433594 30 . 800781 13 . 191406 26 . 03125 13 . 03125 C 26 . 09375 10 . 546875 26 . 363281 8 . 46875 26 . 875 7 . 09375 C 27 . 164063 6 . 316406 27 . 527344 5 . 757813 27 . 875 5 . 4375 C 28 . 222656 5 . 117188 28 . 539063 5 29 5 C 29 . 460938 5 29 . 683594 5 . 125 30 . 03125 5 . 40625 C 30 . 378906 5 . 6875 30 . 785156 6 . 148438 31 . 3125 6 . 6875 C 32 . 253906 7 . 652344 33 . 695313 8 . 714844 36 . 09375 8 . 9375 C 36 . 539063 11 . 238281 38 . 574219 13 41 13 C 43 . 75 13 46 10 . 75 46 8 C 46 5 . 25 43 . 75 3 41 3 C 38 . 605469 3 36 . 574219 4 . 710938 36 . 09375 6 . 96875 C 34 . 3125 6 . 796875 33 . 527344 6 . 109375 32 . 75 5 . 3125 C 32 . 300781 4 . 851563 31 . 886719 4
2024-05-30 02:02:10 +00:00
< span class = "line" > < span style = "--shiki-light:#6A737D;--shiki-dark:#6A737D;" > // Your code goes here< / span > < / span >
< span class = "line" > < span style = "--shiki-light:#6A737D;--shiki-dark:#6A737D;" > // `data` is a pointer to the buffer containing the received HID report< / span > < / span >
< span class = "line" > < span style = "--shiki-light:#6A737D;--shiki-dark:#6A737D;" > // `length` is the length of the report - always `RAW_EPSIZE`< / span > < / span >
< span class = "line" > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > }< / span > < / span > < / code > < / pre > < / div > < div class = "warning custom-block" > < p class = "custom-block-title" > WARNING< / p > < p > Because the HID specification does not support variable length reports, all reports in both directions must be exactly < code > RAW_EPSIZE< / code > (currently 32) bytes long, regardless of actual payload length. However, variable length payloads can potentially be implemented on top of this by creating your own data structure that may span multiple reports.< / p > < / div > < h2 id = "receiving-data-from-the-keyboard" tabindex = "-1" > Receiving Data from the Keyboard < a class = "header-anchor" href = "#receiving-data-from-the-keyboard" aria-label = "Permalink to "Receiving Data from the Keyboard {#receiving-data-from-the-keyboard}"" > < / a > < / h2 > < p > If you need the keyboard to send data back to the host, simply call the < code > raw_hid_send()< / code > function. It requires two arguments - a pointer to a 32-byte buffer containing the data you wish to send, and the length (which should always be < code > RAW_EPSIZE< / code > ).< / p > < p > The received report can then be handled in whichever way your HID library provides.< / p > < h2 id = "simple-example" tabindex = "-1" > Simple Example < a class = "header-anchor" href = "#simple-example" aria-label = "Permalink to "Simple Example {#simple-example}"" > < / a > < / h2 > < p > The following example reads the first byte of the received report from the host, and if it is an ASCII " A" , responds with " B" . < code > memset()< / code > is used to fill the response buffer (which could still contain the previous response) with null bytes.< / p > < div class = "language-c vp-adaptive-theme" > < button title = "Copy Code" class = "copy" > < / button > < span class = "lang" > c< / span > < pre class = "shiki shiki-themes github-light github-dark vp-code" > < code > < span class = "line" > < span style = "--shiki-light:#D73A49;--shiki-dark:#F97583;" > void< / span > < span style = "--shiki-light:#6F42C1;--shiki-dark:#B392F0;" > raw_hid_receive< / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > (< / span > < span style = "--shiki-light:#D73A49;--shiki-dark:#F97583;" > uint8_t< / span > < span style = "--shiki-light:#D73A49;--shiki-dark:#F97583;" > *< / span > < span style = "--shiki-light:#E36209;--shiki-dark:#FFAB70;" > data< / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > , < / span > < span style = "--shiki-light:#D73A49;--shiki-dark:#F97583;" > uint8_t< / span > < span style = "--shiki-light:#E36209;--shiki-dark:#FFAB70;" > length< / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > ) {< / span > < / span >
< span class = "line" > < span style = "--shiki-light:#D73A49;--shiki-dark:#F97583;" > uint8_t< / span > < span style = "--shiki-light:#E36209;--shiki-dark:#FFAB70;" > response< / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > [length];< / span > < / span >
< span class = "line" > < span style = "--shiki-light:#6F42C1;--shiki-dark:#B392F0;" > memset< / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > (response, < / span > < span style = "--shiki-light:#005CC5;--shiki-dark:#79B8FF;" > 0< / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > , length);< / span > < / span >
< span class = "line" > < span style = "--shiki-light:#E36209;--shiki-dark:#FFAB70;" > response< / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > [< / span > < span style = "--shiki-light:#005CC5;--shiki-dark:#79B8FF;" > 0< / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > ] < / span > < span style = "--shiki-light:#D73A49;--shiki-dark:#F97583;" > =< / span > < span style = "--shiki-light:#032F62;--shiki-dark:#9ECBFF;" > ' B' < / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > ;< / span > < / span >
< span class = "line" > < / span >
< span class = "line" > < span style = "--shiki-light:#D73A49;--shiki-dark:#F97583;" > if< / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > (< / span > < span style = "--shiki-light:#E36209;--shiki-dark:#FFAB70;" > data< / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > [< / span > < span style = "--shiki-light:#005CC5;--shiki-dark:#79B8FF;" > 0< / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > ] < / span > < span style = "--shiki-light:#D73A49;--shiki-dark:#F97583;" > ==< / span > < span style = "--shiki-light:#032F62;--shiki-dark:#9ECBFF;" > ' A' < / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > ) {< / span > < / span >
< span class = "line" > < span style = "--shiki-light:#6F42C1;--shiki-dark:#B392F0;" > raw_hid_send< / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > (response, length);< / span > < / span >
< span class = "line" > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > }< / span > < / span >
< span class = "line" > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > }< / span > < / span > < / code > < / pre > < / div > < p > On the host side (here we are using Python and the < code > pyhidapi< / code > library), the HID device is opened by enumerating the interfaces on the USB device, then filtering on the usage page and usage ID. Then, a report containing a single ASCII " A" (hex < code > 0x41< / code > ) is constructed and sent.< / p > < p > For demonstration purposes, the manufacturer and product strings of the device, along with the request and response, are also printed.< / p > < div class = "language-python vp-adaptive-theme" > < button title = "Copy Code" class = "copy" > < / button > < span class = "lang" > python< / span > < pre class = "shiki shiki-themes github-light github-dark vp-code" > < code > < span class = "line" > < span style = "--shiki-light:#D73A49;--shiki-dark:#F97583;" > import< / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > sys< / span > < / span >
< span class = "line" > < span style = "--shiki-light:#D73A49;--shiki-dark:#F97583;" > import< / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > hid< / span > < / span >
< span class = "line" > < / span >
< span class = "line" > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > vendor_id < / span > < span style = "--shiki-light:#D73A49;--shiki-dark:#F97583;" > =< / span > < span style = "--shiki-light:#D73A49;--shiki-dark:#F97583;" > 0x< / span > < span style = "--shiki-light:#005CC5;--shiki-dark:#79B8FF;" > 4335< / span > < / span >
< span class = "line" > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > product_id < / span > < span style = "--shiki-light:#D73A49;--shiki-dark:#F97583;" > =< / span > < span style = "--shiki-light:#D73A49;--shiki-dark:#F97583;" > 0x< / span > < span style = "--shiki-light:#005CC5;--shiki-dark:#79B8FF;" > 0002< / span > < / span >
< span class = "line" > < / span >
< span class = "line" > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > usage_page < / span > < span style = "--shiki-light:#D73A49;--shiki-dark:#F97583;" > =< / span > < span style = "--shiki-light:#D73A49;--shiki-dark:#F97583;" > 0x< / span > < span style = "--shiki-light:#005CC5;--shiki-dark:#79B8FF;" > FF60< / span > < / span >
< span class = "line" > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > usage < / span > < span style = "--shiki-light:#D73A49;--shiki-dark:#F97583;" > =< / span > < span style = "--shiki-light:#D73A49;--shiki-dark:#F97583;" > 0x< / span > < span style = "--shiki-light:#005CC5;--shiki-dark:#79B8FF;" > 61< / span > < / span >
< span class = "line" > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > report_length < / span > < span style = "--shiki-light:#D73A49;--shiki-dark:#F97583;" > =< / span > < span style = "--shiki-light:#005CC5;--shiki-dark:#79B8FF;" > 32< / span > < / span >
< span class = "line" > < / span >
< span class = "line" > < span style = "--shiki-light:#D73A49;--shiki-dark:#F97583;" > def< / span > < span style = "--shiki-light:#6F42C1;--shiki-dark:#B392F0;" > get_raw_hid_interface< / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > ():< / span > < / span >
< span class = "line" > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > device_interfaces < / span > < span style = "--shiki-light:#D73A49;--shiki-dark:#F97583;" > =< / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > hid.enumerate(vendor_id, product_id)< / span > < / span >
< span class = "line" > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > raw_hid_interfaces < / span > < span style = "--shiki-light:#D73A49;--shiki-dark:#F97583;" > =< / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > [i < / span > < span style = "--shiki-light:#D73A49;--shiki-dark:#F97583;" > for< / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > i < / span > < span style = "--shiki-light:#D73A49;--shiki-dark:#F97583;" > in< / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > device_interfaces < / span > < span style = "--shiki-light:#D73A49;--shiki-dark:#F97583;" > if< / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > i[< / span > < span style = "--shiki-light:#032F62;--shiki-dark:#9ECBFF;" > ' usage_page' < / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > ] < / span > < span style = "--shiki-light:#D73A49;--shiki-dark:#F97583;" > ==< / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > usage_page < / span > < span style = "--shiki-light:#D73A49;--shiki-dark:#F97583;" > and< / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > i[< / span > < span style = "--shiki-light:#032F62;--shiki-dark:#9ECBFF;" > ' usage' < / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > ] < / span > < span style = "--shiki-light:#D73A49;--shiki-dark:#F97583;" > ==< / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > usage]< / span > < / span >
< span class = "line" > < / span >
< span class = "line" > < span style = "--shiki-light:#D73A49;--shiki-dark:#F97583;" > if< / span > < span style = "--shiki-light:#005CC5;--shiki-dark:#79B8FF;" > len< / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > (raw_hid_interfaces) < / span > < span style = "--shiki-light:#D73A49;--shiki-dark:#F97583;" > ==< / span > < span style = "--shiki-light:#005CC5;--shiki-dark:#79B8FF;" > 0< / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > :< / span > < / span >
< span class = "line" > < span style = "--shiki-light:#D73A49;--shiki-dark:#F97583;" > return< / span > < span style = "--shiki-light:#005CC5;--shiki-dark:#79B8FF;" > None< / span > < / span >
< span class = "line" > < / span >
< span class = "line" > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > interface < / span > < span style = "--shiki-light:#D73A49;--shiki-dark:#F97583;" > =< / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > hid.Device(< / span > < span style = "--shiki-light:#E36209;--shiki-dark:#FFAB70;" > path< / span > < span style = "--shiki-light:#D73A49;--shiki-dark:#F97583;" > =< / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > raw_hid_interfaces[< / span > < span style = "--shiki-light:#005CC5;--shiki-dark:#79B8FF;" > 0< / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > ][< / span > < span style = "--shiki-light:#032F62;--shiki-dark:#9ECBFF;" > ' path' < / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > ])< / span > < / span >
< span class = "line" > < / span >
< span class = "line" > < span style = "--shiki-light:#005CC5;--shiki-dark:#79B8FF;" > print< / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > (< / span > < span style = "--shiki-light:#D73A49;--shiki-dark:#F97583;" > f< / span > < span style = "--shiki-light:#032F62;--shiki-dark:#9ECBFF;" > " Manufacturer: < / span > < span style = "--shiki-light:#005CC5;--shiki-dark:#79B8FF;" > {< / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > interface.manufacturer< / span > < span style = "--shiki-light:#005CC5;--shiki-dark:#79B8FF;" > }< / span > < span style = "--shiki-light:#032F62;--shiki-dark:#9ECBFF;" > " < / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > )< / span > < / span >
< span class = "line" > < span style = "--shiki-light:#005CC5;--shiki-dark:#79B8FF;" > print< / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > (< / span > < span style = "--shiki-light:#D73A49;--shiki-dark:#F97583;" > f< / span > < span style = "--shiki-light:#032F62;--shiki-dark:#9ECBFF;" > " Product: < / span > < span style = "--shiki-light:#005CC5;--shiki-dark:#79B8FF;" > {< / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > interface.product< / span > < span style = "--shiki-light:#005CC5;--shiki-dark:#79B8FF;" > }< / span > < span style = "--shiki-light:#032F62;--shiki-dark:#9ECBFF;" > " < / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > )< / span > < / span >
< span class = "line" > < / span >
< span class = "line" > < span style = "--shiki-light:#D73A49;--shiki-dark:#F97583;" > return< / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > interface< / span > < / span >
< span class = "line" > < / span >
< span class = "line" > < span style = "--shiki-light:#D73A49;--shiki-dark:#F97583;" > def< / span > < span style = "--shiki-light:#6F42C1;--shiki-dark:#B392F0;" > send_raw_report< / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > (data):< / span > < / span >
< span class = "line" > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > interface < / span > < span style = "--shiki-light:#D73A49;--shiki-dark:#F97583;" > =< / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > get_raw_hid_interface()< / span > < / span >
< span class = "line" > < / span >
< span class = "line" > < span style = "--shiki-light:#D73A49;--shiki-dark:#F97583;" > if< / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > interface < / span > < span style = "--shiki-light:#D73A49;--shiki-dark:#F97583;" > is< / span > < span style = "--shiki-light:#005CC5;--shiki-dark:#79B8FF;" > None< / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > :< / span > < / span >
< span class = "line" > < span style = "--shiki-light:#005CC5;--shiki-dark:#79B8FF;" > print< / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > (< / span > < span style = "--shiki-light:#032F62;--shiki-dark:#9ECBFF;" > " No device found" < / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > )< / span > < / span >
< span class = "line" > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > sys.exit(< / span > < span style = "--shiki-light:#005CC5;--shiki-dark:#79B8FF;" > 1< / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > )< / span > < / span >
< span class = "line" > < / span >
< span class = "line" > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > request_data < / span > < span style = "--shiki-light:#D73A49;--shiki-dark:#F97583;" > =< / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > [< / span > < span style = "--shiki-light:#D73A49;--shiki-dark:#F97583;" > 0x< / span > < span style = "--shiki-light:#005CC5;--shiki-dark:#79B8FF;" > 00< / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > ] < / span > < span style = "--shiki-light:#D73A49;--shiki-dark:#F97583;" > *< / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > (report_length < / span > < span style = "--shiki-light:#D73A49;--shiki-dark:#F97583;" > +< / span > < span style = "--shiki-light:#005CC5;--shiki-dark:#79B8FF;" > 1< / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > ) < / span > < span style = "--shiki-light:#6A737D;--shiki-dark:#6A737D;" > # First byte is Report ID< / span > < / span >
< span class = "line" > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > request_data[< / span > < span style = "--shiki-light:#005CC5;--shiki-dark:#79B8FF;" > 1< / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > :< / span > < span style = "--shiki-light:#005CC5;--shiki-dark:#79B8FF;" > len< / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > (data) < / span > < span style = "--shiki-light:#D73A49;--shiki-dark:#F97583;" > +< / span > < span style = "--shiki-light:#005CC5;--shiki-dark:#79B8FF;" > 1< / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > ] < / span > < span style = "--shiki-light:#D73A49;--shiki-dark:#F97583;" > =< / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > data< / span > < / span >
< span class = "line" > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > request_report < / span > < span style = "--shiki-light:#D73A49;--shiki-dark:#F97583;" > =< / span > < span style = "--shiki-light:#005CC5;--shiki-dark:#79B8FF;" > bytes< / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > (request_data)< / span > < / span >
< span class = "line" > < / span >
< span class = "line" > < span style = "--shiki-light:#005CC5;--shiki-dark:#79B8FF;" > print< / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > (< / span > < span style = "--shiki-light:#032F62;--shiki-dark:#9ECBFF;" > " Request:" < / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > )< / span > < / span >
< span class = "line" > < span style = "--shiki-light:#005CC5;--shiki-dark:#79B8FF;" > print< / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > (request_report)< / span > < / span >
< span class = "line" > < / span >
< span class = "line" > < span style = "--shiki-light:#D73A49;--shiki-dark:#F97583;" > try< / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > :< / span > < / span >
< span class = "line" > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > interface.write(request_report)< / span > < / span >
< span class = "line" > < / span >
< span class = "line" > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > response_report < / span > < span style = "--shiki-light:#D73A49;--shiki-dark:#F97583;" > =< / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > interface.read(report_length, < / span > < span style = "--shiki-light:#E36209;--shiki-dark:#FFAB70;" > timeout< / span > < span style = "--shiki-light:#D73A49;--shiki-dark:#F97583;" > =< / span > < span style = "--shiki-light:#005CC5;--shiki-dark:#79B8FF;" > 1000< / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > )< / span > < / span >
< span class = "line" > < / span >
< span class = "line" > < span style = "--shiki-light:#005CC5;--shiki-dark:#79B8FF;" > print< / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > (< / span > < span style = "--shiki-light:#032F62;--shiki-dark:#9ECBFF;" > " Response:" < / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > )< / span > < / span >
< span class = "line" > < span style = "--shiki-light:#005CC5;--shiki-dark:#79B8FF;" > print< / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > (response_report)< / span > < / span >
< span class = "line" > < span style = "--shiki-light:#D73A49;--shiki-dark:#F97583;" > finally< / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > :< / span > < / span >
< span class = "line" > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > interface.close()< / span > < / span >
< span class = "line" > < / span >
< span class = "line" > < span style = "--shiki-light:#D73A49;--shiki-dark:#F97583;" > if< / span > < span style = "--shiki-light:#005CC5;--shiki-dark:#79B8FF;" > __name__< / span > < span style = "--shiki-light:#D73A49;--shiki-dark:#F97583;" > ==< / span > < span style = "--shiki-light:#032F62;--shiki-dark:#9ECBFF;" > ' __main__' < / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > :< / span > < / span >
< span class = "line" > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > send_raw_report([< / span > < / span >
< span class = "line" > < span style = "--shiki-light:#D73A49;--shiki-dark:#F97583;" > 0x< / span > < span style = "--shiki-light:#005CC5;--shiki-dark:#79B8FF;" > 41< / span > < / span >
2024-06-02 02:43:43 +00:00
< span class = "line" > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > ])< / span > < / span > < / code > < / pre > < / div > < h2 id = "api" tabindex = "-1" > API < a class = "header-anchor" href = "#api" aria-label = "Permalink to "API {#api}"" > < / a > < / h2 > < h3 id = "api-raw-hid-receive" tabindex = "-1" > < code > void raw_hid_receive(uint8_t *data, uint8_t length)< / code > < a class = "header-anchor" href = "#api-raw-hid-receive" aria-label = "Permalink to "`void raw_hid_receive(uint8_t *data, uint8_t length)` {#api-raw-hid-receive}"" > < / a > < / h3 > < p > Callback, invoked when a raw HID report has been received from the host.< / p > < h4 id = "api-raw-hid-receive-arguments" tabindex = "-1" > Arguments < a class = "header-anchor" href = "#api-raw-hid-receive-arguments" aria-label = "Permalink to "Arguments {#api-raw-hid-receive-arguments}"" > < / a > < / h4 > < ul > < li > < code > uint8_t *data< / code > < br > A pointer to the received data. Always 32 bytes in length.< / li > < li > < code > uint8_t length< / code > < br > The length of the buffer. Always 32.< / li > < / ul > < hr > < h3 id = "api-raw-hid-send" tabindex = "-1" > < code > void raw_hid_send(uint8_t *data, uint8_t length)< / code > < a class = "header-anchor" href = "#api-raw-hid-send" aria-label = "Permalink to "`void raw_hid_send(uint8_t *data, uint8_t length)` {#api-raw-hid-send}"" > < / a > < / h3 > < p > Send an HID report.< / p > < h4 id = "api-raw-hid-send-arguments" tabindex = "-1" > Arguments < a class = "header-anchor" href = "#api-raw-hid-send-arguments" aria-label = "Permalink to "Arguments {#api-raw-hid-send-arguments}"" > < / a > < / h4 > < ul > < li > < code > uint8_t *data< / code > < br > A pointer to the data to send. Must always be 32 bytes in length.< / li > < li > < code > uint8_t length< / code > < br > The length of the buffer. Must always be 32.< / li > < / ul > < / div > < / div > < / main > < footer class = "VPDocFooter" data-v-39a288b8 data-v-09de1c0f > <!-- [ --> <!-- ] --> <!-- --> < nav class = "prev-next" data-v-09de1c0f > < div class = "pager" data-v-09de1c0f > < a class = "VPLink link pager-link prev" href = "/features/os_detection" data-v-09de1c0f > <!-- [ --> < span class = "desc" data-v-09de1c0f > Previous page< / span > < span class = "title" data-v-09de1c0f > OS Detection< / span > <!-- ] --> < / a > < / div > < div class = "pager" data-v-09de1c0f > < a class = "VPLink link pager-link next" href = "/features/secure" data-v-09de1c0f > <!-- [ --> < span class = "desc" data-v-09de1c0f > Next page< / span > < span class = "title" data-v-09de1c0f > Secure< / span > <!-- ] --> < / a > < / div > < / nav > < / footer > <!-- [ --> <!-- ] --> < / div > < / div > < / div > <!-- [ --> <!-- ] --> < / div > < / div > <!-- --> <!-- [ --> <!-- ] --> < / div > < / div >
2024-09-18 09:08:45 +00:00
< script > w i n d o w . _ _ V P _ H A S H _ M A P _ _ = J S O N . p a r s e ( " { \ " c a p a b i l i t i e s _ i n c . m d \ " : \ " I e y u I 9 W f \ " , \ " a p i _ d e v e l o p m e n t _ e n v i r o n m e n t . m d \ " : \ " B d P W 5 X x m \ " , \ " c h a n g e l o g _ 2 0 1 9 0 8 3 0 . m d \ " : \ " B i v r 4 B O W \ " , \ " f a q _ b u i l d . m d \ " : \ " D g V Y b 8 Z h \ " , \ " c l i . m d \ " : \ " B m x h R P c P \ " , \ " d r i v e r s _ a w 2 0 2 1 6 s . m d \ " : \ " B I f e X 9 R Q \ " , \ " n e w b s _ l e a r n _ m o r e _ r e s o u r c e s . m d \ " : \ " D J e o 5 k R X \ " , \ " n e w b s _ t e s t i n g _ d e b u g g i n g . m d \ " : \ " D I f K s M T C \ " , \ " o n e _ s h o t _ k e y s . m d \ " : \ " D G 5 U o H I 0 \ " , \ " d r i v e r s _ i s 3 1 f l 3 7 4 2 a . m d \ " : \ " C j v b _ b - G \ " , \ " c h a n g e l o g _ 2 0 2 0 1 1 2 8 . m d \ " : \ " B v 3 M t R Z N \ " , \ " o t h e r _ v s c o d e . m d \ " : \ " B D s v - W I r \ " , \ " p l a t f o r m d e v _ b l a c k p i l l _ f 4 x 1 . m d \ " : \ " B v g w J u B 9 \ " , \ " d r i v e r s _ i 2 c . m d \ " : \ " D r 2 9 Q p w d \ " , \ " p l a t f o r m d e v _ c h i b i o s _ e a r l y i n i t . m d \ " : \ " B K g G p 6 E v \ " , \ " d r i v e r s _ i s 3 1 f l 3 2 1 8 . m d \ " : \ " C b X g Z f 0 f \ " , \ " p l a t f o r m d e v _ p r o t o n _ c . m d \ " : \ " 6 5 A U z K p y \ " , \ " d r i v e r s _ i s 3 1 f l 3 2 3 6 . m d \ " : \ " D B 6 z 9 1 i Z \ " , \ " d r i v e r s _ i s 3 1 f l 3 7 2 9 . m d \ " : \ " D 5 1 u 1 Z j 1 \ " , \ " d r i v e r s _ i s 3 1 f l 3 7 3 1 . m d \ " : \ " B A A D R _ Y T \ " , \ " d r i v e r s _ i s 3 1 f l 3 7 3 3 . m d \ " : \ " D k z Q C 1 r k \ " , \ " d r i v e r s _ i s 3 1 f l 3 7 3 6 . m d \ " : \ " D - S h j Y a v \ " , \ " d r i v e r s _ i s 3 1 f l 3 7 3 7 . m d \ " : \ " B q p m I J M Q \ " , \ " o t h e r _ e c l i p s e . m d \ " : \ " C W b 0 j n Q C \ " , \ " a r m _ d e b u g g i n g . m d \ " : \ " D V e U L k L A \ " , \ " c h a n g e l o g _ 2 0 2 2 0 8 2 7 . m d \ " : \ " C V 9 u G c Q 3 \ " , \ " f e a t u r e s _ l e a d e r _ k e y . m d \ " : \ " N m o g 5 Z z 4 \ " , \ " c h a n g e l o g _ 2 0 2 1 1 1 2 7 . m d \ " : \ " D n z 3 u - H 6 \ " , \ " c h a n g e l o g _ 2 0 2 4 0 5 2 6 . m d \ " : \ " C m S 3 C u z 0 \ " , \ " c h a n g e l o g _ 2 0 2 0 0 5 3 0 . m d \ " : \ " J E J G 5 6 L T \ " , \ " f e a t u r e s _ r a w h i d . m d \ " : \ " a 2 O 7 n 8 y I \ " , \ " c o n f i g u r a t o r _ a r c h i t e c t u r e . m d \ " : \ " C m F D p V L e \ " , \ " f l a s h i n g . m d \ " : \ " C K 6 o O b I F \ " , \ " g e t t i n g _ s t a r t e d _ d o c k e r . m d \ " : \ " d H x m u S d s \ " , \ " g e t t i n g _ s t a r t e d _ g i t h u b . m d \ " : \ " E V x 9 H m - S \ " , \ " g e t t i n g _ s t a r t e d _ i n t r o d u c t i o n . m d \ " : \ " B T O r K q L L \ " , \ " g e t t i n g _ s t a r t e d _ m a k e _ g u i d e . m d \ " : \ " s n y K L k V b \ " , \ " h a n d _ w i r e . m d \ " : \ " B 6 9 N B e Y w \ " , \ " h a r d w a r e _ d r i v e r s . m d \ " : \ " D A 7 3 - x W Q \ " , \ " f e a t u r e s _ b o o t m a g i c . m d \ " : \ " D I H k T T z 1 \ " , \ " f e a t u r e s _ d i g i t i z e r . m d \ " : \ " D B S Z v p w E \ " , \ " f e a t u r e s _ s e q u e n c e r . m d \ " : \ " F 4 3 N F 6 h h \ " , \ " f e a t u r e s _ d i p _ s w i t c h . m d \ " : \ " C f J 3 E v x Z \ " , \ " f e a t u r e s _ d y n a m i c _ m a c r o s . m d \ " : \ " Z T t I h M 8 T \ " , \ " f e a t u r e s _ s p a c e _ c a d e t . m d \ " : \ " D 3 j h C z M k \ " , \ " d r i v e r _ i n s t a l l a t i o n _ z a d i g . m d \ " : \ " D y 2 k Y H S K \ " , \ " c a p a b i l i t i e s . m d \ " : \ " B P L 7 5 V H K \ " , \ " f e a t u r e s _ s w a p _ h a n d s . m d \ " : \ " C h j o V x _ w \ " , \ " a p i _ o v e r v i e w . m d \ " : \ " B z z v V a p Y \ " , \ " f e a t u r e s _ e n c o d e r s . m d \ " : \ " C u g X B k - 4 \ " , \ " f e a t u r e s _ g r a v e _ e s c . m d \ " : \ " D T v s 6 3 9 6 \ " , \ " d r i v e r s _ s e r i a l . m d \ " : \ " C D j O J d N t \ " , \ " a p i _ d e v e l o p m e n t _ o v e r v i e w . m d \ " : \ " B Z J T S E _ s \ " , \ " f e a t u r e s _ h a p t i c _ f e e d b a c k . m d \ " : \ " D V U d h F 3 q \ " , \ " d r i v e r s _ a d c . m d \ " : \ " B 7 G h N 9 c b \ " , \ " b r e a k i n g _ c h a n g e s _ i n s t r u c t i o n s . m d \ " : \ " C 9 S t P y Y H \ " , \ " f e a t u r e s _ h d 4 4 7 8 0 . m d \ " : \ " k U I f 1 - 0 D \ " , \ " d r i v e r s _ i s 3 1 f l 3 7 4 3 a . m d \ " : \ " C 7 T k C r l E \ " , \ " f e a t u r e s _ k e y _ l o c k . m d \ " : \ " C X E Q 5 - M N \ " , \ " f e a t u r e s _ j o y s t i c k . m d \ " : \ " D 4 e a z 8 g V \ " , \ " d r i v e r s _ a p a 1 0 2 . m d \ " : \ " D R K q d W 0 M \ " , \ " n e w b s _ b u i l d i n g _ f i r m w a r e _ w o r k f l o w . m d \ " : \ " C i P 7 v 8 C c \ " , \ " d a t a _ d r i v e n _ c o n f i g . m d \ " : \ " 3 i L 4 - P 4 O \ " , \ " k e y c o d e s _ m a g i c . m d \ " : \ " L O Q R A y 9 4 \ " , \ " e a s y _ m a k e r . m d \ " : \ " C W 6 j l M O - \ " , \ " d o c u m e n t a t i o n _ b e s t _ p r a c t i c e s . m d \ " : \ " C s n E V R O I \ " , \ " d r i v e r s _ i s 3 1 f l 3 7 4 1 . m d \ " : \ " 9 e 7 j z v w W \ " , \ " m o d _ t a p . m d \ " : \ " B 5 t 5 N S B O \ " , \ " n e w b s . m d \ " : \ " B D 3 Q e f y C \ " , \ " n e w b s _ b u i l d i n g _ f i r m w a r e . m d \ " : \ " C y b o v R d t \ " , \ " n e w b s _ b u i l d i n g _ f i r m w a r e _ c o n f i g u r a t o r . m d \ " : \ " B w S L g i p x \ " , \ " n e w b s _ e x t e r n a l _ u s e r s p a c e . m d \ " : \ " B M Y Q p 9 m N \ " , \ " k e y c o d e s _ b a s i c . m d \ " : \ " B _ i S D g m 4 \ " , \ " f e a t u r e s _ a u d i o . m d \ " : \ " D y 0 T o e L W \ " , \ " c o n f i g u r a t o r _ s t e p _ b y _ s t e p . m d \ " : \ " C Q W w P q 1 x \ " , \ " c o n t r i b u t i n g . m d \ " : \ " C - z h 8 z u X \ " , \ " c u s t o m _ m a t r i x . m d \ " : \ " B a J L C N e _ \ " , \ " c h a n g e l o g _ 2 0 2 0 0 8 2 9 . m d \ " : \ " D k r t 3 a r z \ " , \ " c h a n g e l o g _ 2 0 2 3 0 2 2 6 . m d \ " : \ " B h r y C t 4 E \ " , \ " d r i v e r s _ s p i . m d \ " : \ " D o C Z g 1 i V \ " , \ " d r i v e r s _ u a r t . m d \ " : \ " g h 9 2 q K 6 t \ " , \ " f e a t u r e s _ p r o g r a m m a b l e _ b u t t o n . m d \ " : \ " C 7 m T 8 3 X S \ " , \ " c o d i n g _ c o n v e n t i o n s _ p y t h o n . m d \ " : \ " C s s Z F _ d h \ " , \ " f e a t u r e s _ c o m b o . m d \ " : \ " C C 9 Q Z A P 7 \ " , \ " c h i b i o s _ u p g r a d e _ i n s t r u c t i o n s . m d \ " : \ " D I U 6 p 9 9 M \ " , \ " d r i v e r s _ w s 2 8 1 2 . m d \ " : \ " C 9 7 W 5 K w r \ " , \ " f a q _ d e b u g . m d \ " : \ " B D X E R R o T \ " , \ " f e a t u r e s _ a u t o c o r r e c t . m d \ " : \ " C r K w 5 p K P \ " , \ " f e a t u r e s _ p s 2 _ m o u s e . m d \ " : \ " C R 0 p 8 T 4 u \ " , \ " c u s t o m _ q u a n t u m _ f u n c t i o n s . m d \ " : \ " D t I u N x T Q \ " , \ " f e a t u r e s _ l e d _ i n d i c a t o r s . m d \ " : \ " C n u 8 2 P a w \ " , \ " c h a n g e l o g _ 2 0 2 0 0 2 2 9 . m d \ " : \ " B l w j d G d l \ " , \ " f a q _ k e y m a p . m d \ " : \ " D I j g U A J 7 \ " , \ " f e a t u r e s _ s t e n o g r a p h y . m d \ " : \ " B m d U w U E g \ " , \ " f e a t u r e _ l a y o u t s . m d \ " : \ " C j p 6 p Y R h \ " , \ " c h a n g e l o g _ 2 0 2 3 0 8 2 7 . m d \ " : \ " h s 0 C z 5 z a \ " , \ " h a r d w a r e _ k e y b o a r d _ g u i d e l i n e s . m d \ " : \ " M 0 U l p w H v \ " , \ " f e a t u r e s _ b l u e t o o t h . m d \ " : \ " B s 2 L d U w _ \ " , \ " f e a t u r e _ a d v a n c e d _ k e y c o d e s . m d \ " : \ " B I - a c v L B \ " , \ " f e a t u r e _ d e b o u n c e _ t y p e . m d \ " : \ " D B j O R O e v \ " , \ " d r i v e r s _ i s 3 1 f l 3 7 4 5 . m d \ " : \ " D 5 R _ s x f C \ " , \ " f e a t u r e _ e e p r o m . m d \ " : \ " t G E c 5 q B _ \ " , \ " f e a t u r e s _ r g b _ m a t r i x . m d \ " : \ " C 0 k Y z T 0 E \ " , \
2024-05-30 02:02:10 +00:00
< / body >
< / html >
