Instrument Neutral Distributed Interface INDI
2.0.2
|
#include <celestron.h>
Public Member Functions | |
CelestronSCT () | |
const char * | getDefaultName () override |
virtual bool | initProperties () override |
Initilize properties initial state and value. The child class must implement this function. More... | |
virtual bool | updateProperties () override |
updateProperties is called whenever there is a change in the CONNECTION status of the driver. This will enable the driver to react to changes of switching ON/OFF a device. For example, a driver may only define a set of properties after a device is connected, but not before. More... | |
virtual bool | ISNewSwitch (const char *dev, const char *name, ISState *states, char *names[], int n) override |
Process the client newSwitch command. More... | |
![]() | |
Focuser () | |
virtual | ~Focuser () |
virtual void | ISGetProperties (const char *dev) override |
define the driver's properties to the client. Usually, only a minimum set of properties are defined to the client in this function if the device is in disconnected state. Those properties should be enough to enable the client to establish a connection to the device. In addition to CONNECT/DISCONNECT, such properties may include port name, IP address, etc. You should check if the device is already connected, and if this is true, then you must define the remainder of the the properties to the client in this function. Otherwise, the remainder of the driver's properties are defined to the client in updateProperties() function which is called when a client connects/disconnects from a device. More... | |
virtual bool | ISNewNumber (const char *dev, const char *name, double values[], char *names[], int n) override |
Process the client newNumber command. More... | |
virtual bool | ISNewText (const char *dev, const char *name, char *texts[], char *names[], int n) override |
Process the client newSwitch command. More... | |
virtual bool | ISSnoopDevice (XMLEle *root) override |
Process a snoop event from INDI server. This function is called when a snooped property is updated in a snooped driver. More... | |
void | setSupportedConnections (const uint8_t &value) |
setConnection Set Focuser connection mode. Child class should call this in the constructor before Focuser registers any connection interfaces More... | |
uint8_t | getSupportedConnections () const |
![]() | |
DefaultDevice () | |
virtual | ~DefaultDevice () override=default |
void | addAuxControls () |
Add Debug, Simulation, and Configuration options to the driver. More... | |
void | addDebugControl () |
Add Debug control to the driver. More... | |
void | addSimulationControl () |
Add Simulation control to the driver. More... | |
void | addConfigurationControl () |
Add Configuration control to the driver. More... | |
void | addPollPeriodControl () |
Add Polling period control to the driver. More... | |
void | resetProperties () |
Set all properties to IDLE state. More... | |
void | defineNumber (INumberVectorProperty *nvp) |
Define number vector to client & register it. Alternatively, IDDefNumber can be used but the property will not get registered and the driver will not be able to save configuration files. More... | |
void | defineProperty (INumberVectorProperty *property) |
void | defineText (ITextVectorProperty *tvp) |
Define text vector to client & register it. Alternatively, IDDefText can be used but the property will not get registered and the driver will not be able to save configuration files. More... | |
void | defineProperty (ITextVectorProperty *property) |
void | defineSwitch (ISwitchVectorProperty *svp) |
Define switch vector to client & register it. Alternatively, IDDefswitch can be used but the property will not get registered and the driver will not be able to save configuration files. More... | |
void | defineProperty (ISwitchVectorProperty *property) |
void | defineLight (ILightVectorProperty *lvp) |
Define light vector to client & register it. Alternatively, IDDeflight can be used but the property will not get registered and the driver will not be able to save configuration files. More... | |
void | defineProperty (ILightVectorProperty *property) |
void | defineBLOB (IBLOBVectorProperty *bvp) |
Define BLOB vector to client & register it. Alternatively, IDDefBLOB can be used but the property will not get registered and the driver will not be able to save configuration files. More... | |
void | defineProperty (IBLOBVectorProperty *property) |
void | defineProperty (INDI::Property &property) |
virtual bool | deleteProperty (const char *propertyName) |
Delete a property and unregister it. It will also be deleted from all clients. More... | |
bool | deleteProperty (INDI::Property &property) |
deleteProperty Delete a property and unregister it. It will also be deleted from all clients. More... | |
virtual void | setConnected (bool status, IPState state=IPS_OK, const char *msg=nullptr) |
Set connection switch status in the client. More... | |
int | SetTimer (uint32_t ms) |
Set a timer to call the function TimerHit after ms milliseconds. More... | |
void | RemoveTimer (int id) |
Remove timer added with SetTimer. More... | |
virtual const char * | getDriverExec () |
virtual const char * | getDriverName () |
void | setVersion (uint16_t vMajor, uint16_t vMinor) |
Set driver version information to be defined in DRIVER_INFO property as vMajor.vMinor. More... | |
uint16_t | getMajorVersion () const |
uint16_t | getMinorVersion () const |
virtual bool | ISNewBLOB (const char *dev, const char *name, int sizes[], int blobsizes[], char *blobs[], char *formats[], char *names[], int n) |
Process the client newBLOB command. More... | |
uint16_t | getDriverInterface () const |
void | setDriverInterface (uint16_t value) |
setInterface Set driver interface. By default the driver interface is set to GENERAL_DEVICE. You may send an ORed list of DeviceInterface values. More... | |
void | watchDevice (const char *deviceName, const std::function< void(INDI::BaseDevice)> &callback) |
Add a device to the watch list. More... | |
![]() | |
ParentDevice (Type type) | |
~ParentDevice () | |
ParentDevice (ParentDevice &&other)=default | |
ParentDevice & | operator= (ParentDevice &&other)=default |
![]() | |
BaseDevice () | |
virtual | ~BaseDevice () |
void | registerProperty (const INDI::Property &property) |
Register the property to be able to observe and update. More... | |
void | registerProperty (const INDI::Property &property, INDI_PROPERTY_TYPE type) |
int | removeProperty (const char *name, char *errmsg) |
Remove a property. More... | |
void | watchProperty (const char *name, const std::function< void(INDI::Property)> &callback, WATCH watch=WATCH_NEW) |
Call the callback function if property is available. More... | |
Property | getProperty (const char *name, INDI_PROPERTY_TYPE type=INDI_UNKNOWN) const |
Return a property and its type given its name. More... | |
Properties | getProperties () |
Return a list of all properties in the device. More... | |
const Properties | getProperties () const |
INDI::PropertyNumber | getNumber (const char *name) const |
INDI::PropertyText | getText (const char *name) const |
INDI::PropertySwitch | getSwitch (const char *name) const |
INDI::PropertyLight | getLight (const char *name) const |
INDI::PropertyBlob | getBLOB (const char *name) const |
IPState | getPropertyState (const char *name) const |
IPerm | getPropertyPermission (const char *name) const |
void * | getRawProperty (const char *name, INDI_PROPERTY_TYPE type=INDI_UNKNOWN) const |
Return a property and its type given its name. More... | |
void | addMessage (const std::string &msg) |
Add message to the driver's message queue. More... | |
void | checkMessage (XMLEle *root) |
void | doMessage (XMLEle *msg) |
const std::string & | messageQueue (size_t index) const |
const std::string & | lastMessage () const |
bool | isValid () const |
bool | isConnected () const |
void | attach () |
indicates that the device is ready More... | |
void | detach () |
indicates that the device is being removed More... | |
void | setMediator (INDI::BaseMediator *mediator) |
Set the driver's mediator to receive notification of news devices and updated property values. More... | |
INDI::BaseMediator * | getMediator () const |
void | setDeviceName (const char *dev) |
Set the device name. More... | |
const char * | getDeviceName () const |
bool | isDeviceNameMatch (const char *otherName) const |
Check that the device name matches the argument. More... | |
bool | isDeviceNameMatch (const std::string &otherName) const |
Check that the device name matches the argument. More... | |
const char * | getDriverName () const |
const char * | getDriverExec () const |
const char * | getDriverVersion () const |
uint16_t | getDriverInterface () const |
getDriverInterface returns ORed values of DRIVER_INTERFACE. It presents the device classes supported by the driver. More... | |
bool | buildSkeleton (const char *filename) |
Build driver properties from a skeleton file. More... | |
int | buildProp (const INDI::LilXmlElement &root, char *errmsg, bool isDynamic=false) |
Build a property given the supplied XML element (defXXX) More... | |
int | setValue (const INDI::LilXmlElement &root, char *errmsg) |
handle SetXXX commands from client More... | |
operator BaseDevice * () | |
BaseDevice * | operator-> () |
bool | operator!= (std::nullptr_t) const |
bool | operator== (std::nullptr_t) const |
operator bool () const | |
operator bool () | |
![]() | |
uint32_t | GetCapability () const |
GetFocuserCapability returns the capability of the focuser. More... | |
void | SetCapability (uint32_t cap) |
FI::SetCapability sets the focuser capabilities. All capabilities must be initialized. More... | |
bool | CanAbsMove () |
bool | CanRelMove () |
bool | CanAbort () |
bool | CanReverse () |
bool | CanSync () |
bool | HasVariableSpeed () |
bool | HasBacklash () |
Protected Member Functions | |
virtual bool | Handshake () override |
Handshake Try to communicate with Focuser and see if there is a valid response. More... | |
virtual IPState | MoveAbsFocuser (uint32_t targetTicks) override |
MoveAbsFocuser Move to an absolute target position. More... | |
virtual IPState | MoveRelFocuser (FocusDirection dir, uint32_t ticks) override |
MoveRelFocuser Move focuser for a relative amount of ticks in a specific direction. More... | |
virtual bool | AbortFocuser () override |
AbortFocuser Abort Focuser motion. More... | |
virtual void | TimerHit () override |
TimerHit Primary Loop called every POLLMS milliseconds (set in Options) to check on the focuser status like read position, temperature.. and check if the focuser reached the required position. More... | |
virtual bool | SetFocuserBacklash (int32_t steps) override |
SetFocuserBacklash Set the focuser backlash compensation value. More... | |
![]() | |
virtual bool | saveConfigItems (FILE *fp) override |
saveConfigItems Saves the Device Port and Focuser Presets in the configuration file More... | |
virtual bool | SetFocuserMaxPosition (uint32_t ticks) override |
SetFocuserMaxPosition Update focuser maximum position. It only updates the PresetNP property limits. More... | |
virtual void | SyncPresets (uint32_t ticks) |
syncPresets Updates the min/max/step range of the preset as per the maximum name of Absolute Focus Travel More... | |
void | processButton (const char *button_n, ISState state) |
![]() | |
void | setDynamicPropertiesBehavior (bool defineEnabled, bool deleteEnabled) |
setDynamicPropertiesBehavior controls handling of dynamic properties. Dyanmic properties are those generated from an external skeleton XML file. By default all properties, including dynamic properties, are defined to the client in ISGetProperties(). Furthermore, when űdeleteProperty(properyName) is called, the dynamic property is deleted by default, and can only be restored by calling buildSkeleton(filename) again. However, it is sometimes desirable to skip the definition of the dynamic properties on startup and delegate this task to the child class. To control this behavior, set enabled to false. More... | |
virtual bool | loadConfig (bool silent=false, const char *property=nullptr) |
Load the last saved configuration file. More... | |
bool | loadConfig (INDI::Property &property) |
Load property config from the configuration file. If the property configuration is successfully parsed, the corresponding ISNewXXX is called with the values parsed from the config file. More... | |
virtual bool | saveConfig (bool silent=false, const char *property=nullptr) |
Save the current properties in a configuration file. More... | |
bool | saveConfig (INDI::Property &property) |
Save a property in the configuration file. More... | |
virtual bool | purgeConfig () |
purgeConfig Remove config file from disk. More... | |
virtual bool | saveAllConfigItems (FILE *fp) |
saveAllConfigItems Save all the drivers' properties in the configuration file More... | |
virtual bool | loadDefaultConfig () |
Load the default configuration file. More... | |
void | setDebug (bool enable) |
Toggle driver debug status A driver can be more verbose if Debug option is enabled by the client. More... | |
void | setSimulation (bool enable) |
Toggle driver simulation status A driver can run in simulation mode if Simulation option is enabled by the client. More... | |
virtual void | debugTriggered (bool enable) |
Inform driver that the debug option was triggered. This function is called after setDebug is triggered by the client. Reimplement this function if your driver needs to take specific action after debug is enabled/disabled. Otherwise, you can use isDebug() to check if simulation is enabled or disabled. More... | |
virtual void | simulationTriggered (bool enable) |
Inform driver that the simulation option was triggered. This function is called after setSimulation is triggered by the client. Reimplement this function if your driver needs to take specific action after simulation is enabled/disabled. Otherwise, you can use isSimulation() to check if simulation is enabled or disabled. More... | |
bool | isDebug () const |
bool | isSimulation () const |
virtual bool | Connect () |
Connect to the device. INDI::DefaultDevice implementation connects to appropriate connection interface (Serial or TCP) governed by connectionMode. If connection is successful, it proceed to call Handshake() function to ensure communication with device is successful. For other communication interface, override the method in the child class implementation. More... | |
virtual bool | Disconnect () |
Disconnect from device. More... | |
void | registerConnection (Connection::Interface *newConnection) |
registerConnection Add new connection plugin to the existing connection pool. The connection type shall be defined to the client in ISGetProperties() More... | |
bool | unRegisterConnection (Connection::Interface *existingConnection) |
unRegisterConnection Remove connection from existing pool More... | |
Connection::Interface * | getActiveConnection () |
void | setActiveConnection (Connection::Interface *existingConnection) |
setActiveConnection Switch the active connection to the passed connection plugin More... | |
void | setDefaultPollingPeriod (uint32_t msec) |
setDefaultPollingPeriod Change the default polling period to call TimerHit() function in the driver. More... | |
void | setPollingPeriodRange (uint32_t minimum, uint32_t maximum) |
setPollingPeriodRange Set the range permitted by the polling range in milliseconds More... | |
uint32_t | getPollingPeriod () const |
getPollingPeriod Return the polling period. More... | |
void | setCurrentPollingPeriod (uint32_t msec) |
setCurrentPollingPeriod Change the current polling period to call TimerHit() function in the driver. More... | |
uint32_t | getCurrentPollingPeriod () const |
getCurrentPollingPeriod Return the current polling period. More... | |
uint32_t & | refCurrentPollingPeriod () __attribute__((deprecated)) |
uint32_t | refCurrentPollingPeriod () const __attribute__((deprecated)) |
bool | isConfigLoading () const |
isConfigLoading Check if driver configuration is currently in the process of getting loaded. More... | |
bool | isInitializationComplete () const |
isInitializationComplete Check if driver initialization is complete. More... | |
void | syncDriverInfo () |
syncDriverInfo sends the current driver information to the client. More... | |
DefaultDevice (const std::shared_ptr< DefaultDevicePrivate > &dd) | |
![]() | |
ParentDevice (const std::shared_ptr< ParentDevicePrivate > &dd) | |
![]() | |
BaseDevice (BaseDevicePrivate &dd) | |
BaseDevice (const std::shared_ptr< BaseDevicePrivate > &dd) | |
![]() | |
FocuserInterface (DefaultDevice *defaultDevice) | |
virtual | ~FocuserInterface ()=default |
void | initProperties (const char *groupName) |
Initilize focuser properties. It is recommended to call this function within initProperties() of your primary device. More... | |
bool | updateProperties () |
updateProperties Define or Delete Rotator properties based on the connection status of the base device More... | |
bool | processNumber (const char *dev, const char *name, double values[], char *names[], int n) |
Process focus number properties. More... | |
bool | processSwitch (const char *dev, const char *name, ISState *states, char *names[], int n) |
Process focus switch properties. More... | |
virtual bool | SetFocuserSpeed (int speed) |
SetFocuserSpeed Set Focuser speed. More... | |
virtual IPState | MoveFocuser (FocusDirection dir, int speed, uint16_t duration) |
MoveFocuser the focuser in a particular direction with a specific speed for a finite duration. More... | |
virtual bool | ReverseFocuser (bool enabled) |
ReverseFocuser Reverse focuser motion direction. More... | |
virtual bool | SyncFocuser (uint32_t ticks) |
SyncFocuser Set current position to ticks without moving the focuser. More... | |
virtual bool | SetFocuserBacklashEnabled (bool enabled) |
SetFocuserBacklashEnabled Enables or disables the focuser backlash compensation. More... | |
bool | saveConfigItems (FILE *fp) |
saveConfigItems save focuser properties defined in the interface in config file More... | |
Definition at line 30 of file celestron.h.
CelestronSCT::CelestronSCT | ( | ) |
Definition at line 36 of file celestron.cpp.
|
overrideprotectedvirtual |
AbortFocuser Abort Focuser motion.
Reimplemented from INDI::FocuserInterface.
Definition at line 483 of file celestron.cpp.
|
overridevirtual |
Implements INDI::DefaultDevice.
Definition at line 168 of file celestron.cpp.
|
overrideprotectedvirtual |
Handshake Try to communicate with Focuser and see if there is a valid response.
Reimplemented from INDI::Focuser.
Definition at line 156 of file celestron.cpp.
|
overridevirtual |
Initilize properties initial state and value. The child class must implement this function.
Reimplemented from INDI::Focuser.
Definition at line 50 of file celestron.cpp.
|
overridevirtual |
Process the client newSwitch command.
Reimplemented from INDI::Focuser.
Definition at line 267 of file celestron.cpp.
|
overrideprotectedvirtual |
MoveAbsFocuser Move to an absolute target position.
targetTicks | target position |
Reimplemented from INDI::FocuserInterface.
Definition at line 317 of file celestron.cpp.
|
overrideprotectedvirtual |
MoveRelFocuser Move focuser for a relative amount of ticks in a specific direction.
dir | Directoin of motion |
ticks | steps to move |
Reimplemented from INDI::FocuserInterface.
Definition at line 375 of file celestron.cpp.
|
overrideprotectedvirtual |
SetFocuserBacklash Set the focuser backlash compensation value.
steps | value in absolute steps to compensate |
Reimplemented from INDI::FocuserInterface.
Definition at line 495 of file celestron.cpp.
|
overrideprotectedvirtual |
TimerHit Primary Loop called every POLLMS milliseconds (set in Options) to check on the focuser status like read position, temperature.. and check if the focuser reached the required position.
Reimplemented from INDI::DefaultDevice.
Definition at line 389 of file celestron.cpp.
|
overridevirtual |
updateProperties is called whenever there is a change in the CONNECTION status of the driver. This will enable the driver to react to changes of switching ON/OFF a device. For example, a driver may only define a set of properties after a device is connected, but not before.
Reimplemented from INDI::Focuser.
Definition at line 126 of file celestron.cpp.