The MagAO-X flow-from-RPM monitor. More...

#include <flowRPM.hpp>

Inheritance diagram for MagAOX::app::flowRPM:

Collaboration diagram for MagAOX::app::flowRPM:

Classes
struct	parseResult
	Parsed result of the current file contents. More...

Public Types
enum class	parseStatus { success , fileReadError , missingTimestamp , malformedTimestamp , missingRecord , malformedRecord , wrongDescriptor , wrongUnits , badStatus , badValue , staleReading }
	Status returned by the file parser. More...

typedef dev::telemeter< flowRPM >	telemeterT
	The telemeter base type.

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< flowRPM, logFileRaw< verboseT > >	logManagerT
	The log manager type.

Public Member Functions
	flowRPM ()
	Default c'tor.

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

virtual void	setupConfig ()
	Set up the application configuration.

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

virtual void	loadConfig ()
	Load the application configuration.

virtual int	appStartup ()
	Perform application startup.

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

virtual int	appShutdown ()
	Shut the application down.

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	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
int	checkRecordTimes ()
	Check whether telemetry records need to be forced.

int	recordTelem (const logger::telem_flowrpm *)
	Record telemetry when requested by the telemeter helper.

virtual int	recordFlow (bool force=false)
	Record the currently displayed flow state to telemetry.

parseResult	reconcileResult (const parseResult &result, const timespec &now) const
	Reconcile a newly parsed result against the currently displayed state.

virtual int	publishResult (const parseResult &result)
	Publish a parse result to INDI and runtime state.

bool	shouldLogError (const std::string &key, const timespec &now)
	Determine whether a repeated error should be logged now.

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
logManagerT	m_tel

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

Protected Attributes
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.

Configurable Parameters - Data
std::string	m_inputPath { "/tmp/fac_flow.txt" }
	Path to the file written by the systemd producer.

double	m_maxAge { 60.0 }
	Maximum allowed source age in seconds before the reading is treated as stale.

std::string	m_fanDescriptor { "CHA_FAN1" }
	Expected fan descriptor in the pipe-delimited record.

double	m_badValue { -999.0 }
	Bad-value sentinel published on parse or availability failures.

double	m_errorLogInterval { 60.0 }
	Minimum interval between repeated logs for the same persistent error.

Runtime State - Data
double	m_flowRate { -999.0 }
	Current published flow rate in LPM or the bad-value sentinel.

double	m_age { -999.0 }
	Current published age in seconds or the bad-value sentinel.

timespec	m_sourceTs { 0, 0 }
	Timestamp parsed from the input file for the currently displayed value.

bool	m_haveValidReading { false }
	Whether the current displayed value is valid.

double	m_lastTelemFlowRate { std::numeric_limits<double>::quiet_NaN() }
	Last flow value written to telemetry.

bool	m_lastTelemValid { false }
	Last validity state written to telemetry.

timespec	m_lastErrorLogTs { 0, 0 }
	Time of the most recent error log emission.

std::string	m_lastErrorKey
	Key for the most recently logged error class.

pcf::IndiProperty	m_indiP_status
	Read-only status property exposing flow rate and age.

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

flowRPM &	derived ()
	Access the derived class.

Friends
class	flowRPM_test

class	dev::telemeter< flowRPM >

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.
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.

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.

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	resetIndiSetPropertyRetry (indiCallBack &callBack)
	Reset retry tracking for a monitored INDI Set-property subscription.

bool	indiSetPropertyShouldRequest (const indiCallBack &callBack, bool all, const std::chrono::steady_clock::time_point &now) const
	Determine whether an unresolved Set-property subscription should be requested now.

void	noteIndiSetPropertyRequested (indiCallBack &callBack, const std::chrono::steady_clock::time_point &now)
	Update retry tracking after sending a GetProperties request for a monitored Set-property.

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.

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

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.

std::mutex	m_indiCallBackMutex
	Mutex for locking INDI callback maps and per-entry callback state.

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.

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.

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.

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
	Default 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.

int	powerState ()
	Returns the current power state.

int	powerStateTarget ()
	Returns the target power state.

	INDI_SETCALLBACK_DECL (MagAOXApp, m_indiP_powerChannel)

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.

Parser Helpers
int	parseTimestamp (timespec &ts, const std::string &line) const
	Parse a source timestamp line into a timespec.

parseStatus	parseRecordLine (double &flowRate, const std::string &line) const
	Parse the sensor record line into a flow rate in LPM.

int	parseFileContents (parseResult &result, const std::string &contents, const timespec &now) const
	Parse the two-line file contents using a supplied current time.

virtual int	readAndParse (parseResult &result, const timespec &now) const
	Read the configured file and parse its current contents.

const std::string &	inputPath () const
	Get the configured input path.

double	maxAge () const
	Get the configured maximum reading age in seconds.

const std::string &	fanDescriptor () const
	Get the configured fan descriptor.

double	badValue () const
	Get the configured bad-value sentinel.

double	errorLogInterval () const
	Get the configured repeated-error log interval.

double	flowRate () const
	Get the currently published flow rate.

double	age () const
	Get the currently published age.

bool	haveValidReading () const
	Get whether the current published value is valid.

static std::string	statusKey (parseStatus status)
	Get the string key used for a parse status in log rate limiting.

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 flow-from-RPM monitor.

Definition at line 40 of file flowRPM.hpp.

Class Documentation

◆ MagAOX::app::flowRPM::parseResult

struct MagAOX::app::flowRPM::parseResult

Parsed result of the current file contents.

Definition at line 65 of file flowRPM.hpp.

Collaboration diagram for MagAOX::app::flowRPM::parseResult:

Class Members
double	m_age { -999.0 }	Displayed age in seconds or the bad-value sentinel.
double	m_flowRate { -999.0 }	Displayed flow rate in LPM or the bad-value sentinel.
timespec	m_sourceTs { 0, 0 }	Parsed source timestamp when available.
parseStatus	m_status { parseStatus::fileReadError }	Outcome of the parse attempt.

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 694 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 691 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 688 of file MagAOXApp.hpp.

◆ logManagerT [1/2]

typedef logger::logManager<flowRPM , logFileRaw<verboseT> > MagAOX::app::dev::telemeter< flowRPM >::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 178 of file MagAOXApp.hpp.

◆ telemeterT

typedef dev::telemeter<flowRPM> MagAOX::app::flowRPM::telemeterT

The telemeter base type.

Definition at line 74 of file flowRPM.hpp.

◆ verboseT [1/2]

typedef XWC_DEFAULT_VERBOSITY MagAOX::app::dev::telemeter< flowRPM >::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 175 of file MagAOXApp.hpp.

Member Enumeration Documentation

◆ parseStatus

enum class MagAOX::app::flowRPM::parseStatus

strong

Status returned by the file parser.

Enumerator
success
fileReadError
missingTimestamp
malformedTimestamp
missingRecord
malformedRecord
wrongDescriptor
wrongUnits
badStatus
badValue
staleReading

Definition at line 49 of file flowRPM.hpp.

Constructor & Destructor Documentation

◆ flowRPM()

MagAOX::app::flowRPM::flowRPM ( )

inline

Default c'tor.

Definition at line 321 of file flowRPM.hpp.

◆ ~flowRPM()

MagAOX::app::flowRPM::~flowRPM ( )

inlinenoexcept

D'tor, declared and defined for noexcept.

Definition at line 326 of file flowRPM.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 397 of file MagAOXApp.hpp.

◆ age()

double MagAOX::app::flowRPM::age ( ) const

inline

Get the currently published age.

Definition at line 678 of file flowRPM.hpp.

References m_age.

Referenced by libXWCTest::flowRPMTest::TEST_CASE(), and libXWCTest::flowRPMTest::TEST_CASE().

◆ appLogic()

int MagAOX::app::flowRPM::appLogic ( )

inlinevirtual

Implementation of the FSM for flowRPM.

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

Definition at line 418 of file flowRPM.hpp.

References MagAOX::app::MagAOXApp< true >::log(), flatlogs::logPrio::LOG_NOTICE, m_haveValidReading, m_inputPath, m_lastErrorKey, publishResult(), readAndParse(), reconcileResult(), recordFlow(), shouldLogError(), statusKey(), success, and TELEMETER_APP_LOGIC.

Referenced by libXWCTest::flowRPMTest::TEST_CASE(), and libXWCTest::flowRPMTest::TEST_CASE().

◆ appShutdown()

int MagAOX::app::flowRPM::appShutdown ( )

inlinevirtual

Shut the application down.

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

Definition at line 470 of file flowRPM.hpp.

References TELEMETER_APP_SHUTDOWN.

Referenced by libXWCTest::flowRPMTest::TEST_CASE().

◆ appStartup()

int MagAOX::app::flowRPM::appStartup ( )

inlinevirtual

Perform application startup.

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

Definition at line 402 of file flowRPM.hpp.

References MagAOX::app::MagAOXApp< true >::createROIndiNumber(), MagAOX::app::MagAOXApp< true >::log(), m_badValue, m_indiP_status, MagAOX::app::stateCodes::READY, MagAOX::app::MagAOXApp< true >::registerIndiPropertyReadOnly(), MagAOX::app::MagAOXApp< true >::state(), and TELEMETER_APP_STARTUP.

Referenced by libXWCTest::flowRPMTest::TEST_CASE(), libXWCTest::flowRPMTest::TEST_CASE(), libXWCTest::flowRPMTest::TEST_CASE(), and libXWCTest::flowRPMTest::TEST_CASE().

◆ badValue()

double MagAOX::app::flowRPM::badValue ( ) const

inline

Get the configured bad-value sentinel.

Definition at line 663 of file flowRPM.hpp.

References m_badValue.

Referenced by libXWCTest::flowRPMTest::TEST_CASE(), libXWCTest::flowRPMTest::TEST_CASE(), libXWCTest::flowRPMTest::TEST_CASE(), libXWCTest::flowRPMTest::TEST_CASE(), libXWCTest::flowRPMTest::TEST_CASE(), libXWCTest::flowRPMTest::TEST_CASE(), libXWCTest::flowRPMTest::TEST_CASE(), and libXWCTest::flowRPMTest::TEST_CASE().

◆ basePath()

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

inherited

Get the.

Returns: the value of m_ *

Definition at line 1244 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 1266 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 271 of file MagAOXApp.hpp.

◆ checkRecordTimes() [1/4]

int MagAOX::app::flowRPM::checkRecordTimes ( )

inline

Check whether telemetry records need to be forced.

Definition at line 688 of file flowRPM.hpp.

References MagAOX::app::dev::telemeter< flowRPM >::checkRecordTimes().

◆ checkRecordTimes() [2/4]

int MagAOX::app::dev::telemeter< flowRPM >::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< flowRPM >::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< flowRPM >::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 635 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 1261 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 1256 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 377 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 1250 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 1281 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 953 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 776 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 741 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 755 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 802 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 833 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 815 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 728 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 789 of file MagAOXApp.hpp.

◆ derived()

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

inlineprivateinherited

Access the derived class.

Definition at line 181 of file telemeter.hpp.

◆ 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 1310 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 1298 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 1304 of file MagAOXApp.hpp.

◆ errorLogInterval()

double MagAOX::app::flowRPM::errorLogInterval ( ) const

inline

Get the configured repeated-error log interval.

Definition at line 668 of file flowRPM.hpp.

References m_errorLogInterval.

Referenced by libXWCTest::flowRPMTest::TEST_CASE(), and libXWCTest::flowRPMTest::TEST_CASE().

◆ 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 301 of file MagAOXApp.hpp.

◆ fanDescriptor()

const std::string & MagAOX::app::flowRPM::fanDescriptor ( ) const

inline

Get the configured fan descriptor.

Definition at line 658 of file flowRPM.hpp.

References m_fanDescriptor.

Referenced by libXWCTest::flowRPMTest::TEST_CASE(), and libXWCTest::flowRPMTest::TEST_CASE().

◆ flowRate()

double MagAOX::app::flowRPM::flowRate ( ) const

inline

Get the currently published flow rate.

Definition at line 673 of file flowRPM.hpp.

References m_flowRate.

Referenced by parseRecordLine(), libXWCTest::flowRPMTest::TEST_CASE(), and libXWCTest::flowRPMTest::TEST_CASE().

◆ 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 606 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 969 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 975 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 985 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 403 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 994 of file MagAOXApp.hpp.

◆ haveValidReading()

bool MagAOX::app::flowRPM::haveValidReading ( ) const

inline

Get whether the current published value is valid.

Definition at line 683 of file flowRPM.hpp.

References m_haveValidReading.

Referenced by libXWCTest::flowRPMTest::TEST_CASE(), and libXWCTest::flowRPMTest::TEST_CASE().

◆ INDI_SETCALLBACK_DECL()

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

inherited

◆ indiSetPropertyShouldRequest()

bool MagAOX::app::MagAOXApp< _useINDI >::indiSetPropertyShouldRequest	(	const indiCallBack &	callBack,
		bool	all,
		const std::chrono::steady_clock::time_point &	now
	)		const

inlineinherited

Determine whether an unresolved Set-property subscription should be requested now.

Parameters

[in]	callBack	the subscription retry state to evaluate
[in]	all	if true, force an immediate refresh regardless of retry timing
[in]	now	the current monotonic time for scheduling

Definition at line 937 of file MagAOXApp.hpp.

◆ 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 1091 of file MagAOXApp.hpp.

◆ inputPath()

const std::string & MagAOX::app::flowRPM::inputPath ( ) const

inline

Get the configured input path.

Definition at line 648 of file flowRPM.hpp.

References m_inputPath.

Referenced by libXWCTest::flowRPMTest::TEST_CASE(), and libXWCTest::flowRPMTest::TEST_CASE().

◆ 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 265 of file MagAOXApp.hpp.

◆ loadConfig() [1/2]

void MagAOX::app::flowRPM::loadConfig ( )

inlinevirtual

Load the application configuration.

Definition at line 394 of file flowRPM.hpp.

References loadConfigImpl(), and MagAOX::app::MagAOXApp< true >::m_shutdown.

Referenced by libXWCTest::flowRPMTest::TEST_CASE(), libXWCTest::flowRPMTest::TEST_CASE(), and libXWCTest::flowRPMTest::TEST_CASE().

◆ loadConfig() [2/2]

int MagAOX::app::dev::telemeter< flowRPM >::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.

◆ loadConfigImpl()

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

inlinevirtual

Implementation of loadConfig logic, separated for testing.

Parameters

[in] _config application configuration from which to load

Definition at line 381 of file flowRPM.hpp.

References MagAOX::app::MagAOXApp< true >::log(), m_badValue, m_errorLogInterval, m_fanDescriptor, m_inputPath, m_maxAge, and TELEMETER_LOAD_CONFIG.

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 515 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 348 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 361 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 370 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 1286 of file MagAOXApp.hpp.

◆ maxAge()

double MagAOX::app::flowRPM::maxAge ( ) const

inline

Get the configured maximum reading age in seconds.

Definition at line 653 of file flowRPM.hpp.

References m_maxAge.

Referenced by libXWCTest::flowRPMTest::TEST_CASE(), libXWCTest::flowRPMTest::TEST_CASE(), and libXWCTest::flowRPMTest::TEST_CASE().

◆ 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 1148 of file MagAOXApp.hpp.

◆ noteIndiSetPropertyRequested()

void MagAOX::app::MagAOXApp< _useINDI >::noteIndiSetPropertyRequested	(	indiCallBack &	callBack,
		const std::chrono::steady_clock::time_point &	now
	)

inlineinherited

Update retry tracking after sending a GetProperties request for a monitored Set-property.

Parameters

	callBack	[in/out] the subscription retry state to update
[in]	now	the current monotonic time for scheduling

Definition at line 944 of file MagAOXApp.hpp.

◆ 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, MagAOX::app::zaberLowLevel, and MagAOX::app::zaberLowLevelBinary.

Definition at line 1193 of file MagAOXApp.hpp.

◆ parseFileContents()

int MagAOX::app::flowRPM::parseFileContents	(	parseResult &	result,
		const std::string &	contents,
		const timespec &	now
	)		const

inline

Parse the two-line file contents using a supplied current time.

Parameters

[out]	result	parse result
[in]	contents	raw file contents
[in]	now	current time for age calculation

Definition at line 543 of file flowRPM.hpp.

References MagAOX::app::flowRPMDetail::elapsedSeconds(), fileReadError, MagAOX::app::MagAOXApp< true >::log(), m_badValue, m_maxAge, malformedRecord, malformedTimestamp, missingRecord, missingTimestamp, parseRecordLine(), parseTimestamp(), MagAOX::app::flowRPMDetail::splitLogicalLines(), staleReading, and success.

Referenced by readAndParse(), and libXWCTest::flowRPMTest::TEST_CASE().

◆ parseRecordLine()

flowRPM::parseStatus MagAOX::app::flowRPM::parseRecordLine	(	double &	flowRate,
		const std::string &	line
	)		const

inline

Parse the sensor record line into a flow rate in LPM.

Parameters

[out]	flowRate	parsed flow rate in LPM
[in]	line	sensor record line

Definition at line 505 of file flowRPM.hpp.

References badStatus, badValue, flowRate(), MagAOX::app::flowRPMDetail::isValidStatusField(), MagAOX::app::MagAOXApp< true >::log(), m_fanDescriptor, malformedRecord, MagAOX::app::flowRPMDetail::splitPipeDelimited(), success, wrongDescriptor, and wrongUnits.

Referenced by parseFileContents(), and libXWCTest::flowRPMTest::TEST_CASE().

◆ parseTimestamp()

int MagAOX::app::flowRPM::parseTimestamp	(	timespec &	ts,
		const std::string &	line
	)		const

inline

Parse a source timestamp line into a timespec.

Parameters

[out]	ts	parsed timestamp
[in]	line	source timestamp line

Definition at line 477 of file flowRPM.hpp.

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

Referenced by parseFileContents(), and libXWCTest::flowRPMTest::TEST_CASE().

◆ 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 1209 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 1219 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 1228 of file MagAOXApp.hpp.

◆ publishResult()

int MagAOX::app::flowRPM::publishResult ( const parseResult & result )

inlinevirtual

Publish a parse result to INDI and runtime state.

Parameters

[in] result parse result to publish

Definition at line 744 of file flowRPM.hpp.

References INDI_ALERT, INDI_OK, MagAOX::app::MagAOXApp< true >::log(), m_age, m_flowRate, m_haveValidReading, m_indiP_status, m_sourceTs, success, and MagAOX::app::MagAOXApp< true >::updateIfChanged().

Referenced by appLogic(), and libXWCTest::flowRPMTest::TEST_CASE().

◆ readAndParse()

int MagAOX::app::flowRPM::readAndParse	(	parseResult &	result,
		const timespec &	now
	)		const

inlinevirtual

Read the configured file and parse its current contents.

Parameters

[out]	result	parse result
[in]	now	current time for age calculation

Definition at line 597 of file flowRPM.hpp.

References fileReadError, MagAOX::app::MagAOXApp< true >::log(), m_badValue, m_inputPath, and parseFileContents().

Referenced by appLogic(), and libXWCTest::flowRPMTest::TEST_CASE().

◆ reconcileResult()

flowRPM::parseResult MagAOX::app::flowRPM::reconcileResult	(	const parseResult &	result,
		const timespec &	now
	)		const

inline

Reconcile a newly parsed result against the currently displayed state.

Parameters

[in]	result	newly parsed file result
[in]	now	current time

Definition at line 711 of file flowRPM.hpp.

References MagAOX::app::flowRPMDetail::elapsedSeconds(), MagAOX::app::MagAOXApp< true >::log(), m_badValue, m_flowRate, m_haveValidReading, m_maxAge, m_sourceTs, staleReading, and success.

Referenced by appLogic(), and libXWCTest::flowRPMTest::TEST_CASE().

◆ recordFlow()

int MagAOX::app::flowRPM::recordFlow ( bool force = false )

inlinevirtual

Record the currently displayed flow state to telemetry.

Parameters

[in] force force a telemetry record even if unchanged

Definition at line 698 of file flowRPM.hpp.

References MagAOX::app::MagAOXApp< true >::log(), m_age, m_flowRate, m_haveValidReading, m_lastTelemFlowRate, and m_lastTelemValid.

Referenced by appLogic(), and recordTelem().

◆ recordTelem()

int MagAOX::app::flowRPM::recordTelem ( const logger::telem_flowrpm * )

inline

Record telemetry when requested by the telemeter helper.

Definition at line 693 of file flowRPM.hpp.

References recordFlow().

Referenced by libXWCTest::flowRPMTest::TEST_CASE().

◆ 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 849 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 859 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 926 of file MagAOXApp.hpp.

◆ resetIndiSetPropertyRetry()

void MagAOX::app::MagAOXApp< _useINDI >::resetIndiSetPropertyRetry ( indiCallBack & callBack )

inlineinherited

Reset retry tracking for a monitored INDI Set-property subscription.

Parameters

callBack [in/out] the subscription retry state to reset

Definition at line 934 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 1276 of file MagAOXApp.hpp.

◆ sendGetPropertySetList()

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

inherited

Definition at line 963 of file MagAOXApp.hpp.

◆ 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 1114 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 1104 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 1121 of file MagAOXApp.hpp.

◆ 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 243 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 474 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 483 of file MagAOXApp.hpp.

◆ setSigTermHandler()

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

privateinherited

Sets the handler for SIGTERM, SIGQUIT, and SIGINT.

Definition at line 394 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 255 of file MagAOXApp.hpp.

◆ setupConfig() [1/2]

void MagAOX::app::flowRPM::setupConfig ( )

inlinevirtual

Set up the application configuration.

Definition at line 330 of file flowRPM.hpp.

References TELEMETER_SETUP_CONFIG.

Referenced by libXWCTest::flowRPMTest::TEST_CASE(), libXWCTest::flowRPMTest::TEST_CASE(), and libXWCTest::flowRPMTest::TEST_CASE().

◆ setupConfig() [2/2]

int MagAOX::app::dev::telemeter< flowRPM >::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.

◆ shouldLogError()

bool MagAOX::app::flowRPM::shouldLogError	(	const std::string &	key,
		const timespec &	now
	)

inline

Determine whether a repeated error should be logged now.

Parameters

[in]	key	error key under consideration
[in]	now	current time

Definition at line 759 of file flowRPM.hpp.

References MagAOX::app::flowRPMDetail::elapsedSeconds(), MagAOX::app::MagAOXApp< true >::log(), m_errorLogInterval, m_lastErrorKey, and m_lastErrorLogTs.

Referenced by appLogic(), and libXWCTest::flowRPMTest::TEST_CASE().

◆ 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 1292 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 1137 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 960 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 584 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 592 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 600 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 625 of file MagAOXApp.hpp.

◆ statusKey()

std::string MagAOX::app::flowRPM::statusKey ( parseStatus status )

inlinestatic

Get the string key used for a parse status in log rate limiting.

Parameters

[in] status parse status to stringify

Definition at line 617 of file flowRPM.hpp.

References badStatus, badValue, fileReadError, malformedRecord, malformedTimestamp, missingRecord, missingTimestamp, staleReading, success, wrongDescriptor, and wrongUnits.

Referenced by appLogic(), and libXWCTest::flowRPMTest::TEST_CASE().

◆ sysPath()

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

inherited

Get the system path.

Returns: the value of m_sysPath

Definition at line 1271 of file MagAOXApp.hpp.

◆ telem()

int MagAOX::app::dev::telemeter< flowRPM >::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 549 of file MagAOXApp.hpp.

◆ unlockPID()

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

protectedinherited

Remove the PID file.

Definition at line 518 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 1024 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 1053 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 1007 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 1070 of file MagAOXApp.hpp.

◆ 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 1078 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 1035 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, MagAOX::app::zaberLowLevel, and MagAOX::app::zaberLowLevelBinary.

Definition at line 1200 of file MagAOXApp.hpp.

Friends And Related Symbol Documentation

◆ dev::telemeter< flowRPM >

friend class dev::telemeter< flowRPM >

friend

Definition at line 43 of file flowRPM.hpp.

◆ flowRPM_test

friend class flowRPM_test

friend

Definition at line 43 of file flowRPM.hpp.

Member Data Documentation

◆ m_age

double MagAOX::app::flowRPM::m_age { -999.0 }

protected

Current published age in seconds or the bad-value sentinel.

Definition at line 108 of file flowRPM.hpp.

Referenced by age(), publishResult(), recordFlow(), and libXWCTest::flowRPMTest::TEST_CASE().

◆ 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 709 of file MagAOXApp.hpp.

◆ m_badValue

double MagAOX::app::flowRPM::m_badValue { -999.0 }

protected

Bad-value sentinel published on parse or availability failures.

Definition at line 92 of file flowRPM.hpp.

Referenced by appStartup(), badValue(), loadConfigImpl(), parseFileContents(), readAndParse(), and reconcileResult().

◆ m_basePath

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

protectedinherited

The base path of the MagAO-X system.

Definition at line 181 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 189 of file MagAOXApp.hpp.

◆ 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 187 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 185 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 183 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 200 of file MagAOXApp.hpp.

◆ 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 720 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 712 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 715 of file MagAOXApp.hpp.

◆ m_errorLogInterval

double MagAOX::app::flowRPM::m_errorLogInterval { 60.0 }

protected

Minimum interval between repeated logs for the same persistent error.

Definition at line 95 of file flowRPM.hpp.

Referenced by errorLogInterval(), loadConfigImpl(), and shouldLogError().

◆ 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 415 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 414 of file MagAOXApp.hpp.

◆ m_fanDescriptor

std::string MagAOX::app::flowRPM::m_fanDescriptor { "CHA_FAN1" }

protected

Expected fan descriptor in the pipe-delimited record.

Definition at line 89 of file flowRPM.hpp.

Referenced by fanDescriptor(), loadConfigImpl(), and parseRecordLine().

◆ m_flowRate

double MagAOX::app::flowRPM::m_flowRate { -999.0 }

protected

Current published flow rate in LPM or the bad-value sentinel.

Definition at line 105 of file flowRPM.hpp.

Referenced by flowRate(), publishResult(), reconcileResult(), recordFlow(), and libXWCTest::flowRPMTest::TEST_CASE().

◆ m_gitAlert

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

privateinherited

Definition at line 575 of file MagAOXApp.hpp.

◆ m_haveValidReading

bool MagAOX::app::flowRPM::m_haveValidReading { false }

protected

Whether the current displayed value is valid.

Definition at line 114 of file flowRPM.hpp.

Referenced by appLogic(), haveValidReading(), publishResult(), reconcileResult(), recordFlow(), and libXWCTest::flowRPMTest::TEST_CASE().

◆ m_indiCallBackMutex

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

inherited

Mutex for locking INDI callback maps and per-entry callback state.

Lock ordering policy: 1) Prefer never holding both m_indiMutex and m_indiCallBackMutex at the same time. 2) If both are required in future code, always acquire m_indiMutex before m_indiCallBackMutex.

Definition at line 662 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 652 of file MagAOXApp.hpp.

◆ m_indiMutex

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

inherited

Mutex for locking INDI communications.

Definition at line 655 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 700 of file MagAOXApp.hpp.

◆ m_indiP_clearFSMAlert

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

protectedinherited

indi Property to clear an FSM alert.

Definition at line 1130 of file MagAOXApp.hpp.

◆ m_indiP_powerChannel

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

protectedinherited

INDI property used to communicate power state.

Definition at line 1186 of file MagAOXApp.hpp.

◆ m_indiP_state

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

protectedinherited

indi Property to report the application state.

Definition at line 1127 of file MagAOXApp.hpp.

◆ m_indiP_status

pcf::IndiProperty MagAOX::app::flowRPM::m_indiP_status

protected

Read-only status property exposing flow rate and age.

Definition at line 129 of file flowRPM.hpp.

Referenced by appStartup(), publishResult(), libXWCTest::flowRPMTest::TEST_CASE(), and libXWCTest::flowRPMTest::TEST_CASE().

◆ 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 705 of file MagAOXApp.hpp.

◆ m_inputPath

std::string MagAOX::app::flowRPM::m_inputPath { "/tmp/fac_flow.txt" }

protected

Path to the file written by the systemd producer.

Definition at line 83 of file flowRPM.hpp.

Referenced by appLogic(), inputPath(), loadConfigImpl(), readAndParse(), libXWCTest::flowRPMTest::TEST_CASE(), and libXWCTest::flowRPMTest::TEST_CASE().

◆ m_lastErrorKey

std::string MagAOX::app::flowRPM::m_lastErrorKey

protected

Key for the most recently logged error class.

Definition at line 126 of file flowRPM.hpp.

Referenced by appLogic(), shouldLogError(), and libXWCTest::flowRPMTest::TEST_CASE().

◆ m_lastErrorLogTs

timespec MagAOX::app::flowRPM::m_lastErrorLogTs { 0, 0 }

protected

Time of the most recent error log emission.

Definition at line 123 of file flowRPM.hpp.

Referenced by shouldLogError().

◆ m_lastTelemFlowRate

double MagAOX::app::flowRPM::m_lastTelemFlowRate { std::numeric_limits<double>::quiet_NaN() }

protected

Last flow value written to telemetry.

Definition at line 117 of file flowRPM.hpp.

Referenced by recordFlow(), and libXWCTest::flowRPMTest::TEST_CASE().

◆ m_lastTelemValid

bool MagAOX::app::flowRPM::m_lastTelemValid { false }

protected

Last validity state written to telemetry.

Definition at line 120 of file flowRPM.hpp.

Referenced by recordFlow(), and libXWCTest::flowRPMTest::TEST_CASE().

◆ m_log

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

staticinherited

Definition at line 338 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 202 of file MagAOXApp.hpp.

◆ m_maxAge

double MagAOX::app::flowRPM::m_maxAge { 60.0 }

protected

Maximum allowed source age in seconds before the reading is treated as stale.

Definition at line 86 of file flowRPM.hpp.

Referenced by loadConfigImpl(), maxAge(), parseFileContents(), and reconcileResult().

◆ m_maxInterval

double MagAOX::app::dev::telemeter< flowRPM >::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_pid

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

protectedinherited

This process's PID.

Definition at line 499 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 1172 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 1171 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 1173 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 1166 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 1179 of file MagAOXApp.hpp.

◆ m_powerOnWait

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

protectedinherited

Default time in sec to wait for device to boot after power on.

Definition at line 1176 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 1183 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 1174 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 1184 of file MagAOXApp.hpp.

◆ m_secretsPath

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

protectedinherited

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

Definition at line 193 of file MagAOXApp.hpp.

◆ 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 390 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 207 of file MagAOXApp.hpp.

◆ m_sourceTs

timespec MagAOX::app::flowRPM::m_sourceTs { 0, 0 }

protected

Timestamp parsed from the input file for the currently displayed value.

Definition at line 111 of file flowRPM.hpp.

Referenced by publishResult(), and reconcileResult().

◆ 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 569 of file MagAOXApp.hpp.

◆ m_stateAlert

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

privateinherited

Definition at line 572 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 577 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 417 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 191 of file MagAOXApp.hpp.

◆ m_tel

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

inherited

Definition at line 81 of file telemeter.hpp.

◆ 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 647 of file MagAOXApp.hpp.

◆ pidFileName

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

protectedinherited

The name of the PID file.

Definition at line 497 of file MagAOXApp.hpp.

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

apps/flowRPM/flowRPM.hpp

Classes

Public Types

Public Member Functions

Public Attributes

Protected Attributes

Private Member Functions

Friends

INDI Interface

PID Locking

Power Management

Parser Helpers

Logging

Application State

Signal Handling

Privilege Management

Detailed Description

Class Documentation

◆ MagAOX::app::flowRPM::parseResult

Member Typedef Documentation

◆ callBackInsertResult

◆ callBackIterator

◆ callBackValueType

◆ logManagerT [1/2]

◆ logManagerT [2/2]

◆ telemeterT

◆ verboseT [1/2]

◆ verboseT [2/2]

Member Enumeration Documentation

◆ parseStatus

Constructor & Destructor Documentation

◆ flowRPM()

◆ ~flowRPM()

Member Function Documentation

◆ _handlerSigTerm()

◆ age()

◆ appLogic()

◆ appShutdown()

◆ appStartup()

◆ badValue()

◆ 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()

◆ driverCtrlName()

◆ driverInName()

◆ driverOutName()

◆ errorLogInterval()

◆ execute()

◆ fanDescriptor()

◆ flowRate()

◆ gitAlert()

◆ handleDefProperty()

◆ handleGetProperties()

◆ handleNewProperty()

◆ handlerSigTerm()

◆ handleSetProperty()

◆ haveValidReading()

◆ INDI_SETCALLBACK_DECL()

◆ indiSetPropertyShouldRequest()

◆ indiTargetUpdate()

◆ inputPath()