#include <picoMotorCtrl.hpp>
Classes | |
struct | motorChannel |
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< picoMotorCtrl, logFileRaw< verboseT > > | logManagerT |
The log manager type. | |
Public Member Functions | |
picoMotorCtrl () | |
Default c'tor. | |
~picoMotorCtrl () noexcept | |
D'tor, declared and defined for noexcept. | |
virtual void | setupConfig () |
Setup the configuration system (called by MagAOXApp::setup()) | |
int | loadConfigImpl (mx::app::appConfigurator &_config) |
Implementation of loadConfig logic, separated for testing. | |
virtual void | loadConfig () |
load the configuration system results (called by MagAOXApp::setup()) | |
virtual int | appStartup () |
Startup functions. | |
virtual int | appLogic () |
Implementation of the FSM. | |
virtual int | onPowerOff () |
Implementation of the on-power-off FSM logic. | |
virtual int | whilePowerOff () |
Implementation of the while-powered-off FSM. | |
virtual int | appShutdown () |
Do any needed shutdown tasks. | |
posT | readChannelCounts (const std::string &chName) |
Read the current channel counts from disk at startup. | |
int | writeChannelCounts (const std::string &chName, posT counts) |
void | channelThreadExec (motorChannel *mc) |
Channel thread execution function. | |
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 | telem () |
Make a telemetry recording, for an empty record. | |
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_pico *) |
int | recordPico (bool force=false) |
Threads | |
template<class thisPtr , class Function > | |
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. | |
Static Public Member Functions | |
static void | channelThreadStart (motorChannel *mc) |
Channel thread starter function. | |
Public Attributes | |
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 | |
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 { MAGAOX_cpusetPath } |
Path to the cpusets mount. | |
unsigned long | m_loopPause { MAGAOX_default_loopPause } |
int | m_shutdown { 0 } |
Flag to signal it's time to shutdown. When not 0, the main loop exits. | |
Private Types | |
typedef dev::telemeter< picoMotorCtrl > | telemeterT |
typedef long | posT |
typedef std::map< std::string, motorChannel > | channelMapT |
Private Member Functions | |
int | clearFSMAlert () |
Clear the FSM alert state. | |
picoMotorCtrl & | derived () |
Access the derived class. | |
Private Attributes | |
std::vector< int > | m_addresses |
The unique controller addresses. | |
channelMapT | m_channels |
Map of motor names to channel. | |
tty::telnetConn | m_telnetConn |
The telnet connection manager. | |
std::mutex | m_telnetMutex |
Mutex for locking telnet communications. | |
Configurable Parameters | |
std::string | m_deviceAddr |
The device address. | |
std::string | m_devicePort {"23"} |
The device port. | |
int | m_nChannels {4} |
The number of motor channels total on the hardware. Number of attached motors inferred from config. | |
Friends | |
class | dev::telemeter< picoMotorCtrl > |
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. | |
Application State | |
stateCodes::stateCodeT | m_state { stateCodes::UNINITIALIZED } |
bool | m_stateAlert { false } |
bool | m_gitAlert { false } |
int | m_stateLogged { 0 } |
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. | |
INDI | |
std::vector< pcf::IndiProperty > | m_indiP_counts |
int | newCallBack_picopos (const pcf::IndiProperty &ipRecv) |
The handler function for relative position requests, called by the static callback. | |
int | newCallBack_presetName (const pcf::IndiProperty &ipRecv) |
The handler function for position presets, called by the static callback. | |
static int | st_newCallBack_picopos (void *app, const pcf::IndiProperty &ipRecv) |
The static callback function to be registered for relative position requests. | |
static int | st_newCallBack_presetName (void *app, const pcf::IndiProperty &ipRecv) |
The static callback function to be registered for position presets. | |
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 { 0 } |
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 { false } |
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. | |
template<typename T > | |
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 = _useINDI |
Flag controlling whether INDI is used. If false, then no INDI code executes. | |
indiDriver< MagAOXApp > * | m_indiDriver { nullptr } |
The INDI driver wrapper. Constructed and initialized by execute, which starts and stops communications. | |
std::mutex | m_indiMutex |
Mutex for locking INDI communications. | |
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. | |
template<typename T > | |
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. | |
template<typename T > | |
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. | |
template<typename T > | |
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. | |
template<typename T > | |
void | updatesIfChanged (pcf::IndiProperty &p, const std::vector< const char * > &els, const std::vector< T > &newVals, pcf::IndiProperty::PropertyStateType newState=pcf::IndiProperty::Ok) |
template<typename T > | |
int | indiTargetUpdate (pcf::IndiProperty &localProperty, T &localTarget, const pcf::IndiProperty &remoteProperty, bool setBusy=true) |
Get the target element value from an new property. | |
template<typename T > | |
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. | |
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 { false } |
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 { "state" } |
The INDI element name to monitor for this device's power state. | |
std::string | m_powerTargetElement { "target" } |
The INDI element name to monitor for this device's power state. | |
unsigned long | m_powerOnWait { 0 } |
Time in sec to wait for device to boot after power on. | |
int | m_powerOnCounter { -1 } |
int | m_powerState { -1 } |
Current power state, 1=On, 0=Off, -1=Unk. | |
int | m_powerTargetState { -1 } |
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) | |
bool | powerOnWaitElapsed () |
This method tests whether the power on wait time has elapsed. | |
Logging | |
void | logMessage (bufferPtrT &b) |
Handle a log message from the logging system. | |
template<typename logT , int retval = 0> | |
static int | log (const typename logT::messageT &msg, logPrioT level=logPrio::LOG_DEFAULT) |
Make a log entry. | |
template<typename logT , int retval = 0> | |
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. | |
Signal Handling | |
static MagAOXApp * | m_self = nullptr |
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. | |
MagAO-X application to control a multi-channel Newport Picomotor Controller.
need to recognize signals in tty polls and not return errors, etc.
need to implement an onDisconnect() to update values to unknown indicators.
need a frequency-dependent max amp facility.
convert to ioDevice
need telnet device, with optional username/password.
Definition at line 90 of file picoMotorCtrl.hpp.
|
inherited |
Return type of insert on the indiCallBack map.
Definition at line 662 of file MagAOXApp.hpp.
|
inherited |
Iterator type of the indiCallBack map.
Definition at line 659 of file MagAOXApp.hpp.
|
inherited |
Value type of the indiCallBack map.
Definition at line 656 of file MagAOXApp.hpp.
|
private |
Definition at line 167 of file picoMotorCtrl.hpp.
|
inherited |
The log manager type.
Definition at line 73 of file telemeter.hpp.
|
inherited |
The log manager type.
Definition at line 167 of file MagAOXApp.hpp.
Definition at line 97 of file picoMotorCtrl.hpp.
Definition at line 95 of file picoMotorCtrl.hpp.
|
inherited |
Definition at line 70 of file telemeter.hpp.
|
inherited |
Definition at line 164 of file MagAOXApp.hpp.
MagAOX::app::picoMotorCtrl::picoMotorCtrl | ( | ) |
Default c'tor.
Definition at line 308 of file picoMotorCtrl.hpp.
References MagAOX::app::MagAOXApp< _useINDI >::m_powerMgtEnabled, MagAOX::tty::telnetConn::m_prompt, and m_telnetConn.
|
noexcept |
D'tor, declared and defined for noexcept.
Definition at line 315 of file picoMotorCtrl.hpp.
References MagAOX::app::it, and m_channels.
|
staticprivateinherited |
The handler called when SIGTERM, SIGQUIT, or SIGINT is received. Just a wrapper for handlerSigTerm.
[in] | signum | specifies the signal. |
[in] | siginf | ignored by MagAOXApp |
[in] | ucont | ignored by MagAOXApp |
Definition at line 2109 of file MagAOXApp.hpp.
References MagAOX::app::MagAOXApp< _useINDI >::handlerSigTerm().
|
virtual |
Implementation of the FSM.
Implements MagAOX::app::MagAOXApp< _useINDI >.
Definition at line 523 of file picoMotorCtrl.hpp.
References MagAOX::tty::telnetConn::connect(), MagAOX::app::stateCodes::CONNECTED, MagAOX::app::stateCodes::ERROR, MagAOX::app::stateCodes::FAILURE, INDI_BUSY, INDI_IDLE, MagAOX::app::it, MagAOX::app::lock(), MagAOX::app::MagAOXApp< _useINDI >::log(), flatlogs::logPrio::LOG_CRITICAL, m_addresses, m_channels, m_deviceAddr, m_devicePort, MagAOX::app::MagAOXApp< _useINDI >::m_indiDriver, MagAOX::app::MagAOXApp< _useINDI >::m_indiMutex, MagAOX::app::dev::ioDevice::m_readTimeout, MagAOX::tty::telnetConn::m_strRead, m_telnetConn, m_telnetMutex, MagAOX::app::dev::ioDevice::m_writeTimeout, MagAOX::app::msg, MagAOX::tty::telnetConn::noLogin(), MagAOX::app::stateCodes::NOTCONNECTED, MagAOX::app::stateCodes::OPERATING, MagAOX::app::stateCodes::POWERON, MagAOX::app::MagAOXApp< _useINDI >::powerOnWaitElapsed(), MagAOX::app::MagAOXApp< _useINDI >::powerState(), MagAOX::app::MagAOXApp< _useINDI >::powerStateTarget(), MagAOX::tty::telnetConn::read(), MagAOX::app::stateCodes::READY, recordPico(), MagAOX::app::splitResponse(), MagAOX::app::MagAOXApp< _useINDI >::state(), MagAOX::app::MagAOXApp< _useINDI >::stateLogged(), TELEMETER_APP_LOGIC, TTY_E_NOERROR, MagAOX::tty::ttyErrorString(), MagAOX::app::MagAOXApp< _useINDI >::updateIfChanged(), MagAOX::tty::telnetConn::write(), and writeChannelCounts().
|
virtual |
Do any needed shutdown tasks.
Implements MagAOX::app::MagAOXApp< _useINDI >.
Definition at line 905 of file picoMotorCtrl.hpp.
References MagAOX::app::it, MagAOX::app::MagAOXApp< _useINDI >::log(), m_channels, and TELEMETER_APP_SHUTDOWN.
|
virtual |
Startup functions.
Setsup the INDI vars.
Implements MagAOX::app::MagAOXApp< _useINDI >.
Definition at line 458 of file picoMotorCtrl.hpp.
References channelThreadStart(), MagAOX::app::MagAOXApp< _useINDI >::createStandardIndiNumber(), MagAOX::app::MagAOXApp< _useINDI >::createStandardIndiSelectionSw(), INDI_IDLE, MagAOX::app::it, MagAOX::app::MagAOXApp< _useINDI >::log(), m_channels, PICOMOTORCTRL_E_INDIREG, readChannelCounts(), MagAOX::app::MagAOXApp< _useINDI >::registerIndiPropertyNew(), MagAOX::app::sigUsr1Handler(), st_newCallBack_picopos(), st_newCallBack_presetName(), TELEMETER_APP_STARTUP, and MagAOX::app::MagAOXApp< _useINDI >::threadStart().
|
inherited |
Get the.
Definition at line 3695 of file MagAOXApp.hpp.
Referenced by MagAOX::app::streamWriter::loadConfig().
|
inherited |
Get the calibration directory.
Definition at line 3719 of file MagAOXApp.hpp.
void MagAOX::app::picoMotorCtrl::channelThreadExec | ( | motorChannel * | mc | ) |
Channel thread execution function.
Runs until m_shutdown is true.
Definition at line 988 of file picoMotorCtrl.hpp.
References MagAOX::app::stateCodes::ERROR, MagAOX::app::lock(), MagAOX::app::MagAOXApp< _useINDI >::log(), MagAOX::app::MagAOXApp< _useINDI >::m_shutdown, m_telnetConn, m_telnetMutex, MagAOX::app::dev::ioDevice::m_writeTimeout, MagAOX::app::stateCodes::OPERATING, MagAOX::app::MagAOXApp< _useINDI >::powerState(), MagAOX::app::MagAOXApp< _useINDI >::powerStateTarget(), MagAOX::app::stateCodes::READY, recordPico(), MagAOX::app::MagAOXApp< _useINDI >::state(), TTY_E_NOERROR, MagAOX::tty::ttyErrorString(), and MagAOX::tty::telnetConn::write().
|
static |
Channel thread starter function.
[in] | mc | the channel to start controlling |
Definition at line 983 of file picoMotorCtrl.hpp.
References MagAOX::app::MagAOXApp< _useINDI >::log().
Referenced by appStartup().
|
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 1598 of file MagAOXApp.hpp.
References MagAOX::app::it, flatlogs::logPrio::LOG_CRITICAL, flatlogs::logPrio::LOG_WARNING, and MagAOX::app::msg.
int MagAOX::app::picoMotorCtrl::checkRecordTimes | ( | ) |
Definition at line 1149 of file picoMotorCtrl.hpp.
References MagAOX::app::dev::telemeter< picoMotorCtrl >::checkRecordTimes().
|
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.
[in] | tel | [unused] object of the telemetry type to record |
[in] | tels | [unused] objects of the additional telemetry types to record |
Definition at line 150 of file telemeter.hpp.
|
inherited |
Empty function called at the end of the template list.
[in] | ts | [unused] the timestamp that records are compared to |
Definition at line 171 of file telemeter.hpp.
|
inherited |
Worker function to actually perform the record time checking logic.
Recursively calls itself until the variadic template list is exhausted.
[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 161 of file telemeter.hpp.
|
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 2565 of file MagAOXApp.hpp.
References INDI_ALERT, INDI_BUSY, INDI_IDLE, INDI_OK, and flatlogs::logPrio::LOG_WARNING.
|
inherited |
Get the config base file.
Definition at line 3713 of file MagAOXApp.hpp.
|
inherited |
Get the config directory.
Definition at line 3707 of file MagAOXApp.hpp.
|
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.
[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 2051 of file MagAOXApp.hpp.
|
inherited |
Get the config name.
Definition at line 3701 of file MagAOXApp.hpp.
Referenced by MagAOX::app::andorCtrl::loadConfig(), and MagAOX::app::andorCtrl::writeConfig().
|
inherited |
Get the cpuset path.
Definition at line 3737 of file MagAOXApp.hpp.
|
protectedinherited |
Create the INDI FIFOs.
Changes permissions to max available and creates the FIFOs at the configured path.
Definition at line 3034 of file MagAOXApp.hpp.
References flatlogs::logPrio::LOG_CRITICAL, and MAGAOX_driverFIFORelPath.
|
inherited |
Create a ReadOnly INDI Number property.
[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 2720 of file MagAOXApp.hpp.
Referenced by MagAOX::app::picamCtrl::appStartup(), and MagAOX::app::zaberCtrl::appStartup().
|
inherited |
Create a standard ReadOnly INDI Text property, with at least one element.
[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 2637 of file MagAOXApp.hpp.
|
inherited |
Create a standard R/W INDI Number property with target and current elements.
[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 2673 of file MagAOXApp.hpp.
Referenced by appStartup().
|
inherited |
Create a standard R/W INDI switch with a single request element.
This switch is intended to function like a momentary switch.
[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 2776 of file MagAOXApp.hpp.
Referenced by MagAOX::app::ocam2KCtrl::appStartup().
|
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.
[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 2851 of file MagAOXApp.hpp.
|
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.
[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 2806 of file MagAOXApp.hpp.
Referenced by appStartup().
|
inherited |
Create a standard R/W INDI Text property with target and current elements.
[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 2609 of file MagAOXApp.hpp.
|
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.
[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 2746 of file MagAOXApp.hpp.
Referenced by MagAOX::app::siglentSDG::appStartup(), MagAOX::app::streamWriter::appStartup(), and MagAOX::app::sysMonitor::appStartup().
|
inlineprivateinherited |
Access the derived class.
Definition at line 175 of file telemeter.hpp.
|
inherited |
Get the INDI control FIFO file name.
Definition at line 3767 of file MagAOXApp.hpp.
|
inherited |
Get the INDI input FIFO file name.
Definition at line 3755 of file MagAOXApp.hpp.
|
inherited |
Get the INDI output FIFO file name.
Definition at line 3761 of file MagAOXApp.hpp.
|
virtualinherited |
The execute method implementing the standard main loop. Should not normally be overridden.
Performs final startup steps. That is:
Errors in the above steps will cause a process exit.
Then commences the main event loop. Conditions on entry to the main loop:
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.
Definition at line 1665 of file MagAOXApp.hpp.
References flatlogs::logPrio::LOG_ERROR.
|
inherited |
Get the value of the git alert flag.
Definition at line 2544 of file MagAOXApp.hpp.
|
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.
[in] | ipRecv | The property being sent. |
Definition at line 3197 of file MagAOXApp.hpp.
References MagAOX::app::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.
[in] | ipRecv | The property being requested. |
Definition at line 3203 of file MagAOXApp.hpp.
References MagAOX::app::ipRecv, and MagAOX::app::it.
|
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.
[in] | ipRecv | The property being changed. |
Definition at line 3272 of file MagAOXApp.hpp.
References MagAOX::app::ipRecv.
|
privateinherited |
Handles SIGTERM, SIGQUIT, and SIGINT. Sets m_shutdown to 1 and logs the signal.
[in] | signum | specifies the signal. |
[in] | siginf | ignored by MagAOXApp |
[in] | ucont | ignored by MagAOXApp |
Definition at line 2115 of file MagAOXApp.hpp.
Referenced by MagAOX::app::MagAOXApp< _useINDI >::_handlerSigTerm().
|
inherited |
Handler for the set INDI property request.
This is called by m_indiDriver's indiDriver::handleSetProperties.
[in] | ipRecv | The property being changed. |
Definition at line 3297 of file MagAOXApp.hpp.
References MagAOX::app::ipRecv.
|
inherited |
|
protectedinherited |
Get the target element value from an new property.
[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 3425 of file MagAOXApp.hpp.
References INDI_BUSY, and flatlogs::logPrio::LOG_ERROR.
Referenced by newCallBack_picopos().
|
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 1539 of file MagAOXApp.hpp.
References INDI_SETCALLBACK, flatlogs::logPrio::LOG_CRITICAL, and flatlogs::logPrio::LOG_ERROR.
|
virtual |
load the configuration system results (called by MagAOXApp::setup())
Definition at line 440 of file picoMotorCtrl.hpp.
References MagAOX::app::dev::ioDevice::loadConfig(), loadConfigImpl(), MagAOX::app::MagAOXApp< _useINDI >::log(), flatlogs::logPrio::LOG_CRITICAL, and MagAOX::app::MagAOXApp< _useINDI >::m_shutdown.
|
inherited |
Load the device section from an application configurator.
[in] | config | an application configuration from which to load values |
Definition at line 114 of file telemeter.hpp.
|
inherited |
Load the device section from an application configurator.
[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 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 MagAOX::app::tcsInterface::loadConfigImpl().
int MagAOX::app::picoMotorCtrl::loadConfigImpl | ( | mx::app::appConfigurator & | _config | ) |
Implementation of loadConfig logic, separated for testing.
This is called by loadConfig().
[in] | _config | an application configuration from which to load values |
Definition at line 345 of file picoMotorCtrl.hpp.
References MagAOX::app::MagAOXApp< _useINDI >::log(), flatlogs::logPrio::LOG_CRITICAL, m_addresses, m_channels, m_deviceAddr, m_nChannels, PICOMOTORCTRL_E_BADCHANNEL, PICOMOTORCTRL_E_DUPMOTOR, PICOMOTORCTRL_E_NOMOTORS, and TELEMETER_LOAD_CONFIG.
Referenced by loadConfig().
|
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
Definition at line 2185 of file MagAOXApp.hpp.
|
staticinherited |
Make a log entry.
Wrapper for logManager::log
logT | the log entry type |
retval | the value returned by this method. |
[in] | msg | the message to log |
[in] | level | [optional] the log level. The default is used if not specified. |
Definition at line 1992 of file MagAOXApp.hpp.
References MagAOX::app::msg.
Referenced by SMCTEST::cameraSim_test::cameraSim_test(), MagAOX::app::picoMotorCtrl::motorChannel::motorChannel(), SDGTEST::siglentSDG_test::siglentSDG_test(), SMCTEST::smc100ccCtrl_test::smc100ccCtrl_test(), MagAOX::app::streamWriter_test::streamWriter_test(), SYSMONTEST::sysMonitor_test::sysMonitor_test(), ZCTRLTEST::zaberCtrl_test::zaberCtrl_test(), MagAOX::app::zylaCtrl::zylaCtrl(), MagAOX::app::picamCtrl::~picamCtrl(), MagAOX::app::streamWriter::~streamWriter(), MagAOX::app::zylaCtrl::~zylaCtrl(), visxCtrl.xapp.VisX::_gather_metadata(), MagAOX::app::mzmqClient::_handlerSigSegv(), MagAOX::app::mzmqServer::_handlerSigSegv(), MagAOX::app::streamWriter::_handlerSigSegv(), visxCtrl.xapp.VisX::_init_properties(), MagAOX::app::qhyCtrl::AbortAcquisition(), MagAOX::app::andorCtrl::acquireAndCheckValid(), MagAOX::app::baslerCtrl::acquireAndCheckValid(), MagAOX::app::cameraSim::acquireAndCheckValid(), MagAOX::app::ocam2KCtrl::acquireAndCheckValid(), MagAOX::app::picamCtrl::acquireAndCheckValid(), MagAOX::app::zylaCtrl::acquireAndCheckValid(), MagAOX::app::streamWriter::allocate_circbufs(), MagAOX::app::streamWriter::allocate_xrif(), MagAOX::app::acronameUsbHub::appLogic(), MagAOX::app::andorCtrl::appLogic(), MagAOX::app::baslerCtrl::appLogic(), MagAOX::app::cameraSim::appLogic(), MagAOX::app::filterWheelCtrl::appLogic(), MagAOX::app::hsfwCtrl::appLogic(), MagAOX::app::mzmqClient::appLogic(), MagAOX::app::mzmqServer::appLogic(), MagAOX::app::ocam2KCtrl::appLogic(), MagAOX::app::picamCtrl::appLogic(), appLogic(), MagAOX::app::qhyCtrl::appLogic(), MagAOX::app::siglentSDG::appLogic(), MagAOX::app::smc100ccCtrl::appLogic(), MagAOX::app::streamWriter::appLogic(), MagAOX::app::sysMonitor::appLogic(), MagAOX::app::trippLitePDU::appLogic(), MagAOX::app::ttmModulator::appLogic(), MagAOX::app::xt1121Ctrl::appLogic(), MagAOX::app::xt1121DCDU::appLogic(), MagAOX::app::zaberCtrl::appLogic(), MagAOX::app::zylaCtrl::appLogic(), MagAOX::app::andorCtrl::appShutdown(), MagAOX::app::baslerCtrl::appShutdown(), MagAOX::app::hsfwCtrl::appShutdown(), MagAOX::app::mzmqClient::appShutdown(), MagAOX::app::mzmqServer::appShutdown(), MagAOX::app::picamCtrl::appShutdown(), appShutdown(), MagAOX::app::qhyCtrl::appShutdown(), MagAOX::app::streamWriter::appShutdown(), MagAOX::app::zylaCtrl::appShutdown(), MagAOX::app::acronameUsbHub::appStartup(), MagAOX::app::andorCtrl::appStartup(), MagAOX::app::baslerCtrl::appStartup(), MagAOX::app::cameraSim::appStartup(), MagAOX::app::filterWheelCtrl::appStartup(), MagAOX::app::hsfwCtrl::appStartup(), MagAOX::app::magAOXMaths::appStartup(), MagAOX::app::mzmqClient::appStartup(), MagAOX::app::mzmqServer::appStartup(), MagAOX::app::ocam2KCtrl::appStartup(), MagAOX::app::picamCtrl::appStartup(), appStartup(), MagAOX::app::qhyCtrl::appStartup(), MagAOX::app::siglentSDG::appStartup(), MagAOX::app::smc100ccCtrl::appStartup(), MagAOX::app::streamWriter::appStartup(), MagAOX::app::sysMonitor::appStartup(), MagAOX::app::trippLitePDU::appStartup(), MagAOX::app::xt1121DCDU::appStartup(), MagAOX::app::zaberCtrl::appStartup(), MagAOX::app::zylaCtrl::appStartup(), MagAOX::app::ttmModulator::calcState(), MagAOX::app::andorCtrl::cameraSelect(), MagAOX::app::zylaCtrl::cameraSelect(), visxCtrl.xapp.VisX::cancel_exposure(), MagAOX::app::picamCtrl::capExpTime(), MagAOX::app::siglentSDG::changeAmp(), MagAOX::app::siglentSDG::changeAmp(), MagAOX::app::siglentSDG::changeFreq(), MagAOX::app::siglentSDG::changeFreq(), MagAOX::app::siglentSDG::changeOfst(), MagAOX::app::siglentSDG::changeOfst(), MagAOX::app::siglentSDG::changeOutp(), MagAOX::app::siglentSDG::changeOutp(), MagAOX::app::siglentSDG::changePhse(), MagAOX::app::siglentSDG::changePhse(), MagAOX::app::siglentSDG::changeSync(), MagAOX::app::siglentSDG::changeSync(), MagAOX::app::siglentSDG::changeWdth(), MagAOX::app::siglentSDG::changeWdth(), MagAOX::app::siglentSDG::changeWvtp(), MagAOX::app::siglentSDG::changeWvtp(), MagAOX::app::xt1121Ctrl::channelSetCallback(), channelThreadExec(), channelThreadStart(), MagAOX::app::baslerCtrl::checkNextROI(), MagAOX::app::andorCtrl::checkRecordTimes(), MagAOX::app::baslerCtrl::checkRecordTimes(), MagAOX::app::cameraSim::checkRecordTimes(), MagAOX::app::ocam2KCtrl::checkRecordTimes(), MagAOX::app::picamCtrl::checkRecordTimes(), MagAOX::app::qhyCtrl::checkRecordTimes(), MagAOX::app::siglentSDG::checkRecordTimes(), MagAOX::app::smc100ccCtrl::checkRecordTimes(), MagAOX::app::sysMonitor::checkRecordTimes(), MagAOX::app::zaberCtrl::checkRecordTimes(), MagAOX::app::zylaCtrl::checkRecordTimes(), MagAOX::app::siglentSDG::checkSetup(), MagAOX::app::andorCtrl::configureAcquisition(), MagAOX::app::baslerCtrl::configureAcquisition(), MagAOX::app::cameraSim::configureAcquisition(), MagAOX::app::ocam2KCtrl::configureAcquisition(), MagAOX::app::picamCtrl::configureAcquisition(), MagAOX::app::qhyCtrl::configureAcquisition(), MagAOX::app::zylaCtrl::configureAcquisition(), MagAOX::app::baslerCtrl::connect(), MagAOX::app::picamCtrl::connect(), MagAOX::app::qhyCtrl::connect(), MagAOX::app::sysMonitor::criticalCoreTemperature(), MagAOX::app::sysMonitor::criticalDiskTemperature(), MagAOX::app::trippLitePDU::devConnect(), MagAOX::app::trippLitePDU::devLogin(), MagAOX::app::trippLitePDU::devPostLogin(), MagAOX::app::trippLitePDU::devStatus(), MagAOX::app::streamWriter::doEncode(), MagAOX::app::streamWriter::fgThreadExec(), MagAOX::app::streamWriter::fgThreadStart(), visxCtrl.xapp.VisX::finalize_exposure(), MagAOX::app::sysMonitor::findChronyStatus(), MagAOX::app::sysMonitor::findCPULoads(), MagAOX::app::sysMonitor::findCPUTemperatures(), MagAOX::app::sysMonitor::findDiskTemperature(), MagAOX::app::sysMonitor::findDiskUsage(), MagAOX::app::sysMonitor::findRamUsage(), camtipSR.core.camtipSR::fit_SR_EE(), camtipSR.core.camtipSR::fit_SR_gauss(), MagAOX::app::picamCtrl::getAcquisitionState(), MagAOX::app::streamWriter::getCircBuffLengths(), MagAOX::app::smc100ccCtrl::getCtrlState(), MagAOX::app::andorCtrl::getEMGain(), MagAOX::app::ocam2KCtrl::getEMGain(), MagAOX::app::baslerCtrl::getExpTime(), MagAOX::app::qhyCtrl::getExpTime(), MagAOX::app::andorCtrl::getFPS(), MagAOX::app::ocam2KCtrl::getFPS(), MagAOX::app::smc100ccCtrl::getLastError(), MagAOX::app::filterWheelCtrl::getMoving(), MagAOX::app::picamCtrl::getPicamParameter(), MagAOX::app::picamCtrl::getPicamParameter(), MagAOX::app::filterWheelCtrl::getPos(), MagAOX::app::smc100ccCtrl::getPosition(), MagAOX::app::xt1121Ctrl::getState(), MagAOX::app::filterWheelCtrl::getSwitch(), MagAOX::app::andorCtrl::getTemp(), MagAOX::app::baslerCtrl::getTemp(), MagAOX::app::qhyCtrl::getTemp(), MagAOX::app::zylaCtrl::getTemp(), MagAOX::app::ocam2KCtrl::getTemps(), MagAOX::app::picamCtrl::getTemps(), camtipSR.core.camtipSR::grab_img(), camtipSR.core.camtipSR::grab_stack(), corAlign.corAlign::handle_closed_loop(), adcCtrl.adcCtrl::handle_ctrl_mtx(), visxCtrl.xapp.VisX::handle_expose(), visxCtrl.xapp.VisX::handle_exptime(), adcCtrl.adcCtrl::handle_gain(), visxCtrl.xapp.VisX::handle_gain(), adcCtrl.adcCtrl::handle_knife_edge(), adcCtrl.adcCtrl::handle_knife_edge_findzero(), adcCtrl.adcCtrl::handle_labmode(), adcCtrl.adcCtrl::handle_n_avg(), camtipSR.core.camtipSR::handle_n_avg(), corAlign.corAlign::handle_n_avg(), camtipSR.core.camtipSR::handle_n_jitter(), adcCtrl.adcCtrl::handle_no_measurements(), adcCtrl.adcCtrl::handle_offset(), audibleAlerts.core.AudibleAlerts::handle_personality_switch(), corAlign.corAlign::handle_ref_x(), corAlign.corAlign::handle_ref_y(), adcCtrl.adcCtrl::handle_reset(), audibleAlerts.core.AudibleAlerts::handle_soundboard_switch(), audibleAlerts.core.AudibleAlerts::handle_speech_request(), audibleAlerts.core.AudibleAlerts::handle_speech_text(), adcCtrl.adcCtrl::handle_state(), corAlign.corAlign::handle_state(), visxCtrl.xapp.VisX::handle_temp_ccd(), MagAOX::app::mzmqClient::handlerSigSegv(), MagAOX::app::mzmqServer::handlerSigSegv(), MagAOX::app::streamWriter::handlerSigSegv(), MagAOX::app::filterWheelCtrl::home(), MagAOX::app::INDI_NEWCALLBACK_DEFN(), dbIngest.dbIngest::ingest_line(), MagAOX::app::streamWriter::initialize_xrif(), dbIngest.dbIngest::launch_followers(), audibleAlerts.core.AudibleAlerts::load_personality(), MagAOX::app::andorCtrl::loadConfig(), MagAOX::app::filterWheelCtrl::loadConfig(), MagAOX::app::hsfwCtrl::loadConfig(), MagAOX::app::mzmqClient::loadConfig(), MagAOX::app::mzmqServer::loadConfig(), MagAOX::app::ocam2KCtrl::loadConfig(), loadConfig(), MagAOX::app::qhyCtrl::loadConfig(), MagAOX::app::smc100ccCtrl::loadConfig(), MagAOX::app::streamWriter::loadConfig(), MagAOX::app::sysMonitor::loadConfig(), MagAOX::app::xt1121Ctrl::loadConfig(), loadConfigImpl(), MagAOX::app::zaberCtrl::loadConfigImpl(), MagAOX::app::cameraSim::loadConfigImpl(), MagAOX::app::andorCtrl::loadImageIntoStream(), MagAOX::app::baslerCtrl::loadImageIntoStream(), MagAOX::app::cameraSim::loadImageIntoStream(), MagAOX::app::ocam2KCtrl::loadImageIntoStream(), MagAOX::app::picamCtrl::loadImageIntoStream(), MagAOX::app::qhyCtrl::loadImageIntoStream(), MagAOX::app::zylaCtrl::loadImageIntoStream(), adcCtrl.adcCtrl::loop(), audibleAlerts.core.AudibleAlerts::loop(), corAlign.corAlign::loop(), dbIngest.dbIngest::loop(), visxCtrl.xapp.VisX::loop(), MagAOX::app::smc100ccCtrl::makeCom(), corAlign.corAlign::measure_fpm_mask_shift(), MagAOX::app::ttmModulator::modTTM(), MagAOX::app::filterWheelCtrl::moveTo(), MagAOX::app::hsfwCtrl::moveTo(), MagAOX::app::zaberCtrl::moveTo(), MagAOX::app::smc100ccCtrl::moveTo(), MagAOX::app::filterWheelCtrl::moveToRaw(), MagAOX::app::filterWheelCtrl::moveToRawRelative(), newCallBack_picopos(), newCallBack_presetName(), MagAOX::app::siglentSDG::normalizeSetup(), MagAOX::app::ttmModulator::offset12(), MagAOX::app::ttmModulator::offsetXY(), MagAOX::app::acronameUsbHub::onPowerOff(), MagAOX::app::andorCtrl::onPowerOff(), MagAOX::app::filterWheelCtrl::onPowerOff(), MagAOX::app::hsfwCtrl::onPowerOff(), MagAOX::app::ocam2KCtrl::onPowerOff(), MagAOX::app::picamCtrl::onPowerOff(), MagAOX::app::zylaCtrl::onPowerOff(), MagAOX::app::filterWheelCtrl::onPowerOnConnect(), MagAOX::app::sysMonitor::parseCPULoads(), MagAOX::app::sysMonitor::parseCPUTemperatures(), MagAOX::app::sysMonitor::parseCPUTemperaturesAMD(), MagAOX::app::sysMonitor::parseCPUTemperaturesIntel(), MagAOX::app::sysMonitor::parseDiskTemperature(), MagAOX::app::sysMonitor::parseDiskUsage(), MagAOX::app::trippLitePDU::parsePDUStatus(), MagAOX::app::sysMonitor::parseRamUsage(), MagAOX::app::zylaCtrl::powerOnDefaults(), audibleAlerts.core.AudibleAlerts::preprocess(), MagAOX::app::filterWheelCtrl::presetNumber(), MagAOX::app::smc100ccCtrl::presetNumber(), MagAOX::app::zaberCtrl::presetNumber(), MagAOX::app::siglentSDG::queryARWV(), MagAOX::app::siglentSDG::queryBSWV(), MagAOX::app::siglentSDG::queryBTWV(), MagAOX::app::siglentSDG::queryMDWV(), MagAOX::app::siglentSDG::queryOUTP(), MagAOX::app::siglentSDG::querySWWV(), MagAOX::app::siglentSDG::querySYNC(), audibleAlerts.core.AudibleAlerts::reaction_handler(), readChannelCounts(), MagAOX::app::andorCtrl::reconfig(), MagAOX::app::ocam2KCtrl::reconfig(), MagAOX::app::picamCtrl::reconfig(), MagAOX::app::zylaCtrl::reconfig(), MagAOX::app::sysMonitor::recordChronyStatus(), MagAOX::app::sysMonitor::recordCoreLoads(), MagAOX::app::sysMonitor::recordCoreTemps(), MagAOX::app::sysMonitor::recordDriveTemps(), MagAOX::app::siglentSDG::recordParams(), MagAOX::app::streamWriter::recordSavingState(), MagAOX::app::streamWriter::recordSavingStats(), MagAOX::app::filterWheelCtrl::recordStage(), MagAOX::app::smc100ccCtrl::recordStage(), MagAOX::app::zaberCtrl::recordTelem(), MagAOX::app::sysMonitor::recordUsage(), MagAOX::app::zaberCtrl::recordZaber(), dbIngest.dbIngest::refresh_properties(), visxCtrl.xapp.VisX::refresh_properties(), MagAOX::app::mzmqClient::reportError(), MagAOX::app::mzmqServer::reportError(), MagAOX::app::mzmqClient::reportInfo(), MagAOX::app::mzmqServer::reportInfo(), MagAOX::app::mzmqClient::reportNotice(), MagAOX::app::mzmqServer::reportNotice(), MagAOX::app::mzmqClient::reportWarning(), MagAOX::app::mzmqServer::reportWarning(), dbIngest.dbIngest::rescan_files(), MagAOX::app::ocam2KCtrl::resetEMProtection(), MagAOX::app::ttmModulator::restTTM(), adcCtrl.adcCtrl::send_command(), MagAOX::app::andorCtrl::setCropMode(), MagAOX::app::andorCtrl::setEMGain(), MagAOX::app::ocam2KCtrl::setEMGain(), MagAOX::app::picamCtrl::setEMGain(), MagAOX::app::andorCtrl::setExpTime(), MagAOX::app::baslerCtrl::setExpTime(), MagAOX::app::cameraSim::setExpTime(), MagAOX::app::picamCtrl::setExpTime(), MagAOX::app::qhyCtrl::setExpTime(), MagAOX::app::baslerCtrl::setFPS(), MagAOX::app::cameraSim::setFPS(), MagAOX::app::ocam2KCtrl::setFPS(), MagAOX::app::sysMonitor::setlatThreadExec(), MagAOX::app::sysMonitor::setlatThreadStart(), MagAOX::app::picamCtrl::setPicamParameter(), MagAOX::app::picamCtrl::setPicamParameter(), MagAOX::app::picamCtrl::setPicamParameter(), MagAOX::app::picamCtrl::setPicamParameter(), MagAOX::app::picamCtrl::setPicamParameter(), MagAOX::app::picamCtrl::setPicamParameterOnline(), MagAOX::app::picamCtrl::setPicamParameterOnline(), MagAOX::app::picamCtrl::setPicamParameterOnline(), MagAOX::app::picamCtrl::setPicamParameterOnline(), MagAOX::app::andorCtrl::setReadoutSpeed(), MagAOX::app::ocam2KCtrl::setShutter(), MagAOX::app::picamCtrl::setShutter(), MagAOX::app::zylaCtrl::setShutter(), MagAOX::app::cameraSim::setShutter(), MagAOX::app::andorCtrl::setShutter(), MagAOX::app::mzmqClient::setSigSegvHandler(), MagAOX::app::mzmqServer::setSigSegvHandler(), MagAOX::app::streamWriter::setSigSegvHandler(), MagAOX::app::ocam2KCtrl::setSynchro(), MagAOX::app::andorCtrl::setTempControl(), MagAOX::app::ocam2KCtrl::setTempControl(), MagAOX::app::zylaCtrl::setTempControl(), MagAOX::app::andorCtrl::setTempSetPt(), MagAOX::app::ocam2KCtrl::setTempSetPt(), MagAOX::app::ttmModulator::setTTM(), adcCtrl.adcCtrl::setup(), camtipSR.core.camtipSR::setup(), corAlign.corAlign::setup(), efcControl.efcControl::setup(), MagAOX::app::andorCtrl::setVShiftSpeed(), MagAOX::app::smc100ccCtrl::splitResponse(), MagAOX::app::andorCtrl::startAcquisition(), MagAOX::app::baslerCtrl::startAcquisition(), MagAOX::app::ocam2KCtrl::startAcquisition(), MagAOX::app::zylaCtrl::startAcquisition(), MagAOX::app::hsfwCtrl::startHoming(), MagAOX::app::smc100ccCtrl::startHoming(), MagAOX::app::zaberCtrl::startHoming(), MagAOX::app::baslerCtrl::stateString(), MagAOX::app::ocam2KCtrl::stateString(), MagAOX::app::filterWheelCtrl::stop(), MagAOX::app::smc100ccCtrl::stop(), MagAOX::app::zaberCtrl::stop(), visxCtrl.xapp.VisX::subscribe_to_other_devices(), MagAOX::app::streamWriter::swThreadExec(), MagAOX::app::streamWriter::swThreadStart(), MagAOX::app::smc100ccCtrl::testConnection(), adcCtrl.adcCtrl::transition_to_idle(), camtipSR.core.camtipSR::transition_to_idle(), corAlign.corAlign::transition_to_idle(), MagAOX::app::acronameUsbHub::turnOutletOff(), MagAOX::app::trippLitePDU::turnOutletOff(), MagAOX::app::xt1121DCDU::turnOutletOff(), MagAOX::app::acronameUsbHub::turnOutletOn(), MagAOX::app::trippLitePDU::turnOutletOn(), MagAOX::app::xt1121DCDU::turnOutletOn(), adcCtrl.adcCtrl::update_wavelength(), MagAOX::app::trippLitePDU::updateAlarmsAndWarnings(), MagAOX::app::acronameUsbHub::updateOutletState(), MagAOX::app::trippLitePDU::updateOutletState(), MagAOX::app::xt1121DCDU::updateOutletState(), MagAOX::app::trippLitePDU::updateOutletStates(), MagAOX::app::magAOXMaths::updateVals(), MagAOX::app::sysMonitor::updateVals(), audibleAlerts.core.AudibleAlerts::walkup_handler(), MagAOX::app::andorCtrl::whilePowerOff(), MagAOX::app::filterWheelCtrl::whilePowerOff(), MagAOX::app::hsfwCtrl::whilePowerOff(), MagAOX::app::ocam2KCtrl::whilePowerOff(), MagAOX::app::picamCtrl::whilePowerOff(), MagAOX::app::zylaCtrl::whilePowerOff(), writeChannelCounts(), MagAOX::app::siglentSDG::writeCommand(), MagAOX::app::andorCtrl::writeConfig(), MagAOX::app::siglentSDG::writeRead(), MagAOX::app::xt1121DCDU::xtChannelName(), and MagAOX::app::xt1121DCDU::xtChannelProperty().
|
staticinherited |
Make a log entry.
Wrapper for logManager::log
logT | the log entry type |
retval | the value returned by this method. |
[in] | level | [optional] the log level. The default is used if not specified. |
Definition at line 2000 of file MagAOXApp.hpp.
Referenced by visxCtrl.xapp.VisX::_gather_metadata(), visxCtrl.xapp.VisX::_init_properties(), visxCtrl.xapp.VisX::cancel_exposure(), visxCtrl.xapp.VisX::finalize_exposure(), camtipSR.core.camtipSR::fit_SR_EE(), camtipSR.core.camtipSR::fit_SR_gauss(), camtipSR.core.camtipSR::grab_img(), camtipSR.core.camtipSR::grab_stack(), corAlign.corAlign::handle_closed_loop(), adcCtrl.adcCtrl::handle_ctrl_mtx(), visxCtrl.xapp.VisX::handle_expose(), visxCtrl.xapp.VisX::handle_exptime(), adcCtrl.adcCtrl::handle_gain(), visxCtrl.xapp.VisX::handle_gain(), adcCtrl.adcCtrl::handle_knife_edge(), adcCtrl.adcCtrl::handle_knife_edge_findzero(), adcCtrl.adcCtrl::handle_labmode(), adcCtrl.adcCtrl::handle_n_avg(), camtipSR.core.camtipSR::handle_n_avg(), corAlign.corAlign::handle_n_avg(), camtipSR.core.camtipSR::handle_n_jitter(), adcCtrl.adcCtrl::handle_no_measurements(), adcCtrl.adcCtrl::handle_offset(), audibleAlerts.core.AudibleAlerts::handle_personality_switch(), corAlign.corAlign::handle_ref_x(), corAlign.corAlign::handle_ref_y(), adcCtrl.adcCtrl::handle_reset(), audibleAlerts.core.AudibleAlerts::handle_soundboard_switch(), audibleAlerts.core.AudibleAlerts::handle_speech_request(), audibleAlerts.core.AudibleAlerts::handle_speech_text(), adcCtrl.adcCtrl::handle_state(), corAlign.corAlign::handle_state(), visxCtrl.xapp.VisX::handle_temp_ccd(), dbIngest.dbIngest::ingest_line(), dbIngest.dbIngest::launch_followers(), audibleAlerts.core.AudibleAlerts::load_personality(), adcCtrl.adcCtrl::loop(), audibleAlerts.core.AudibleAlerts::loop(), corAlign.corAlign::loop(), dbIngest.dbIngest::loop(), visxCtrl.xapp.VisX::loop(), corAlign.corAlign::measure_fpm_mask_shift(), audibleAlerts.core.AudibleAlerts::preprocess(), audibleAlerts.core.AudibleAlerts::reaction_handler(), dbIngest.dbIngest::refresh_properties(), visxCtrl.xapp.VisX::refresh_properties(), dbIngest.dbIngest::rescan_files(), adcCtrl.adcCtrl::send_command(), adcCtrl.adcCtrl::setup(), camtipSR.core.camtipSR::setup(), corAlign.corAlign::setup(), efcControl.efcControl::setup(), visxCtrl.xapp.VisX::subscribe_to_other_devices(), adcCtrl.adcCtrl::transition_to_idle(), camtipSR.core.camtipSR::transition_to_idle(), corAlign.corAlign::transition_to_idle(), adcCtrl.adcCtrl::update_wavelength(), and audibleAlerts.core.AudibleAlerts::walkup_handler().
|
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 2007 of file MagAOXApp.hpp.
References b(), flatlogs::logPrio::LOG_ERROR, flatlogs::logPrio::LOG_NOTICE, flatlogs::logHeader::logLevel(), MagAOX::logger::logMinStdFormat(), MagAOX::logger::logStdFormat(), MagAOX::app::msg, flatlogs::timespecX::time_ns, flatlogs::timespecX::time_s, and flatlogs::logHeader::timespec().
|
inherited |
Get the loop pause time.
Definition at line 3743 of file MagAOXApp.hpp.
|
protectedinherited |
The callback called by the static version, to actually process the FSM Alert Clear request.
[in] | ipRecv | the INDI property sent with the new property request. |
Definition at line 3576 of file MagAOXApp.hpp.
References INDI_IDLE, and MagAOX::app::ipRecv.
The handler function for relative position requests, called by the static callback.
Signals the relavent thread.
[in] | ipRecv | the INDI property sent with the the new property request. |
Definition at line 1046 of file picoMotorCtrl.hpp.
References MagAOX::app::MagAOXApp< _useINDI >::indiTargetUpdate(), MagAOX::app::ipRecv, MagAOX::app::it, MagAOX::app::lock(), MagAOX::app::MagAOXApp< _useINDI >::log(), flatlogs::logPrio::LOG_WARNING, m_channels, and MagAOX::app::MagAOXApp< _useINDI >::m_indiMutex.
Referenced by st_newCallBack_picopos().
The handler function for position presets, called by the static callback.
Signals the relavent thread.
[in] | ipRecv | the INDI property sent with the the new property request. |
Definition at line 1099 of file picoMotorCtrl.hpp.
References MagAOX::app::ipRecv, MagAOX::app::it, MagAOX::app::lock(), MagAOX::app::MagAOXApp< _useINDI >::log(), flatlogs::logPrio::LOG_ERROR, flatlogs::logPrio::LOG_WARNING, m_channels, and MagAOX::app::MagAOXApp< _useINDI >::m_indiMutex.
Referenced by st_newCallBack_presetName().
|
virtual |
Implementation of the on-power-off FSM logic.
Reimplemented from MagAOX::app::MagAOXApp< _useINDI >.
Definition at line 895 of file picoMotorCtrl.hpp.
|
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.
Definition at line 3609 of file MagAOXApp.hpp.
Referenced by appLogic(), MagAOX::app::smc100ccCtrl::appLogic(), and MagAOX::app::xt1121Ctrl::appLogic().
|
inherited |
Returns the current power state.
If power management is not enabled, this always returns 1=On.
Definition at line 3628 of file MagAOXApp.hpp.
Referenced by MagAOX::app::ocam2KCtrl::acquireAndCheckValid(), MagAOX::app::andorCtrl::appLogic(), MagAOX::app::hsfwCtrl::appLogic(), MagAOX::app::ocam2KCtrl::appLogic(), MagAOX::app::picamCtrl::appLogic(), appLogic(), MagAOX::app::picamCtrl::capExpTime(), channelThreadExec(), MagAOX::app::ocam2KCtrl::configureAcquisition(), MagAOX::app::picamCtrl::configureAcquisition(), MagAOX::app::picamCtrl::connect(), MagAOX::app::picamCtrl::getAcquisitionState(), MagAOX::app::ocam2KCtrl::getEMGain(), MagAOX::app::ocam2KCtrl::getFPS(), MagAOX::app::picamCtrl::getPicamParameter(), MagAOX::app::picamCtrl::getPicamParameter(), MagAOX::app::ocam2KCtrl::getTemps(), MagAOX::app::picamCtrl::getTemps(), MagAOX::app::hsfwCtrl::moveTo(), MagAOX::app::ocam2KCtrl::resetEMProtection(), MagAOX::app::ocam2KCtrl::setEMGain(), MagAOX::app::picamCtrl::setEMGain(), MagAOX::app::picamCtrl::setExpTime(), MagAOX::app::ocam2KCtrl::setFPS(), MagAOX::app::picamCtrl::setPicamParameter(), MagAOX::app::picamCtrl::setPicamParameter(), MagAOX::app::picamCtrl::setPicamParameter(), MagAOX::app::picamCtrl::setPicamParameterOnline(), MagAOX::app::picamCtrl::setPicamParameterOnline(), MagAOX::app::ocam2KCtrl::setSynchro(), MagAOX::app::ocam2KCtrl::setTempControl(), MagAOX::app::ocam2KCtrl::setTempSetPt(), and MagAOX::app::hsfwCtrl::startHoming().
|
inherited |
Returns the target power state.
If power management is not enabled, this always returns 1=On.
Definition at line 3639 of file MagAOXApp.hpp.
Referenced by MagAOX::app::ocam2KCtrl::acquireAndCheckValid(), MagAOX::app::andorCtrl::appLogic(), MagAOX::app::hsfwCtrl::appLogic(), MagAOX::app::ocam2KCtrl::appLogic(), MagAOX::app::picamCtrl::appLogic(), appLogic(), MagAOX::app::picamCtrl::capExpTime(), channelThreadExec(), MagAOX::app::ocam2KCtrl::configureAcquisition(), MagAOX::app::picamCtrl::configureAcquisition(), MagAOX::app::picamCtrl::connect(), MagAOX::app::picamCtrl::getAcquisitionState(), MagAOX::app::ocam2KCtrl::getEMGain(), MagAOX::app::ocam2KCtrl::getFPS(), MagAOX::app::picamCtrl::getPicamParameter(), MagAOX::app::picamCtrl::getPicamParameter(), MagAOX::app::ocam2KCtrl::getTemps(), MagAOX::app::picamCtrl::getTemps(), MagAOX::app::hsfwCtrl::moveTo(), MagAOX::app::ocam2KCtrl::resetEMProtection(), MagAOX::app::ocam2KCtrl::setEMGain(), MagAOX::app::picamCtrl::setEMGain(), MagAOX::app::picamCtrl::setExpTime(), MagAOX::app::ocam2KCtrl::setFPS(), MagAOX::app::picamCtrl::setPicamParameter(), MagAOX::app::picamCtrl::setPicamParameter(), MagAOX::app::picamCtrl::setPicamParameter(), MagAOX::app::picamCtrl::setPicamParameterOnline(), MagAOX::app::picamCtrl::setPicamParameterOnline(), MagAOX::app::ocam2KCtrl::setSynchro(), MagAOX::app::ocam2KCtrl::setTempControl(), MagAOX::app::ocam2KCtrl::setTempSetPt(), and MagAOX::app::hsfwCtrl::startHoming().
picoMotorCtrl::posT MagAOX::app::picoMotorCtrl::readChannelCounts | ( | const std::string & | chName | ) |
Read the current channel counts from disk at startup.
Reads the counts from the file with the specified name in this apps sys directory. Returns the file contents as a posT.
Definition at line 928 of file picoMotorCtrl.hpp.
References MagAOX::app::MagAOXApp< _useINDI >::log(), MagAOX::app::MagAOXApp< _useINDI >::m_configName, and MagAOX::app::MagAOXApp< _useINDI >::m_sysPath.
Referenced by appStartup().
Definition at line 1159 of file picoMotorCtrl.hpp.
Referenced by appLogic(), channelThreadExec(), and recordTelem().
int MagAOX::app::picoMotorCtrl::recordTelem | ( | const telem_pico * | ) |
Definition at line 1154 of file picoMotorCtrl.hpp.
References recordPico().
|
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.
[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 |
|
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.
[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 |
|
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.
[in] | prop | the property to register, must be fully set up |
Referenced by MagAOX::app::filterWheelCtrl::appStartup(), MagAOX::app::magAOXMaths::appStartup(), MagAOX::app::ocam2KCtrl::appStartup(), appStartup(), MagAOX::app::siglentSDG::appStartup(), MagAOX::app::streamWriter::appStartup(), MagAOX::app::sysMonitor::appStartup(), and MagAOX::app::zaberCtrl::appStartup().
|
inherited |
Register an INDI property which is read only.
This version requires the property be fully set up.
[in] | prop | the property to register, must be completely setup |
Definition at line 2861 of file MagAOXApp.hpp.
Referenced by MagAOX::app::picamCtrl::appStartup(), and MagAOX::app::zaberCtrl::appStartup().
|
inherited |
Register an INDI property which is read only.
This verison sets up the INDI property according to the arguments.
[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 2890 of file MagAOXApp.hpp.
|
inherited |
Register an INDI property which is monitored for updates from others.
[out] | prop | the property to register |
[in] | devName | the device which owns this property |
[in] | propName | the name of the property |
Definition at line 2998 of file MagAOXApp.hpp.
|
inherited |
Get the secrets path.
Definition at line 3731 of file MagAOXApp.hpp.
|
inherited |
Definition at line 3157 of file MagAOXApp.hpp.
References MagAOX::app::it.
|
protectedinherited |
Send a newProperty command to another device (using the INDI Client interface)
[in] | ipSend | The property to send a "new" INDI command for |
Definition at line 3512 of file MagAOXApp.hpp.
|
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.
[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 3476 of file MagAOXApp.hpp.
References MagAOX::app::MagAOXApp< _useINDI >::sendNewProperty().
Referenced by MagAOX::app::ttmModulator::modTTM(), MagAOX::app::zaberCtrl::moveTo(), MagAOX::app::ttmModulator::offset12(), MagAOX::app::ttmModulator::offsetXY(), MagAOX::app::ttmModulator::restTTM(), MagAOX::app::MagAOXApp< _useINDI >::sendNewProperty(), MagAOX::app::ocam2KCtrl::setFPS(), MagAOX::app::ttmModulator::setTTM(), MagAOX::app::zaberCtrl::startHoming(), MagAOX::app::zaberCtrl::stop(), MagAOX::app::xt1121DCDU::turnOutletOff(), and MagAOX::app::xt1121DCDU::turnOutletOn().
|
protectedinherited |
Send a new property commmand for a standard toggle switch.
[in] | device | The device name |
[in] | property | The property name |
[in] | onoff | Switch state to send: true = on, false = off |
Definition at line 3533 of file MagAOXApp.hpp.
|
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.
[in] | argc | standard command line result specifying number of arguments in argv |
[in] | argv | standard command line result containing the arguments. |
Definition at line 1327 of file MagAOXApp.hpp.
References MAGAOX_calibRelPath, MAGAOX_configRelPath, MAGAOX_env_calib, MAGAOX_env_config, MAGAOX_env_cpuset, MAGAOX_env_log, MAGAOX_env_path, MAGAOX_env_secrets, MAGAOX_env_sys, MAGAOX_logRelPath, MAGAOX_path, MAGAOX_secretsRelPath, and MAGAOX_sysRelPath.
|
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
Definition at line 2149 of file MagAOXApp.hpp.
Referenced by MagAOX::app::MagAOXApp< _useINDI >::elevatedPrivileges::elevate().
|
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
Definition at line 2167 of file MagAOXApp.hpp.
Referenced by MagAOX::app::MagAOXApp< _useINDI >::elevatedPrivileges::restore().
|
privateinherited |
Sets the handler for SIGTERM, SIGQUIT, and SIGINT.
Definition at line 2060 of file MagAOXApp.hpp.
References flatlogs::logPrio::LOG_DEBUG.
|
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 1444 of file MagAOXApp.hpp.
|
virtual |
Setup the configuration system (called by MagAOXApp::setup())
Definition at line 329 of file picoMotorCtrl.hpp.
References MagAOX::app::dev::ioDevice::setupConfig(), and TELEMETER_SETUP_CONFIG.
|
inherited |
Setup an application configurator for the device section.
[in] | config | an application configuration to setup |
Definition at line 106 of file telemeter.hpp.
|
inherited |
Setup an application configurator for the device section.
[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(), setupConfig(), MagAOX::app::rhusbMon::setupConfig(), MagAOX::app::smc100ccCtrl::setupConfig(), MagAOX::app::tcsInterface::setupConfig(), MagAOX::app::trippLitePDU::setupConfig(), and MagAOX::app::dev::edtCamera< derivedT >::setupConfig().
|
inherited |
Get the value of the shutdown flag.
Definition at line 3749 of file MagAOXApp.hpp.
Referenced by MagAOX::app::streamWriter::swThreadExec().
|
staticprotectedinherited |
The static callback function to be registered for requesting to clear the FSM alert.
[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 3570 of file MagAOXApp.hpp.
References MagAOX::app::ipRecv.
|
static |
The static callback function to be registered for relative position requests.
Dispatches to the handler, which then signals the relavent thread.
[in] | app | a pointer to this, will be static_cast-ed to this |
[in] | ipRecv | the INDI property sent with the the new property request. |
Definition at line 1039 of file picoMotorCtrl.hpp.
References MagAOX::app::ipRecv, and newCallBack_picopos().
Referenced by appStartup().
|
static |
The static callback function to be registered for position presets.
Dispatches to the handler, which then signals the relavent thread.
[in] | app | a pointer to this, will be static_cast-ed to this |
[in] | ipRecv | the INDI property sent with the the new property request. |
Definition at line 1092 of file picoMotorCtrl.hpp.
References MagAOX::app::ipRecv, and newCallBack_presetName().
Referenced by appStartup().
|
protectedinherited |
Start INDI Communications.
Definition at line 3100 of file MagAOXApp.hpp.
|
inherited |
Get the current state code.
Definition at line 2474 of file MagAOXApp.hpp.
Referenced by MagAOX::app::baslerCtrl::acquireAndCheckValid(), MagAOX::app::picamCtrl::acquireAndCheckValid(), MagAOX::app::qhyCtrl::acquireAndCheckValid(), MagAOX::app::acronameUsbHub::appLogic(), MagAOX::app::andorCtrl::appLogic(), MagAOX::app::baslerCtrl::appLogic(), MagAOX::app::cameraSim::appLogic(), MagAOX::app::filterWheelCtrl::appLogic(), MagAOX::app::hsfwCtrl::appLogic(), MagAOX::app::ocam2KCtrl::appLogic(), MagAOX::app::picamCtrl::appLogic(), appLogic(), MagAOX::app::siglentSDG::appLogic(), MagAOX::app::smc100ccCtrl::appLogic(), MagAOX::app::streamWriter::appLogic(), MagAOX::app::trippLitePDU::appLogic(), MagAOX::app::ttmModulator::appLogic(), MagAOX::app::xt1121Ctrl::appLogic(), MagAOX::app::xt1121DCDU::appLogic(), MagAOX::app::zaberCtrl::appLogic(), MagAOX::app::zylaCtrl::appLogic(), MagAOX::app::acronameUsbHub::appStartup(), MagAOX::app::andorCtrl::appStartup(), MagAOX::app::baslerCtrl::appStartup(), MagAOX::app::cameraSim::appStartup(), MagAOX::app::filterWheelCtrl::appStartup(), MagAOX::app::hsfwCtrl::appStartup(), MagAOX::app::magAOXMaths::appStartup(), MagAOX::app::qhyCtrl::appStartup(), MagAOX::app::smc100ccCtrl::appStartup(), MagAOX::app::sysMonitor::appStartup(), MagAOX::app::trippLitePDU::appStartup(), MagAOX::app::xt1121DCDU::appStartup(), MagAOX::app::zylaCtrl::appStartup(), MagAOX::app::andorCtrl::cameraSelect(), MagAOX::app::siglentSDG::changeAmp(), MagAOX::app::siglentSDG::changeFreq(), MagAOX::app::siglentSDG::changeOfst(), MagAOX::app::siglentSDG::changeOutp(), MagAOX::app::siglentSDG::changePhse(), MagAOX::app::siglentSDG::changeSync(), MagAOX::app::siglentSDG::changeWdth(), MagAOX::app::siglentSDG::changeWvtp(), channelThreadExec(), MagAOX::app::siglentSDG::checkSetup(), MagAOX::app::andorCtrl::configureAcquisition(), MagAOX::app::baslerCtrl::configureAcquisition(), MagAOX::app::cameraSim::configureAcquisition(), MagAOX::app::ocam2KCtrl::configureAcquisition(), MagAOX::app::picamCtrl::configureAcquisition(), MagAOX::app::qhyCtrl::configureAcquisition(), MagAOX::app::baslerCtrl::connect(), MagAOX::app::picamCtrl::connect(), MagAOX::app::qhyCtrl::connect(), MagAOX::app::picamCtrl::getAcquisitionState(), MagAOX::app::smc100ccCtrl::getCtrlState(), MagAOX::app::baslerCtrl::getExpTime(), MagAOX::app::qhyCtrl::getExpTime(), MagAOX::app::baslerCtrl::getFPS(), MagAOX::app::baslerCtrl::getTemp(), MagAOX::app::qhyCtrl::getTemp(), MagAOX::app::picamCtrl::getTemps(), MagAOX::app::filterWheelCtrl::home(), MagAOX::app::baslerCtrl::loadImageIntoStream(), MagAOX::app::qhyCtrl::loadImageIntoStream(), MagAOX::app::hsfwCtrl::moveTo(), MagAOX::app::smc100ccCtrl::moveTo(), MagAOX::app::siglentSDG::queryBTWV(), MagAOX::app::siglentSDG::queryMDWV(), MagAOX::app::siglentSDG::querySWWV(), MagAOX::app::andorCtrl::reconfig(), MagAOX::app::ocam2KCtrl::reconfig(), MagAOX::app::picamCtrl::reconfig(), MagAOX::app::streamWriter::recordSavingState(), MagAOX::app::andorCtrl::setCropMode(), MagAOX::app::picamCtrl::setEMGain(), MagAOX::app::andorCtrl::setExpTime(), MagAOX::app::picamCtrl::setExpTime(), MagAOX::app::andorCtrl::setNextROI(), MagAOX::app::qhyCtrl::setNextROI(), MagAOX::app::andorCtrl::setReadoutSpeed(), MagAOX::app::andorCtrl::setShutter(), MagAOX::app::andorCtrl::setVShiftSpeed(), MagAOX::app::andorCtrl::startAcquisition(), MagAOX::app::baslerCtrl::startAcquisition(), MagAOX::app::cameraSim::startAcquisition(), MagAOX::app::qhyCtrl::startAcquisition(), MagAOX::app::hsfwCtrl::startHoming(), MagAOX::app::ocam2KCtrl::stateStringValid(), MagAOX::app::streamWriter::swThreadExec(), MagAOX::app::acronameUsbHub::updateOutletState(), MagAOX::app::trippLitePDU::updateOutletStates(), and MagAOX::app::siglentSDG::writeRead().
|
inherited |
Set the current state code.
[in] | s | The new application state |
[in] | stateAlert | [optional] flag to set the alert state of the FSM property. |
Definition at line 2480 of file MagAOXApp.hpp.
References INDI_ALERT, INDI_BUSY, INDI_IDLE, INDI_OK, MagAOX::app::lock(), flatlogs::logPrio::LOG_CRITICAL, flatlogs::logPrio::LOG_ERROR, flatlogs::logPrio::LOG_INFO, and flatlogs::logPrio::LOG_WARNING.
|
inherited |
Get the value of the state alert flag.
Definition at line 2538 of file MagAOXApp.hpp.
|
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:
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.
Definition at line 2550 of file MagAOXApp.hpp.
Referenced by MagAOX::app::acronameUsbHub::appLogic(), MagAOX::app::filterWheelCtrl::appLogic(), MagAOX::app::hsfwCtrl::appLogic(), appLogic(), MagAOX::app::siglentSDG::appLogic(), MagAOX::app::smc100ccCtrl::appLogic(), MagAOX::app::trippLitePDU::appLogic(), MagAOX::app::ttmModulator::appLogic(), MagAOX::app::xt1121Ctrl::appLogic(), MagAOX::app::andorCtrl::cameraSelect(), MagAOX::app::baslerCtrl::connect(), MagAOX::app::picamCtrl::connect(), and MagAOX::app::qhyCtrl::connect().
|
inherited |
|
inherited |
Make a telemetry recording, for an empty record.
Wrapper for logManager::log, which updates telT::lastRecord.
logT | the log entry type |
retval | the value returned by this method. |
Definition at line 99 of file telemeter.hpp.
|
inherited |
Make a telemetry recording.
Wrapper for logManager::log, which updates telT::lastRecord.
logT | the log entry type |
retval | the value returned by this method. |
[in] | msg | the data to log |
Definition at line 89 of file telemeter.hpp.
|
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:
where impl
is the derived class, and mThreadStart
and myThreadExec
are members of impl
.
[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 2334 of file MagAOXApp.hpp.
References flatlogs::logPrio::LOG_NOTICE, and MAGAOX_RT_SCHED_POLICY.
Referenced by appStartup(), MagAOX::app::streamWriter::appStartup(), and MagAOX::app::sysMonitor::appStartup().
|
protectedinherited |
Remove the PID file.
Definition at line 2313 of file MagAOXApp.hpp.
|
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.
p | [in/out] The property containing the element to possibly update | |
[in] | el | The element name |
[in] | newVal | the new value |
Definition at line 3343 of file MagAOXApp.hpp.
|
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.
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 3368 of file MagAOXApp.hpp.
|
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.
p | [in/out] The property containing the element to possibly update | |
[in] | el | The element name |
[in] | newVal | the new value |
Definition at line 3328 of file MagAOXApp.hpp.
Referenced by MagAOX::app::filterWheelCtrl::appLogic(), MagAOX::app::ocam2KCtrl::appLogic(), appLogic(), MagAOX::app::smc100ccCtrl::appLogic(), MagAOX::app::ttmModulator::appLogic(), MagAOX::app::zaberCtrl::appLogic(), MagAOX::app::xt1121Ctrl::channelSetCallback(), MagAOX::app::baslerCtrl::checkNextROI(), MagAOX::app::cameraSim::checkNextROI(), MagAOX::app::andorCtrl::configureAcquisition(), MagAOX::app::baslerCtrl::configureAcquisition(), MagAOX::app::picamCtrl::configureAcquisition(), MagAOX::app::qhyCtrl::configureAcquisition(), MagAOX::app::zylaCtrl::configureAcquisition(), MagAOX::app::ocam2KCtrl::getEMGain(), MagAOX::app::xt1121Ctrl::getState(), MagAOX::app::ocam2KCtrl::getTemps(), MagAOX::app::INDI_NEWCALLBACK_DEFN(), MagAOX::app::smc100ccCtrl::moveTo(), MagAOX::app::filterWheelCtrl::moveToRaw(), MagAOX::app::acronameUsbHub::onPowerOff(), MagAOX::app::ocam2KCtrl::onPowerOff(), MagAOX::app::siglentSDG::onPowerOff(), MagAOX::app::xt1121Ctrl::onPowerOff(), MagAOX::app::siglentSDG::queryBSWV(), MagAOX::app::siglentSDG::queryOUTP(), MagAOX::app::ocam2KCtrl::resetEMProtection(), MagAOX::app::picamCtrl::setExpTime(), MagAOX::app::trippLitePDU::updateOutletStates(), MagAOX::app::magAOXMaths::updateVals(), and MagAOX::app::sysMonitor::updateVals().
|
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.
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 3389 of file MagAOXApp.hpp.
|
protectedinherited |
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 3405 of file MagAOXApp.hpp.
|
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.
p | [in/out] The property containing the element to possibly update | |
[in] | el | The element name |
[in] | newVal | the new value |
Definition at line 3352 of file MagAOXApp.hpp.
Referenced by MagAOX::app::siglentSDG::appLogic(), MagAOX::app::siglentSDG::onPowerOff(), MagAOX::app::andorCtrl::setNextROI(), MagAOX::app::baslerCtrl::setNextROI(), MagAOX::app::cameraSim::setNextROI(), MagAOX::app::picamCtrl::setNextROI(), MagAOX::app::qhyCtrl::setNextROI(), MagAOX::app::zylaCtrl::setNextROI(), MagAOX::app::ocam2KCtrl::setSynchro(), MagAOX::app::picamCtrl::setTempControl(), MagAOX::app::filterWheelCtrl::startHoming(), MagAOX::app::hsfwCtrl::startHoming(), MagAOX::app::smc100ccCtrl::startHoming(), MagAOX::app::zaberCtrl::startHoming(), MagAOX::app::filterWheelCtrl::stop(), MagAOX::app::hsfwCtrl::stop(), MagAOX::app::smc100ccCtrl::stop(), MagAOX::app::zaberCtrl::stop(), and MagAOX::app::sysMonitor::updateVals().
|
virtual |
Implementation of the while-powered-off FSM.
Reimplemented from MagAOX::app::MagAOXApp< _useINDI >.
Definition at line 900 of file picoMotorCtrl.hpp.
Definition at line 955 of file picoMotorCtrl.hpp.
References MagAOX::app::MagAOXApp< _useINDI >::log(), flatlogs::logPrio::LOG_ERROR, MagAOX::app::MagAOXApp< _useINDI >::m_configName, and MagAOX::app::MagAOXApp< _useINDI >::m_sysPath.
Referenced by appLogic().
|
friend |
Definition at line 1159 of file picoMotorCtrl.hpp.
|
private |
The unique controller addresses.
Definition at line 180 of file picoMotorCtrl.hpp.
Referenced by appLogic(), and loadConfigImpl().
|
protectedinherited |
Flag indicating that all registered Set properties have been updated since last Get.
Definition at line 677 of file MagAOXApp.hpp.
|
protectedinherited |
The base path of the MagAO-X system.
Definition at line 170 of file MagAOXApp.hpp.
|
protectedinherited |
The path to calibration files for MagAOX.
Definition at line 178 of file MagAOXApp.hpp.
|
private |
Map of motor names to channel.
Definition at line 182 of file picoMotorCtrl.hpp.
Referenced by ~picoMotorCtrl(), appLogic(), appShutdown(), appStartup(), loadConfigImpl(), newCallBack_picopos(), and newCallBack_presetName().
|
protectedinherited |
The name of a base config class for this app (minus .conf).
Definition at line 176 of file MagAOXApp.hpp.
|
protectedinherited |
The path to configuration files for MagAOX.
Definition at line 174 of file MagAOXApp.hpp.
Referenced by MagAOX::app::ocam2KCtrl::configureAcquisition().
|
protectedinherited |
The name of the configuration file (minus .conf).
Definition at line 172 of file MagAOXApp.hpp.
Referenced by SMCTEST::cameraSim_test::cameraSim_test(), SDGTEST::siglentSDG_test::siglentSDG_test(), SMCTEST::smc100ccCtrl_test::smc100ccCtrl_test(), MagAOX::app::streamWriter_test::streamWriter_test(), SYSMONTEST::sysMonitor_test::sysMonitor_test(), ZCTRLTEST::zaberCtrl_test::zaberCtrl_test(), MagAOX::app::mzmqClient::loadConfig(), MagAOX::app::mzmqServer::loadConfig(), MagAOX::app::zaberCtrl::loadConfigImpl(), readChannelCounts(), and writeChannelCounts().
|
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 189 of file MagAOXApp.hpp.
|
private |
The device address.
Definition at line 173 of file picoMotorCtrl.hpp.
Referenced by appLogic(), and loadConfigImpl().
|
private |
|
protectedinherited |
Full path name of the INDI driver control FIFO.
This is currently only used to signal restarts.
Definition at line 688 of file MagAOXApp.hpp.
|
protectedinherited |
Full path name of the INDI driver input FIFO.
Definition at line 680 of file MagAOXApp.hpp.
|
protectedinherited |
Full path name of the INDI driver output FIFO.
Definition at line 683 of file MagAOXApp.hpp.
|
privateinherited |
The user id of the process as called (i.e. the higher privileged id of the owner, root if setuid).
Definition at line 404 of file MagAOXApp.hpp.
|
privateinherited |
The real user id of the proces (i.e. the lower privileged id of the user)
Definition at line 403 of file MagAOXApp.hpp.
|
privateinherited |
Definition at line 560 of file MagAOXApp.hpp.
|
inherited |
The INDI driver wrapper. Constructed and initialized by execute, which starts and stops communications.
Definition at line 637 of file MagAOXApp.hpp.
Referenced by appLogic(), MagAOX::app::smc100ccCtrl::appLogic(), MagAOX::app::zaberCtrl::appLogic(), MagAOX::app::streamWriter::updateINDI(), and MagAOX::app::magAOXMaths::updateVals().
|
inherited |
Mutex for locking INDI communications.
Definition at line 640 of file MagAOXApp.hpp.
Referenced by MagAOX::app::acronameUsbHub::appLogic(), MagAOX::app::andorCtrl::appLogic(), MagAOX::app::baslerCtrl::appLogic(), MagAOX::app::cameraSim::appLogic(), MagAOX::app::filterWheelCtrl::appLogic(), MagAOX::app::hsfwCtrl::appLogic(), MagAOX::app::ocam2KCtrl::appLogic(), MagAOX::app::picamCtrl::appLogic(), appLogic(), MagAOX::app::siglentSDG::appLogic(), MagAOX::app::smc100ccCtrl::appLogic(), MagAOX::app::trippLitePDU::appLogic(), MagAOX::app::ttmModulator::appLogic(), MagAOX::app::xt1121Ctrl::appLogic(), MagAOX::app::xt1121DCDU::appLogic(), MagAOX::app::zaberCtrl::appLogic(), MagAOX::app::zylaCtrl::appLogic(), MagAOX::app::siglentSDG::changeAmp(), MagAOX::app::siglentSDG::changeFreq(), MagAOX::app::siglentSDG::changeOfst(), MagAOX::app::siglentSDG::changeOutp(), MagAOX::app::siglentSDG::changePhse(), MagAOX::app::siglentSDG::changeSync(), MagAOX::app::siglentSDG::changeWdth(), MagAOX::app::siglentSDG::changeWvtp(), MagAOX::app::xt1121Ctrl::channelSetCallback(), MagAOX::app::andorCtrl::configureAcquisition(), MagAOX::app::ocam2KCtrl::configureAcquisition(), MagAOX::app::picamCtrl::configureAcquisition(), MagAOX::app::qhyCtrl::configureAcquisition(), MagAOX::app::zylaCtrl::configureAcquisition(), MagAOX::app::INDI_NEWCALLBACK_DEFN(), newCallBack_picopos(), newCallBack_presetName(), MagAOX::app::acronameUsbHub::onPowerOff(), MagAOX::app::andorCtrl::onPowerOff(), MagAOX::app::ocam2KCtrl::onPowerOff(), MagAOX::app::picamCtrl::onPowerOff(), MagAOX::app::siglentSDG::onPowerOff(), MagAOX::app::xt1121Ctrl::onPowerOff(), MagAOX::app::zylaCtrl::onPowerOff(), MagAOX::app::filterWheelCtrl::onPowerOnConnect(), MagAOX::app::ocam2KCtrl::reconfig(), MagAOX::app::zylaCtrl::reconfig(), MagAOX::app::filterWheelCtrl::stop(), MagAOX::app::trippLitePDU::turnOutletOff(), MagAOX::app::xt1121DCDU::turnOutletOff(), MagAOX::app::trippLitePDU::turnOutletOn(), MagAOX::app::xt1121DCDU::turnOutletOn(), MagAOX::app::ocam2KCtrl::whilePowerOff(), and MagAOX::app::zylaCtrl::whilePowerOff().
|
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 668 of file MagAOXApp.hpp.
|
protectedinherited |
indi Property to clear an FSM alert.
Definition at line 1083 of file MagAOXApp.hpp.
|
protected |
Definition at line 254 of file picoMotorCtrl.hpp.
|
protectedinherited |
INDI property used to communicate power state.
Definition at line 1139 of file MagAOXApp.hpp.
|
protectedinherited |
indi Property to report the application state.
Definition at line 1080 of file MagAOXApp.hpp.
|
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 673 of file MagAOXApp.hpp.
|
staticinherited |
Definition at line 327 of file MagAOXApp.hpp.
|
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 191 of file MagAOXApp.hpp.
Referenced by MagAOX::app::trippLitePDU::trippLitePDU(), and MagAOX::app::siglentSDG::appLogic().
|
inherited |
The maximum interval, in seconds, between telemetry records. Default is 10.0 seconds.
Definition at line 77 of file telemeter.hpp.
|
private |
The number of motor channels total on the hardware. Number of attached motors inferred from config.
Definition at line 176 of file picoMotorCtrl.hpp.
Referenced by loadConfigImpl().
|
protectedinherited |
This process's PID.
Definition at line 484 of file MagAOXApp.hpp.
|
protectedinherited |
The INDI property name of the channel controlling this device's power.
Definition at line 1125 of file MagAOXApp.hpp.
|
protectedinherited |
The INDI device name of the power controller.
Definition at line 1124 of file MagAOXApp.hpp.
|
protectedinherited |
The INDI element name to monitor for this device's power state.
Definition at line 1126 of file MagAOXApp.hpp.
|
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 1119 of file MagAOXApp.hpp.
Referenced by MagAOX::app::acronameUsbHub::acronameUsbHub(), MagAOX::app::andorCtrl::andorCtrl(), MagAOX::app::baslerCtrl::baslerCtrl(), MagAOX::app::cameraSim::cameraSim(), MagAOX::app::filterWheelCtrl::filterWheelCtrl(), MagAOX::app::hsfwCtrl::hsfwCtrl(), MagAOX::app::mzmqClient::mzmqClient(), MagAOX::app::mzmqServer::mzmqServer(), MagAOX::app::ocam2KCtrl::ocam2KCtrl(), MagAOX::app::picamCtrl::picamCtrl(), picoMotorCtrl(), MagAOX::app::qhyCtrl::qhyCtrl(), MagAOX::app::siglentSDG::siglentSDG(), MagAOX::app::smc100ccCtrl::smc100ccCtrl(), MagAOX::app::streamWriter::streamWriter(), MagAOX::app::ttmModulator::ttmModulator(), MagAOX::app::xt1121Ctrl::xt1121Ctrl(), MagAOX::app::xt1121DCDU::xt1121DCDU(), and MagAOX::app::zylaCtrl::zylaCtrl().
|
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 1132 of file MagAOXApp.hpp.
Referenced by MagAOX::app::andorCtrl::onPowerOff(), MagAOX::app::ocam2KCtrl::onPowerOff(), and MagAOX::app::zylaCtrl::onPowerOff().
|
protectedinherited |
Time in sec to wait for device to boot after power on.
Definition at line 1129 of file MagAOXApp.hpp.
Referenced by MagAOX::app::andorCtrl::andorCtrl(), MagAOX::app::ocam2KCtrl::ocam2KCtrl(), MagAOX::app::smc100ccCtrl::smc100ccCtrl(), MagAOX::app::xt1121Ctrl::xt1121Ctrl(), and MagAOX::app::zylaCtrl::zylaCtrl().
|
protectedinherited |
Current power state, 1=On, 0=Off, -1=Unk.
Definition at line 1136 of file MagAOXApp.hpp.
Referenced by MagAOX::app::andorCtrl::appLogic(), MagAOX::app::filterWheelCtrl::appLogic(), MagAOX::app::ocam2KCtrl::appLogic(), MagAOX::app::siglentSDG::appLogic(), MagAOX::app::smc100ccCtrl::appLogic(), MagAOX::app::xt1121Ctrl::appLogic(), MagAOX::app::zylaCtrl::appLogic(), MagAOX::app::siglentSDG::changeAmp(), MagAOX::app::siglentSDG::changeFreq(), MagAOX::app::siglentSDG::changeOfst(), MagAOX::app::siglentSDG::changeOutp(), MagAOX::app::siglentSDG::changePhse(), MagAOX::app::siglentSDG::changeSync(), MagAOX::app::siglentSDG::changeWdth(), MagAOX::app::siglentSDG::changeWvtp(), MagAOX::app::xt1121Ctrl::channelSetCallback(), MagAOX::app::siglentSDG::checkSetup(), MagAOX::app::picamCtrl::getAcquisitionState(), MagAOX::app::picamCtrl::getPicamParameter(), MagAOX::app::picamCtrl::getPicamParameter(), MagAOX::app::xt1121Ctrl::getState(), MagAOX::app::INDI_NEWCALLBACK_DEFN(), MagAOX::app::siglentSDG::queryARWV(), MagAOX::app::siglentSDG::queryBSWV(), MagAOX::app::siglentSDG::queryBTWV(), MagAOX::app::siglentSDG::queryMDWV(), MagAOX::app::siglentSDG::queryOUTP(), MagAOX::app::siglentSDG::querySWWV(), MagAOX::app::siglentSDG::querySYNC(), MagAOX::app::picamCtrl::reconfig(), MagAOX::app::siglentSDG::writeCommand(), and MagAOX::app::siglentSDG::writeRead().
|
protectedinherited |
The INDI element name to monitor for this device's power state.
Definition at line 1127 of file MagAOXApp.hpp.
|
protectedinherited |
Current target power state, 1=On, 0=Off, -1=Unk.
Definition at line 1137 of file MagAOXApp.hpp.
Referenced by MagAOX::app::siglentSDG::appLogic(), MagAOX::app::smc100ccCtrl::appLogic(), MagAOX::app::siglentSDG::changeAmp(), MagAOX::app::siglentSDG::changeFreq(), MagAOX::app::siglentSDG::changeOfst(), MagAOX::app::siglentSDG::changeOutp(), MagAOX::app::siglentSDG::changePhse(), MagAOX::app::siglentSDG::changeSync(), MagAOX::app::siglentSDG::changeWdth(), MagAOX::app::siglentSDG::changeWvtp(), MagAOX::app::siglentSDG::checkSetup(), MagAOX::app::smc100ccCtrl::getCtrlState(), MagAOX::app::smc100ccCtrl::getLastError(), MagAOX::app::smc100ccCtrl::getPosition(), MagAOX::app::smc100ccCtrl::moveTo(), MagAOX::app::siglentSDG::queryARWV(), MagAOX::app::siglentSDG::queryBSWV(), MagAOX::app::siglentSDG::queryBTWV(), MagAOX::app::siglentSDG::queryMDWV(), MagAOX::app::siglentSDG::queryOUTP(), MagAOX::app::siglentSDG::querySWWV(), MagAOX::app::siglentSDG::querySYNC(), MagAOX::app::smc100ccCtrl::startHoming(), MagAOX::app::smc100ccCtrl::stop(), MagAOX::app::smc100ccCtrl::testConnection(), MagAOX::app::siglentSDG::writeCommand(), and MagAOX::app::siglentSDG::writeRead().
|
inherited |
The read timeout [msec].
Definition at line 28 of file ioDevice.hpp.
Referenced by MagAOX::app::rhusbMon::rhusbMon(), MagAOX::app::tcsInterface::acquireFromGuider(), 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(), MagAOX::app::tcsInterface::getMagTelStatus(), MagAOX::app::flipperCtrl::getPos(), MagAOX::app::smc100ccCtrl::getPosition(), MagAOX::app::pi335Ctrl::initDM(), MagAOX::app::dev::ioDevice::loadConfig(), MagAOX::app::rhusbMon::readProbe(), MagAOX::app::tcsInterface::sendFoffload(), MagAOX::app::tcsInterface::sendPyrNudge(), MagAOX::app::tcsInterface::sendTToffload(), MagAOX::app::pi335Ctrl::testConnection(), MagAOX::app::smc100ccCtrl::testConnection(), MagAOX::app::trippLitePDU::turnOutletOff(), and MagAOX::app::trippLitePDU::turnOutletOn().
|
protectedinherited |
Path to the secrets directory, where passwords, etc, are stored.
Definition at line 182 of file MagAOXApp.hpp.
|
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 379 of file MagAOXApp.hpp.
|
protectedinherited |
Flag to signal it's time to shutdown. When not 0, the main loop exits.
Definition at line 196 of file MagAOXApp.hpp.
Referenced by MagAOX::app::siglentSDG::appLogic(), MagAOX::app::smc100ccCtrl::appStartup(), channelThreadExec(), MagAOX::app::siglentSDG::checkSetup(), MagAOX::app::streamWriter::fgThreadExec(), MagAOX::app::andorCtrl::loadConfig(), MagAOX::app::cameraSim::loadConfig(), loadConfig(), MagAOX::app::smc100ccCtrl::loadConfig(), MagAOX::app::streamWriter::loadConfig(), MagAOX::app::sysMonitor::loadConfig(), MagAOX::app::siglentSDG::queryARWV(), MagAOX::app::siglentSDG::queryBSWV(), MagAOX::app::siglentSDG::queryBTWV(), MagAOX::app::siglentSDG::queryMDWV(), MagAOX::app::siglentSDG::queryOUTP(), MagAOX::app::siglentSDG::querySWWV(), MagAOX::app::siglentSDG::querySYNC(), MagAOX::app::sysMonitor::setlatThreadExec(), MagAOX::app::streamWriter::swThreadExec(), MagAOX::app::siglentSDG::writeCommand(), and MagAOX::app::siglentSDG::writeRead().
|
privateinherited |
The application's state. Never ever set this directly, use state(const stateCodeT & s).
Definition at line 554 of file MagAOXApp.hpp.
|
privateinherited |
Definition at line 557 of file MagAOXApp.hpp.
|
privateinherited |
Counter and flag for use to log errors just once. Never ever access directly, use stateLogged().
Definition at line 562 of file MagAOXApp.hpp.
|
privateinherited |
The save-set user id of the process.
Definition at line 406 of file MagAOXApp.hpp.
|
protectedinherited |
The path to the system directory, for PID file, etc.
Definition at line 180 of file MagAOXApp.hpp.
Referenced by readChannelCounts(), and writeChannelCounts().
|
inherited |
Definition at line 75 of file telemeter.hpp.
|
private |
The telnet connection manager.
Definition at line 184 of file picoMotorCtrl.hpp.
Referenced by picoMotorCtrl(), appLogic(), and channelThreadExec().
|
private |
Mutex for locking telnet communications.
Definition at line 187 of file picoMotorCtrl.hpp.
Referenced by appLogic(), and channelThreadExec().
|
staticconstexprprotectedinherited |
Flag controlling whether INDI is used. If false, then no INDI code executes.
Definition at line 632 of file MagAOXApp.hpp.
|
inherited |
The write timeout [msec].
Definition at line 29 of file ioDevice.hpp.
Referenced by MagAOX::app::rhusbMon::rhusbMon(), appLogic(), MagAOX::app::smc100ccCtrl::appLogic(), channelThreadExec(), MagAOX::app::trippLitePDU::devPostLogin(), MagAOX::app::trippLitePDU::devStatus(), MagAOX::app::pi335Ctrl::finishInit(), MagAOX::app::pi335Ctrl::getCom(), MagAOX::app::smc100ccCtrl::getCtrlState(), MagAOX::app::smc100ccCtrl::getLastError(), MagAOX::app::flipperCtrl::getPos(), MagAOX::app::smc100ccCtrl::getPosition(), MagAOX::app::pi335Ctrl::home_1(), MagAOX::app::pi335Ctrl::home_2(), MagAOX::app::pi335Ctrl::home_3(), MagAOX::app::pi335Ctrl::initDM(), MagAOX::app::dev::ioDevice::loadConfig(), MagAOX::app::pi335Ctrl::move_1(), MagAOX::app::pi335Ctrl::move_2(), MagAOX::app::pi335Ctrl::move_3(), MagAOX::app::smc100ccCtrl::moveTo(), MagAOX::app::flipperCtrl::moveTo(), MagAOX::app::rhusbMon::readProbe(), MagAOX::app::pi335Ctrl::releaseDM(), MagAOX::app::smc100ccCtrl::startHoming(), MagAOX::app::smc100ccCtrl::stop(), MagAOX::app::pi335Ctrl::testConnection(), MagAOX::app::smc100ccCtrl::testConnection(), MagAOX::app::trippLitePDU::turnOutletOff(), and MagAOX::app::trippLitePDU::turnOutletOn().
|
protectedinherited |
The name of the PID file.
Definition at line 482 of file MagAOXApp.hpp.