enlighten.common Namespace Reference

Classes
class	Axes
class	AxesHelper
class	FakeOutputHandle
	We [think we] need to build Windows installers with PyInstaller. More...
class	LaserPowerUnits
class	LaserStates
	We don't actually have FW API to read all of these; final implementation should treat enable, delayState, watchdogLockdown, interlockState, and isFiring as separate bits. More...
class	OperationModes
class	Pages
class	Techniques
	ENLIGHTEN's application version number (checked by scripts/deploy and bootstrap.bat) More...
class	TechniquesHelper
class	Views
	It's important to keep this list in sync with the comboBox_view items. More...
class	ViewsHelper

Functions
	get_default_data_dir ()
	Return the path used for all Enlighten data except for spectra.
	is_rpi ()
	msgbox (prompt, title="Alert", buttons="", detail=None, informative_text=None)
	Display an interupting message to the user.
	set_controller_instance (inst)
	use_pyside2 ()

Variables
	ctl = None
	log = logging.getLogger(__name__)
str	VERSION = "4.1.37"

Function Documentation

get_default_data_dir()

enlighten.common.get_default_data_dir

(

)

Return the path used for all Enlighten data except for spectra.

This will be something like "~/Documents/EnlightenSpectra" The path appropriate for the given platform is returned.

This location is used for logs and configuration files. Not that this path is NOT configurable, since it is used to load the config (.ini) file.

The default save location for spectra is also ~/Documents/EnlightenSpectra, but that is driven by SaveOptions, and it IS configurable.

is_rpi()

enlighten.common.is_rpi

(

)

msgbox()

enlighten.common.msgbox	(		prompt,
			title = "Alert",
			buttons = "",
			detail = None,
			informative_text = None )

Display an interupting message to the user.

In common rather than GUI so it can be used before Controller / Business Objects fully instantiated.

Inspired by VB msgbox: https://learn.microsoft.com/en-us/office/vba/language/reference/user-interface-help/msgbox-function

set_controller_instance()

enlighten.common.set_controller_instance

(

inst

)

use_pyside2()

enlighten.common.use_pyside2

(

)

Variable Documentation

ctl

enlighten.common.ctl = None

log

enlighten.common.log = logging.getLogger(__name__)

VERSION

str enlighten.common.VERSION = "4.1.37"