hwm.hardware.devices.drivers.driver.HardwareDriver Class Reference

The base hardware driver interface. More...

Inheritance diagram for hwm.hardware.devices.drivers.driver.HardwareDriver:

Public Member Functions
def	__init__
	Sets up the physical hardware driver. More...
Public Member Functions inherited from hwm.hardware.devices.drivers.driver.Driver
def	__init__
	Initializes the new device driver. More...
def	write_telemetry
	Writes device telemetry data back to the device's registered pipelines. More...
def	write_output
	Writes device output to the device's pipelines. More...
def	write
	Writes the specified data chunk to the device. More...
def	get_command_handler
	Returns the device's command handler. More...
def	get_state
	Returns a dictionary containing the current state of the device. More...
def	cleanup_after_session
	Allows the driver to cleanup after a session that was using it has ended. More...
def	prepare_for_session
	Allows the driver to prepare for new sessions. More...
def	register_pipeline
	Associates a pipeline with the device. More...
def	reserve_device
	Reserves the device for a pipeline usage session. More...
def	free_device
	Frees up the driver reservation. More...
def	is_active
	Indicates if the driver is active or not. More...
def	is_locked
	Indicates if the driver has been locked or not. More...

Additional Inherited Members
Public Attributes inherited from hwm.hardware.devices.drivers.driver.Driver
	settings
	configuration
	id
	allow_concurrent_use
	associated_pipelines

Detailed Description

The base hardware driver interface.

This class provides the base driver interface that must be implemented when developing physical hardware device drivers for the hardware manager.

Constructor & Destructor Documentation

def hwm.hardware.devices.drivers.driver.HardwareDriver.__init__	(		self,
			device_configuration,
			command_parser
	)

Sets up the physical hardware driver.

Parameters

device_configuration	A dictionary containing the device configuration (from the devices.yml configuration file).
command_parser	A reference to the active CommandParser instance. Drivers may use this to execute commands at any time during a session.

---

The documentation for this class was generated from the following file:

• hwm/hardware/devices/drivers/driver.py