Python API

• Driver
  • DeviceContext
    • DeviceContext.close()
    • DeviceContext.publish()
    • DeviceContext.publish_and_wait()
    • DeviceContext.query()
    • DeviceContext.subscribe()
    • DeviceContext.topic()
    • DeviceContext.unsubscribe()
  • Driver
    • Driver.close()
    • Driver.device_paths()
    • Driver.device_watch()
    • Driver.finalize()
    • Driver.find_devices()
    • Driver.find_one_device()
    • Driver.is_driver_thread()
    • Driver.log_level
    • Driver.open()
    • Driver.publish()
    • Driver.publish_and_wait()
    • Driver.query()
    • Driver.subscribe()
    • Driver.unsubscribe()
    • Driver.unsubscribe_all()
  • ElementType
  • ErrorCode
  • Field
  • LogLevel
  • MemClient
    • MemClient.cmd()
    • MemClient.erase_64k()
    • MemClient.read()
    • MemClient.read_personality()
    • MemClient.write_pages()
    • MemClient.write_verify()
    • MemClient.write_verify_records()
  • StdMsg
  • SubscribeContext
    • SubscribeContext.extend()
    • SubscribeContext.unsubscribe()
  • SubscribeFlags
  • TimeMap
    • TimeMap.time_map_get()
• Device selection
  • DevicePath
    • DevicePath.backend
    • DevicePath.brand
    • DevicePath.is_bootloader
    • DevicePath.match()
    • DevicePath.model
    • DevicePath.serial_number
  • BRANDS_TO_MODELS
  • BRAND_ALIASES
  • brand_validate()
  • DeviceFilterError
  • find()
  • find_one()
• Record
• Program
  • release_program()
  • program_js320()
• time64
  • as_datetime()
  • as_isostr()
  • as_time64()
  • as_timestamp()
  • duration_to_seconds()
  • filename()
  • now()

Command-line tools

The package installs command-line entry points. For the full list:

python -m pyjoulescope_driver --help

The commands that operate on devices select them with --device (-d), which accepts the same device specifications as Driver.find_devices(), such as -d js320 or -d 8W2A. The commands that support any device also accept --brand, such as --brand joulescope. For example:

python -m pyjoulescope_driver info
python -m pyjoulescope_driver values -d js320
python -m pyjoulescope_driver metadata --brand joulescope