DeviceInfo

Translation of `serial.tools.list_ports.ListPortInfo` for unified interface between USB and Serial `DeviceManagers`. Attrs here represent valid filter criteria during device search.

Decorators
dataclasses.dataclass

Methods

  • __init__(
      self,
      device : str,
      name : str,
      description : typing.Optional[str],
      hwid : typing.Optional[str],
      vid : typing.Optional[str],
      pid : typing.Optional[str],
      serial_number : typing.Optional[str],
      location : typing.Optional[str],
      manufacturer : typing.Optional[str],
      product : typing.Optional[str],
      interface : typing.Optional[str]
    ) -> None

    Parameters

    • Name
      self
      Type
      Default
      Description

    • Name
      device
      Type
      str
      Default
      Description

    • Name
      name
      Type
      str
      Default
      Description

    • Name
      description
      Type
      typing.Optional[str]
      Default
      = None
      Description

    • Name
      hwid
      Type
      typing.Optional[str]
      Default
      = None
      Description

    • Name
      vid
      Type
      typing.Optional[str]
      Default
      = None
      Description

    • Name
      pid
      Type
      typing.Optional[str]
      Default
      = None
      Description

    • Name
      serial_number
      Type
      typing.Optional[str]
      Default
      = None
      Description

    • Name
      location
      Type
      typing.Optional[str]
      Default
      = None
      Description

    • Name
      manufacturer
      Type
      typing.Optional[str]
      Default
      = None
      Description

    • Name
      product
      Type
      typing.Optional[str]
      Default
      = None
      Description

    • Name
      interface
      Type
      typing.Optional[str]
      Default
      = None
      Description

  • __post_init__(self) -> None

  • __repr__(self) -> None

Attributes

  • Name
    device
    Type
    str
    Value

    = None

    Description

  • Name
    name
    Type
    str
    Value

    = None

    Description

  • Name
    description
    Type
    typing.Optional[str]
    Value

    = None

    Description

  • Name
    hwid
    Type
    typing.Optional[str]
    Value

    = None

    Description

  • Name
    vid
    Type
    typing.Optional[str]
    Value

    = None

    Description

  • Name
    pid
    Type
    typing.Optional[str]
    Value

    = None

    Description

  • Name
    serial_number
    Type
    typing.Optional[str]
    Value

    = None

    Description

  • Name
    location
    Type
    typing.Optional[str]
    Value

    = None

    Description

  • Name
    manufacturer
    Type
    typing.Optional[str]
    Value

    = None

    Description

  • Name
    product
    Type
    typing.Optional[str]
    Value

    = None

    Description

  • Name
    interface
    Type
    typing.Optional[str]
    Value

    = None

    Description

Copyright © 2024