haniwers.v1.cli.options.device

haniwers.v1.cli.options.device#

Device settings option group.

Module Contents#

Classes#

DeviceOptions

Device settings option group.

API#

class haniwers.v1.cli.options.device.DeviceOptions#

Device settings option group.

Contains options for configuring serial port communication with the OSECHI cosmic ray detector.

port#

‘Option(…)’

Serial port path.

Specifies which serial port to communicate with the OSECHI detector. This overrides the port specified in the configuration file.

Examples:

  • /dev/ttyUSB0 (Linux)

  • /dev/cu.usbserial-140 (macOS)

  • COM3 (Windows)

Tip: Use ‘haniwers-v1 port list’ to discover available ports.

Type: Optional[str] Default: None (use config file value)

baudrate#

‘Option(…)’

Serial baud rate.

Sets the communication speed for serial port. Must be one of the standard serial port baud rates: 300, 600, 1200, 2400, 4800, 9600, 14400, 19200, 28800, 38400, 57600, or 115200. This overrides the baudrate in the configuration file.

Type: int Default: 115200 (standard modern serial communication speed) Allowed values: Standard serial port baud rates only

timeout#

‘Option(…)’

Serial read timeout.

Specifies how long to wait for a response from the OSECHI detector before timing out. Typical values: 1.0-5.0 seconds.

Type: Optional[float] Default: None (use config file value) Minimum: 0.1 seconds

device_label#

‘Option(…)’

Device identifier label.

Human-readable label to identify this detector in logs and documentation. Useful when multiple detectors are in use. Example: “detector_001_main_lab”.

Type: Optional[str] Default: None (use config file value)

目次