Warning

This documentation is actively being updated as the project evolves and may not be complete in all areas.

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.streamingcall()
  • Example
• Adapter API Reference
  • Adapters
    • ClientAdapter
    • FabricAdapter
    • NovncAdapter
    • OpendalAdapter
    • PexpectAdapter
    • PortforwardAdapter
• Driver Packages
  • Ustreamer driver
    • UStreamerClient
      • UStreamerClient.snapshot()
      • UStreamerClient.state()
  • 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()
  • SDWire driver
    • StorageMuxClient
      • StorageMuxClient.dut()
      • StorageMuxClient.host()
      • StorageMuxClient.off()
      • StorageMuxClient.write_local_file()