usbid 2.2

USB file system abstraction API

This module provides a USB file system abstraction API which can be used to gain information of the physical USB bus structure on a Linux System.

# ls  /sys/bus/usb/devices/
1-0:1.0      1-1.3        1-1.3.1:1.0  1-1:1.0
1-1          1-1.3.1      1-1.3:1.0    usb1

bus-port.port.port ...

:config.interface

1-1:1.0        1-1.3:1.0        1-1.3.1:1.0

Usage

The API consists of a USB root object, from which all children can be accessed like python container types.

>>> from usbid import USB
>>> usb = USB()
>>> usb
<usbid.fs.USB [/sys/bus/usb/devices] at ...>

>>> usb.keys()
['1', '2']

Get a specific bus.

>>> bus = usb['1']
>>> bus
<usbid.fs.Bus [usb1] at ...>

Get port from bus.

>>> port = bus['1']
>>> port
<usbid.fs.Port [1-1] at ...>

Get interface from port.

>>> port.interfaces
[<usbid.fs.Interface [1-1:1.0] at ...>]

Interfaces might have tty associated.

>>> port.interfaces[0].tty
'ttyUSB0'

It’s not a good idea to refer to a USB interface by its tty mount name. But it’s a good idea to remember the file system name for unique identification, lookup interface by this name and then connect to corresponding tty.

>>> interface = usb.get_interface('1-1:1.0')
>>> interface.tty
'ttyUSB0'

For debugging you can print the USB structure.

>>> usb.printtree()
<usbid.fs.USB [/sys/bus/usb/devices] at ...>
  <usbid.fs.Bus [usb1] at ...>
      - Linux 3.13.0-48-generic xhci_hcd
      - xHCI Host Controller
    <usbid.fs.Interface [1-0:1.0] at ...>
    <usbid.fs.Port [1-1] at ...>
        - FTDI
        - FT232R USB UART
      <usbid.fs.Interface [1-1:1.0] at ...>
        - ttyUSB0

Source Code

The sources are in a GIT DVCS with its main branches at github.

Contributors

• Robert Niederreiter <rnix@squarewave.at>

• Jens W. Klein <jens@bluedynamics.com>

• Benjamin Stefaner <bs@kleinundpartner.at>

Changelog

License

Copyright (c) 2013-2023, BlueDynamics Alliance, Austria, Germany, Switzerland All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

• Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

• Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

• Neither the name of the BlueDynamics Alliance nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY BlueDynamics Alliance AS IS AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL BlueDynamics Alliance BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.