cbrx_get_usb (tree)
Return the entire USB tree that has been discovered.
Syntax: see Call Structure
|
{ "method": "cbrx_get_usb, "params": ["tree"] } |
Returns
|
{ "result": [ { "VID": vendor-id, "PID": product-id, "Description": "description", "LocationID": location-id, "USBVersion": USB-version, "USBPower": { "State": "power-state", "Description": "power-description" }, "HostController": { "Type": "host-controller-type", "EndpointTotal": active-endpoints, "EndpointPeakTotal": peak-endpoints, "EndpointMemoryUsed": endoint-memory, "EndpointPeakMemoryUsed": peak-endpoint-memory }, "children": [ { "VID": vendor-id, "PID": product-id, "LocationID": location-id, "USBVersion": USB-version, "USBPower": { "State": "power-state", "Description": "power-description" }, "USBSpeed": { "Speed": "USB-speed", "Description": "speed-name" }, "Endpoints": { "Active": active-endpoints, "Maximum": maximum-endpoints, "Memory": endpoint-memory, "TotalInTree": { "Endpoints": tree-endpoints "Memory": tree-memory } } } ] } ] } |
| Output | Description |
|---|---|
| Vendor-ID | Device Vendor ID, or VID. Displayed as an Integer |
| product-ID | Product ID, PID. Displayed as an Integer |
| description | Name of hardware |
| location-id | The Location IDs as an Integer |
| usb-version | The USB version number of the connection to the hub. Format 'N.nn' |
| power-state | USB Power States code |
| power-description | USB power turned on/off |
| host-controller-type | The type of USB host controller |
| peak-endpoints | Peak endpoint usage on the USB host controller. see Endpoints |
| peak-endpoint-memory | Peak endpoint memory usage. see Endpoints |
| USB-speed | Maximum speed USB connection capable of |
| speed-name | Name of USB connection i.e. SuperSpeed USB 5Gbps |
| active-endpoints | How many endpoints the device is using |
| maximum-endpoints | How many endpoints the device is capable of using |
| endpoint-memory | Amount of memory being used by endpoints |
| tree-endpoints | How many endpoints the tree is using |
| tree-memory | Amount of memory being used by endpoints in the tree |
Examples
Example JSON-RPC request:
{
"jsonrpc": "2.0",
"id": 0,
"method": "cbrx_get_usb",
"params": ["tree"]
}Example successful response:
{
"jsonrpc": "2.0",
"id": 0,
"result": [
{
"VID": 32902,
"PID": 40429,
"Description": "Intel(R) USB 3.1 eXtensible HostController - 1.10
(Microsoft)", "LocationID": 553648128, "USBVersion": 3.1, "USBPower": {
"State": "D0",
"Description": "On"
},
"HostController": {
"Type": "XHCI",
"EndpointTotal": 9,
"EndpointPeakTotal": 60,
"EndpointMemoryUsed": 57344,
"EndpointPeakMemoryUsed": 331776
},
"children": [
{
"VID": 3141,
"PID": 26403,
"LocationID": 558891008,
"USBVersion": 2.01,
"USBPower": {
"State": "D0",
"Description": "On"
},
"USBSpeed": {
"Speed": "480Mbps",
"Description": "High"
},
"Endpoints": {
"Active": 2,
"Maximum": 3,
"Memory": 12288
}
},
{
"VID": 1161,
"PID": 57506,
"LocationID": 560988160,
"USBVersion": 1.1,
"USBPower": {
"State": "D2",
"Description": "Low power"
},
"USBSpeed": {
"Speed": "12Mbps",
"Description": "Full"
},
"Endpoints": {
"Active": 6,
"Memory": 24576
}
},
{
"VID": 0,
"PID": 0,
"LocationID": 563085312,
"USBVersion": 0,
"USBSpeed": {
"Speed": "1.5Mbps",
"Description": "Low"
},
"Endpoints": {
"Active": 1,
"Memory": 4096
}
]
}
]
}