The MagAO-X Clay Telescope TCS Interface. More...

#include <tcsInterface.hpp>

Inheritance diagram for MagAOX::app::tcsInterface:

Collaboration diagram for MagAOX::app::tcsInterface:

Public Types
typedef XWC_DEFAULT_VERBOSITY	verboseT

typedef logger::logManager< MagAOXApp< _useINDI >, logFileRaw< verboseT > >	logManagerT
	The log manager type.

typedef XWC_DEFAULT_VERBOSITY	verboseT

typedef logger::logManager< tcsInterface, logFileRaw< verboseT > >	logManagerT
	The log manager type.

Public Member Functions
	tcsInterface ()
	Default c'tor.

	~tcsInterface () noexcept
	D'tor, declared and defined for noexcept.

virtual void	setupConfig ()

int	loadConfigImpl (mx::app::appConfigurator &_config)
	Implementation of loadConfig logic, separated for testing.

virtual void	loadConfig ()

virtual int	appStartup ()
	Startup function.

virtual int	appLogic ()
	Implementation of the FSM for tcsInterface.

virtual int	appShutdown ()
	Shutdown the app.

int	getMagTelStatus (std::string &response, const std::string &statreq)

int	sendMagTelCommand (const std::string &command, int timeout)

int	parse_xms (double &x, double &m, double &s, const std::string &xmsstr)

std::vector< std::string >	parse_teldata (std::string &tdat)

int	getTelTime ()

int	getTelPos ()

int	getTelData ()

int	getCatData ()

int	getVaneData ()

int	getEnvData ()

int	badSeeing ()
	Record bad seeing measurements on errors in getSeeing().

int	getSeeing ()
	Query, parse, and record seeing measurements.

int	updateINDI ()

	INDI_SETCALLBACK_DECL (tcsInterface, m_indiP_loopState)

virtual void	setDefaults (int argc, char **argv)
	Set the paths for config files.

virtual void	setupBasicConfig ()
	The basic MagAO-X configuration setup method. Should not normally be overridden.

virtual void	loadBasicConfig ()
	The basic MagAO-X configuration processing method. Should not normally be overridden.

virtual void	checkConfig ()
	Check for unused and unrecognized config options and settings.

virtual int	execute ()
	The execute method implementing the standard main loop. Should not normally be overridden.

int	setupConfig (mx::app::appConfigurator &config)
	Setup an application configurator for the device section.

int	loadConfig (mx::app::appConfigurator &config)
	Load the device section from an application configurator.

int	telem (const typename telT::messageT &msg)
	Make a telemetry recording.

int	setupConfig (appConfigurator &config)
	Setup an application configurator for the device section.

int	loadConfig (appConfigurator &config)
	Load the device section from an application configurator.

int	checkRecordTimes (const telT &tel, telTs... tels)
	Check the time of the last record for each telemetry type and make an entry if needed.

int	checkRecordTimes (timespec &ts, const telT &tel, telTs... tels)
	Worker function to actually perform the record time checking logic.

int	checkRecordTimes (timespec &ts)
	Empty function called at the end of the template list.

Telemeter Interface
int	checkRecordTimes ()

int	recordTelem (const telem_telpos *)

int	recordTelem (const telem_teldata *)

int	recordTelem (const telem_telvane *)

int	recordTelem (const telem_telenv *)

int	recordTelem (const telem_telcat *)

int	recordTelem (const telem_telsee *)

int	recordTelPos (bool force=false)

int	recordTelData (bool force=false)

int	recordTelVane (bool force=false)

int	recordTelEnv (bool force=false)

int	recordTelCat (bool force=false)

int	recordTelSee (bool force=false)

Threads
int	threadStart (std::thread &thrd, bool &thrdInit, pid_t &tpid, pcf::IndiProperty &thProp, int thrdPrio, const std::string &cpuset, const std::string &thrdName, thisPtr *thrdThis, Function &&thrdStart)
	Start a thread, using this class's privileges to set priority, etc.

Member Accessors
std::string	basePath ()
	Get the.

std::string	configName ()
	Get the config name.

std::string	configDir ()
	Get the config directory.

std::string	configBase ()
	Get the config base file.

std::string	calibDir ()
	Get the calibration directory.

std::string	sysPath ()
	Get the system path.

std::string	secretsPath ()
	Get the secrets path.

std::string	cpusetPath ()
	Get the cpuset path.

unsigned long	loopPause ()
	Get the loop pause time.

int	shutdown ()
	Get the value of the shutdown flag.

std::string	driverInName ()
	Get the INDI input FIFO file name.

std::string	driverOutName ()
	Get the INDI output FIFO file name.

std::string	driverCtrlName ()
	Get the INDI control FIFO file name.

Public Attributes
int	m_loopState { 0 }

pcf::IndiProperty	m_indiP_loopState
	Property used to report the loop state.

unsigned	m_readTimeout {1000}
	The read timeout [msec].

unsigned	m_writeTimeout {1000}
	The write timeout [msec].

logManagerT	m_tel

double	m_maxInterval
	The maximum interval, in seconds, between telemetry records. Default is 10.0 seconds.

Protected Attributes
double	m_telST { 0 }

pcf::IndiProperty	m_indiP_teltime

double	m_telEpoch { 0 }

double	m_telRA { 0 }

double	m_telDec { 0 }

double	m_telEl { 0 }

double	m_telHA { 0 }

double	m_telAM { 0 }

double	m_telRotOff { 0 }

pcf::IndiProperty	m_indiP_telpos

double	m_telSecZ { 0 }

double	m_telEncZ { 0 }

double	m_telSecX { 0 }

double	m_telEncX { 0 }

double	m_telSecY { 0 }

double	m_telEncY { 0 }

double	m_telSecH { 0 }

double	m_telEncH { 0 }

double	m_telSecV { 0 }

double	m_telEncV { 0 }

pcf::IndiProperty	m_indiP_vaneend
	INDI Property for the vane end positions.

double	m_wxtemp { 0 }
	Outside temperature, Celsius.

double	m_wxpres { 0 }
	Outside pressue, millibars.

double	m_wxhumid { 0 }
	Outside humidity, percent.

double	m_wxwind { 0 }
	outside wind intensity, mph

double	m_wxwdir { 0 }
	outside wind direction, degrees

double	m_ttruss { 0 }
	Telescope truss temperature, Celsius.

double	m_tcell { 0 }
	Primary mirror cell temperature, Celsius.

double	m_tseccell { 0 }
	Secondary mirror cell temperature, Celsius.

double	m_tambient { 0 }
	Dome air temperature, Celsius.

double	m_wxdewpoint { 0 }
	Dew point from weather station.

pcf::IndiProperty	m_indiP_env
	INDI Property for environment.

double	m_dimm_el { 0 }
	DIMM elevation at time of seeing measurement.

double	m_dimm_fwhm_corr { 0 }
	DIMM elevation corrected FWHM.

int	m_dimm_time { 0 }
	Seconds since midnight of DIMM measurement.

double	m_mag1_fwhm_corr { 0 }
	MAG1 elevation corrected FWHM.

int	m_mag1_time { 0 }
	Seconds since midnight of MAG1 measurement.

double	m_mag2_fwhm_corr { 0 }
	MAG2 elevation corrected FWHM.

int	m_mag2_time { 0 }
	Seconds since midnight of MAG2 measurement.

pcf::IndiProperty	m_indiP_seeing
	INDI Property for seeing.

std::string	m_basePath
	The base path of the MagAO-X system.

std::string	m_configName
	The name of the configuration file (minus .conf).

std::string	m_configDir
	The path to configuration files for MagAOX.

std::string	m_configBase
	The name of a base config class for this app (minus .conf).

std::string	m_calibDir
	The path to calibration files for MagAOX.

std::string	m_sysPath
	The path to the system directory, for PID file, etc.

std::string	m_secretsPath
	Path to the secrets directory, where passwords, etc, are stored.

std::string	m_cpusetPath
	Path to the cpusets mount.

unsigned long	m_loopPause

int	m_shutdown
	Flag to signal it's time to shutdown. When not 0, the main loop exits.

TCS Networking
std::string	m_deviceAddr { "localhost" }
	The IP address or resolvable name of the TCS.

int	m_devicePort { 5811 }
	The IP port for TCS communications. Should be the command port. Default is 5811.

int	m_seeingInterval { 2 }

std::mutex	m_tcsMutex
	Mutex for locking TCS communications.

tty::netSerial	m_sock

Telescope Data
int	m_telROI { 0 }
	The rotator of interest.

int	m_telTracking { 0 }
	tracking state

int	m_telGuiding { 0 }
	guider moving state

int	m_telSlewing { 0 }
	slewing state

int	m_telGuiderMoving { 0 }
	guider moving state

double	m_telAz { 0 }
	azimuth

double	m_telZd { 0 }
	zenith distance

double	m_telPA { 0 }
	parallactic angle

double	m_telDomeAz { 0 }
	dome azimuth

int	m_telDomeStat { 0 }
	dome status

pcf::IndiProperty	m_indiP_teldata

Telescope Catalog Information
double	m_catRA { 0 }
	Catalog right ascension [degrees].

double	m_catDec { 0 }
	Catalog declination [degrees].

double	m_catEp { 0 }
	Catalog epoch.

double	m_catRo { 0 }
	Catalog rotator offset.

std::string	m_catRm
	Catalog rotator mode.

std::string	m_catObj
	Catalog object name.

pcf::IndiProperty	m_indiP_catalog
	INDI Property for the catalog text information.

pcf::IndiProperty	m_indiP_catdata
	INDI Property for the catalog data.

Private Member Functions
int	clearFSMAlert ()
	Clear the FSM alert state.

tcsInterface &	derived ()
	Access the derived class.

Friends
class	tcsInterface_test

class	dev::telemeter< tcsInterface >

lab mode
bool	m_labMode { true }

pcf::IndiProperty	m_indiP_labMode

	INDI_NEWCALLBACK_DECL (tcsInterface, m_indiP_labMode)

PID Locking
Each MagAOXApp has a PID lock file in the system directory. The app will not startup if it detects that the PID is already locked, preventing duplicates. This is based on the configured name, not the invoked name (argv[0]).
std::string	pidFileName
	The name of the PID file.

pid_t	m_pid
	This process's PID.

int	lockPID ()

int	unlockPID ()
	Remove the PID file.

INDI Interface
For reference: "Get" and "New" refer to properties we own. "Set" refers to properties owned by others. So we respond to GetProperties by listing our own properties, and NewProperty is a request to change a property we own. Whereas SetProperty is a notification that someone else has changed a property.
std::unordered_map< std::string, indiCallBack >	m_indiNewCallBacks
	Map to hold the NewProperty indiCallBacks for this App, with fast lookup by property name.

std::unordered_map< std::string, indiCallBack >	m_indiSetCallBacks
	Map to hold the SetProperty indiCallBacks for this App, with fast lookup by property name.

bool	m_allDefsReceived
	Flag indicating that all registered Set properties have been updated since last Get.

std::string	m_driverInName
	Full path name of the INDI driver input FIFO.

std::string	m_driverOutName
	Full path name of the INDI driver output FIFO.

std::string	m_driverCtrlName
	Full path name of the INDI driver control FIFO.

pcf::IndiProperty	m_indiP_state
	indi Property to report the application state.

pcf::IndiProperty	m_indiP_clearFSMAlert
	indi Property to clear an FSM alert.

indiDriver< MagAOXApp > *	m_indiDriver
	The INDI driver wrapper. Constructed and initialized by execute, which starts and stops communications.

std::mutex	m_indiMutex
	Mutex for locking INDI communications.

int	createINDIFIFOS ()
	Create the INDI FIFOs.

int	startINDI ()
	Start INDI Communications.

void	updateIfChanged (pcf::IndiProperty &p, const std::string &el, const T &newVal, pcf::IndiProperty::PropertyStateType ipState=pcf::IndiProperty::Ok)
	Update an INDI property element value if it has changed.

void	updateIfChanged (pcf::IndiProperty &p, const std::string &el, const char *newVal, pcf::IndiProperty::PropertyStateType ipState=pcf::IndiProperty::Ok)
	Update an INDI property element value if it has changed.

void	updateIfChanged (pcf::IndiProperty &p, const std::string &el, const std::vector< T > &newVals, pcf::IndiProperty::PropertyStateType ipState=pcf::IndiProperty::Ok)
	Update an INDI property if values have changed.

void	updateIfChanged (pcf::IndiProperty &p, const std::vector< std::string > &els, const std::vector< T > &newVals, pcf::IndiProperty::PropertyStateType newState=pcf::IndiProperty::Ok)
	Update an INDI property if values have changed.

void	updateSwitchIfChanged (pcf::IndiProperty &p, const std::string &el, const pcf::IndiElement::SwitchStateType &newVal, pcf::IndiProperty::PropertyStateType ipState=pcf::IndiProperty::Ok)
	Update an INDI switch element value if it has changed.

void	updatesIfChanged (pcf::IndiProperty &p, const std::vector< const char * > &els, const std::vector< T > &newVals, pcf::IndiProperty::PropertyStateType newState=pcf::IndiProperty::Ok)

int	indiTargetUpdate (pcf::IndiProperty &localProperty, T &localTarget, const pcf::IndiProperty &remoteProperty, bool setBusy=true)
	Get the target element value from an new property.

int	sendNewProperty (const pcf::IndiProperty &ipSend, const std::string &el, const T &newVal)
	Send a newProperty command to another device (using the INDI Client interface)

int	sendNewProperty (const pcf::IndiProperty &ipSend)
	Send a newProperty command to another device (using the INDI Client interface)

int	sendNewStandardIndiToggle (const std::string &device, const std::string &property, bool onoff)
	Send a new property commmand for a standard toggle switch.

int	newCallBack_clearFSMAlert (const pcf::IndiProperty &ipRecv)
	The callback called by the static version, to actually process the FSM Alert Clear request.

int	createStandardIndiText (pcf::IndiProperty &prop, const std::string &propName, const std::string &label="", const std::string &group="")
	Create a standard R/W INDI Text property with target and current elements.

int	createROIndiText (pcf::IndiProperty &prop, const std::string &propName, const std::string &elName, const std::string &propLabel="", const std::string &propGroup="", const std::string &elLabel="")
	Create a standard ReadOnly INDI Text property, with at least one element.

int	createStandardIndiNumber (pcf::IndiProperty &prop, const std::string &name, const T &min, const T &max, const T &step, const std::string &format, const std::string &label="", const std::string &group="")
	Create a standard R/W INDI Number property with target and current elements.

int	createROIndiNumber (pcf::IndiProperty &prop, const std::string &propName, const std::string &propLabel="", const std::string &propGroup="")
	Create a ReadOnly INDI Number property.

int	createStandardIndiToggleSw (pcf::IndiProperty &prop, const std::string &name, const std::string &label="", const std::string &group="")
	Create a standard R/W INDI switch with a single toggle element.

int	createStandardIndiRequestSw (pcf::IndiProperty &prop, const std::string &name, const std::string &label="", const std::string &group="")
	Create a standard R/W INDI switch with a single request element.

int	createStandardIndiSelectionSw (pcf::IndiProperty &prop, const std::string &name, const std::vector< std::string > &elements, const std::vector< std::string > &elementLabels, const std::string &label="", const std::string &group="")
	Create a standard R/W INDI selection (one of many) switch with vector of elements and element labels.

int	createStandardIndiSelectionSw (pcf::IndiProperty &prop, const std::string &name, const std::vector< std::string > &elements, const std::string &label="", const std::string &group="")

int	registerIndiPropertyReadOnly (pcf::IndiProperty &prop)
	Register an INDI property which is read only.

int	registerIndiPropertyReadOnly (pcf::IndiProperty &prop, const std::string &propName, const pcf::IndiProperty::Type &propType, const pcf::IndiProperty::PropertyPermType &propPerm, const pcf::IndiProperty::PropertyStateType &propState)
	Register an INDI property which is read only.

int	registerIndiPropertyNew (pcf::IndiProperty &prop, int()(void , const pcf::IndiProperty &))
	Register an INDI property which is exposed for others to request a New Property for.

int	registerIndiPropertyNew (pcf::IndiProperty &prop, const std::string &propName, const pcf::IndiProperty::Type &propType, const pcf::IndiProperty::PropertyPermType &propPerm, const pcf::IndiProperty::PropertyStateType &propState, int()(void , const pcf::IndiProperty &))
	Register an INDI property which is exposed for others to request a New Property for.

int	registerIndiPropertyNew (pcf::IndiProperty &prop, const std::string &propName, const pcf::IndiProperty::Type &propType, const pcf::IndiProperty::PropertyPermType &propPerm, const pcf::IndiProperty::PropertyStateType &propState, const pcf::IndiProperty::SwitchRuleType &propRule, int()(void , const pcf::IndiProperty &))
	Register an INDI property which is exposed for others to request a New Property for, with a switch rule.

int	registerIndiPropertySet (pcf::IndiProperty &prop, const std::string &devName, const std::string &propName, int()(void , const pcf::IndiProperty &))
	Register an INDI property which is monitored for updates from others.

void	sendGetPropertySetList (bool all=false)

void	handleDefProperty (const pcf::IndiProperty &ipRecv)
	Handler for the DEF INDI properties notification.

void	handleGetProperties (const pcf::IndiProperty &ipRecv)
	Handler for the get INDI properties request.

void	handleNewProperty (const pcf::IndiProperty &ipRecv)
	Handler for the new INDI property request.

void	handleSetProperty (const pcf::IndiProperty &ipRecv)
	Handler for the set INDI property request.

typedef std::pair< std::string, indiCallBack >	callBackValueType
	Value type of the indiCallBack map.

typedef std::unordered_map< std::string, indiCallBack >::iterator	callBackIterator
	Iterator type of the indiCallBack map.

typedef std::pair< callBackIterator, bool >	callBackInsertResult
	Return type of insert on the indiCallBack map.

static constexpr bool	m_useINDI
	Flag controlling whether INDI is used. If false, then no INDI code executes.

static int	st_newCallBack_clearFSMAlert (void *app, const pcf::IndiProperty &ipRecv)
	The static callback function to be registered for requesting to clear the FSM alert.

Power Management
For devices which have remote power management (e.g. from one of the PDUs) we implement a standard power state monitoring and management component for the FSM. This needs to be enabled in the derived app constructor. To stay enabled, m_powerDevice and m_powerChannel must be not empty strings after the configuration. These could be set in the derived app defaults. If power management is enabled, then while power is off, appLogic will not be called. Instead a parrallel set of virtual functions is called, onPowerOff (to allow apps to perform cleanup) and whilePowerOff (to allow apps to keep variables updated, etc). Note that these could merely call appLogic if desired.
bool	m_powerMgtEnabled

std::string	m_powerDevice
	The INDI device name of the power controller.

std::string	m_powerChannel
	The INDI property name of the channel controlling this device's power.

std::string	m_powerElement
	The INDI element name to monitor for this device's power state.

std::string	m_powerTargetElement
	The INDI element name to monitor for this device's power state.

unsigned long	m_powerOnWait
	Time in sec to wait for device to boot after power on.

int	m_powerOnCounter

int	m_powerState
	Current power state, 1=On, 0=Off, -1=Unk.

int	m_powerTargetState
	Current target power state, 1=On, 0=Off, -1=Unk.

pcf::IndiProperty	m_indiP_powerChannel
	INDI property used to communicate power state.

virtual int	onPowerOff ()
	This method is called when the change to poweroff is detected.

virtual int	whilePowerOff ()
	This method is called while the power is off, once per FSM loop.

bool	powerOnWaitElapsed ()
	This method tests whether the power on wait time has elapsed.

int	powerState ()
	Returns the current power state.

int	powerStateTarget ()
	Returns the target power state.

	INDI_SETCALLBACK_DECL (MagAOXApp, m_indiP_powerChannel)

Pyramid Nudging and Acquisition
Handling of nudges on pyramid tip.
float	m_pyrNudge_C_00 { 1 }

float	m_pyrNudge_C_01 { 0 }

float	m_pyrNudge_C_10 { 0 }

float	m_pyrNudge_C_11 { 1 }

float	m_pyrNudge_F_sign { 1 }

float	m_pyrNudge_ang { 45.0 }

float	m_pyrNudge_ang0 { 0.0 }

float	m_pyrNudge_parity { -1 }

pcf::IndiProperty	m_indiP_pyrNudge
	Property used to request a pyramid nudge.

int	m_acqZdSign { -1 }

float	m_acqAz0 { 18.5 }

float	m_acqAzOff { 0 }

float	m_acqEl0 { 10 }

float	m_acqElOff { 0 }

float	m_acqFocus { 1400 }

pcf::IndiProperty	m_indiP_acqFromGuider
	Property used to request a pyramid nudge.

int	sendPyrNudge (float x, float y, float z)

	INDI_NEWCALLBACK_DECL (tcsInterface, m_indiP_pyrNudge)

int	acquireFromGuider ()

	INDI_NEWCALLBACK_DECL (tcsInterface, m_indiP_acqFromGuider)

Woofer Offloading
Handling of offloads from the average woofer shape to the telescope
bool	m_offloadThreadInit { true }
	Initialization flag for the offload thread.

pid_t	m_offloadThreadID { 0 }
	Offload thread pid.

pcf::IndiProperty	m_offloadThreadProp
	Offload thread INDI property.

std::thread	m_offloadThread
	The offloading thread.

pcf::IndiProperty	m_indiP_offloadCoeffs
	Property used to report the latest woofer modal coefficients for offloading.

std::vector< std::vector< float > >	m_offloadRequests

size_t	m_firstRequest { 0 }

size_t	m_lastRequest { std::numeric_limits<size_t>::max() }

size_t	m_nRequests { 0 }

size_t	m_last_nRequests { 0 }

float	m_lab_offlTT_C_00 { 0.17 }

float	m_lab_offlTT_C_01 { 1.03 }

float	m_lab_offlTT_C_10 { -1.03 }

float	m_lab_offlTT_C_11 { 0.48 }

float	m_offlTT_C_00 { -0.5 }

float	m_offlTT_C_01 { 0 }

float	m_offlTT_C_10 { 0 }

float	m_offlTT_C_11 { -0.25 }

bool	m_offlTT_enabled { false }

bool	m_offlTT_dump { false }

float	m_offlTT_avgInt { 1.0 }

float	m_offlTT_gain { 0.1 }

float	m_offlTT_thresh { 0.1 }

pcf::IndiProperty	m_indiP_offlTTenable

pcf::IndiProperty	m_indiP_offlTTdump

pcf::IndiProperty	m_indiP_offlTTavgInt

pcf::IndiProperty	m_indiP_offlTTgain

pcf::IndiProperty	m_indiP_offlTTthresh

float	m_offlCFocus_00 { 1 }

bool	m_offlF_enabled { false }

bool	m_offlF_dump { false }

float	m_offlF_avgInt { 1.0 }

float	m_offlF_gain { 0.1 }

float	m_offlF_thresh { 0.1 }

pcf::IndiProperty	m_indiP_offlFenable

pcf::IndiProperty	m_indiP_offlFdump

pcf::IndiProperty	m_indiP_offlFavgInt

pcf::IndiProperty	m_indiP_offlFgain

pcf::IndiProperty	m_indiP_offlFthresh

float	m_offlCComa_00 { 1 }

float	m_offlCComa_01 { 0 }

float	m_offlCComa_10 { 1 }

float	m_offlCComa_11 { 0 }

void	offloadThreadExec ()
	Offload thread function.

int	doTToffload (float TT_0, float TT_1)

int	sendTToffload (float TT_0, float TT_1)

int	doFoffload (float F_0)

int	sendFoffload (float F_0)

	INDI_SETCALLBACK_DECL (tcsInterface, m_indiP_offloadCoeffs)

	INDI_NEWCALLBACK_DECL (tcsInterface, m_indiP_offlTTenable)

	INDI_NEWCALLBACK_DECL (tcsInterface, m_indiP_offlTTdump)

	INDI_NEWCALLBACK_DECL (tcsInterface, m_indiP_offlTTavgInt)

	INDI_NEWCALLBACK_DECL (tcsInterface, m_indiP_offlTTgain)

	INDI_NEWCALLBACK_DECL (tcsInterface, m_indiP_offlTTthresh)

	INDI_NEWCALLBACK_DECL (tcsInterface, m_indiP_offlFenable)

	INDI_NEWCALLBACK_DECL (tcsInterface, m_indiP_offlFdump)

	INDI_NEWCALLBACK_DECL (tcsInterface, m_indiP_offlFavgInt)

	INDI_NEWCALLBACK_DECL (tcsInterface, m_indiP_offlFgain)

	INDI_NEWCALLBACK_DECL (tcsInterface, m_indiP_offlFthresh)

static void	offloadThreadStart (tcsInterface *t)
	Offload thread starter function.

Logging
void	logMessage (bufferPtrT &b)
	Handle a log message from the logging system.

static int	log (const typename logT::messageT &msg, logPrioT level=logPrio::LOG_DEFAULT)
	Make a log entry.

static int	log (logPrioT level=logPrio::LOG_DEFAULT)
	Make a log entry.

static logManagerT	m_log

static void	configLog (const std::string &name, const int &code, const std::string &value, const std::string &source)
	Callback for config system logging.

Application State
stateCodes::stateCodeT	state ()
	Get the current state code.

void	state (const stateCodes::stateCodeT &s, bool stateAlert=false)
	Set the current state code.

bool	stateAlert ()
	Get the value of the state alert flag.

bool	gitAlert ()
	Get the value of the git alert flag.

int	stateLogged ()
	Updates and returns the value of m_stateLogged. Will be 0 on first call after a state change, >0 afterwards.

stateCodes::stateCodeT	m_state

bool	m_stateAlert

bool	m_gitAlert

int	m_stateLogged

Signal Handling
libMagAOX/logger/types/software_log.hpp
static MagAOXApp *	m_self

int	setSigTermHandler ()
	Sets the handler for SIGTERM, SIGQUIT, and SIGINT.

void	handlerSigTerm (int signum, siginfo_t siginf, void ucont)
	Handles SIGTERM, SIGQUIT, and SIGINT. Sets m_shutdown to 1 and logs the signal.

static void	_handlerSigTerm (int signum, siginfo_t siginf, void ucont)
	The handler called when SIGTERM, SIGQUIT, or SIGINT is received. Just a wrapper for handlerSigTerm.

Privilege Management
uid_t	m_euidReal
	The real user id of the proces (i.e. the lower privileged id of the user)

uid_t	m_euidCalled

uid_t	m_suid
	The save-set user id of the process.

int	setEuidCalled ()
	Set the effective user ID to the called value, i.e. the highest possible.

int	setEuidReal ()
	Set the effective user ID to the real value, i.e. the file owner.

Detailed Description

The MagAO-X Clay Telescope TCS Interface.

Definition at line 42 of file tcsInterface.hpp.

Member Typedef Documentation

◆ callBackInsertResult

typedef std::pair<callBackIterator, bool> MagAOX::app::MagAOXApp< _useINDI >::callBackInsertResult

inherited

Return type of insert on the indiCallBack map.

Definition at line 673 of file MagAOXApp.hpp.

◆ callBackIterator

typedef std::unordered_map<std::string,indiCallBack>::iterator MagAOX::app::MagAOXApp< _useINDI >::callBackIterator

inherited

Iterator type of the indiCallBack map.

Definition at line 670 of file MagAOXApp.hpp.

◆ callBackValueType

typedef std::pair<std::string, indiCallBack> MagAOX::app::MagAOXApp< _useINDI >::callBackValueType

inherited

Value type of the indiCallBack map.

Definition at line 667 of file MagAOXApp.hpp.

◆ logManagerT [1/2]

typedef logger::logManager<tcsInterface , logFileRaw<verboseT> > MagAOX::app::dev::telemeter< tcsInterface >::logManagerT

inherited

The log manager type.

Definition at line 79 of file telemeter.hpp.

◆ logManagerT [2/2]

typedef logger::logManager<MagAOXApp<_useINDI>, logFileRaw<verboseT> > MagAOX::app::MagAOXApp< _useINDI >::logManagerT

inherited

The log manager type.

Definition at line 174 of file MagAOXApp.hpp.

◆ verboseT [1/2]

typedef XWC_DEFAULT_VERBOSITY MagAOX::app::dev::telemeter< tcsInterface >::verboseT

inherited

Definition at line 76 of file telemeter.hpp.

◆ verboseT [2/2]

typedef XWC_DEFAULT_VERBOSITY MagAOX::app::MagAOXApp< _useINDI >::verboseT

inherited

Definition at line 171 of file MagAOXApp.hpp.

Constructor & Destructor Documentation

◆ tcsInterface()

MagAOX::app::tcsInterface::tcsInterface ( )

inline

Default c'tor.

Definition at line 404 of file tcsInterface.hpp.

◆ ~tcsInterface()

MagAOX::app::tcsInterface::~tcsInterface ( )

inlinenoexcept

D'tor, declared and defined for noexcept.

Definition at line 170 of file tcsInterface.hpp.

Member Function Documentation

◆ _handlerSigTerm()

void MagAOX::app::MagAOXApp< _useINDI >::_handlerSigTerm	(	int	signum,
		siginfo_t *	siginf,
		void *	ucont
	)

staticprivateinherited

The handler called when SIGTERM, SIGQUIT, or SIGINT is received. Just a wrapper for handlerSigTerm.

Parameters

[in]	signum	specifies the signal.
[in]	siginf	ignored by MagAOXApp
[in]	ucont	ignored by MagAOXApp

Definition at line 393 of file MagAOXApp.hpp.

◆ acquireFromGuider()

int MagAOX::app::tcsInterface::acquireFromGuider ( )

Todo:: need logtypes for nudges and offloads

Definition at line 2833 of file tcsInterface.hpp.

References MagAOX::app::MagAOXApp< true >::log(), flatlogs::logPrio::LOG_NOTICE, m_acqAz0, m_acqAzOff, m_acqEl0, m_acqElOff, m_acqFocus, m_acqZdSign, m_pyrNudge_F_sign, MagAOX::app::dev::ioDevice::m_readTimeout, m_telZd, and sendMagTelCommand().

◆ appLogic()

int MagAOX::app::tcsInterface::appLogic ( )

inlinevirtual

Implementation of the FSM for tcsInterface.

Returns: 0 on no critical error; -1 on an error requiring shutdown

Implements MagAOX::app::MagAOXApp< true >.

Definition at line 1192 of file tcsInterface.hpp.

References MagAOX::app::stateCodes::CONNECTED, MagAOX::app::stateCodes::ERROR, getCatData(), getEnvData(), getSeeing(), getTelData(), getTelPos(), getTelTime(), getVaneData(), MagAOX::app::MagAOXApp< true >::log(), flatlogs::logPrio::LOG_ERROR, flatlogs::logPrio::LOG_WARNING, m_deviceAddr, m_devicePort, m_sock, MagAOX::app::stateCodes::NOTCONNECTED, MagAOX::tty::netSerial::serialInit(), MagAOX::app::MagAOXApp< true >::state(), MagAOX::app::MagAOXApp< true >::stateLogged(), MagAOX::tty::ttyErrorString(), and updateINDI().

◆ appShutdown()

int MagAOX::app::tcsInterface::appShutdown ( )

inlinevirtual

Shutdown the app.

Implements MagAOX::app::MagAOXApp< true >.

Definition at line 1303 of file tcsInterface.hpp.

References m_offloadThread.

◆ appStartup()

int MagAOX::app::tcsInterface::appStartup ( )

inlinevirtual

Startup function.

Implements MagAOX::app::MagAOXApp< true >.

Definition at line 789 of file tcsInterface.hpp.

References MagAOX::app::dev::ioDevice::appStartup(), CREATE_REG_INDI_NEW_TOGGLESWITCH, MagAOX::app::MagAOXApp< true >::createROIndiNumber(), MagAOX::app::MagAOXApp< true >::createROIndiText(), MagAOX::app::MagAOXApp< true >::createStandardIndiNumber(), MagAOX::app::MagAOXApp< true >::createStandardIndiRequestSw(), MagAOX::app::MagAOXApp< true >::createStandardIndiToggleSw(), INDI_OK, MagAOX::app::MagAOXApp< true >::log(), flatlogs::logPrio::LOG_NOTICE, m_catDec, m_catEp, m_catRA, m_catRo, m_dimm_fwhm_corr, m_dimm_time, m_indiP_acqFromGuider, m_indiP_catalog, m_indiP_catdata, m_indiP_env, m_indiP_labMode, m_indiP_loopState, m_indiP_offlFavgInt, m_indiP_offlFdump, m_indiP_offlFenable, m_indiP_offlFgain, m_indiP_offlFthresh, m_indiP_offloadCoeffs, m_indiP_offlTTavgInt, m_indiP_offlTTdump, m_indiP_offlTTenable, m_indiP_offlTTgain, m_indiP_offlTTthresh, m_indiP_pyrNudge, m_indiP_seeing, m_indiP_teldata, m_indiP_telpos, m_indiP_teltime, m_indiP_vaneend, m_labMode, m_mag1_fwhm_corr, m_mag1_time, m_mag2_fwhm_corr, m_mag2_time, m_offlF_avgInt, m_offlF_gain, m_offlF_thresh, m_offloadRequests, m_offloadThread, m_offloadThreadID, m_offloadThreadInit, m_offloadThreadProp, m_offlTT_avgInt, m_offlTT_gain, m_offlTT_thresh, m_tambient, m_tcell, m_telAM, m_telAz, m_telDec, m_telDomeAz, m_telDomeStat, m_telEl, m_telEncH, m_telEncV, m_telEncX, m_telEncY, m_telEncZ, m_telEpoch, m_telGuiderMoving, m_telGuiding, m_telHA, m_telPA, m_telRA, m_telROI, m_telRotOff, m_telSecH, m_telSecV, m_telSecX, m_telSecY, m_telSecZ, m_telSlewing, m_telST, m_telTracking, m_telZd, m_tseccell, m_ttruss, m_wxdewpoint, m_wxhumid, m_wxpres, m_wxtemp, m_wxwdir, m_wxwind, MagAOX::app::stateCodes::NOTCONNECTED, offloadThreadStart(), REG_INDI_NEWPROP, REG_INDI_SETPROP, MagAOX::app::MagAOXApp< true >::registerIndiPropertyNew(), MagAOX::app::MagAOXApp< true >::registerIndiPropertyReadOnly(), resize(), MagAOX::app::MagAOXApp< true >::state(), MagAOX::app::MagAOXApp< true >::threadStart(), and MagAOX::app::MagAOXApp< true >::updateSwitchIfChanged().

◆ badSeeing()

int MagAOX::app::tcsInterface::badSeeing ( )

Record bad seeing measurements on errors in getSeeing().

Definition at line 1952 of file tcsInterface.hpp.

References MagAOX::app::MagAOXApp< true >::log(), m_dimm_fwhm_corr, m_dimm_time, m_mag1_fwhm_corr, m_mag1_time, m_mag2_fwhm_corr, m_mag2_time, and recordTelSee().

Referenced by getSeeing().

◆ basePath()

std::string MagAOX::app::MagAOXApp< _useINDI >::basePath ( )

inherited

Get the.

Returns: the value of m_ *

Definition at line 1208 of file MagAOXApp.hpp.

◆ calibDir()

std::string MagAOX::app::MagAOXApp< _useINDI >::calibDir ( )

inherited

Get the calibration directory.

Returns: the value of m_calibDir

Definition at line 1230 of file MagAOXApp.hpp.

◆ checkConfig()

void MagAOX::app::MagAOXApp< _useINDI >::checkConfig ( )

virtualinherited

Check for unused and unrecognized config options and settings.

Logs the unused targets as warnings. Unrecognized and unused options are logged as critical, and m_shutdown is set. Any command line argument (not an option) will also be critical and cause shutdown.

Definition at line 267 of file MagAOXApp.hpp.

◆ checkRecordTimes() [1/4]

int MagAOX::app::tcsInterface::checkRecordTimes ( )

inline

Definition at line 2537 of file tcsInterface.hpp.

References MagAOX::app::MagAOXApp< true >::log().

◆ checkRecordTimes() [2/4]

int MagAOX::app::dev::telemeter< tcsInterface >::checkRecordTimes	(	const telT &	tel,
		telTs...	tels
	)

inherited

Check the time of the last record for each telemetry type and make an entry if needed.

This must be called from derivedT::checkRecordTimes(), with one template parameter for ach telemetry log type being recorded.

Returns: 0 on succcess; -1 on error

Parameters

[in]	tel	[unused] object of the telemetry type to record
[in]	tels	[unused] objects of the additional telemetry types to record

Definition at line 156 of file telemeter.hpp.

◆ checkRecordTimes() [3/4]

int MagAOX::app::dev::telemeter< tcsInterface >::checkRecordTimes ( timespec & ts )

inherited

Empty function called at the end of the template list.

Returns: 0 on succcess; -1 on error

Parameters

[in] ts [unused] the timestamp that records are compared to

Definition at line 177 of file telemeter.hpp.

◆ checkRecordTimes() [4/4]

int MagAOX::app::dev::telemeter< tcsInterface >::checkRecordTimes	(	timespec &	ts,
		const telT &	tel,
		telTs...	tels
	)

inherited

Worker function to actually perform the record time checking logic.

Recursively calls itself until the variadic template list is exhausted.

Returns: 0 on succcess; -1 on error

Parameters

[in]	ts	[unused] the timestamp that records are compared to
[in]	tel	[unused] objects of the telemetry type to record
[in]	tels	[unused] objects of the additional telemetry types to record

Definition at line 167 of file telemeter.hpp.

◆ clearFSMAlert()

int MagAOX::app::MagAOXApp< _useINDI >::clearFSMAlert ( )

privateinherited

Clear the FSM alert state.

This can only be done from within this class, and this should only be possible via user action via INDI.

Definition at line 631 of file MagAOXApp.hpp.

◆ configBase()

std::string MagAOX::app::MagAOXApp< _useINDI >::configBase ( )

inherited

Get the config base file.

Returns: the value of m_confgBase

Definition at line 1225 of file MagAOXApp.hpp.

◆ configDir()

std::string MagAOX::app::MagAOXApp< _useINDI >::configDir ( )

inherited

Get the config directory.

Returns: the current value of m_configDir

Definition at line 1220 of file MagAOXApp.hpp.

◆ configLog()

void MagAOX::app::MagAOXApp< _useINDI >::configLog	(	const std::string &	name,
		const int &	code,
		const std::string &	value,
		const std::string &	source
	)

staticprotectedinherited

Callback for config system logging.

Called by appConfigurator each time a value is set using the config() operator. You never need to call this directly.

Parameters

[in]	name	The name of the config value
[in]	code	numeric code specifying the type
[in]	value	the value read by the config system
[in]	source	the source of the value.

Definition at line 373 of file MagAOXApp.hpp.

◆ configName()

std::string MagAOX::app::MagAOXApp< _useINDI >::configName ( )

inherited

Get the config name.

Returns: the current value of m_configName

Definition at line 1214 of file MagAOXApp.hpp.

◆ cpusetPath()

std::string MagAOX::app::MagAOXApp< _useINDI >::cpusetPath ( )

inherited

Get the cpuset path.

Returns: the value of m_cpusetPath

Definition at line 1245 of file MagAOXApp.hpp.

◆ createINDIFIFOS()

int MagAOX::app::MagAOXApp< _useINDI >::createINDIFIFOS ( )

protectedinherited

Create the INDI FIFOs.

Changes permissions to max available and creates the FIFOs at the configured path.

Todo:: make driver FIFO path full configurable.

Definition at line 917 of file MagAOXApp.hpp.

◆ createROIndiNumber()

int MagAOX::app::MagAOXApp< _useINDI >::createROIndiNumber	(	pcf::IndiProperty &	prop,
		const std::string &	propName,
		const std::string &	propLabel = `""`,
		const std::string &	propGroup = `""`
	)

inherited

Create a ReadOnly INDI Number property.

Returns: 0 on success; -1 on error

Parameters

[out]	prop	the property to create and setup
[in]	propName	the name of the property
[in]	propLabel	[optional] the GUI label suggestion for this property
[in]	propGroup	[optional] the group for this property

Definition at line 755 of file MagAOXApp.hpp.

◆ createROIndiText()

int MagAOX::app::MagAOXApp< _useINDI >::createROIndiText	(	pcf::IndiProperty &	prop,
		const std::string &	propName,
		const std::string &	elName,
		const std::string &	propLabel = `""`,
		const std::string &	propGroup = `""`,
		const std::string &	elLabel = `""`
	)

inherited

Create a standard ReadOnly INDI Text property, with at least one element.

Returns: 0 on success; -1 on error

Parameters

[out]	prop	the property to create and setup
[in]	propName	the name of the property
[in]	elName	the name of the element
[in]	propLabel	[optional] the GUI label suggestion for this property
[in]	propGroup	[optional] the group for this property
[in]	elLabel	[optional] the GUI label suggestion for the element

Definition at line 720 of file MagAOXApp.hpp.

◆ createStandardIndiNumber()

int MagAOX::app::MagAOXApp< _useINDI >::createStandardIndiNumber	(	pcf::IndiProperty &	prop,
		const std::string &	name,
		const T &	min,
		const T &	max,
		const T &	step,
		const std::string &	format,
		const std::string &	label = `""`,
		const std::string &	group = `""`
	)

inherited

Create a standard R/W INDI Number property with target and current elements.

Returns: 0 on success; -1 on error

Parameters

[out]	prop	the property to create and setup
[in]	name	the name of the property
[in]	min	the minimum value for the elements, applied to both target and current
[in]	max	the minimum value for the elements, applied to both target and current
[in]	step	the step size for the elements, applied to both target and current
[in]	format	the _ value for the elements, applied to both target and current. Set to "" to use the MagAO-X standard for type.
[in]	label	[optional] the GUI label suggestion for this property
[in]	group	[optional] the group for this property

Definition at line 734 of file MagAOXApp.hpp.

◆ createStandardIndiRequestSw()

int MagAOX::app::MagAOXApp< _useINDI >::createStandardIndiRequestSw	(	pcf::IndiProperty &	prop,
		const std::string &	name,
		const std::string &	label = `""`,
		const std::string &	group = `""`
	)

inherited

Create a standard R/W INDI switch with a single request element.

This switch is intended to function like a momentary switch.

Returns: 0 on success; -1 on error

Parameters

[out]	prop	the property to create and setup
[in]	name	the name of the property
[in]	label	[optional] the GUI label suggestion for this property
[in]	group	[optional] the group for this property

Definition at line 781 of file MagAOXApp.hpp.

◆ createStandardIndiSelectionSw() [1/2]

int MagAOX::app::MagAOXApp< _useINDI >::createStandardIndiSelectionSw	(	pcf::IndiProperty &	prop,
		const std::string &	name,
		const std::vector< std::string > &	elements,
		const std::string &	label = `""`,
		const std::string &	group = `""`
	)

inherited

Create a standard R/W INDI selection (one of many) switch with vector of elements using the element strings as their own labels This switch is intended to function like drop down menu.

Returns: 0 on success; -1 on error

Parameters

[out]	prop	the property to create and setup
[in]	name	the name of the property,
[in]	elements	the element names to give to the switches
[in]	label	[optional] the GUI label suggestion for this property
[in]	group	[optional] the group for this property

Definition at line 812 of file MagAOXApp.hpp.

◆ createStandardIndiSelectionSw() [2/2]

int MagAOX::app::MagAOXApp< _useINDI >::createStandardIndiSelectionSw	(	pcf::IndiProperty &	prop,
		const std::string &	name,
		const std::vector< std::string > &	elements,
		const std::vector< std::string > &	elementLabels,
		const std::string &	label = `""`,
		const std::string &	group = `""`
	)

inherited

Create a standard R/W INDI selection (one of many) switch with vector of elements and element labels.

This switch is intended to function like drop down menu.

Returns: 0 on success; -1 on error

Parameters

[out]	prop	the property to create and setup
[in]	name	the name of the property,
[in]	elements	the element names to give to the switches
[in]	elementLabels	the element labels to give to the switches
[in]	label	[optional] the GUI label suggestion for this property
[in]	group	[optional] the group for this property

Definition at line 794 of file MagAOXApp.hpp.

◆ createStandardIndiText()

int MagAOX::app::MagAOXApp< _useINDI >::createStandardIndiText	(	pcf::IndiProperty &	prop,
		const std::string &	propName,
		const std::string &	label = `""`,
		const std::string &	group = `""`
	)

inherited

Create a standard R/W INDI Text property with target and current elements.

Returns: 0 on success; -1 on error

Parameters

[out]	prop	the property to create and setup
[in]	propName	the name of the property
[in]	label	[optional] the GUI label suggestion for this property
[in]	group	[optional] the group for this property

Definition at line 707 of file MagAOXApp.hpp.

◆ createStandardIndiToggleSw()

int MagAOX::app::MagAOXApp< _useINDI >::createStandardIndiToggleSw	(	pcf::IndiProperty &	prop,
		const std::string &	name,
		const std::string &	label = `""`,
		const std::string &	group = `""`
	)

inherited

Create a standard R/W INDI switch with a single toggle element.

This switch is intended to function like an on/off toggle switch.

Returns: 0 on success; -1 on error

Parameters

[out]	prop	the property to create and setup
[in]	name	the name of the property
[in]	label	[optional] the GUI label suggestion for this property
[in]	group	[optional] the group for this property

Definition at line 768 of file MagAOXApp.hpp.

◆ derived()

tcsInterface & MagAOX::app::dev::telemeter< tcsInterface >::derived ( )

inlineprivateinherited

Access the derived class.

Definition at line 181 of file telemeter.hpp.

◆ doFoffload()

int MagAOX::app::tcsInterface::doFoffload ( float F_0 )

Definition at line 3065 of file tcsInterface.hpp.

References MagAOX::app::MagAOXApp< true >::log(), flatlogs::logPrio::LOG_WARNING, m_labMode, m_offlF_dump, m_offlF_enabled, m_offlF_gain, m_offlF_thresh, and sendFoffload().

Referenced by offloadThreadExec().

◆ doTToffload()

int MagAOX::app::tcsInterface::doTToffload	(	float	TT_0,
		float	TT_1
	)

Definition at line 3000 of file tcsInterface.hpp.

References MagAOX::app::MagAOXApp< true >::log(), flatlogs::logPrio::LOG_WARNING, m_labMode, m_offlTT_dump, m_offlTT_enabled, m_offlTT_gain, m_offlTT_thresh, and sendTToffload().

Referenced by offloadThreadExec().

◆ driverCtrlName()

std::string MagAOX::app::MagAOXApp< _useINDI >::driverCtrlName ( )

inherited

Get the INDI control FIFO file name.

Returns: the current value of m_driverCtrlName

Definition at line 1274 of file MagAOXApp.hpp.

◆ driverInName()

std::string MagAOX::app::MagAOXApp< _useINDI >::driverInName ( )

inherited

Get the INDI input FIFO file name.

Returns: the current value of m_driverInName

Definition at line 1262 of file MagAOXApp.hpp.

◆ driverOutName()

std::string MagAOX::app::MagAOXApp< _useINDI >::driverOutName ( )

inherited

Get the INDI output FIFO file name.

Returns: the current value of m_driverOutName

Definition at line 1268 of file MagAOXApp.hpp.

◆ execute()

int MagAOX::app::MagAOXApp< _useINDI >::execute ( )

virtualinherited

The execute method implementing the standard main loop. Should not normally be overridden.

Performs final startup steps. That is:

Verifies correct effective user-id by comparison to logs directory.
PID locking lockPID()
log thread startup by logThreadStart()
signal handling installation by setSigTermHandler()
appStartup() is called
INDI communications started by startINDI()
power state is checked, pausing if unknown (if being managed)

Errors in the above steps will cause a process exit.

Then commences the main event loop. Conditions on entry to the main loop:

PID locked
Log thread running
Signal handling installed
appStartup successful
INDI communications started successfully (if being used)
power state known (if being managed)

In the event loop, the power state is checked (if being managed). If power is off, then onPowerOff is called. If power is on, or power is not managed, appLogic is called. These methods are implemented in derived classes, and are called every m_loopPause interval.

If an error is returned by either onPowerOff or appLogic, or a signal is handled, then the shutdown is managed. This includes shutting down INDI, calling appShutdown, and unlocking the PID. The log thread will shutdown.

Todo:: Need a heartbeat update here.

Definition at line 297 of file MagAOXApp.hpp.

◆ getCatData()

int MagAOX::app::tcsInterface::getCatData ( )

inline

Definition at line 1765 of file tcsInterface.hpp.

References MagAOX::app::stateCodes::ERROR, getMagTelStatus(), MagAOX::app::MagAOXApp< true >::log(), flatlogs::logPrio::LOG_ERROR, flatlogs::logPrio::LOG_WARNING, m_catDec, m_catEp, m_catObj, m_catRA, m_catRm, m_catRo, MagAOX::app::stateCodes::NOTCONNECTED, parse_teldata(), parse_xms(), and MagAOX::app::MagAOXApp< true >::state().

Referenced by appLogic().

◆ getEnvData()

int MagAOX::app::tcsInterface::getEnvData ( )

inline

Definition at line 1903 of file tcsInterface.hpp.

References getMagTelStatus(), MagAOX::app::MagAOXApp< true >::log(), flatlogs::logPrio::LOG_ERROR, flatlogs::logPrio::LOG_WARNING, m_tambient, m_tcell, m_tseccell, m_ttruss, m_wxdewpoint, m_wxhumid, m_wxpres, m_wxtemp, m_wxwdir, m_wxwind, MagAOX::app::stateCodes::NOTCONNECTED, parse_teldata(), recordTelEnv(), and MagAOX::app::MagAOXApp< true >::state().

Referenced by appLogic().

◆ getMagTelStatus()

int MagAOX::app::tcsInterface::getMagTelStatus	(	std::string &	response,
		const std::string &	statreq
	)

inline

Definition at line 1320 of file tcsInterface.hpp.

References MagAOX::app::MagAOXApp< true >::log(), flatlogs::logPrio::LOG_ERROR, MagAOX::app::dev::ioDevice::m_readTimeout, m_sock, m_tcsMutex, NETSERIAL_E_NOERROR, MagAOX::tty::netSerial::serialInString(), and MagAOX::tty::netSerial::serialOut().

Referenced by getCatData(), getEnvData(), getTelData(), getTelPos(), getTelTime(), and getVaneData().

◆ getSeeing()

int MagAOX::app::tcsInterface::getSeeing ( )

Query, parse, and record seeing measurements.

Definition at line 1969 of file tcsInterface.hpp.

References badSeeing(), MagAOX::app::MagAOXApp< true >::log(), m_dimm_fwhm_corr, m_dimm_time, m_labMode, m_mag1_fwhm_corr, m_mag1_time, m_mag2_fwhm_corr, m_mag2_time, m_seeingInterval, parse_xms(), and recordTelSee().

Referenced by appLogic().

◆ getTelData()

int MagAOX::app::tcsInterface::getTelData ( )

inline

Definition at line 1697 of file tcsInterface.hpp.

References MagAOX::app::stateCodes::ERROR, getMagTelStatus(), MagAOX::app::MagAOXApp< true >::log(), flatlogs::logPrio::LOG_ERROR, flatlogs::logPrio::LOG_WARNING, m_telAz, m_telDomeAz, m_telDomeStat, m_telEl, m_telGuiderMoving, m_telGuiding, m_telPA, m_telROI, m_telSlewing, m_telTracking, m_telZd, MagAOX::app::stateCodes::NOTCONNECTED, parse_teldata(), recordTelData(), and MagAOX::app::MagAOXApp< true >::state().

Referenced by appLogic().

◆ getTelPos()

int MagAOX::app::tcsInterface::getTelPos ( )

inline

Definition at line 1623 of file tcsInterface.hpp.

References MagAOX::app::stateCodes::ERROR, getMagTelStatus(), MagAOX::app::MagAOXApp< true >::log(), flatlogs::logPrio::LOG_ERROR, flatlogs::logPrio::LOG_WARNING, m_telAM, m_telDec, m_telEpoch, m_telHA, m_telRA, m_telRotOff, MagAOX::app::stateCodes::NOTCONNECTED, parse_teldata(), parse_xms(), recordTelPos(), and MagAOX::app::MagAOXApp< true >::state().

Referenced by appLogic().

◆ getTelTime()

int MagAOX::app::tcsInterface::getTelTime ( )

inline

Definition at line 1580 of file tcsInterface.hpp.

References MagAOX::app::stateCodes::ERROR, getMagTelStatus(), MagAOX::app::MagAOXApp< true >::log(), flatlogs::logPrio::LOG_ERROR, flatlogs::logPrio::LOG_WARNING, m_telST, MagAOX::app::stateCodes::NOTCONNECTED, parse_teldata(), parse_xms(), and MagAOX::app::MagAOXApp< true >::state().

Referenced by appLogic().

◆ getVaneData()

int MagAOX::app::tcsInterface::getVaneData ( )

inline

Definition at line 1854 of file tcsInterface.hpp.

References MagAOX::app::stateCodes::ERROR, getMagTelStatus(), MagAOX::app::MagAOXApp< true >::log(), flatlogs::logPrio::LOG_ERROR, flatlogs::logPrio::LOG_WARNING, m_telEncH, m_telEncV, m_telEncX, m_telEncY, m_telEncZ, m_telSecH, m_telSecV, m_telSecX, m_telSecY, m_telSecZ, MagAOX::app::stateCodes::NOTCONNECTED, parse_teldata(), recordTelVane(), and MagAOX::app::MagAOXApp< true >::state().

Referenced by appLogic().

◆ gitAlert()

bool MagAOX::app::MagAOXApp< _useINDI >::gitAlert ( )

inherited

Get the value of the git alert flag.

Returns: the current value of m_gitAlert

Definition at line 602 of file MagAOXApp.hpp.

◆ handleDefProperty()

void MagAOX::app::MagAOXApp< _useINDI >::handleDefProperty ( const pcf::IndiProperty & ipRecv )

inherited

Handler for the DEF INDI properties notification.

Uses the properties registered in m_indiSetCallBacks to process the notification. This is called by m_indiDriver's indiDriver::handleDefProperties.

Parameters

[in] ipRecv The property being sent.

Definition at line 933 of file MagAOXApp.hpp.

◆ handleGetProperties()

void MagAOX::app::MagAOXApp< _useINDI >::handleGetProperties ( const pcf::IndiProperty & ipRecv )

inherited

Handler for the get INDI properties request.

Uses the properties registered in m_indiCallBacks to respond to the request. This is called by m_indiDriver's indiDriver::handleGetProperties.

Parameters

[in] ipRecv The property being requested.

Definition at line 939 of file MagAOXApp.hpp.

◆ handleNewProperty()

void MagAOX::app::MagAOXApp< _useINDI >::handleNewProperty ( const pcf::IndiProperty & ipRecv )

inherited

Handler for the new INDI property request.

Uses the properties registered in m_indiCallBacks to respond to the request, looking up the callback for this property and calling it.

This is called by m_indiDriver's indiDriver::handleGetProperties.

Todo:: handle errors, are they FATAL?

Parameters

[in] ipRecv The property being changed.

Definition at line 949 of file MagAOXApp.hpp.

◆ handlerSigTerm()

void MagAOX::app::MagAOXApp< _useINDI >::handlerSigTerm	(	int	signum,
		siginfo_t *	siginf,
		void *	ucont
	)

privateinherited

Handles SIGTERM, SIGQUIT, and SIGINT. Sets m_shutdown to 1 and logs the signal.

Parameters

[in]	signum	specifies the signal.
[in]	siginf	ignored by MagAOXApp
[in]	ucont	ignored by MagAOXApp

Definition at line 399 of file MagAOXApp.hpp.

◆ handleSetProperty()

void MagAOX::app::MagAOXApp< _useINDI >::handleSetProperty ( const pcf::IndiProperty & ipRecv )

inherited

Handler for the set INDI property request.

This is called by m_indiDriver's indiDriver::handleSetProperties.

Todo:: handle errors, are they FATAL?

Todo:: log an error here because callBack should not be null

Todo:: log invalid SetProperty request.

Parameters

[in] ipRecv The property being changed.

Definition at line 958 of file MagAOXApp.hpp.

◆ INDI_NEWCALLBACK_DECL() [1/13]

MagAOX::app::tcsInterface::INDI_NEWCALLBACK_DECL	(	tcsInterface	,
		m_indiP_acqFromGuider
	)

◆ INDI_NEWCALLBACK_DECL() [2/13]

MagAOX::app::tcsInterface::INDI_NEWCALLBACK_DECL	(	tcsInterface	,
		m_indiP_labMode
	)

protected

◆ INDI_NEWCALLBACK_DECL() [3/13]

MagAOX::app::tcsInterface::INDI_NEWCALLBACK_DECL	(	tcsInterface	,
		m_indiP_offlFavgInt
	)

◆ INDI_NEWCALLBACK_DECL() [4/13]

MagAOX::app::tcsInterface::INDI_NEWCALLBACK_DECL	(	tcsInterface	,
		m_indiP_offlFdump
	)

◆ INDI_NEWCALLBACK_DECL() [5/13]

MagAOX::app::tcsInterface::INDI_NEWCALLBACK_DECL	(	tcsInterface	,
		m_indiP_offlFenable
	)

◆ INDI_NEWCALLBACK_DECL() [6/13]

MagAOX::app::tcsInterface::INDI_NEWCALLBACK_DECL	(	tcsInterface	,
		m_indiP_offlFgain
	)

◆ INDI_NEWCALLBACK_DECL() [7/13]

MagAOX::app::tcsInterface::INDI_NEWCALLBACK_DECL	(	tcsInterface	,
		m_indiP_offlFthresh
	)

◆ INDI_NEWCALLBACK_DECL() [8/13]

MagAOX::app::tcsInterface::INDI_NEWCALLBACK_DECL	(	tcsInterface	,
		m_indiP_offlTTavgInt
	)

◆ INDI_NEWCALLBACK_DECL() [9/13]

MagAOX::app::tcsInterface::INDI_NEWCALLBACK_DECL	(	tcsInterface	,
		m_indiP_offlTTdump
	)

◆ INDI_NEWCALLBACK_DECL() [10/13]

MagAOX::app::tcsInterface::INDI_NEWCALLBACK_DECL	(	tcsInterface	,
		m_indiP_offlTTenable
	)

◆ INDI_NEWCALLBACK_DECL() [11/13]

MagAOX::app::tcsInterface::INDI_NEWCALLBACK_DECL	(	tcsInterface	,
		m_indiP_offlTTgain
	)

◆ INDI_NEWCALLBACK_DECL() [12/13]

MagAOX::app::tcsInterface::INDI_NEWCALLBACK_DECL	(	tcsInterface	,
		m_indiP_offlTTthresh
	)

◆ INDI_NEWCALLBACK_DECL() [13/13]

MagAOX::app::tcsInterface::INDI_NEWCALLBACK_DECL	(	tcsInterface	,
		m_indiP_pyrNudge
	)

◆ INDI_SETCALLBACK_DECL() [1/3]

MagAOX::app::MagAOXApp< _useINDI >::INDI_SETCALLBACK_DECL	(	MagAOXApp< true >	,
		m_indiP_powerChannel
	)

inherited

◆ INDI_SETCALLBACK_DECL() [2/3]

MagAOX::app::tcsInterface::INDI_SETCALLBACK_DECL	(	tcsInterface	,
		m_indiP_loopState
	)

◆ INDI_SETCALLBACK_DECL() [3/3]

MagAOX::app::tcsInterface::INDI_SETCALLBACK_DECL	(	tcsInterface	,
		m_indiP_offloadCoeffs
	)

◆ indiTargetUpdate()

int MagAOX::app::MagAOXApp< _useINDI >::indiTargetUpdate	(	pcf::IndiProperty &	localProperty,
		T &	localTarget,
		const pcf::IndiProperty &	remoteProperty,
		bool	setBusy = `true`
	)

protectedinherited

Get the target element value from an new property.

Returns: 0 on success; -1 on error

Parameters

[out]	localProperty	The local property to update
[out]	localTarget	The local value to update
[in]	remoteProperty	the new property received
[in]	setBusy	[optional] set property to busy if true

Definition at line 1055 of file MagAOXApp.hpp.

◆ loadBasicConfig()

void MagAOX::app::MagAOXApp< _useINDI >::loadBasicConfig ( )

virtualinherited

The basic MagAO-X configuration processing method. Should not normally be overridden.

This method processes the standard MagAO-X key=value pairs.

Though it is virtual, it should not normally be overridden unless you need to depart from the MagAO-X standard.

Processing of app specific config goes in loadConfig() implemented by the derived class.

Definition at line 261 of file MagAOXApp.hpp.

◆ loadConfig() [1/3]

void MagAOX::app::tcsInterface::loadConfig ( )

inlinevirtual

Definition at line 784 of file tcsInterface.hpp.

References loadConfigImpl().

◆ loadConfig() [2/3]

int MagAOX::app::dev::telemeter< tcsInterface >::loadConfig ( appConfigurator & config )

inherited

Load the device section from an application configurator.

Returns: 0 on success; -1 on error (nothing implemented yet)

Parameters

[in] config an application configuration from which to load values

Definition at line 120 of file telemeter.hpp.

◆ loadConfig() [3/3]

int MagAOX::app::dev::ioDevice::loadConfig ( mx::app::appConfigurator & config )

inherited

Load the device section from an application configurator.

Returns: 0 on success; -1 on error (nothing implemented yet)

Parameters

[in] config an application configuration from which to load values

Definition at line 28 of file ioDevice.cpp.

References MagAOX::app::dev::ioDevice::m_readTimeout, and MagAOX::app::dev::ioDevice::m_writeTimeout.

Referenced by MagAOX::app::picoMotorCtrl::loadConfig(), MagAOX::app::smc100ccCtrl::loadConfig(), MagAOX::app::trippLitePDU::loadConfig(), MagAOX::app::dev::edtCamera< derivedT >::loadConfig(), MagAOX::app::flipperCtrl::loadConfigImpl(), MagAOX::app::pi335Ctrl::loadConfigImpl(), MagAOX::app::rhusbMon::loadConfigImpl(), and loadConfigImpl().

◆ loadConfigImpl()

int MagAOX::app::tcsInterface::loadConfigImpl ( mx::app::appConfigurator & _config )

inline

Implementation of loadConfig logic, separated for testing.

This is called by loadConfig().

Parameters

[in] _config an application configuration from which to load values

Definition at line 728 of file tcsInterface.hpp.

References MagAOX::app::dev::telemeter< derivedT >::loadConfig(), MagAOX::app::dev::ioDevice::loadConfig(), MagAOX::app::MagAOXApp< true >::log(), m_acqAz0, m_acqAzOff, m_acqEl0, m_acqElOff, m_acqFocus, m_acqZdSign, m_deviceAddr, m_devicePort, m_lab_offlTT_C_00, m_lab_offlTT_C_01, m_lab_offlTT_C_10, m_lab_offlTT_C_11, m_labMode, m_offlCComa_00, m_offlCComa_01, m_offlCComa_10, m_offlCComa_11, m_offlCFocus_00, m_offlF_avgInt, m_offlF_gain, m_offlF_thresh, m_offlTT_avgInt, m_offlTT_C_00, m_offlTT_C_01, m_offlTT_C_10, m_offlTT_C_11, m_offlTT_gain, m_offlTT_thresh, m_pyrNudge_ang, m_pyrNudge_ang0, m_pyrNudge_C_00, m_pyrNudge_C_01, m_pyrNudge_C_10, m_pyrNudge_C_11, and m_pyrNudge_parity.

Referenced by loadConfig().

◆ lockPID()

int MagAOX::app::MagAOXApp< _useINDI >::lockPID ( )

protectedinherited

Attempt to lock the PID by writing it to a file. Fails if a process is already running with the same config name. First checks the PID file for an existing PID. If found, interrogates /proc to determine if that process is running and if so if the command line matches. If a matching process is currently running, then this returns an error.

Will not fail if a PID file exists but the stored PID does not correspond to a running process with the same command line name.

Reference: https://linux.die.net/man/3/getpid

Returns: 0 on success.; -1 on any error, including creating the PID file or if this app is already running.

Definition at line 511 of file MagAOXApp.hpp.

◆ log() [1/2]

int MagAOX::app::MagAOXApp< _useINDI >::log	(	const typename logT::messageT &	msg,
		logPrioT	level = `logPrio::LOG_DEFAULT`
	)

staticinherited

Make a log entry.

Wrapper for logManager::log

Template Parameters

logT	the log entry type
retval	the value returned by this method.

Parameters

[in]	msg	the message to log
[in]	level	[optional] the log level. The default is used if not specified.

Definition at line 344 of file MagAOXApp.hpp.

◆ log() [2/2]

int MagAOX::app::MagAOXApp< _useINDI >::log ( logPrioT level = logPrio::LOG_DEFAULT )

staticinherited

Make a log entry.

Wrapper for logManager::log

Template Parameters

logT	the log entry type
retval	the value returned by this method.

Parameters

[in] level [optional] the log level. The default is used if not specified.

Definition at line 357 of file MagAOXApp.hpp.

◆ logMessage()

void MagAOX::app::MagAOXApp< _useINDI >::logMessage ( bufferPtrT & b )

inherited

Handle a log message from the logging system.

This is a callback from the logManager, and is called when the log thread is processing log entries.

Decides whether to display to stderr and whether to send via INDI.

Definition at line 366 of file MagAOXApp.hpp.

◆ loopPause()

unsigned long MagAOX::app::MagAOXApp< _useINDI >::loopPause ( )

inherited

Get the loop pause time.

Returns: the value of m_loopPause

Definition at line 1250 of file MagAOXApp.hpp.

◆ newCallBack_clearFSMAlert()

int MagAOX::app::MagAOXApp< _useINDI >::newCallBack_clearFSMAlert ( const pcf::IndiProperty & ipRecv )

protectedinherited

The callback called by the static version, to actually process the FSM Alert Clear request.

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

Parameters

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

Definition at line 1112 of file MagAOXApp.hpp.

◆ offloadThreadExec()

void MagAOX::app::tcsInterface::offloadThreadExec ( )

Offload thread function.

Runs until m_shutdown is true.

Todo:: offloading: These sections ought to be separate functions for clarity

Definition at line 2871 of file tcsInterface.hpp.

References MagAOX::app::stateCodes::CONNECTED, doFoffload(), doTToffload(), MagAOX::app::MagAOXApp< true >::log(), m_firstRequest, m_last_nRequests, m_lastRequest, m_loopState, m_nRequests, m_offlF_avgInt, m_offloadRequests, m_offloadThreadID, m_offloadThreadInit, m_offlTT_avgInt, MagAOX::app::MagAOXApp< true >::shutdown(), and MagAOX::app::MagAOXApp< true >::state().

Referenced by offloadThreadStart().

◆ offloadThreadStart()

void MagAOX::app::tcsInterface::offloadThreadStart ( tcsInterface * t )

static

Offload thread starter function.

Parameters

[in] t pointer to this

Definition at line 2866 of file tcsInterface.hpp.

References offloadThreadExec().

Referenced by appStartup().

◆ onPowerOff()

int MagAOX::app::MagAOXApp< _useINDI >::onPowerOff ( )

protectedvirtualinherited

This method is called when the change to poweroff is detected.

Returns: 0 on success.; -1 on any error which means the app should exit.

Reimplemented in MagAOX::app::alpaoCtrl, MagAOX::app::bmcCtrl, MagAOX::app::irisaoCtrl, and MagAOX::app::zaberLowLevel.

Definition at line 1157 of file MagAOXApp.hpp.

◆ parse_teldata()

std::vector< std::string > MagAOX::app::tcsInterface::parse_teldata ( std::string & tdat )

inline

Definition at line 1408 of file tcsInterface.hpp.

References MagAOX::app::MagAOXApp< true >::log().

Referenced by getCatData(), getEnvData(), getTelData(), getTelPos(), getTelTime(), and getVaneData().

◆ parse_xms()

int MagAOX::app::tcsInterface::parse_xms	(	double &	x,
		double &	m,
		double &	s,
		const std::string &	xmsstr
	)

inline

Definition at line 1459 of file tcsInterface.hpp.

References MagAOX::app::MagAOXApp< true >::log().

Referenced by getCatData(), getSeeing(), getTelPos(), getTelTime(), and TCSITEST::SCENARIO().

◆ powerOnWaitElapsed()

bool MagAOX::app::MagAOXApp< _useINDI >::powerOnWaitElapsed ( )

protectedinherited

This method tests whether the power on wait time has elapsed.

You would call this once per appLogic loop while in state POWERON. While false, you would return 0. Once it becomes true, take post-power-on actions and go on with life.

Returns: true if the time since POWERON is greater than the power-on wait, or if power management is not enabled; false otherwise

Definition at line 1173 of file MagAOXApp.hpp.

◆ powerState()

int MagAOX::app::MagAOXApp< _useINDI >::powerState ( )

inherited

Returns the current power state.

If power management is not enabled, this always returns 1=On.

Returns: -1 if power state is unknown; 0 if power is off; 1 if power is on or m_powerMgtEnabled==false

Definition at line 1183 of file MagAOXApp.hpp.

◆ powerStateTarget()

int MagAOX::app::MagAOXApp< _useINDI >::powerStateTarget ( )

inherited

Returns the target power state.

If power management is not enabled, this always returns 1=On.

Returns: -1 if target power state is unknown; 0 if target power state is off; 1 if target power is on or m_powerMgtEnabled==false

Definition at line 1192 of file MagAOXApp.hpp.

◆ recordTelCat()

int MagAOX::app::tcsInterface::recordTelCat ( bool force = false )

inline

Definition at line 2735 of file tcsInterface.hpp.

References MagAOX::app::MagAOXApp< true >::log(), m_catDec, m_catEp, m_catObj, m_catRA, m_catRm, and m_catRo.

Referenced by recordTelem().

◆ recordTelData()

int MagAOX::app::tcsInterface::recordTelData ( bool force = false )

inline

Definition at line 2606 of file tcsInterface.hpp.

References MagAOX::app::MagAOXApp< true >::log(), m_telAz, m_telDomeAz, m_telDomeStat, m_telGuiderMoving, m_telGuiding, m_telPA, m_telROI, m_telSlewing, m_telTracking, and m_telZd.

Referenced by getTelData(), and recordTelem().

◆ recordTelem() [1/6]

int MagAOX::app::tcsInterface::recordTelem ( const telem_telcat * )

inline

Definition at line 2567 of file tcsInterface.hpp.

References recordTelCat().

◆ recordTelem() [2/6]

int MagAOX::app::tcsInterface::recordTelem ( const telem_teldata * )

inline

Definition at line 2549 of file tcsInterface.hpp.

References recordTelData().

◆ recordTelem() [3/6]

int MagAOX::app::tcsInterface::recordTelem ( const telem_telenv * )

inline

Definition at line 2561 of file tcsInterface.hpp.

References recordTelEnv().

◆ recordTelem() [4/6]

int MagAOX::app::tcsInterface::recordTelem ( const telem_telpos * )

inline

Definition at line 2543 of file tcsInterface.hpp.

References recordTelPos().

◆ recordTelem() [5/6]

int MagAOX::app::tcsInterface::recordTelem ( const telem_telsee * )

inline

Definition at line 2573 of file tcsInterface.hpp.

References recordTelSee().

◆ recordTelem() [6/6]

int MagAOX::app::tcsInterface::recordTelem ( const telem_telvane * )

inline

Definition at line 2555 of file tcsInterface.hpp.

References recordTelVane().

◆ recordTelEnv()

int MagAOX::app::tcsInterface::recordTelEnv ( bool force = false )

inline

Definition at line 2692 of file tcsInterface.hpp.

References MagAOX::app::MagAOXApp< true >::log(), m_tambient, m_tcell, m_tseccell, m_ttruss, m_wxdewpoint, m_wxhumid, m_wxpres, m_wxtemp, m_wxwdir, and m_wxwind.

Referenced by getEnvData(), and recordTelem().

◆ recordTelPos()

int MagAOX::app::tcsInterface::recordTelPos ( bool force = false )

inline

Definition at line 2579 of file tcsInterface.hpp.

References MagAOX::app::MagAOXApp< true >::log(), m_telAM, m_telDec, m_telEl, m_telEpoch, m_telHA, m_telRA, and m_telRotOff.

Referenced by getTelPos(), and recordTelem().

◆ recordTelSee()

int MagAOX::app::tcsInterface::recordTelSee ( bool force = false )

inline

Definition at line 2760 of file tcsInterface.hpp.

References MagAOX::app::MagAOXApp< true >::log(), m_dimm_fwhm_corr, m_dimm_time, m_mag1_fwhm_corr, m_mag1_time, m_mag2_fwhm_corr, and m_mag2_time.

Referenced by badSeeing(), getSeeing(), and recordTelem().

◆ recordTelVane()

int MagAOX::app::tcsInterface::recordTelVane ( bool force = false )

inline

Definition at line 2649 of file tcsInterface.hpp.

References MagAOX::app::MagAOXApp< true >::log(), m_telEncH, m_telEncV, m_telEncX, m_telEncY, m_telEncZ, m_telSecH, m_telSecV, m_telSecX, m_telSecY, and m_telSecZ.

Referenced by getVaneData(), and recordTelem().

◆ registerIndiPropertyNew() [1/3]

int MagAOX::app::MagAOXApp< _useINDI >::registerIndiPropertyNew	(	pcf::IndiProperty &	prop,
		const std::string &	propName,
		const pcf::IndiProperty::Type &	propType,
		const pcf::IndiProperty::PropertyPermType &	propPerm,
		const pcf::IndiProperty::PropertyStateType &	propState,
		const pcf::IndiProperty::SwitchRuleType &	propRule,
		int()(void , const pcf::IndiProperty &)
	)

inherited

Register an INDI property which is exposed for others to request a New Property for, with a switch rule.

This verison sets up the INDI property according to the arguments.

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

Parameters

[out]	prop	the property to register
[in]	propName	the name of the property
[in]	propType	the type of the property
[in]	propPerm	the permissions of the property
[in]	propState	the state of the property
[in]	propRule	the switch rule type

◆ registerIndiPropertyNew() [2/3]

int MagAOX::app::MagAOXApp< _useINDI >::registerIndiPropertyNew	(	pcf::IndiProperty &	prop,
		const std::string &	propName,
		const pcf::IndiProperty::Type &	propType,
		const pcf::IndiProperty::PropertyPermType &	propPerm,
		const pcf::IndiProperty::PropertyStateType &	propState,
		int()(void , const pcf::IndiProperty &)
	)

inherited

Register an INDI property which is exposed for others to request a New Property for.

This verison sets up the INDI property according to the arguments.

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

Parameters

[out]	prop	the property to register
[in]	propName	the name of the property
[in]	propType	the type of the property
[in]	propPerm	the permissions of the property
[in]	propState	the state of the property

◆ registerIndiPropertyNew() [3/3]

int MagAOX::app::MagAOXApp< _useINDI >::registerIndiPropertyNew	(	pcf::IndiProperty &	prop,
		int()(void , const pcf::IndiProperty &)
	)

inherited

Register an INDI property which is exposed for others to request a New Property for.

In this version the supplied IndiProperty must be fully set up before passing in.

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

Parameters

[in] prop the property to register, must be fully set up

◆ registerIndiPropertyReadOnly() [1/2]

int MagAOX::app::MagAOXApp< _useINDI >::registerIndiPropertyReadOnly ( pcf::IndiProperty & prop )

inherited

Register an INDI property which is read only.

This version requires the property be fully set up.

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

Parameters

[in] prop the property to register, must be completely setup

Definition at line 828 of file MagAOXApp.hpp.

◆ registerIndiPropertyReadOnly() [2/2]

int MagAOX::app::MagAOXApp< _useINDI >::registerIndiPropertyReadOnly	(	pcf::IndiProperty &	prop,
		const std::string &	propName,
		const pcf::IndiProperty::Type &	propType,
		const pcf::IndiProperty::PropertyPermType &	propPerm,
		const pcf::IndiProperty::PropertyStateType &	propState
	)

inherited

Register an INDI property which is read only.

This verison sets up the INDI property according to the arguments.

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

Parameters

[out]	prop	the property to register, will be configured
[in]	propName	the name of the property
[in]	propType	the type of the property
[in]	propPerm	the permissions of the property
[in]	propState	the state of the property

Definition at line 838 of file MagAOXApp.hpp.

◆ registerIndiPropertySet()

int MagAOX::app::MagAOXApp< _useINDI >::registerIndiPropertySet	(	pcf::IndiProperty &	prop,
		const std::string &	devName,
		const std::string &	propName,
		int()(void , const pcf::IndiProperty &)
	)

inherited

Register an INDI property which is monitored for updates from others.

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

Parameters

[out]	prop	the property to register
[in]	devName	the device which owns this property
[in]	propName	the name of the property

Definition at line 905 of file MagAOXApp.hpp.

◆ secretsPath()

std::string MagAOX::app::MagAOXApp< _useINDI >::secretsPath ( )

inherited

Get the secrets path.

Returns: the value of m_secretsPath

Definition at line 1240 of file MagAOXApp.hpp.

◆ sendFoffload()

int MagAOX::app::tcsInterface::sendFoffload ( float F_0 )

Definition at line 3097 of file tcsInterface.hpp.

References MagAOX::app::MagAOXApp< true >::log(), MagAOX::app::dev::ioDevice::m_readTimeout, and sendMagTelCommand().

Referenced by doFoffload().

◆ sendGetPropertySetList()

void MagAOX::app::MagAOXApp< _useINDI >::sendGetPropertySetList ( bool all = false )

inherited

Definition at line 927 of file MagAOXApp.hpp.

◆ sendMagTelCommand()

int MagAOX::app::tcsInterface::sendMagTelCommand	(	const std::string &	command,
		int	timeout
	)

inline

Definition at line 1366 of file tcsInterface.hpp.

References MagAOX::app::MagAOXApp< true >::log(), flatlogs::logPrio::LOG_ERROR, m_sock, m_tcsMutex, NETSERIAL_E_NOERROR, MagAOX::tty::netSerial::serialInString(), and MagAOX::tty::netSerial::serialOut().

Referenced by acquireFromGuider(), sendFoffload(), sendPyrNudge(), and sendTToffload().

◆ sendNewProperty() [1/2]

int MagAOX::app::MagAOXApp< _useINDI >::sendNewProperty ( const pcf::IndiProperty & ipSend )

protectedinherited

Send a newProperty command to another device (using the INDI Client interface)

Returns: 0 on success.; -1 on an error, which will be logged

Parameters

[in] ipSend The property to send a "new" INDI command for

Definition at line 1078 of file MagAOXApp.hpp.

◆ sendNewProperty() [2/2]

int MagAOX::app::MagAOXApp< _useINDI >::sendNewProperty	(	const pcf::IndiProperty &	ipSend,
		const std::string &	el,
		const T &	newVal
	)

protectedinherited

Send a newProperty command to another device (using the INDI Client interface)

Copies the input IndiProperty, then updates the element with the new value.

Returns: 0 on success.; -1 on an errory.

Parameters

[in]	ipSend	The property to send a "new" INDI command for
[in]	el	The element of the property to change
[in]	newVal	The value to request for the element.

Definition at line 1068 of file MagAOXApp.hpp.

◆ sendNewStandardIndiToggle()

int MagAOX::app::MagAOXApp< _useINDI >::sendNewStandardIndiToggle	(	const std::string &	device,
		const std::string &	property,
		bool	onoff
	)

protectedinherited

Send a new property commmand for a standard toggle switch.

Returns: 0 on success; -1 on an error, which will be logged.

Parameters

[in]	device	The device name
[in]	property	The property name
[in]	onoff	Switch state to send: true = on, false = off

Definition at line 1085 of file MagAOXApp.hpp.

◆ sendPyrNudge()

int MagAOX::app::tcsInterface::sendPyrNudge	(	float	x,
		float	y,
		float	z
	)

Todo:: need logtypes for nudges and offloads

Definition at line 2792 of file tcsInterface.hpp.

References MagAOX::app::MagAOXApp< true >::log(), flatlogs::logPrio::LOG_NOTICE, m_pyrNudge_C_00, m_pyrNudge_C_01, m_pyrNudge_C_10, m_pyrNudge_C_11, m_pyrNudge_F_sign, MagAOX::app::dev::ioDevice::m_readTimeout, and sendMagTelCommand().

◆ sendTToffload()

int MagAOX::app::tcsInterface::sendTToffload	(	float	TT_0,
		float	TT_1
	)

Definition at line 3036 of file tcsInterface.hpp.

References MagAOX::app::MagAOXApp< true >::log(), m_labMode, MagAOX::app::dev::ioDevice::m_readTimeout, sendMagTelCommand(), and MagAOX::app::MagAOXApp< true >::sendNewProperty().

Referenced by doTToffload().

◆ setDefaults()

void MagAOX::app::MagAOXApp< _useINDI >::setDefaults	(	int	argc,
		char **	argv
	)

virtualinherited

Set the paths for config files.

Replaces the mx::application defaults with the MagAO-X config system.

This function parses the CL for "-n" or "--name".

Do not override this unless you intend to depart from the MagAO-X standard.

Parameters

[in]	argc	standard command line result specifying number of arguments in argv
[in]	argv	standard command line result containing the arguments.

Definition at line 239 of file MagAOXApp.hpp.

◆ setEuidCalled()

int MagAOX::app::MagAOXApp< _useINDI >::setEuidCalled ( )

privateinherited

Set the effective user ID to the called value, i.e. the highest possible.

If setuid is set on the file, this will be super-user privileges.

Reference: http://pubs.opengroup.org/onlinepubs/009695399/functions/seteuid.html

Returns: 0 on success; -1 on error from setuid().

Definition at line 470 of file MagAOXApp.hpp.

◆ setEuidReal()

int MagAOX::app::MagAOXApp< _useINDI >::setEuidReal ( )

privateinherited

Set the effective user ID to the real value, i.e. the file owner.

Reference: http://pubs.opengroup.org/onlinepubs/009695399/functions/seteuid.html

Returns: 0 on success; -1 on error from setuid().

Definition at line 479 of file MagAOXApp.hpp.

◆ setSigTermHandler()

int MagAOX::app::MagAOXApp< _useINDI >::setSigTermHandler ( )

privateinherited

Sets the handler for SIGTERM, SIGQUIT, and SIGINT.

Definition at line 390 of file MagAOXApp.hpp.

◆ setupBasicConfig()

void MagAOX::app::MagAOXApp< _useINDI >::setupBasicConfig ( )

virtualinherited

The basic MagAO-X configuration setup method. Should not normally be overridden.

This method sets up the config system with the standard MagAO-X key=value pairs.

Though it is virtual, it should not normally be overridden unless you need to depart from the MagAO-X standard.

Setting up app specific config goes in setupConfig() implemented in the derived class.

Definition at line 251 of file MagAOXApp.hpp.

◆ setupConfig() [1/3]

void MagAOX::app::tcsInterface::setupConfig ( )

inlinevirtual

Definition at line 409 of file tcsInterface.hpp.

References MagAOX::app::dev::telemeter< derivedT >::setupConfig(), and MagAOX::app::dev::ioDevice::setupConfig().

◆ setupConfig() [2/3]

int MagAOX::app::dev::telemeter< tcsInterface >::setupConfig ( appConfigurator & config )

inherited

Setup an application configurator for the device section.

Returns: 0 on success.; -1 on error (nothing implemented yet)

Parameters

[in] config an application configuration to setup

Definition at line 112 of file telemeter.hpp.

◆ setupConfig() [3/3]

int MagAOX::app::dev::ioDevice::setupConfig ( mx::app::appConfigurator & config )

inherited

Setup an application configurator for the device section.

Returns: 0 on success.; -1 on error (nothing implemented yet)

Parameters

[in] config an application configuration to setup

Definition at line 20 of file ioDevice.cpp.

Referenced by MagAOX::app::flipperCtrl::setupConfig(), MagAOX::app::pi335Ctrl::setupConfig(), MagAOX::app::picoMotorCtrl::setupConfig(), MagAOX::app::rhusbMon::setupConfig(), MagAOX::app::smc100ccCtrl::setupConfig(), setupConfig(), MagAOX::app::trippLitePDU::setupConfig(), and MagAOX::app::dev::edtCamera< derivedT >::setupConfig().

◆ shutdown()

int MagAOX::app::MagAOXApp< _useINDI >::shutdown ( )

inherited

Get the value of the shutdown flag.

Returns: the current value of m_shutdown

Definition at line 1256 of file MagAOXApp.hpp.

◆ st_newCallBack_clearFSMAlert()

int MagAOX::app::MagAOXApp< _useINDI >::st_newCallBack_clearFSMAlert	(	void *	app,
		const pcf::IndiProperty &	ipRecv
	)

staticprotectedinherited

The static callback function to be registered for requesting to clear the FSM alert.

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

Parameters

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

Definition at line 1101 of file MagAOXApp.hpp.

◆ startINDI()

int MagAOX::app::MagAOXApp< _useINDI >::startINDI ( )

protectedinherited

Start INDI Communications.

Returns: 0 on success; -1 on error. This is fatal.

Definition at line 924 of file MagAOXApp.hpp.

◆ state() [1/2]

stateCodes::stateCodeT MagAOX::app::MagAOXApp< _useINDI >::state ( )

inherited

Get the current state code.

Returns: m_state

Definition at line 580 of file MagAOXApp.hpp.

◆ state() [2/2]

void MagAOX::app::MagAOXApp< _useINDI >::state	(	const stateCodes::stateCodeT &	s,
		bool	stateAlert = `false`
	)

inherited

Set the current state code.

Todo:: move this to a function in stateCodes

Parameters

[in]	s	The new application state
[in]	stateAlert	[optional] flag to set the alert state of the FSM property.

Definition at line 588 of file MagAOXApp.hpp.

◆ stateAlert()

bool MagAOX::app::MagAOXApp< _useINDI >::stateAlert ( )

inherited

Get the value of the state alert flag.

Returns: the current value of m_stateAlert

Definition at line 596 of file MagAOXApp.hpp.

◆ stateLogged()

int MagAOX::app::MagAOXApp< _useINDI >::stateLogged ( )

inherited

Updates and returns the value of m_stateLogged. Will be 0 on first call after a state change, >0 afterwards.

This method exists to facilitate logging the reason for a state change once, but not logging it on subsequent event loops. Returns the current value upon entry, but updates before returning so that the next call returns the incremented value. Example usage:

if( connection_failed ) //some condition set this to true
{
   state( stateCodes::NOTCONNECTED );
   if(!stateLogged()) log<text_log>("Not connected");
}

In this example, the log entry is made the first time the state changes. If there are no changes to a different state in the mean time, then when the event loop gets here again and decides it is not connected, the log entry will not be made.

Returns: current value of m_stateLogged, that is the value before it is incremented.

Definition at line 621 of file MagAOXApp.hpp.

◆ sysPath()

std::string MagAOX::app::MagAOXApp< _useINDI >::sysPath ( )

inherited

Get the system path.

Returns: the value of m_sysPath

Definition at line 1235 of file MagAOXApp.hpp.

◆ telem()

int MagAOX::app::dev::telemeter< tcsInterface >::telem ( const typename telT::messageT & msg )

inherited

Make a telemetry recording.

Wrapper for logManager::log, which updates telT::lastRecord.

Template Parameters

logT	the log entry type
retval	the value returned by this method.

Parameters

[in] msg the data to log

Definition at line 95 of file telemeter.hpp.

◆ threadStart()

int MagAOX::app::MagAOXApp< _useINDI >::threadStart	(	std::thread &	thrd,
		bool &	thrdInit,
		pid_t &	tpid,
		pcf::IndiProperty &	thProp,
		int	thrdPrio,
		const std::string &	cpuset,
		const std::string &	thrdName,
		thisPtr *	thrdThis,
		Function &&	thrdStart
	)

inherited

Start a thread, using this class's privileges to set priority, etc.

The thread initialization synchronizer bool is set to true at the beginning of this function, then is set to false once all initialization is complete. The thread exec function should wait until this is false before doing anything except setting the pid. This is to avoid privilege escalation bugs.

The interface of the thread start function is:

static void impl::myThreadStart( impl * o )
{
   o->myThreadExec(); //A member function which actually executes the thread
}

where impl is the derived class, and mThreadStart and myThreadExec are members of impl.

Returns: 0 on success; -1 on error

Parameters

[out]	thrd	The thread object to start executing
	thrdInit	[in/out] The thread initilization synchronizer.
	tpid	[in/out] The thread pid to be filled in by thrdStart immediately upon call
	thProp	[in/out] The INDI property to publish the thread details
[in]	thrdPrio	The r/t priority to set for this thread
[in]	cpuset	the cpuset to place this thread on. Ignored if "".
[in]	thrdName	The name of the thread (just for logging)
[in]	thrdThis	The `this` pointer to pass to the thread starter function
[in]	thrdStart	The thread starting function, a static function taking a `this` pointer as argument.

Definition at line 545 of file MagAOXApp.hpp.

◆ unlockPID()

int MagAOX::app::MagAOXApp< _useINDI >::unlockPID ( )

protectedinherited

Remove the PID file.

Definition at line 514 of file MagAOXApp.hpp.

◆ updateIfChanged() [1/4]

void MagAOX::app::MagAOXApp< _useINDI >::updateIfChanged	(	pcf::IndiProperty &	p,
		const std::string &	el,
		const char *	newVal,
		pcf::IndiProperty::PropertyStateType	ipState = `pcf::IndiProperty::Ok`
	)

protectedinherited

Update an INDI property element value if it has changed.

Will only peform a SetProperty if the new element value has changed compared to the stored value, or if the property state has changed.

This comparison is done in the true type of the value.

This is a specialization for const char * to std::string.

For a property with multiple elements, you should use the vector version to minimize network traffic. This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Parameters

	p	[in/out] The property containing the element to possibly update
[in]	el	The element name
[in]	newVal	the new value

Definition at line 988 of file MagAOXApp.hpp.

◆ updateIfChanged() [2/4]

void MagAOX::app::MagAOXApp< _useINDI >::updateIfChanged	(	pcf::IndiProperty &	p,
		const std::string &	el,
		const std::vector< T > &	newVals,
		pcf::IndiProperty::PropertyStateType	ipState = `pcf::IndiProperty::Ok`
	)

protectedinherited

Update an INDI property if values have changed.

Will only peform a SetProperty if at least one value has changed compared to the stored value, or if the property state has changed.

Constructs the element names for each value as elX where X is the index of the vector.

This comparison is done in the true type of the value.

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Parameters

	p	[in/out] The property containing the element to possibly update
[in]	el	Beginning of each element name
[in]	newVals	the new values
[in]	ipState	[optional] the new state

Definition at line 1017 of file MagAOXApp.hpp.

◆ updateIfChanged() [3/4]

void MagAOX::app::MagAOXApp< _useINDI >::updateIfChanged	(	pcf::IndiProperty &	p,
		const std::string &	el,
		const T &	newVal,
		pcf::IndiProperty::PropertyStateType	ipState = `pcf::IndiProperty::Ok`
	)

protectedinherited

Update an INDI property element value if it has changed.

Will only peform a SetProperty if the new element value has changed compared to the stored value, or if the property state has changed.

This comparison is done in the true type of the value.

For a property with multiple elements, you should use the vector version to minimize network traffic.

Parameters

	p	[in/out] The property containing the element to possibly update
[in]	el	The element name
[in]	newVal	the new value

Definition at line 971 of file MagAOXApp.hpp.

◆ updateIfChanged() [4/4]

void MagAOX::app::MagAOXApp< _useINDI >::updateIfChanged	(	pcf::IndiProperty &	p,
		const std::vector< std::string > &	els,
		const std::vector< T > &	newVals,
		pcf::IndiProperty::PropertyStateType	newState = `pcf::IndiProperty::Ok`
	)

protectedinherited

Update an INDI property if values have changed.

Will only peform a SetProperty if at least one value has changed compared to the stored value, or if the property state has changed.

This comparison is done in the true type of the value.

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Parameters

	p	[in/out] The property containing the element to possibly update
[in]	els	String vector of element names
[in]	newVals	the new values
[in]	newState	[optional] The state of the property

Definition at line 1034 of file MagAOXApp.hpp.

◆ updateINDI()

int MagAOX::app::tcsInterface::updateINDI ( )

inline

Definition at line 2166 of file tcsInterface.hpp.

References INDI_IDLE, INDI_OK, MagAOX::app::MagAOXApp< true >::log(), m_catDec, m_catEp, m_catObj, m_catRA, m_catRm, m_catRo, m_dimm_fwhm_corr, m_dimm_time, MagAOX::app::MagAOXApp< true >::m_indiDriver, m_indiP_catalog, m_indiP_catdata, m_indiP_env, m_indiP_offlFavgInt, m_indiP_offlFdump, m_indiP_offlFenable, m_indiP_offlFgain, m_indiP_offlFthresh, m_indiP_offlTTavgInt, m_indiP_offlTTdump, m_indiP_offlTTenable, m_indiP_offlTTgain, m_indiP_offlTTthresh, m_indiP_seeing, m_indiP_teldata, m_indiP_telpos, m_indiP_teltime, m_indiP_vaneend, m_mag1_fwhm_corr, m_mag1_time, m_mag2_fwhm_corr, m_mag2_time, m_offlF_avgInt, m_offlF_dump, m_offlF_enabled, m_offlF_gain, m_offlF_thresh, m_offlTT_avgInt, m_offlTT_dump, m_offlTT_enabled, m_offlTT_gain, m_offlTT_thresh, m_tambient, m_tcell, m_telAM, m_telAz, m_telDec, m_telDomeAz, m_telDomeStat, m_telEl, m_telEncH, m_telEncV, m_telEncX, m_telEncY, m_telEncZ, m_telEpoch, m_telGuiderMoving, m_telGuiding, m_telHA, m_telPA, m_telRA, m_telROI, m_telRotOff, m_telSecH, m_telSecV, m_telSecX, m_telSecY, m_telSecZ, m_telSlewing, m_telST, m_telTracking, m_telZd, m_tseccell, m_ttruss, m_wxdewpoint, m_wxhumid, m_wxpres, m_wxtemp, m_wxwdir, m_wxwind, MagAOX::app::indi::updateIfChanged(), MagAOX::app::MagAOXApp< true >::updateIfChanged(), and MagAOX::app::MagAOXApp< true >::updateSwitchIfChanged().

Referenced by appLogic().

◆ updatesIfChanged()

void MagAOX::app::MagAOXApp< _useINDI >::updatesIfChanged	(	pcf::IndiProperty &	p,
		const std::vector< const char * > &	els,
		const std::vector< T > &	newVals,
		pcf::IndiProperty::PropertyStateType	newState = `pcf::IndiProperty::Ok`
	)

protectedinherited

Parameters

	p	[in/out] The property containing the element to possibly update
[in]	els	String vector of element names
[in]	newVals	the new values
[in]	newState	[optional] The state of the property

Definition at line 1042 of file MagAOXApp.hpp.

◆ updateSwitchIfChanged()

void MagAOX::app::MagAOXApp< _useINDI >::updateSwitchIfChanged	(	pcf::IndiProperty &	p,
		const std::string &	el,
		const pcf::IndiElement::SwitchStateType &	newVal,
		pcf::IndiProperty::PropertyStateType	ipState = `pcf::IndiProperty::Ok`
	)

protectedinherited

Update an INDI switch element value if it has changed.

Will only peform a SetProperty if the new element switch state has changed, or the propery state has changed.

Parameters

	p	[in/out] The property containing the element to possibly update
[in]	el	The element name
[in]	newVal	the new value

Definition at line 999 of file MagAOXApp.hpp.

◆ whilePowerOff()

int MagAOX::app::MagAOXApp< _useINDI >::whilePowerOff ( )

protectedvirtualinherited

This method is called while the power is off, once per FSM loop.

Returns: 0 on success.; -1 on any error which means the app should exit.

Reimplemented in MagAOX::app::alpaoCtrl, MagAOX::app::bmcCtrl, MagAOX::app::irisaoCtrl, and MagAOX::app::zaberLowLevel.

Definition at line 1164 of file MagAOXApp.hpp.

Friends And Related Symbol Documentation

◆ dev::telemeter< tcsInterface >

friend class dev::telemeter< tcsInterface >

friend

Definition at line 46 of file tcsInterface.hpp.

◆ tcsInterface_test

friend class tcsInterface_test

friend

Definition at line 46 of file tcsInterface.hpp.

Member Data Documentation

◆ m_acqAz0

float MagAOX::app::tcsInterface::m_acqAz0 { 18.5 }

Definition at line 286 of file tcsInterface.hpp.

Referenced by acquireFromGuider(), and loadConfigImpl().

◆ m_acqAzOff

float MagAOX::app::tcsInterface::m_acqAzOff { 0 }

Definition at line 287 of file tcsInterface.hpp.

Referenced by acquireFromGuider(), and loadConfigImpl().

◆ m_acqEl0

float MagAOX::app::tcsInterface::m_acqEl0 { 10 }

Definition at line 288 of file tcsInterface.hpp.

Referenced by acquireFromGuider(), and loadConfigImpl().

◆ m_acqElOff

float MagAOX::app::tcsInterface::m_acqElOff { 0 }

Definition at line 289 of file tcsInterface.hpp.

Referenced by acquireFromGuider(), and loadConfigImpl().

◆ m_acqFocus

float MagAOX::app::tcsInterface::m_acqFocus { 1400 }

Definition at line 290 of file tcsInterface.hpp.

Referenced by acquireFromGuider(), and loadConfigImpl().

◆ m_acqZdSign

int MagAOX::app::tcsInterface::m_acqZdSign { -1 }

Definition at line 285 of file tcsInterface.hpp.

Referenced by acquireFromGuider(), and loadConfigImpl().

◆ m_allDefsReceived

bool MagAOX::app::MagAOXApp< _useINDI >::m_allDefsReceived

protectedinherited

Flag indicating that all registered Set properties have been updated since last Get.

Definition at line 688 of file MagAOXApp.hpp.

◆ m_basePath

std::string MagAOX::app::MagAOXApp< _useINDI >::m_basePath

protectedinherited

The base path of the MagAO-X system.

Definition at line 177 of file MagAOXApp.hpp.

◆ m_calibDir

std::string MagAOX::app::MagAOXApp< _useINDI >::m_calibDir

protectedinherited

The path to calibration files for MagAOX.

Definition at line 185 of file MagAOXApp.hpp.

◆ m_catDec

double MagAOX::app::tcsInterface::m_catDec { 0 }

protected

Catalog declination [degrees].

Definition at line 114 of file tcsInterface.hpp.

Referenced by appStartup(), getCatData(), recordTelCat(), and updateINDI().

◆ m_catEp

double MagAOX::app::tcsInterface::m_catEp { 0 }

protected

Catalog epoch.

Definition at line 115 of file tcsInterface.hpp.

Referenced by appStartup(), getCatData(), recordTelCat(), and updateINDI().

◆ m_catObj

std::string MagAOX::app::tcsInterface::m_catObj

protected

Catalog object name.

Definition at line 118 of file tcsInterface.hpp.

Referenced by getCatData(), recordTelCat(), and updateINDI().

◆ m_catRA

double MagAOX::app::tcsInterface::m_catRA { 0 }

protected

Catalog right ascension [degrees].

Definition at line 113 of file tcsInterface.hpp.

Referenced by appStartup(), getCatData(), recordTelCat(), and updateINDI().

◆ m_catRm

std::string MagAOX::app::tcsInterface::m_catRm

protected

Catalog rotator mode.

Definition at line 117 of file tcsInterface.hpp.

Referenced by getCatData(), recordTelCat(), and updateINDI().

◆ m_catRo

double MagAOX::app::tcsInterface::m_catRo { 0 }

protected

Catalog rotator offset.

Definition at line 116 of file tcsInterface.hpp.

Referenced by appStartup(), getCatData(), recordTelCat(), and updateINDI().

◆ m_configBase

std::string MagAOX::app::MagAOXApp< _useINDI >::m_configBase

protectedinherited

The name of a base config class for this app (minus .conf).

Definition at line 183 of file MagAOXApp.hpp.

◆ m_configDir

std::string MagAOX::app::MagAOXApp< _useINDI >::m_configDir

protectedinherited

The path to configuration files for MagAOX.

Definition at line 181 of file MagAOXApp.hpp.

◆ m_configName

std::string MagAOX::app::MagAOXApp< _useINDI >::m_configName

protectedinherited

The name of the configuration file (minus .conf).

Definition at line 179 of file MagAOXApp.hpp.

◆ m_cpusetPath

std::string MagAOX::app::MagAOXApp< _useINDI >::m_cpusetPath

protectedinherited

Path to the cpusets mount.

The path to the cpusets mount is configured by the environment variable defined by MAGOX_env_cpuset in environment.hpp. This environment variable is normally named "CGROUPS1_CPUSET_MOUNTPOINT". If the environment variable is not set, the default defined by MAGAOX_cpusetPath in paths.hpp is used.

Definition at line 196 of file MagAOXApp.hpp.

◆ m_deviceAddr

std::string MagAOX::app::tcsInterface::m_deviceAddr { "localhost" }

protected

The IP address or resolvable name of the TCS.

Definition at line 66 of file tcsInterface.hpp.

Referenced by appLogic(), and loadConfigImpl().

◆ m_devicePort

int MagAOX::app::tcsInterface::m_devicePort { 5811 }

protected

The IP port for TCS communications. Should be the command port. Default is 5811.

Definition at line 67 of file tcsInterface.hpp.

Referenced by appLogic(), and loadConfigImpl().

◆ m_dimm_el

double MagAOX::app::tcsInterface::m_dimm_el { 0 }

protected

DIMM elevation at time of seeing measurement.

Definition at line 153 of file tcsInterface.hpp.

◆ m_dimm_fwhm_corr

double MagAOX::app::tcsInterface::m_dimm_fwhm_corr { 0 }

protected

DIMM elevation corrected FWHM.

Definition at line 154 of file tcsInterface.hpp.

Referenced by appStartup(), badSeeing(), getSeeing(), recordTelSee(), and updateINDI().

◆ m_dimm_time

int MagAOX::app::tcsInterface::m_dimm_time { 0 }

protected

Seconds since midnight of DIMM measurement.

Definition at line 155 of file tcsInterface.hpp.

Referenced by appStartup(), badSeeing(), getSeeing(), recordTelSee(), and updateINDI().

◆ m_driverCtrlName

std::string MagAOX::app::MagAOXApp< _useINDI >::m_driverCtrlName

protectedinherited

Full path name of the INDI driver control FIFO.

This is currently only used to signal restarts.

Definition at line 699 of file MagAOXApp.hpp.

◆ m_driverInName

std::string MagAOX::app::MagAOXApp< _useINDI >::m_driverInName

protectedinherited

Full path name of the INDI driver input FIFO.

Definition at line 691 of file MagAOXApp.hpp.

◆ m_driverOutName

std::string MagAOX::app::MagAOXApp< _useINDI >::m_driverOutName

protectedinherited

Full path name of the INDI driver output FIFO.

Definition at line 694 of file MagAOXApp.hpp.

◆ m_euidCalled

uid_t MagAOX::app::MagAOXApp< _useINDI >::m_euidCalled

privateinherited

The user id of the process as called (i.e. the higher privileged id of the owner, root if setuid).

Definition at line 411 of file MagAOXApp.hpp.

◆ m_euidReal

uid_t MagAOX::app::MagAOXApp< _useINDI >::m_euidReal

privateinherited

The real user id of the proces (i.e. the lower privileged id of the user)

Definition at line 410 of file MagAOXApp.hpp.

◆ m_firstRequest

size_t MagAOX::app::tcsInterface::m_firstRequest { 0 }

Definition at line 334 of file tcsInterface.hpp.

Referenced by offloadThreadExec().

◆ m_gitAlert

bool MagAOX::app::MagAOXApp< _useINDI >::m_gitAlert

privateinherited

Definition at line 571 of file MagAOXApp.hpp.

◆ m_indiDriver

indiDriver<MagAOXApp>* MagAOX::app::MagAOXApp< _useINDI >::m_indiDriver

inherited

The INDI driver wrapper. Constructed and initialized by execute, which starts and stops communications.

Todo:: instead of making this public, provide an accessor.

Definition at line 648 of file MagAOXApp.hpp.

◆ m_indiMutex

std::mutex MagAOX::app::MagAOXApp< _useINDI >::m_indiMutex

inherited

Mutex for locking INDI communications.

Definition at line 651 of file MagAOXApp.hpp.

◆ m_indiNewCallBacks

std::unordered_map<std::string, indiCallBack> MagAOX::app::MagAOXApp< _useINDI >::m_indiNewCallBacks

protectedinherited

Map to hold the NewProperty indiCallBacks for this App, with fast lookup by property name.

The key for these is the property name.

Definition at line 679 of file MagAOXApp.hpp.

◆ m_indiP_acqFromGuider

pcf::IndiProperty MagAOX::app::tcsInterface::m_indiP_acqFromGuider

Property used to request a pyramid nudge.

Definition at line 294 of file tcsInterface.hpp.

Referenced by appStartup().

◆ m_indiP_catalog

pcf::IndiProperty MagAOX::app::tcsInterface::m_indiP_catalog

protected

INDI Property for the catalog text information.

Definition at line 120 of file tcsInterface.hpp.

Referenced by appStartup(), and updateINDI().

◆ m_indiP_catdata

pcf::IndiProperty MagAOX::app::tcsInterface::m_indiP_catdata

protected

INDI Property for the catalog data.

Definition at line 121 of file tcsInterface.hpp.

Referenced by appStartup(), and updateINDI().

◆ m_indiP_clearFSMAlert

pcf::IndiProperty MagAOX::app::MagAOXApp< _useINDI >::m_indiP_clearFSMAlert

protectedinherited

indi Property to clear an FSM alert.

Definition at line 1094 of file MagAOXApp.hpp.

◆ m_indiP_env

pcf::IndiProperty MagAOX::app::tcsInterface::m_indiP_env

protected

INDI Property for environment.

Definition at line 150 of file tcsInterface.hpp.

Referenced by appStartup(), and updateINDI().

◆ m_indiP_labMode

pcf::IndiProperty MagAOX::app::tcsInterface::m_indiP_labMode

protected

Definition at line 57 of file tcsInterface.hpp.

Referenced by appStartup().

◆ m_indiP_loopState

pcf::IndiProperty MagAOX::app::tcsInterface::m_indiP_loopState

Property used to report the loop state.

Definition at line 260 of file tcsInterface.hpp.

Referenced by appStartup().

◆ m_indiP_offlFavgInt

pcf::IndiProperty MagAOX::app::tcsInterface::m_indiP_offlFavgInt

Definition at line 387 of file tcsInterface.hpp.

Referenced by appStartup(), and updateINDI().

◆ m_indiP_offlFdump

pcf::IndiProperty MagAOX::app::tcsInterface::m_indiP_offlFdump

Definition at line 384 of file tcsInterface.hpp.

Referenced by appStartup(), and updateINDI().

◆ m_indiP_offlFenable

pcf::IndiProperty MagAOX::app::tcsInterface::m_indiP_offlFenable

Definition at line 381 of file tcsInterface.hpp.

Referenced by appStartup(), and updateINDI().

◆ m_indiP_offlFgain

pcf::IndiProperty MagAOX::app::tcsInterface::m_indiP_offlFgain

Definition at line 390 of file tcsInterface.hpp.

Referenced by appStartup(), and updateINDI().

◆ m_indiP_offlFthresh

pcf::IndiProperty MagAOX::app::tcsInterface::m_indiP_offlFthresh

Definition at line 393 of file tcsInterface.hpp.

Referenced by appStartup(), and updateINDI().

◆ m_indiP_offloadCoeffs

pcf::IndiProperty MagAOX::app::tcsInterface::m_indiP_offloadCoeffs

Property used to report the latest woofer modal coefficients for offloading.

Definition at line 329 of file tcsInterface.hpp.

Referenced by appStartup().

◆ m_indiP_offlTTavgInt

pcf::IndiProperty MagAOX::app::tcsInterface::m_indiP_offlTTavgInt

Definition at line 363 of file tcsInterface.hpp.

Referenced by appStartup(), and updateINDI().

◆ m_indiP_offlTTdump

pcf::IndiProperty MagAOX::app::tcsInterface::m_indiP_offlTTdump

Definition at line 360 of file tcsInterface.hpp.

Referenced by appStartup(), and updateINDI().

◆ m_indiP_offlTTenable

pcf::IndiProperty MagAOX::app::tcsInterface::m_indiP_offlTTenable

Definition at line 357 of file tcsInterface.hpp.

Referenced by appStartup(), and updateINDI().

◆ m_indiP_offlTTgain

pcf::IndiProperty MagAOX::app::tcsInterface::m_indiP_offlTTgain

Definition at line 366 of file tcsInterface.hpp.

Referenced by appStartup(), and updateINDI().

◆ m_indiP_offlTTthresh

pcf::IndiProperty MagAOX::app::tcsInterface::m_indiP_offlTTthresh

Definition at line 369 of file tcsInterface.hpp.

Referenced by appStartup(), and updateINDI().

◆ m_indiP_powerChannel

pcf::IndiProperty MagAOX::app::MagAOXApp< _useINDI >::m_indiP_powerChannel

protectedinherited

INDI property used to communicate power state.

Definition at line 1150 of file MagAOXApp.hpp.

◆ m_indiP_pyrNudge

pcf::IndiProperty MagAOX::app::tcsInterface::m_indiP_pyrNudge

Property used to request a pyramid nudge.

Definition at line 282 of file tcsInterface.hpp.

Referenced by appStartup().

◆ m_indiP_seeing

pcf::IndiProperty MagAOX::app::tcsInterface::m_indiP_seeing

protected

INDI Property for seeing.

Definition at line 163 of file tcsInterface.hpp.

Referenced by appStartup(), and updateINDI().

◆ m_indiP_state

pcf::IndiProperty MagAOX::app::MagAOXApp< _useINDI >::m_indiP_state

protectedinherited

indi Property to report the application state.

Definition at line 1091 of file MagAOXApp.hpp.

◆ m_indiP_teldata

pcf::IndiProperty MagAOX::app::tcsInterface::m_indiP_teldata

protected

Definition at line 107 of file tcsInterface.hpp.

Referenced by appStartup(), and updateINDI().

◆ m_indiP_telpos

pcf::IndiProperty MagAOX::app::tcsInterface::m_indiP_telpos

protected

Definition at line 91 of file tcsInterface.hpp.

Referenced by appStartup(), and updateINDI().

◆ m_indiP_teltime

pcf::IndiProperty MagAOX::app::tcsInterface::m_indiP_teltime

protected

Definition at line 80 of file tcsInterface.hpp.

Referenced by appStartup(), and updateINDI().

◆ m_indiP_vaneend

pcf::IndiProperty MagAOX::app::tcsInterface::m_indiP_vaneend

protected

INDI Property for the vane end positions.

Definition at line 136 of file tcsInterface.hpp.

Referenced by appStartup(), and updateINDI().

◆ m_indiSetCallBacks

std::unordered_map<std::string, indiCallBack> MagAOX::app::MagAOXApp< _useINDI >::m_indiSetCallBacks

protectedinherited

Map to hold the SetProperty indiCallBacks for this App, with fast lookup by property name.

The key for these is device.name

Definition at line 684 of file MagAOXApp.hpp.

◆ m_lab_offlTT_C_00

float MagAOX::app::tcsInterface::m_lab_offlTT_C_00 { 0.17 }

Definition at line 340 of file tcsInterface.hpp.

Referenced by loadConfigImpl().

◆ m_lab_offlTT_C_01

float MagAOX::app::tcsInterface::m_lab_offlTT_C_01 { 1.03 }

Definition at line 341 of file tcsInterface.hpp.

Referenced by loadConfigImpl().

◆ m_lab_offlTT_C_10

float MagAOX::app::tcsInterface::m_lab_offlTT_C_10 { -1.03 }

Definition at line 342 of file tcsInterface.hpp.

Referenced by loadConfigImpl().

◆ m_lab_offlTT_C_11

float MagAOX::app::tcsInterface::m_lab_offlTT_C_11 { 0.48 }

Definition at line 343 of file tcsInterface.hpp.

Referenced by loadConfigImpl().

◆ m_labMode

bool MagAOX::app::tcsInterface::m_labMode { true }

protected

Definition at line 55 of file tcsInterface.hpp.

Referenced by appStartup(), doFoffload(), doTToffload(), getSeeing(), loadConfigImpl(), and sendTToffload().

◆ m_last_nRequests

size_t MagAOX::app::tcsInterface::m_last_nRequests { 0 }

Definition at line 337 of file tcsInterface.hpp.

Referenced by offloadThreadExec().

◆ m_lastRequest

size_t MagAOX::app::tcsInterface::m_lastRequest { std::numeric_limits<size_t>::max() }

Definition at line 335 of file tcsInterface.hpp.

Referenced by offloadThreadExec().

◆ m_log

MagAOXApp< _useINDI >::logManagerT MagAOX::app::MagAOXApp< _useINDI >::m_log

staticinherited

Definition at line 334 of file MagAOXApp.hpp.

◆ m_loopPause

unsigned long MagAOX::app::MagAOXApp< _useINDI >::m_loopPause

protectedinherited

The time in nanoseconds to pause the main loop. The appLogic() function of the derived class is called every m_loopPause nanoseconds. Default is 1,000,000,000 ns. Config with loopPause=X.

Definition at line 198 of file MagAOXApp.hpp.

◆ m_loopState

int MagAOX::app::tcsInterface::m_loopState { 0 }

Definition at line 259 of file tcsInterface.hpp.

Referenced by offloadThreadExec().

◆ m_mag1_fwhm_corr

double MagAOX::app::tcsInterface::m_mag1_fwhm_corr { 0 }

protected

MAG1 elevation corrected FWHM.

Definition at line 157 of file tcsInterface.hpp.

Referenced by appStartup(), badSeeing(), getSeeing(), recordTelSee(), and updateINDI().

◆ m_mag1_time

int MagAOX::app::tcsInterface::m_mag1_time { 0 }

protected

Seconds since midnight of MAG1 measurement.

Definition at line 158 of file tcsInterface.hpp.

Referenced by appStartup(), badSeeing(), getSeeing(), recordTelSee(), and updateINDI().

◆ m_mag2_fwhm_corr

double MagAOX::app::tcsInterface::m_mag2_fwhm_corr { 0 }

protected

MAG2 elevation corrected FWHM.

Definition at line 160 of file tcsInterface.hpp.

Referenced by appStartup(), badSeeing(), getSeeing(), recordTelSee(), and updateINDI().

◆ m_mag2_time

int MagAOX::app::tcsInterface::m_mag2_time { 0 }

protected

Seconds since midnight of MAG2 measurement.

Definition at line 161 of file tcsInterface.hpp.

Referenced by appStartup(), badSeeing(), getSeeing(), recordTelSee(), and updateINDI().

◆ m_maxInterval

double MagAOX::app::dev::telemeter< tcsInterface >::m_maxInterval

inherited

The maximum interval, in seconds, between telemetry records. Default is 10.0 seconds.

Definition at line 83 of file telemeter.hpp.

◆ m_nRequests

size_t MagAOX::app::tcsInterface::m_nRequests { 0 }

Definition at line 336 of file tcsInterface.hpp.

Referenced by offloadThreadExec().

◆ m_offlCComa_00

float MagAOX::app::tcsInterface::m_offlCComa_00 { 1 }

Definition at line 396 of file tcsInterface.hpp.

Referenced by loadConfigImpl().

◆ m_offlCComa_01

float MagAOX::app::tcsInterface::m_offlCComa_01 { 0 }

Definition at line 397 of file tcsInterface.hpp.

Referenced by loadConfigImpl().

◆ m_offlCComa_10

float MagAOX::app::tcsInterface::m_offlCComa_10 { 1 }

Definition at line 398 of file tcsInterface.hpp.

Referenced by loadConfigImpl().

◆ m_offlCComa_11

float MagAOX::app::tcsInterface::m_offlCComa_11 { 0 }

Definition at line 399 of file tcsInterface.hpp.

Referenced by loadConfigImpl().

◆ m_offlCFocus_00

float MagAOX::app::tcsInterface::m_offlCFocus_00 { 1 }

Definition at line 373 of file tcsInterface.hpp.

Referenced by loadConfigImpl().

◆ m_offlF_avgInt

float MagAOX::app::tcsInterface::m_offlF_avgInt { 1.0 }

Definition at line 377 of file tcsInterface.hpp.

Referenced by appStartup(), loadConfigImpl(), offloadThreadExec(), and updateINDI().

◆ m_offlF_dump

bool MagAOX::app::tcsInterface::m_offlF_dump { false }

Definition at line 376 of file tcsInterface.hpp.

Referenced by doFoffload(), and updateINDI().

◆ m_offlF_enabled

bool MagAOX::app::tcsInterface::m_offlF_enabled { false }

Definition at line 375 of file tcsInterface.hpp.

Referenced by doFoffload(), and updateINDI().

◆ m_offlF_gain

float MagAOX::app::tcsInterface::m_offlF_gain { 0.1 }

Definition at line 378 of file tcsInterface.hpp.

Referenced by appStartup(), doFoffload(), loadConfigImpl(), and updateINDI().

◆ m_offlF_thresh

float MagAOX::app::tcsInterface::m_offlF_thresh { 0.1 }

Definition at line 379 of file tcsInterface.hpp.

Referenced by appStartup(), doFoffload(), loadConfigImpl(), and updateINDI().

◆ m_offloadRequests

std::vector<std::vector<float> > MagAOX::app::tcsInterface::m_offloadRequests

Definition at line 333 of file tcsInterface.hpp.

Referenced by appStartup(), and offloadThreadExec().

◆ m_offloadThread

std::thread MagAOX::app::tcsInterface::m_offloadThread

The offloading thread.

Definition at line 310 of file tcsInterface.hpp.

Referenced by appShutdown(), and appStartup().

◆ m_offloadThreadID

pid_t MagAOX::app::tcsInterface::m_offloadThreadID { 0 }

Offload thread pid.

Definition at line 306 of file tcsInterface.hpp.

Referenced by appStartup(), and offloadThreadExec().

◆ m_offloadThreadInit

bool MagAOX::app::tcsInterface::m_offloadThreadInit { true }

Initialization flag for the offload thread.

Definition at line 304 of file tcsInterface.hpp.

Referenced by appStartup(), and offloadThreadExec().

◆ m_offloadThreadProp

pcf::IndiProperty MagAOX::app::tcsInterface::m_offloadThreadProp

Offload thread INDI property.

Definition at line 308 of file tcsInterface.hpp.

Referenced by appStartup().

◆ m_offlTT_avgInt

float MagAOX::app::tcsInterface::m_offlTT_avgInt { 1.0 }

Definition at line 353 of file tcsInterface.hpp.

Referenced by appStartup(), loadConfigImpl(), offloadThreadExec(), and updateINDI().

◆ m_offlTT_C_00

float MagAOX::app::tcsInterface::m_offlTT_C_00 { -0.5 }

Definition at line 346 of file tcsInterface.hpp.

Referenced by loadConfigImpl().

◆ m_offlTT_C_01

float MagAOX::app::tcsInterface::m_offlTT_C_01 { 0 }

Definition at line 347 of file tcsInterface.hpp.

Referenced by loadConfigImpl().

◆ m_offlTT_C_10

float MagAOX::app::tcsInterface::m_offlTT_C_10 { 0 }

Definition at line 348 of file tcsInterface.hpp.

Referenced by loadConfigImpl().

◆ m_offlTT_C_11

float MagAOX::app::tcsInterface::m_offlTT_C_11 { -0.25 }

Definition at line 349 of file tcsInterface.hpp.

Referenced by loadConfigImpl().

◆ m_offlTT_dump

bool MagAOX::app::tcsInterface::m_offlTT_dump { false }

Definition at line 352 of file tcsInterface.hpp.

Referenced by doTToffload(), and updateINDI().

◆ m_offlTT_enabled

bool MagAOX::app::tcsInterface::m_offlTT_enabled { false }

Definition at line 351 of file tcsInterface.hpp.

Referenced by doTToffload(), and updateINDI().

◆ m_offlTT_gain

float MagAOX::app::tcsInterface::m_offlTT_gain { 0.1 }

Definition at line 354 of file tcsInterface.hpp.

Referenced by appStartup(), doTToffload(), loadConfigImpl(), and updateINDI().

◆ m_offlTT_thresh

float MagAOX::app::tcsInterface::m_offlTT_thresh { 0.1 }

Definition at line 355 of file tcsInterface.hpp.

Referenced by appStartup(), doTToffload(), loadConfigImpl(), and updateINDI().

◆ m_pid

pid_t MagAOX::app::MagAOXApp< _useINDI >::m_pid

protectedinherited

This process's PID.

Definition at line 495 of file MagAOXApp.hpp.

◆ m_powerChannel

std::string MagAOX::app::MagAOXApp< _useINDI >::m_powerChannel

protectedinherited

The INDI property name of the channel controlling this device's power.

Definition at line 1136 of file MagAOXApp.hpp.

◆ m_powerDevice

std::string MagAOX::app::MagAOXApp< _useINDI >::m_powerDevice

protectedinherited

The INDI device name of the power controller.

Definition at line 1135 of file MagAOXApp.hpp.

◆ m_powerElement

std::string MagAOX::app::MagAOXApp< _useINDI >::m_powerElement

protectedinherited

The INDI element name to monitor for this device's power state.

Definition at line 1137 of file MagAOXApp.hpp.

◆ m_powerMgtEnabled

bool MagAOX::app::MagAOXApp< _useINDI >::m_powerMgtEnabled

protectedinherited

Flag controls whether power mgt is used. Set this in the constructor of a derived app. If true, then if after loadConfig the powerDevice and powerChannel are empty, then the app will exit with a critical error.

Definition at line 1130 of file MagAOXApp.hpp.

◆ m_powerOnCounter

int MagAOX::app::MagAOXApp< _useINDI >::m_powerOnCounter

protectedinherited

Counts numer of loops after power on, implements delay for device bootup. If -1, then device was NOT powered off on app startup.

Definition at line 1143 of file MagAOXApp.hpp.

◆ m_powerOnWait

unsigned long MagAOX::app::MagAOXApp< _useINDI >::m_powerOnWait

protectedinherited

Time in sec to wait for device to boot after power on.

Definition at line 1140 of file MagAOXApp.hpp.

◆ m_powerState

int MagAOX::app::MagAOXApp< _useINDI >::m_powerState

protectedinherited

Current power state, 1=On, 0=Off, -1=Unk.

Definition at line 1147 of file MagAOXApp.hpp.

◆ m_powerTargetElement

std::string MagAOX::app::MagAOXApp< _useINDI >::m_powerTargetElement

protectedinherited

The INDI element name to monitor for this device's power state.

Definition at line 1138 of file MagAOXApp.hpp.

◆ m_powerTargetState

int MagAOX::app::MagAOXApp< _useINDI >::m_powerTargetState

protectedinherited

Current target power state, 1=On, 0=Off, -1=Unk.

Definition at line 1148 of file MagAOXApp.hpp.

◆ m_pyrNudge_ang

float MagAOX::app::tcsInterface::m_pyrNudge_ang { 45.0 }

Definition at line 276 of file tcsInterface.hpp.

Referenced by loadConfigImpl().

◆ m_pyrNudge_ang0

float MagAOX::app::tcsInterface::m_pyrNudge_ang0 { 0.0 }

Definition at line 277 of file tcsInterface.hpp.

Referenced by loadConfigImpl().

◆ m_pyrNudge_C_00

float MagAOX::app::tcsInterface::m_pyrNudge_C_00 { 1 }

Definition at line 270 of file tcsInterface.hpp.

Referenced by loadConfigImpl(), and sendPyrNudge().

◆ m_pyrNudge_C_01

float MagAOX::app::tcsInterface::m_pyrNudge_C_01 { 0 }

Definition at line 271 of file tcsInterface.hpp.

Referenced by loadConfigImpl(), and sendPyrNudge().

◆ m_pyrNudge_C_10

float MagAOX::app::tcsInterface::m_pyrNudge_C_10 { 0 }

Definition at line 272 of file tcsInterface.hpp.

Referenced by loadConfigImpl(), and sendPyrNudge().

◆ m_pyrNudge_C_11

float MagAOX::app::tcsInterface::m_pyrNudge_C_11 { 1 }

Definition at line 273 of file tcsInterface.hpp.

Referenced by loadConfigImpl(), and sendPyrNudge().

◆ m_pyrNudge_F_sign

float MagAOX::app::tcsInterface::m_pyrNudge_F_sign { 1 }

Definition at line 274 of file tcsInterface.hpp.

Referenced by acquireFromGuider(), and sendPyrNudge().

◆ m_pyrNudge_parity

float MagAOX::app::tcsInterface::m_pyrNudge_parity { -1 }

Definition at line 278 of file tcsInterface.hpp.

Referenced by loadConfigImpl().

◆ m_readTimeout

unsigned MagAOX::app::dev::ioDevice::m_readTimeout {1000}

inherited

The read timeout [msec].

Definition at line 28 of file ioDevice.hpp.

Referenced by MagAOX::app::rhusbMon::rhusbMon(), acquireFromGuider(), MagAOX::app::picoMotorCtrl::appLogic(), MagAOX::app::trippLitePDU::devPostLogin(), MagAOX::app::trippLitePDU::devStatus(), MagAOX::app::pi335Ctrl::finishInit(), MagAOX::app::pi335Ctrl::getCom(), MagAOX::app::smc100ccCtrl::getCtrlState(), MagAOX::app::smc100ccCtrl::getLastError(), getMagTelStatus(), MagAOX::app::flipperCtrl::getPos(), MagAOX::app::smc100ccCtrl::getPosition(), MagAOX::app::pi335Ctrl::initDM(), MagAOX::app::dev::ioDevice::loadConfig(), MagAOX::app::rhusbMon::readProbe(), sendFoffload(), sendPyrNudge(), sendTToffload(), MagAOX::app::pi335Ctrl::testConnection(), MagAOX::app::smc100ccCtrl::testConnection(), MagAOX::app::trippLitePDU::turnOutletOff(), and MagAOX::app::trippLitePDU::turnOutletOn().

◆ m_secretsPath

std::string MagAOX::app::MagAOXApp< _useINDI >::m_secretsPath

protectedinherited

Path to the secrets directory, where passwords, etc, are stored.

Definition at line 189 of file MagAOXApp.hpp.

◆ m_seeingInterval

int MagAOX::app::tcsInterface::m_seeingInterval { 2 }

protected

Definition at line 68 of file tcsInterface.hpp.

Referenced by getSeeing().

◆ m_self

MagAOXApp< _useINDI > * MagAOX::app::MagAOXApp< _useINDI >::m_self

staticprivateinherited

Static pointer to this (set in constructor). Used to test whether a a MagAOXApp is already instatiated (a fatal error) and used for getting out of static signal handlers.

Definition at line 386 of file MagAOXApp.hpp.

◆ m_shutdown

int MagAOX::app::MagAOXApp< _useINDI >::m_shutdown

protectedinherited

Flag to signal it's time to shutdown. When not 0, the main loop exits.

Definition at line 203 of file MagAOXApp.hpp.

◆ m_sock

tty::netSerial MagAOX::app::tcsInterface::m_sock

protected

Definition at line 73 of file tcsInterface.hpp.

Referenced by appLogic(), getMagTelStatus(), and sendMagTelCommand().

◆ m_state

stateCodes::stateCodeT MagAOX::app::MagAOXApp< _useINDI >::m_state

privateinherited

The application's state. Never ever set this directly, use state(const stateCodeT & s).

Definition at line 565 of file MagAOXApp.hpp.

◆ m_stateAlert

bool MagAOX::app::MagAOXApp< _useINDI >::m_stateAlert

privateinherited

Definition at line 568 of file MagAOXApp.hpp.

◆ m_stateLogged

int MagAOX::app::MagAOXApp< _useINDI >::m_stateLogged

privateinherited

Counter and flag for use to log errors just once. Never ever access directly, use stateLogged().

Definition at line 573 of file MagAOXApp.hpp.

◆ m_suid

uid_t MagAOX::app::MagAOXApp< _useINDI >::m_suid

privateinherited

The save-set user id of the process.

Definition at line 413 of file MagAOXApp.hpp.

◆ m_sysPath

std::string MagAOX::app::MagAOXApp< _useINDI >::m_sysPath

protectedinherited

The path to the system directory, for PID file, etc.

Definition at line 187 of file MagAOXApp.hpp.

◆ m_tambient

double MagAOX::app::tcsInterface::m_tambient { 0 }

protected

Dome air temperature, Celsius.

Definition at line 147 of file tcsInterface.hpp.

Referenced by appStartup(), getEnvData(), recordTelEnv(), and updateINDI().

◆ m_tcell

double MagAOX::app::tcsInterface::m_tcell { 0 }

protected

Primary mirror cell temperature, Celsius.

Definition at line 145 of file tcsInterface.hpp.

Referenced by appStartup(), getEnvData(), recordTelEnv(), and updateINDI().

◆ m_tcsMutex

std::mutex MagAOX::app::tcsInterface::m_tcsMutex

protected

Mutex for locking TCS communications.

Definition at line 71 of file tcsInterface.hpp.

Referenced by getMagTelStatus(), and sendMagTelCommand().

◆ m_tel

logManagerT MagAOX::app::dev::telemeter< tcsInterface >::m_tel

inherited

Definition at line 81 of file telemeter.hpp.

◆ m_telAM

double MagAOX::app::tcsInterface::m_telAM { 0 }

protected

Definition at line 88 of file tcsInterface.hpp.

Referenced by appStartup(), getTelPos(), recordTelPos(), and updateINDI().

◆ m_telAz

double MagAOX::app::tcsInterface::m_telAz { 0 }

protected

azimuth

Definition at line 101 of file tcsInterface.hpp.

Referenced by appStartup(), getTelData(), recordTelData(), and updateINDI().

◆ m_telDec

double MagAOX::app::tcsInterface::m_telDec { 0 }

protected

Definition at line 85 of file tcsInterface.hpp.

Referenced by appStartup(), getTelPos(), recordTelPos(), and updateINDI().

◆ m_telDomeAz

double MagAOX::app::tcsInterface::m_telDomeAz { 0 }

protected

dome azimuth

Definition at line 104 of file tcsInterface.hpp.

Referenced by appStartup(), getTelData(), recordTelData(), and updateINDI().

◆ m_telDomeStat

int MagAOX::app::tcsInterface::m_telDomeStat { 0 }

protected

dome status

Definition at line 105 of file tcsInterface.hpp.

Referenced by appStartup(), getTelData(), recordTelData(), and updateINDI().

◆ m_telEl

double MagAOX::app::tcsInterface::m_telEl { 0 }

protected

Definition at line 86 of file tcsInterface.hpp.

Referenced by appStartup(), getTelData(), recordTelPos(), and updateINDI().

◆ m_telEncH

double MagAOX::app::tcsInterface::m_telEncH { 0 }

protected

Definition at line 132 of file tcsInterface.hpp.

Referenced by appStartup(), getVaneData(), recordTelVane(), and updateINDI().

◆ m_telEncV

double MagAOX::app::tcsInterface::m_telEncV { 0 }

protected

Definition at line 134 of file tcsInterface.hpp.

Referenced by appStartup(), getVaneData(), recordTelVane(), and updateINDI().

◆ m_telEncX

double MagAOX::app::tcsInterface::m_telEncX { 0 }

protected

Definition at line 128 of file tcsInterface.hpp.

Referenced by appStartup(), getVaneData(), recordTelVane(), and updateINDI().

◆ m_telEncY

double MagAOX::app::tcsInterface::m_telEncY { 0 }

protected

Definition at line 130 of file tcsInterface.hpp.

Referenced by appStartup(), getVaneData(), recordTelVane(), and updateINDI().

◆ m_telEncZ

double MagAOX::app::tcsInterface::m_telEncZ { 0 }

protected

Definition at line 126 of file tcsInterface.hpp.

Referenced by appStartup(), getVaneData(), recordTelVane(), and updateINDI().

◆ m_telEpoch

double MagAOX::app::tcsInterface::m_telEpoch { 0 }

protected

Definition at line 83 of file tcsInterface.hpp.

Referenced by appStartup(), getTelPos(), recordTelPos(), and updateINDI().

◆ m_telGuiderMoving

int MagAOX::app::tcsInterface::m_telGuiderMoving { 0 }

protected

guider moving state

Definition at line 100 of file tcsInterface.hpp.

Referenced by appStartup(), getTelData(), recordTelData(), and updateINDI().

◆ m_telGuiding

int MagAOX::app::tcsInterface::m_telGuiding { 0 }

protected

guider moving state

Definition at line 98 of file tcsInterface.hpp.

Referenced by appStartup(), getTelData(), recordTelData(), and updateINDI().

◆ m_telHA

double MagAOX::app::tcsInterface::m_telHA { 0 }

protected

Definition at line 87 of file tcsInterface.hpp.

Referenced by appStartup(), getTelPos(), recordTelPos(), and updateINDI().

◆ m_telPA

double MagAOX::app::tcsInterface::m_telPA { 0 }

protected

parallactic angle

Definition at line 103 of file tcsInterface.hpp.

Referenced by appStartup(), getTelData(), recordTelData(), and updateINDI().

◆ m_telRA

double MagAOX::app::tcsInterface::m_telRA { 0 }

protected

Definition at line 84 of file tcsInterface.hpp.

Referenced by appStartup(), getTelPos(), recordTelPos(), and updateINDI().

◆ m_telROI

int MagAOX::app::tcsInterface::m_telROI { 0 }

protected

The rotator of interest.

Definition at line 96 of file tcsInterface.hpp.

Referenced by appStartup(), getTelData(), recordTelData(), and updateINDI().

◆ m_telRotOff

double MagAOX::app::tcsInterface::m_telRotOff { 0 }

protected

Definition at line 89 of file tcsInterface.hpp.

Referenced by appStartup(), getTelPos(), recordTelPos(), and updateINDI().

◆ m_telSecH

double MagAOX::app::tcsInterface::m_telSecH { 0 }

protected

Definition at line 131 of file tcsInterface.hpp.

Referenced by appStartup(), getVaneData(), recordTelVane(), and updateINDI().

◆ m_telSecV

double MagAOX::app::tcsInterface::m_telSecV { 0 }

protected

Definition at line 133 of file tcsInterface.hpp.

Referenced by appStartup(), getVaneData(), recordTelVane(), and updateINDI().

◆ m_telSecX

double MagAOX::app::tcsInterface::m_telSecX { 0 }

protected

Definition at line 127 of file tcsInterface.hpp.

Referenced by appStartup(), getVaneData(), recordTelVane(), and updateINDI().

◆ m_telSecY

double MagAOX::app::tcsInterface::m_telSecY { 0 }

protected

Definition at line 129 of file tcsInterface.hpp.

Referenced by appStartup(), getVaneData(), recordTelVane(), and updateINDI().

◆ m_telSecZ

double MagAOX::app::tcsInterface::m_telSecZ { 0 }

protected

Definition at line 125 of file tcsInterface.hpp.

Referenced by appStartup(), getVaneData(), recordTelVane(), and updateINDI().

◆ m_telSlewing

int MagAOX::app::tcsInterface::m_telSlewing { 0 }

protected

slewing state

Definition at line 99 of file tcsInterface.hpp.

Referenced by appStartup(), getTelData(), recordTelData(), and updateINDI().

◆ m_telST

double MagAOX::app::tcsInterface::m_telST { 0 }

protected

Definition at line 78 of file tcsInterface.hpp.

Referenced by appStartup(), getTelTime(), and updateINDI().

◆ m_telTracking

int MagAOX::app::tcsInterface::m_telTracking { 0 }

protected

tracking state

Definition at line 97 of file tcsInterface.hpp.

Referenced by appStartup(), getTelData(), recordTelData(), and updateINDI().

◆ m_telZd

double MagAOX::app::tcsInterface::m_telZd { 0 }

protected

zenith distance

Definition at line 102 of file tcsInterface.hpp.

Referenced by acquireFromGuider(), appStartup(), getTelData(), recordTelData(), and updateINDI().

◆ m_tseccell

double MagAOX::app::tcsInterface::m_tseccell { 0 }

protected

Secondary mirror cell temperature, Celsius.

Definition at line 146 of file tcsInterface.hpp.

Referenced by appStartup(), getEnvData(), recordTelEnv(), and updateINDI().

◆ m_ttruss

double MagAOX::app::tcsInterface::m_ttruss { 0 }

protected

Telescope truss temperature, Celsius.

Definition at line 144 of file tcsInterface.hpp.

Referenced by appStartup(), getEnvData(), recordTelEnv(), and updateINDI().

◆ m_useINDI

constexpr bool MagAOX::app::MagAOXApp< _useINDI >::m_useINDI

staticconstexprprotectedinherited

Flag controlling whether INDI is used. If false, then no INDI code executes.

Definition at line 643 of file MagAOXApp.hpp.

◆ m_writeTimeout

unsigned MagAOX::app::dev::ioDevice::m_writeTimeout {1000}

inherited

The write timeout [msec].

Definition at line 29 of file ioDevice.hpp.

◆ m_wxdewpoint

double MagAOX::app::tcsInterface::m_wxdewpoint { 0 }

protected

Dew point from weather station.

Definition at line 148 of file tcsInterface.hpp.

Referenced by appStartup(), getEnvData(), recordTelEnv(), and updateINDI().

◆ m_wxhumid

double MagAOX::app::tcsInterface::m_wxhumid { 0 }

protected

Outside humidity, percent.

Definition at line 141 of file tcsInterface.hpp.

Referenced by appStartup(), getEnvData(), recordTelEnv(), and updateINDI().

◆ m_wxpres

double MagAOX::app::tcsInterface::m_wxpres { 0 }

protected

Outside pressue, millibars.

Definition at line 140 of file tcsInterface.hpp.

Referenced by appStartup(), getEnvData(), recordTelEnv(), and updateINDI().

◆ m_wxtemp

double MagAOX::app::tcsInterface::m_wxtemp { 0 }

protected

Outside temperature, Celsius.

Definition at line 139 of file tcsInterface.hpp.

Referenced by appStartup(), getEnvData(), recordTelEnv(), and updateINDI().

◆ m_wxwdir

double MagAOX::app::tcsInterface::m_wxwdir { 0 }

protected

outside wind direction, degrees

Definition at line 143 of file tcsInterface.hpp.

Referenced by appStartup(), getEnvData(), recordTelEnv(), and updateINDI().

◆ m_wxwind

double MagAOX::app::tcsInterface::m_wxwind { 0 }

protected

outside wind intensity, mph

Definition at line 142 of file tcsInterface.hpp.

Referenced by appStartup(), getEnvData(), recordTelEnv(), and updateINDI().

◆ pidFileName

std::string MagAOX::app::MagAOXApp< _useINDI >::pidFileName

protectedinherited

The name of the PID file.

Definition at line 493 of file MagAOXApp.hpp.

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

apps/tcsInterface/tcsInterface.hpp

Public Types

Public Member Functions

Public Attributes

Protected Attributes

Private Member Functions

Friends

lab mode

PID Locking

INDI Interface

Power Management

Pyramid Nudging and Acquisition

Woofer Offloading

Logging

Application State

Signal Handling

Privilege Management

Detailed Description

Member Typedef Documentation

◆ callBackInsertResult

◆ callBackIterator

◆ callBackValueType

◆ logManagerT [1/2]

◆ logManagerT [2/2]

◆ verboseT [1/2]

◆ verboseT [2/2]

Constructor & Destructor Documentation

◆ tcsInterface()

◆ ~tcsInterface()

Member Function Documentation

◆ _handlerSigTerm()

◆ acquireFromGuider()

◆ appLogic()

◆ appShutdown()

◆ appStartup()

◆ badSeeing()

◆ basePath()

◆ calibDir()

◆ checkConfig()

◆ checkRecordTimes() [1/4]

◆ checkRecordTimes() [2/4]

◆ checkRecordTimes() [3/4]

◆ checkRecordTimes() [4/4]

◆ clearFSMAlert()

◆ configBase()

◆ configDir()

◆ configLog()

◆ configName()

◆ cpusetPath()

◆ createINDIFIFOS()

◆ createROIndiNumber()

◆ createROIndiText()

◆ createStandardIndiNumber()

◆ createStandardIndiRequestSw()

◆ createStandardIndiSelectionSw() [1/2]

◆ createStandardIndiSelectionSw() [2/2]

◆ createStandardIndiText()

◆ createStandardIndiToggleSw()

◆ derived()

◆ doFoffload()

◆ doTToffload()

◆ driverCtrlName()

◆ driverInName()

◆ driverOutName()

◆ execute()

◆ getCatData()

◆ getEnvData()

◆ getMagTelStatus()

◆ getSeeing()

◆ getTelData()

◆ getTelPos()

◆ getTelTime()

◆ getVaneData()

◆ gitAlert()

◆ handleDefProperty()

◆ handleGetProperties()

◆ handleNewProperty()

◆ handlerSigTerm()

◆ handleSetProperty()

◆ INDI_NEWCALLBACK_DECL() [1/13]

◆ INDI_NEWCALLBACK_DECL() [2/13]