MagAO-X Uniblitz DSS Shutter interface. More...

#include <dssShutter.hpp>

Collaboration diagram for MagAOX::app::dev::dssShutter< derivedT >:

Public Member Functions
	dssShutter ()
	Default c'tor.

void	setupConfig (mx::app::appConfigurator &config)
	Setup the configuration system.

void	loadConfig (mx::app::appConfigurator &config)
	load the configuration system results

int	appStartup ()
	Startup function.

int	appLogic ()
	application logic

int	appShutdown ()
	applogic shutdown

int	onPowerOff ()
	Actions on power off.

int	whilePowerOff ()
	Actions while powered off.

int	setShutterState (int sh)
	Change shutter state.

int	open ()
	Open the shutter.

int	shut ()
	Shut the shutter.

Protected Attributes
int	m_powerState {-1}
	The current power state, -1 is unknown, 0 is off, 1 is on.

int	m_sensorState {-1}
	The current sensor state, -1 is unknown, 0 is shut, 1 is open.

int	m_triggerState {-1}
	The current trigger state. -1 is unknown, 0 is low, 1 is high.

Configurable Parameters
std::string	m_powerDevice
	The device controlling this shutter's power.

std::string	m_powerChannel
	The channel controlling this shutter's power.

std::string	m_dioDevice
	The device controlling this shutter's digital I/O.

std::string	m_sensorChannel
	The channel reading this shutter's sensor.

std::string	m_triggerChannel
	The channel sending this shutter's trigger.

unsigned	m_shutterWait {100}
	The time to pause between checks of the sensor state during open/shut [msec]. Default is 100.

unsigned	m_shutterTimeout {2000}
	Total time to wait for sensor to change state before timing out [msec]. Default is 2000.

Private Member Functions
derivedT &	derived ()
	Access the derived class.

Open/Shut Threads
Separate threads are used since we need INDI updates while trying to open/shut. These threads sleep(1), unless interrupted by a signal. When signaled, they check for the m_doOpen or m_doShut flag, and if true the appropriate open() or shut() function is called. If not, they go back to sleep unless m_shutdown is true.
bool	m_doOpen {false}
	Flag telling the open thread that it should actually open the shutter, not just go back to sleep.

bool	m_openThreadInit {true}
	Initialization flag for the open thread.

pid_t	m_openThreadID {0}
	Open thread PID.

pcf::IndiProperty	m_openThreadProp
	The property to hold the open thread details.

std::thread	m_openThread
	The opening thread.

bool	m_doShut {false}
	Flag telling the shut thread that it should actually shut the shutter, not just go back to sleep.

bool	m_shutThreadInit {true}
	Initialization flag for the shut thread.

pid_t	m_shutThreadID {0}
	Shut thread PID.

pcf::IndiProperty	m_shutThreadProp
	The property to hold the shut thread details.

std::thread	m_shutThread
	The shutting thread.

static void	openThreadStart (dssShutter *d)
	Open thread starter function.

static void	shutThreadStart (dssShutter *d)
	Shut thread starter function.

void	openThreadExec ()
	Open thread function.

void	shutThreadExec ()
	Shut thread function.

INDI
pcf::IndiProperty	m_indiP_powerChannel
	Property used to monitor the shutter's power state.

pcf::IndiProperty	m_indiP_sensorChannel
	Property used to monitor the shutter's hall sensor.

pcf::IndiProperty	m_indiP_triggerChannel
	Property used to monitor and set the shutter's trigger.

int	setCallBack_powerChannel (const pcf::IndiProperty &ipRecv)
	The callback called by the static version, to actually process the new request.

int	setCallBack_sensorChannel (const pcf::IndiProperty &ipRecv)
	The callback called by the static version, to actually process the new request.

int	setCallBack_triggerChannel (const pcf::IndiProperty &ipRecv)
	The callback called by the static version, to actually process the new request.

static int	st_setCallBack_powerChannel (void *app, const pcf::IndiProperty &ipRecv)
	The static callback function to be registered for shutter power channel changes.

static int	st_setCallBack_sensorChannel (void *app, const pcf::IndiProperty &ipRecv)
	The static callback function to be registered for shutter sensor channel changes.

static int	st_setCallBack_triggerChannel (void *app, const pcf::IndiProperty &ipRecv)
	The static callback function to be registered for shutter trigger channel changes.

Detailed Description

template<class derivedT>
class MagAOX::app::dev::dssShutter< derivedT >

MagAO-X Uniblitz DSS Shutter interface.

This is actually an interface to the digital I/O system, which controls the shutter.

The derived class derivedT must be a MagAOXApp<true>, and should declare this class a friend like so:

friend class dev::dssShutter<derivedT>;

MagAOX::app::dev::dssShutter

MagAO-X Uniblitz DSS Shutter interface.

Definition dssShutter.hpp:37

Calls to this class's setupConfig, loadConfig, appStartup, appLogic, appShutdown onPowerOff, whilePowerOff, functions must be placed in the derived class's functions of the same name.

Definition at line 36 of file dssShutter.hpp.

Constructor & Destructor Documentation

◆ dssShutter()

template<class derivedT >

MagAOX::app::dev::dssShutter< derivedT >::dssShutter ( )

Default c'tor.

Sets derived().m_hasShutter to true.

Definition at line 299 of file dssShutter.hpp.

Member Function Documentation

◆ appLogic()

template<class derivedT >

int MagAOX::app::dev::dssShutter< derivedT >::appLogic ( )

application logic

This should be called in derivedT::appLogic as

dssShutter<derivedT>::appLogic();

MagAOX::app::dev::dssShutter::appLogic

int appLogic()

application logic

Definition dssShutter.hpp:403

with appropriate error checking.

Returns: 0 on success; -1 on error, which is logged.

Definition at line 403 of file dssShutter.hpp.

◆ appShutdown()

template<class derivedT >

int MagAOX::app::dev::dssShutter< derivedT >::appShutdown ( )

applogic shutdown

This should be called in derivedT::appShutdown as

dssShutter<derivedT>::appShutdown();

MagAOX::app::dev::dssShutter::appShutdown

int appShutdown()

applogic shutdown

Definition dssShutter.hpp:437

with appropriate error checking.

Returns: 0 on success; -1 on error, which is logged.

Definition at line 437 of file dssShutter.hpp.

Referenced by MagAOX::app::ocam2KCtrl::appShutdown(), and MagAOX::app::picamCtrl::appShutdown().

◆ appStartup()

template<class derivedT >

int MagAOX::app::dev::dssShutter< derivedT >::appStartup ( )

Startup function.

This should be called in derivedT::appStartup as

dssShutter<derivedT>::appStartup();

MagAOX::app::dev::dssShutter::appStartup

int appStartup()

Startup function.

Definition dssShutter.hpp:335

with appropriate error checking.

Returns: 0 on success; -1 on error, which is logged.

Definition at line 335 of file dssShutter.hpp.

References MagAOX::app::sigUsr1Handler().

◆ derived()

template<class derivedT >

derivedT & MagAOX::app::dev::dssShutter< derivedT >::derived ( )

inlineprivate

Access the derived class.

Definition at line 292 of file dssShutter.hpp.

◆ loadConfig()

template<class derivedT >

void MagAOX::app::dev::dssShutter< derivedT >::loadConfig ( mx::app::appConfigurator & config )

load the configuration system results

This should be called in derivedT::loadConfig as

dssShutter<derivedT>::loadConfig(config);

MagAOX::app::dev::dssShutter::loadConfig

void loadConfig(mx::app::appConfigurator &config)

load the configuration system results

Definition dssShutter.hpp:322

with appropriate error checking.

Parameters

[in] config the derived classes configurator

Definition at line 322 of file dssShutter.hpp.

Referenced by MagAOX::app::ocam2KCtrl::loadConfig(), and MagAOX::app::picamCtrl::loadConfig().

◆ onPowerOff()

template<class derivedT >

int MagAOX::app::dev::dssShutter< derivedT >::onPowerOff ( )

Actions on power off.

This should be called in derivedT::appPowerOff as

dssShutter<derivedT>::appPowerOff();

with appropriate error checking.

Returns: 0 on success; -1 on error, which is logged.

Definition at line 474 of file dssShutter.hpp.

◆ open()

template<class derivedT >

int MagAOX::app::dev::dssShutter< derivedT >::open ( )

Open the shutter.

Do not lock the mutex before calling this.

Returns: 0 on success; -1 on error

Todo:: need shutter log types

Definition at line 513 of file dssShutter.hpp.

◆ openThreadExec()

template<class derivedT >

void MagAOX::app::dev::dssShutter< derivedT >::openThreadExec ( )

protected

Open thread function.

Runs until m_shutdown is true.

Definition at line 646 of file dssShutter.hpp.

Referenced by MagAOX::app::dev::dssShutter< derivedT >::openThreadStart().

◆ openThreadStart()

template<class derivedT >

void MagAOX::app::dev::dssShutter< derivedT >::openThreadStart ( dssShutter< derivedT > * d )

staticprotected

Open thread starter function.

Parameters

[in] d pointer to this

Definition at line 640 of file dssShutter.hpp.

References MagAOX::app::dev::dssShutter< derivedT >::openThreadExec().

◆ setCallBack_powerChannel()

template<class derivedT >

int MagAOX::app::dev::dssShutter< derivedT >::setCallBack_powerChannel ( const pcf::IndiProperty & ipRecv )

The callback called by the static version, to actually process the new request.

Returns: 0 on success.; -1 on error.

Parameters

[in] ipRecv the INDI property sent with the the new property request.

Definition at line 715 of file dssShutter.hpp.

References MagAOX::app::ipRecv.

◆ setCallBack_sensorChannel()

template<class derivedT >

int MagAOX::app::dev::dssShutter< derivedT >::setCallBack_sensorChannel ( const pcf::IndiProperty & ipRecv )

The callback called by the static version, to actually process the new request.

Returns: 0 on success.; -1 on error.

Parameters

[in] ipRecv the INDI property sent with the the new property request.

Definition at line 752 of file dssShutter.hpp.

References MagAOX::app::ipRecv.

◆ setCallBack_triggerChannel()

template<class derivedT >

int MagAOX::app::dev::dssShutter< derivedT >::setCallBack_triggerChannel ( const pcf::IndiProperty & ipRecv )

The callback called by the static version, to actually process the new request.

Returns: 0 on success.; -1 on error.

Parameters

[in] ipRecv the INDI property sent with the the new property request.

Definition at line 789 of file dssShutter.hpp.

References MagAOX::app::ipRecv.

◆ setShutterState()

template<class derivedT >

int MagAOX::app::dev::dssShutter< derivedT >::setShutterState ( int sh )

Change shutter state.

Sets m_doOpen or m_doShut and signals the appropriate thread.

Returns: 0 on success; -1 on error

Parameters

sh	Desired shutter state. 0 for shut,1 for open

Definition at line 486 of file dssShutter.hpp.

◆ setupConfig()

template<class derivedT >

void MagAOX::app::dev::dssShutter< derivedT >::setupConfig ( mx::app::appConfigurator & config )

Setup the configuration system.

This should be called in derivedT::setupConfig as

dssShutter<derivedT>::setupConfig(config);

MagAOX::app::dev::dssShutter::setupConfig

void setupConfig(mx::app::appConfigurator &config)

Setup the configuration system.

Definition dssShutter.hpp:304

with appropriate error checking.

Parameters

[out] config the derived classes configurator

Definition at line 304 of file dssShutter.hpp.

Referenced by MagAOX::app::ocam2KCtrl::setupConfig(), and MagAOX::app::picamCtrl::setupConfig().

◆ shut()

template<class derivedT >

int MagAOX::app::dev::dssShutter< derivedT >::shut ( )

Shut the shutter.

Do not lock the mutex before calling this.

Returns: 0 on success; -1 on error

Todo:: need shutter log types

Todo:: need shutter log types

Definition at line 575 of file dssShutter.hpp.

◆ shutThreadExec()

template<class derivedT >

void MagAOX::app::dev::dssShutter< derivedT >::shutThreadExec ( )

protected

Shut thread function.

Runs until m_shutdown is true.

Definition at line 680 of file dssShutter.hpp.

Referenced by MagAOX::app::dev::dssShutter< derivedT >::shutThreadStart().

◆ shutThreadStart()

template<class derivedT >

void MagAOX::app::dev::dssShutter< derivedT >::shutThreadStart ( dssShutter< derivedT > * d )

staticprotected

Shut thread starter function.

Parameters

[in] d pointer to this

Definition at line 674 of file dssShutter.hpp.

References MagAOX::app::dev::dssShutter< derivedT >::shutThreadExec().

◆ st_setCallBack_powerChannel()

template<class derivedT >

int MagAOX::app::dev::dssShutter< derivedT >::st_setCallBack_powerChannel	(	void *	app,
		const pcf::IndiProperty &	ipRecv
	)

static

The static callback function to be registered for shutter power channel changes.

Returns: 0 on success.; -1 on error.

Parameters

[in]	app	a pointer to this, will be static_cast-ed to derivedT.
[in]	ipRecv	the INDI property sent with the the new property request.

Definition at line 707 of file dssShutter.hpp.

References MagAOX::app::ipRecv.

◆ st_setCallBack_sensorChannel()

template<class derivedT >

int MagAOX::app::dev::dssShutter< derivedT >::st_setCallBack_sensorChannel	(	void *	app,
		const pcf::IndiProperty &	ipRecv
	)

static

The static callback function to be registered for shutter sensor channel changes.

Returns: 0 on success.; -1 on error.

Parameters

[in]	app	a pointer to this, will be static_cast-ed to derivedT.
[in]	ipRecv	the INDI property sent with the the new property request.

Definition at line 744 of file dssShutter.hpp.

References MagAOX::app::ipRecv.

◆ st_setCallBack_triggerChannel()

template<class derivedT >

int MagAOX::app::dev::dssShutter< derivedT >::st_setCallBack_triggerChannel	(	void *	app,
		const pcf::IndiProperty &	ipRecv
	)

static

The static callback function to be registered for shutter trigger channel changes.

Returns: 0 on success.; -1 on error.

Parameters

[in]	app	a pointer to this, will be static_cast-ed to derivedT.
[in]	ipRecv	the INDI property sent with the the new property request.

Definition at line 781 of file dssShutter.hpp.

References MagAOX::app::ipRecv.

◆ whilePowerOff()

template<class derivedT >

int MagAOX::app::dev::dssShutter< derivedT >::whilePowerOff ( )

Actions while powered off.

This should be called in derivedT::whilePowerOff as

dssShutter<derivedT>::whilePowerOff();

MagAOX::app::dev::dssShutter::whilePowerOff

int whilePowerOff()

Actions while powered off.

Definition dssShutter.hpp:480

with appropriate error checking.

Returns: 0 on success; -1 on error, which is logged.

The current trigger state. -1 is unknown, 0 is low, 1 is high.

Definition at line 60 of file dssShutter.hpp.

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

libMagAOX/app/dev/dssShutter.hpp

Public Member Functions

Protected Attributes

Private Member Functions

Open/Shut Threads

INDI

Detailed Description

Constructor & Destructor Documentation

◆ dssShutter()

Member Function Documentation

◆ appLogic()

◆ appShutdown()

◆ appStartup()

◆ derived()

◆ loadConfig()

◆ onPowerOff()

◆ open()

◆ openThreadExec()

◆ openThreadStart()

◆ setCallBack_powerChannel()

◆ setCallBack_sensorChannel()

◆ setCallBack_triggerChannel()

◆ setShutterState()

◆ setupConfig()

◆ shut()

◆ shutThreadExec()

◆ shutThreadStart()

◆ st_setCallBack_powerChannel()

◆ st_setCallBack_sensorChannel()

◆ st_setCallBack_triggerChannel()

◆ whilePowerOff()

Member Data Documentation

◆ m_dioDevice

◆ m_doOpen

◆ m_doShut

◆ m_indiP_powerChannel

◆ m_indiP_sensorChannel

◆ m_indiP_triggerChannel

◆ m_openThread

◆ m_openThreadID

◆ m_openThreadInit

◆ m_openThreadProp

◆ m_powerChannel

◆ m_powerDevice

◆ m_powerState

◆ m_sensorChannel

◆ m_sensorState

◆ m_shutterTimeout

◆ m_shutterWait

◆ m_shutThread

◆ m_shutThreadID

◆ m_shutThreadInit

◆ m_shutThreadProp

◆ m_triggerChannel

◆ m_triggerState