|
Instrument Neutral Distributed Interface INDI 2.2.5
|
#include <alluna_tcs2.h>
Public Member Functions | |
| AllunaTCS2 () | |
| virtual bool | Handshake () override |
| Performs a device-specific handshake after a connection is established. This method should be overridden by concrete focuser drivers to implement any necessary communication checks or initialization sequences with the hardware. The base implementation does nothing and returns false. | |
| const char * | getDefaultName () override |
| bool | initProperties () override |
| Initializes the default properties for the focuser device. Sets up standard INDI properties, presets, controller mappings, and connection types. Overrides DefaultDevice::initProperties. | |
| bool | updateProperties () override |
| Updates the state and definition of properties based on the current connection status. For example, preset properties are only defined if the device is connected and supports absolute moves. Overrides DefaultDevice::updateProperties. | |
| bool | ISNewSwitch (const char *dev, const char *name, ISState *states, char *names[], int n) override |
| Processes incoming new switch states from the client for this device. Handles updates to FocuserInterface properties and preset goto commands. Overrides DefaultDevice::ISNewSwitch. | |
| bool | ISNewNumber (const char *dev, const char *name, double values[], char *names[], int n) override |
| Processes incoming new number values from the client for this device. Handles updates to FocuserInterface properties and preset values. Overrides DefaultDevice::ISNewNumber. | |
Public Member Functions inherited from INDI::Focuser | |
| Focuser () | |
| Construct a new Focuser object. Initializes the controller and sets up the FocuserInterface. | |
| virtual | ~Focuser () |
| Destroy the Focuser object. Cleans up the controller resource. | |
| virtual void | ISGetProperties (const char *dev) override |
| Handles client requests for property definitions for this device or all devices. Delegates to the base class and the internal controller. Overrides DefaultDevice::ISGetProperties. | |
| virtual bool | ISNewText (const char *dev, const char *name, char *texts[], char *names[], int n) override |
| Processes incoming new text values from the client for this device. Delegates processing to the controller and the base class. Overrides DefaultDevice::ISNewText. | |
| virtual bool | ISSnoopDevice (XMLEle *root) override |
| Processes properties snooped from other devices. Delegates processing to the controller and the base class. Overrides DefaultDevice::ISSnoopDevice. | |
| void | setSupportedConnections (const uint8_t &value) |
| uint8_t | getSupportedConnections () const |
| Get the currently configured supported connection modes. | |
Public Member Functions inherited from INDI::DefaultDevice | |
| DefaultDevice () | |
| virtual | ~DefaultDevice () override=default |
| void | addAuxControls () |
| Add Debug, Simulation, and Configuration options to the driver. | |
| void | addDebugControl () |
| Add Debug control to the driver. | |
| void | addSimulationControl () |
| Add Simulation control to the driver. | |
| void | addConfigurationControl () |
| Add Configuration control to the driver. | |
| void | addPollPeriodControl () |
| Add Polling period control to the driver. | |
| void | addNicknameControl () |
| Add Nickname text property to the driver. | |
| void | resetProperties () |
| Set all properties to IDLE state. | |
| 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. | |
| 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. | |
| 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. | |
| 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. | |
| 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. | |
| 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. | |
| bool | deleteProperty (INDI::Property &property) |
| deleteProperty Delete a property and unregister it. It will also be deleted from all clients. | |
| virtual void | setConnected (bool status, IPState state=IPS_OK, const char *msg=nullptr) |
| Set connection switch status in the client. | |
| int | SetTimer (uint32_t ms) |
| Set a timer to call the function TimerHit after ms milliseconds. | |
| void | RemoveTimer (int id) |
| Remove timer added with SetTimer. | |
| 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. | |
| 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. | |
| bool | ISNewProperty (INDI::Property &property, const std::string &elementName, const std::any &value) |
| Generic convenience function to update a property element as if by client request, simulating an ISNew... call. | |
| template<typename PropertyType , typename ValueType > | |
| bool | updateProperty (PropertyType &property, ValueType *values, char *names[], int n, std::function< bool()> updater, bool saveConfig=false) |
| Generic helper function to update an INDI property based on an external operation. | |
| uint32_t | getDriverInterface () const |
| void | setDriverInterface (uint32_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. | |
| void | watchDevice (const char *deviceName, const std::function< void(INDI::BaseDevice)> &callback) |
| Add a device to the watch list. | |
Public Member Functions inherited from INDI::ParentDevice | |
| ParentDevice (Type type) | |
| ~ParentDevice () | |
| ParentDevice (ParentDevice &&other)=default | |
| ParentDevice & | operator= (ParentDevice &&other)=default |
Public Member Functions inherited from INDI::BaseDevice | |
| BaseDevice () | |
| virtual | ~BaseDevice () |
| void | registerProperty (const INDI::Property &property) |
| Register the property to be able to observe and update. | |
| void | registerProperty (const INDI::Property &property, INDI_PROPERTY_TYPE type) |
| int | removeProperty (const char *name, char *errmsg) |
| Remove a property. | |
| void | watchProperty (const char *name, const std::function< void(INDI::Property)> &callback, WATCH watch=WATCH_NEW) |
| Call the callback function if property is available. | |
| Property | getProperty (const char *name, INDI_PROPERTY_TYPE type=INDI_UNKNOWN) const |
| Return a property and its type given its name. | |
| Properties | getProperties () |
| Return a list of all properties in the device. | |
| 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. | |
| void | addMessage (const std::string &msg) |
| Add message to the driver's message queue. | |
| 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 | isSameDevice (const BaseDevice &other) const |
| bool | isConnected () const |
| void | attach () |
| indicates that the device is ready | |
| void | detach () |
| indicates that the device is being removed | |
| void | setMediator (INDI::BaseMediator *mediator) |
| Set the driver's mediator to receive notification of news devices and updated property values. | |
| INDI::BaseMediator * | getMediator () const |
| void | setDeviceName (const char *dev) |
| Set the device name. | |
| const char * | getDeviceName () const |
| bool | isDeviceNameMatch (const char *otherName) const |
| Check that the device name matches the argument. | |
| bool | isDeviceNameMatch (const std::string &otherName) const |
| Check that the device name matches the argument. | |
| 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. | |
| bool | buildSkeleton (const char *filename) |
| Build driver properties from a skeleton file. | |
| int | buildProp (const INDI::LilXmlElement &root, char *errmsg, bool isDynamic=false) |
| Build a property given the supplied XML element (defXXX) | |
| int | setValue (const INDI::LilXmlElement &root, char *errmsg) |
| handle SetXXX commands from client | |
| operator BaseDevice * () | |
| BaseDevice * | operator-> () |
| bool | operator!= (std::nullptr_t) const |
| bool | operator== (std::nullptr_t) const |
| operator bool () const | |
| operator bool () | |
Public Member Functions inherited from INDI::FocuserInterface | |
| uint32_t | GetCapability () const |
| GetFocuserCapability returns the capability of the focuser. | |
| void | SetCapability (uint32_t cap) |
| FI::SetCapability sets the focuser capabilities. All capabilities must be initialized. | |
| bool | CanAbsMove () |
| bool | CanRelMove () |
| bool | CanAbort () |
| bool | CanReverse () |
| bool | CanSync () |
| bool | HasVariableSpeed () |
| bool | HasBacklash () |
Protected Member Functions | |
| void | TimerHit () override |
| Callback function to be called once SetTimer duration elapses. | |
| bool | saveConfigItems (FILE *fp) override |
| virtual IPState | ParkCap () override |
| Park dust cap (close cover). Must be implemented by child. | |
| virtual IPState | UnParkCap () override |
| unPark dust cap (open cover). Must be implemented by child. | |
| IPState | MoveRelFocuser (FocusDirection dir, uint32_t ticks) override |
| MoveFocuser the focuser to an relative position. | |
| IPState | MoveAbsFocuser (uint32_t targetTicks) override |
| MoveFocuser the focuser to an absolute position. | |
| bool | AbortFocuser () override |
| AbortFocuser all focus motion. | |
Protected Member Functions inherited from INDI::Focuser | |
| virtual bool | SetFocuserMaxPosition (uint32_t ticks) override |
| SetFocuserMaxPosition Update focuser maximum position. It only updates the PresetNP property limits. | |
| virtual void | SyncPresets (uint32_t ticks) |
| Synchronizes the range (min, max, step) of the preset number properties (PresetNP) based on the focuser's maximum absolute position. | |
| void | processButton (const char *button_n, ISState state) |
| Processes button press events received from the controller via buttonHelper. Handles actions like "Focus In", "Focus Out", and "Abort Focus". | |
Protected Member Functions inherited from INDI::DefaultDevice | |
| void | setDynamicPropertiesBehavior (bool defineEnabled, bool deleteEnabled) |
| setDynamicPropertiesBehavior controls handling of dynamic properties. Dynamic 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. | |
| virtual bool | loadConfig (bool silent=false, const char *property=nullptr) |
| Load the last saved configuration file. | |
| 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. | |
| virtual bool | saveConfig (bool silent=false, const char *property=nullptr) |
| Save the current properties in a configuration file. | |
| bool | saveConfig (INDI::Property &property) |
| Save a property in the configuration file. | |
| virtual bool | purgeConfig () |
| purgeConfig Remove config file from disk. | |
| virtual bool | saveAllConfigItems (FILE *fp) |
| saveAllConfigItems Save all the drivers' properties in the configuration file | |
| virtual bool | loadDefaultConfig () |
| Load the default configuration file. | |
| void | setDebug (bool enable) |
| Toggle driver debug status A driver can be more verbose if Debug option is enabled by the client. | |
| void | setSimulation (bool enable) |
| Toggle driver simulation status A driver can run in simulation mode if Simulation option is enabled by the client. | |
| 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. | |
| 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. | |
| 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. | |
| virtual bool | Disconnect () |
| Disconnect from device. | |
| 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() | |
| bool | unRegisterConnection (Connection::Interface *existingConnection) |
| unRegisterConnection Remove connection from existing pool | |
| Connection::Interface * | getActiveConnection () |
| void | setActiveConnection (Connection::Interface *existingConnection) |
| setActiveConnection Switch the active connection to the passed connection plugin | |
| void | setDefaultPollingPeriod (uint32_t msec) |
| setDefaultPollingPeriod Change the default polling period to call TimerHit() function in the driver. | |
| void | setPollingPeriodRange (uint32_t minimum, uint32_t maximum) |
| setPollingPeriodRange Set the range permitted by the polling range in milliseconds | |
| uint32_t | getPollingPeriod () const |
| getPollingPeriod Return the polling period. | |
| void | setCurrentPollingPeriod (uint32_t msec) |
| setCurrentPollingPeriod Change the current polling period to call TimerHit() function in the driver. | |
| uint32_t | getCurrentPollingPeriod () const |
| getCurrentPollingPeriod Return the current polling period. | |
| 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. | |
| bool | isInitializationComplete () const |
| isInitializationComplete Check if driver initialization is complete. | |
| void | syncDriverInfo () |
| syncDriverInfo sends the current driver information to the client. | |
| void | setDeviceNickname (const char *nick) |
| Set the device nickname. | |
| const char * | getDeviceNickname () |
| const char * | lookupDeviceNicknameFromId (const char *identifier, const char *device=nullptr) |
| Lookup device nickname for an identifier. | |
| bool | setDeviceNicknameFromId (const char *identifier) |
| Set device nickname based on an identifier. | |
| void | saveNicknameId (const char *nickname, const char *identifier) |
| virtual void | nicknameSet (const char *nickname) |
| Inform driver that the nickname has been set. | |
| DefaultDevice (const std::shared_ptr< DefaultDevicePrivate > &dd) | |
Protected Member Functions inherited from INDI::ParentDevice | |
| ParentDevice (const std::shared_ptr< ParentDevicePrivate > &dd) | |
Protected Member Functions inherited from INDI::BaseDevice | |
| BaseDevice (BaseDevicePrivate &dd) | |
| BaseDevice (const std::shared_ptr< BaseDevicePrivate > &dd) | |
Protected Member Functions inherited from INDI::FocuserInterface | |
| FocuserInterface (DefaultDevice *defaultDevice) | |
| virtual | ~FocuserInterface ()=default |
| void | initProperties (const char *groupName) |
| Initialize focuser properties. It is recommended to call this function within initProperties() of your primary device. | |
| bool | updateProperties () |
| updateProperties Define or Delete Rotator properties based on the connection status of the base device | |
| bool | processNumber (const char *dev, const char *name, double values[], char *names[], int n) |
| Process focus number properties. | |
| bool | processSwitch (const char *dev, const char *name, ISState *states, char *names[], int n) |
| Process focus switch properties. | |
| virtual bool | SetFocuserSpeed (int speed) |
| SetFocuserSpeed Set Focuser speed. | |
| 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. | |
| virtual bool | ReverseFocuser (bool enabled) |
| ReverseFocuser Reverse focuser motion direction. | |
| virtual bool | SyncFocuser (uint32_t ticks) |
| SyncFocuser Set current position to ticks without moving the focuser. | |
| virtual bool | SetFocuserBacklash (int32_t steps) |
| SetFocuserBacklash Set the focuser backlash compensation value. | |
| virtual bool | SetFocuserBacklashEnabled (bool enabled) |
| SetFocuserBacklashEnabled Enables or disables the focuser backlash compensation. | |
| bool | saveConfigItems (FILE *fp) |
| saveConfigItems save focuser properties defined in the interface in config file | |
Protected Member Functions inherited from INDI::DustCapInterface | |
| DustCapInterface (DefaultDevice *device) | |
| virtual | ~DustCapInterface ()=default |
| virtual IPState | AbortCap () |
| Abort motion. Must be implemented by child. | |
| void | initProperties (const char *group, uint32_t capabilities=0) |
| Initialize dust cap properties. It is recommended to call this function within initProperties() of your primary device. | |
| bool | updateProperties () |
| updateProperties Defines or Delete properties based on default device connection status | |
| bool | processSwitch (const char *dev, const char *name, ISState *states, char *names[], int n) |
| Process dust cap switch properties. | |
Definition at line 29 of file alluna_tcs2.h.
| AllunaTCS2::AllunaTCS2 | ( | ) |
Definition at line 35 of file alluna_tcs2.cpp.
|
overrideprotectedvirtual |
AbortFocuser all focus motion.
Reimplemented from INDI::FocuserInterface.
Definition at line 564 of file alluna_tcs2.cpp.
|
overridevirtual |
Implements INDI::DefaultDevice.
Definition at line 112 of file alluna_tcs2.cpp.
|
overridevirtual |
Performs a device-specific handshake after a connection is established. This method should be overridden by concrete focuser drivers to implement any necessary communication checks or initialization sequences with the hardware. The base implementation does nothing and returns false.
Reimplemented from INDI::Focuser.
Definition at line 177 of file alluna_tcs2.cpp.
|
overridevirtual |
Initializes the default properties for the focuser device. Sets up standard INDI properties, presets, controller mappings, and connection types. Overrides DefaultDevice::initProperties.
Reimplemented from INDI::Focuser.
Definition at line 53 of file alluna_tcs2.cpp.
|
overridevirtual |
Processes incoming new number values from the client for this device. Handles updates to FocuserInterface properties and preset values. Overrides DefaultDevice::ISNewNumber.
| dev | The target device name. |
| name | The property name. |
| values | Array of new numerical values. |
| names | Array of element names corresponding to the values. |
| n | The number of elements being updated. |
Reimplemented from INDI::Focuser.
Definition at line 514 of file alluna_tcs2.cpp.
|
overridevirtual |
Processes incoming new switch states from the client for this device. Handles updates to FocuserInterface properties and preset goto commands. Overrides DefaultDevice::ISNewSwitch.
| dev | The target device name. |
| name | The property name. |
| states | Array of new switch states (ISS_ON or ISS_OFF). |
| names | Array of element names corresponding to the states. |
| n | The number of elements being updated. |
Reimplemented from INDI::Focuser.
Definition at line 363 of file alluna_tcs2.cpp.
|
overrideprotectedvirtual |
MoveFocuser the focuser to an absolute position.
| ticks | The new position of the focuser. |
Reimplemented from INDI::FocuserInterface.
Definition at line 543 of file alluna_tcs2.cpp.
|
overrideprotectedvirtual |
MoveFocuser the focuser to an relative position.
| dir | Direction of focuser, either FOCUS_INWARD or FOCUS_OUTWARD. |
| ticks | The relative ticks to move. |
Reimplemented from INDI::FocuserInterface.
Definition at line 558 of file alluna_tcs2.cpp.
|
overrideprotectedvirtual |
Park dust cap (close cover). Must be implemented by child.
Reimplemented from INDI::DustCapInterface.
Definition at line 819 of file alluna_tcs2.cpp.
|
overrideprotectedvirtual |
@brief saveConfigItems Saves the Device Port and Focuser Presets in the configuration file @param fp pointer to configuration file
Reimplemented from INDI::Focuser.
Definition at line 1042 of file alluna_tcs2.cpp.
|
overrideprotectedvirtual |
Callback function to be called once SetTimer duration elapses.
Reimplemented from INDI::DefaultDevice.
Definition at line 569 of file alluna_tcs2.cpp.
|
overrideprotectedvirtual |
unPark dust cap (open cover). Must be implemented by child.
Reimplemented from INDI::DustCapInterface.
Definition at line 838 of file alluna_tcs2.cpp.
|
overridevirtual |
Updates the state and definition of properties based on the current connection status. For example, preset properties are only defined if the device is connected and supports absolute moves. Overrides DefaultDevice::updateProperties.
Reimplemented from INDI::Focuser.
Definition at line 117 of file alluna_tcs2.cpp.