API Reference

This section provides details on the Jumpstarter core API and contrib drivers.

• Driver API Reference
  • Driver
    • Driver
      • Driver.client()
      • Driver.resources
    • export()
    • exportstream()
  • Driver Client
    • DriverClient
      • DriverClient.call()
      • DriverClient.close()
      • DriverClient.open_stream()
      • DriverClient.stream()
      • DriverClient.streamingcall()
  • Example
• Adapter API Reference
  • Adapters
    • ClientAdapter
    • FabricAdapter
    • NovncAdapter
    • OpendalAdapter
    • PexpectAdapter
    • PortforwardAdapter
• Driver Packages
  • CAN driver
    • CanClient
      • CanClient.channel_info
      • CanClient.flush_tx_buffer()
      • CanClient.protocol
      • CanClient.send()
      • CanClient.shutdown()
      • CanClient.state
    • IsoTpClient
      • IsoTpClient.available()
      • IsoTpClient.recv()
      • IsoTpClient.send()
      • IsoTpClient.set_address()
      • IsoTpClient.start()
      • IsoTpClient.stop()
      • IsoTpClient.stop_receiving()
      • IsoTpClient.stop_sending()
      • IsoTpClient.transmitting()
  • PySerial
    • Driver configuration
      • Config parameters
    • PySerialClient API
      • PySerialClient
        • PySerialClient.close()
        • PySerialClient.open()
        • PySerialClient.open_stream()
        • PySerialClient.pexpect()
        • PySerialClient.stream()
    • Examples
  • SDWire driver
    • StorageMuxClient
      • StorageMuxClient.dut()
      • StorageMuxClient.host()
      • StorageMuxClient.off()
      • StorageMuxClient.read_local_file()
      • StorageMuxClient.write_local_file()
  • Ustreamer driver
    • UStreamerClient
      • UStreamerClient.snapshot()
      • UStreamerClient.state()