pygmc

Subpackages

• pygmc.connection package
  • Submodules
  • pygmc.connection.connection module
    • Connection
      • Connection.close_connection()
      • Connection.connect()
      • Connection.connect_exact()
      • Connection.connect_user_provided()
      • Connection.get()
      • Connection.get_exact()
      • Connection.read()
      • Connection.read_until()
      • Connection.reset_buffers()
      • Connection.write()
  • Module contents
• pygmc.devices package
  • Submodules
  • pygmc.devices.device module
    • BaseDevice
      • BaseDevice.get_serial()
      • BaseDevice.get_version()
  • pygmc.devices.device_rfc1201 module
    • DeviceRFC1201
      • DeviceRFC1201.get_config()
      • DeviceRFC1201.get_cpm()
      • DeviceRFC1201.get_datetime()
      • DeviceRFC1201.get_gyro()
      • DeviceRFC1201.get_usv_h()
      • DeviceRFC1201.get_voltage()
      • DeviceRFC1201.heartbeat_live()
      • DeviceRFC1201.heartbeat_off()
      • DeviceRFC1201.heartbeat_on()
  • pygmc.devices.device_rfc1801 module
    • DeviceRFC1801
      • DeviceRFC1801.get_config()
      • DeviceRFC1801.get_cpm()
      • DeviceRFC1801.get_cpmh()
      • DeviceRFC1801.get_cpml()
      • DeviceRFC1801.get_cps()
      • DeviceRFC1801.get_datetime()
      • DeviceRFC1801.get_gyro()
      • DeviceRFC1801.get_max_cps()
      • DeviceRFC1801.get_usv_h()
      • DeviceRFC1801.get_voltage()
      • DeviceRFC1801.heartbeat_live()
      • DeviceRFC1801.heartbeat_live_print()
      • DeviceRFC1801.heartbeat_off()
      • DeviceRFC1801.heartbeat_on()
  • Module contents
    • auto_get_device()

Submodules

pygmc.cli module

Module contents

pygmc.connect(port=None, baudrate=None, vid=None, pid=None, description=None, hardware_id=None)

Connect to device. If all parameters are None, _auto_connect() flow is used which attempts to connect to all available ports. If ANY parameter is given; it’s used to refine the search, any matches are considered. Parameters are used as an OR search.

Parameters:

• port (str | None, optional) – Exact port (device dev path / com port) e.g. ‘/dev/ttyUSB0’ If port is specified, the following kwargs are ignored: vid, pid, description, hardware_id.

• baudrate (int | None) – Device baudrate. Leave None to auto-detect baudrate. Only applicable when port is specified.

• vid (str | None, optional) – Device vendor ID as hex, by default None

• pid (str | None, optional) – Device product ID as hex, by default None

• description (str | None, optional) – Device description, by default None

• hardware_id (str | None, optional) – Device hwid, by default None e.g. ‘USB VID:PID=1A86:7523 LOCATION=2-1’ Use hex for vid:pid input

Raises:

ConnectionError – Unable to connect to device.