Device string
When the API queries a device it can return the below string.
|
"Device": { "VID": vendor-ID, "PID": product-ID, "Manufacturer": "device-manufacturer", "Description": "description", "SerialNumber": "usb-serial", "LocationID": location-id, "DevicePath": device-path "USBVersion": usb-version, "USBPower": { "State": "power-state", "Description": "power-description" }, "USBSpeed": { "Speed": "USB-speed", "Description": "USB-description" "Capability": { "Speed": "capable-speed", "Description": "capable-description" } }, "Endpoints": { "Active": active-endpoints, "Maximum": maximum-endpoints, "Memory": endpoint-memory }, "Battery": { "DataSource": "battery-data-source", "TrustLevel": "trust-level", "PairingSupported": support-pairing, "CurrentLevel": battery-current-level, "CurrentTime": current-hub-time, "StartingLevel": charge-start-level, "StartingTime": charge-start-time, "CapacityNew": new-battery-capacity, "Capacity": current-battery-capacity, "ChargingStatus": "charge-status", "HealthPercent": battery-health, "Temperature": device-temperature }, "PhoneSerialNumber": "phone-serial", "PhoneIdentity": "phone-name", "PhoneModel": "phone-model", "IMEI": "IMEI-number", "MacAddress": "MacAddress", "PhoneSoftwareVersion": "phone-OS-version", "PhoneECID": ECID, "PhoneProductType": "phone-product", "PhoneOSType": "phone-OS", "PhoneColour": "phone-colour" } } |
| Output | Description |
|---|---|
| vendor-ID | Device Vendor ID number, VID. Displayed as an Integer |
| product-ID | Product ID number, PID. Displayed as an Integer |
| device-manufacturer | The name of the device manufacturer |
| description | Name of the hardware |
| usb-serial | USB serial number |
| location-id | The Location IDs as an Integer |
| device-path | The platform specific path for the device |
| usb-version | The USB version number of the connection to the hub |
| power-state | USB Power States code |
| power-description | USB power turned on/off |
| USB-speed | Maximum speed USB connection capable of |
| USB-description | Name of USB connection i.e. SuperSpeed USB 5Gbps |
| capable-speed | Maximum data speed device capable of |
| capable-description | Name of maximum data speed device capable of |
| active-endpoints | How many endpoints the device is using, displayed as a integer |
| maximum-endpoints | How many endpoints the device is capable of using, displayed as a integer |
| endpoint-memory | Amount of memory being used by endpoints, displayed as a integer |
| battery-data-source | The source of the device battery information |
| trust-level | Whether the device is trusted/ paired |
| support-pairing | Whether the device supports being trusted/ paired |
| battery-current-level | Current battery percent level of device, displayed as a integer |
| current-hub-time | The hub time in ms, shown as an integer in ms |
| charge-start-level | Battery percentage level when device connected, displayed as a integer |
| charge-start-time | The hub time in ms charging started, shown as an integer in ms |
| new-battery-capacity | The battery capacity of device from new, displayed as a integer |
| current-battery-capacity | The battery capacity of the device now, displayed as a integer |
| charge-status | Charging status of the battery i.e. full |
| battery-health | Battery health percentage, displayed as a integer |
| device-temperature | The temperature the device is reporting |
| phone-serial | Phone serial number |
| phone-name | Name of the phone |
| phone-model | The model of the phone i.e. "iPhone 12" |
| IMEI-number | The IMEI number of the phone |
| MacAdress | A unique address assigned to the mobile device. It is a 48 bit value, consisting of twelve hexadecimal characters |
| phone-os-version | Version number of the OS on the phone |
| ECID | Exclusive Chip Identification also referred to as Unique Chip ID |
| phone-product | Mobile device code i.e. "iPhone13,2" |
| phone-OS | The OS version of the phone i.e. "iPhone OS" |
| phone-colour | The colour of the phone |