ENLIGHTEN
Cross-platform desktop GUI for Wasatch Photonics spectrometers
Loading...
Searching...
No Matches
wasatch.OceanDevice.OceanDevice Class Reference

This is the basic implementation of our interface with Ocean Spectrometers. More...

Inheritance diagram for wasatch.OceanDevice.OceanDevice:
[legend]
Collaboration diagram for wasatch.OceanDevice.OceanDevice:
[legend]

Public Member Functions

 __init__ (self, device_id, message_queue=None, alert_queue=None)
 
 acquire_data (self)
 
 connect (self)
 Public Methods.
 
 scans_to_average (self, int value)
 
- Public Member Functions inherited from wasatch.InterfaceDevice.InterfaceDevice
 __init__ (self)
 Any class that communicates to a spectrometer should inherit this class.
 
 handle_requests (self, requests)
 

Public Attributes

 alert_queue = alert_queue
 
list command_queue = []
 
bool connected = False
 
 device = None
 
 device_id = device_id
 
int failure_count = 0
 
bool immediate_mode = False
 
int last_battery_percentage = 0
 
 last_memory_check = datetime.datetime.now()
 
 message_queue = message_queue
 
 process_id = os.getpid()
 
int session_reading_count = 0
 
 settings = SpectrometerSettings(self.device_id)
 
 spec = Spectrometer(self.device)
 
int sum_count = 0
 
list summed_spectra = None
 
bool take_one = False
 
- Public Attributes inherited from wasatch.InterfaceDevice.InterfaceDevice
dict process_f = {}
 
int remaining_throwaways = 0
 

Protected Member Functions

 _init_process_funcs (self)
 Private Methods.
 
 _take_one_averaged_reading (self)
 

Detailed Description

This is the basic implementation of our interface with Ocean Spectrometers.

########################################################################## This class adopts the external device interface structure This invlovles receiving a request through the handle_request function A request is processed based on the key in the request The processing function passes the commands to the requested device Once it recevies a response from the connected device it then passes that back up the chain Enlighten Request | handle_requests

|

/ / | \ \ { get_laser status, acquire, set_laser_watchdog, etc....}

\ \ | / /

| {self.ocean_call} ############################################################################

Constructor & Destructor Documentation

◆ __init__()

wasatch.OceanDevice.OceanDevice.__init__ ( self,
device_id,
message_queue = None,
alert_queue = None )

Member Function Documentation

◆ _init_process_funcs()

wasatch.OceanDevice.OceanDevice._init_process_funcs ( self)
protected

Private Methods.

◆ _take_one_averaged_reading()

wasatch.OceanDevice.OceanDevice._take_one_averaged_reading ( self)
protected

◆ acquire_data()

wasatch.OceanDevice.OceanDevice.acquire_data ( self)

◆ connect()

wasatch.OceanDevice.OceanDevice.connect ( self)

Public Methods.

◆ scans_to_average()

wasatch.OceanDevice.OceanDevice.scans_to_average ( self,
int value )

Member Data Documentation

◆ alert_queue

wasatch.OceanDevice.OceanDevice.alert_queue = alert_queue

◆ command_queue

list wasatch.OceanDevice.OceanDevice.command_queue = []

◆ connected

bool wasatch.OceanDevice.OceanDevice.connected = False

◆ device

wasatch.OceanDevice.OceanDevice.device = None

◆ device_id

wasatch.OceanDevice.OceanDevice.device_id = device_id

◆ failure_count

int wasatch.OceanDevice.OceanDevice.failure_count = 0

◆ immediate_mode

bool wasatch.OceanDevice.OceanDevice.immediate_mode = False

◆ last_battery_percentage

int wasatch.OceanDevice.OceanDevice.last_battery_percentage = 0

◆ last_memory_check

wasatch.OceanDevice.OceanDevice.last_memory_check = datetime.datetime.now()

◆ message_queue

wasatch.OceanDevice.OceanDevice.message_queue = message_queue

◆ process_id

wasatch.OceanDevice.OceanDevice.process_id = os.getpid()

◆ session_reading_count

int wasatch.OceanDevice.OceanDevice.session_reading_count = 0

◆ settings

wasatch.OceanDevice.OceanDevice.settings = SpectrometerSettings(self.device_id)

◆ spec

wasatch.OceanDevice.OceanDevice.spec = Spectrometer(self.device)

◆ sum_count

int wasatch.OceanDevice.OceanDevice.sum_count = 0

◆ summed_spectra

wasatch.OceanDevice.OceanDevice.summed_spectra = None

◆ take_one

bool wasatch.OceanDevice.OceanDevice.take_one = False

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