API Reference

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

• 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()
  • Network drivers
    • Driver configuration
      • TcpNetwork
      • UdpNetwork
      • UnixNetwork
      • EchoNetwork
    • Client API
      • NetworkClient
  • PySerial
    • Driver configuration
      • Config parameters
    • PySerialClient API
      • PySerialClient
        • PySerialClient.close()
        • PySerialClient.open()
        • PySerialClient.open_stream()
        • PySerialClient.pexpect()
        • PySerialClient.stream()
    • Examples
  • SDWire driver
    • Driver Configuration
    • Client API
      • StorageMuxClient
        • StorageMuxClient.dut()
        • StorageMuxClient.host()
        • StorageMuxClient.off()
        • StorageMuxClient.read_local_file()
        • StorageMuxClient.write_local_file()
  • Shell driver
    • Driver configuration
    • ShellClient API
      • ShellClient
  • SNMP
    • Driver configuration
      • Config parameters
    • SNMPServerClient API
      • Methods
        • SNMPServerClient
          • SNMPServerClient.off()
          • SNMPServerClient.on()
    • Examples
  • TFTP Driver
    • Driver Configuration
      • Config parameters
    • TftpServerClient API
      • TftpServerClient
        • TftpServerClient.delete_file()
        • TftpServerClient.get_host()
        • TftpServerClient.get_port()
        • TftpServerClient.list_files()
        • TftpServerClient.start()
        • TftpServerClient.stop()
    • Exception Classes
      • TftpError
      • ServerNotRunning
      • FileNotFound
    • Examples
  • Ustreamer driver
    • Driver configuration
    • Client API
      • UStreamerClient
        • UStreamerClient.snapshot()
        • UStreamerClient.state()
  • Yepkit
    • Ykush driver
      • Driver configuration
      • Config parameters
      • PowerClient API
        • PowerClient
      • Examples
      • CLI access
• Adapter Packages
  • Network adapters
    • TcpPortforwardAdapter
    • UnixPortforwardAdapter
    • NovncAdapter
    • PexpectAdapter
    • FabricAdapter
    • Examples
      • Forward a remote TCP port to a local TCP port
      • Forward a remote Unix domain socket to a local socket
• Base Driver classes
  • Driver
    • Driver
      • Driver.client()
      • Driver.resources
    • export()
    • exportstream()
  • Driver Client
    • DriverClient
      • DriverClient.call()
      • DriverClient.close()
      • DriverClient.open_stream()
      • DriverClient.stream()
      • DriverClient.streamingcall()
  • Example