|
Instrument Neutral Distributed Interface INDI 2.2.5
|
#include <planewave_mount.h>
Public Member Functions | |
| PlaneWave () | |
| Constructor / Destructor. | |
| virtual | ~PlaneWave () |
| virtual const char * | getDefaultName () override |
| virtual bool | Handshake () override |
| Handshake — build the persistent client and verify the mount is live. | |
| virtual bool | ReadScopeStatus () override |
| ReadScopeStatus — called every polling interval. | |
| virtual bool | initProperties () override |
| initProperties | |
| virtual bool | updateProperties () override |
| updateProperties | |
| virtual bool | ISNewText (const char *dev, const char *name, char *texts[], char *names[], int n) override |
| ISNewText. | |
| virtual bool | ISNewNumber (const char *dev, const char *name, double values[], char *names[], int n) override |
| ISNewNumber. | |
| virtual bool | ISNewSwitch (const char *dev, const char *name, ISState *states, char *names[], int n) override |
| ISNewSwitch. | |
Public Member Functions inherited from INDI::Telescope | |
| Telescope () | |
| virtual | ~Telescope () |
| 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. | |
| 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. | |
| uint32_t | GetTelescopeCapability () const |
| GetTelescopeCapability returns the capability of the Telescope. | |
| void | SetTelescopeCapability (uint32_t cap, uint8_t slewRateCount) |
| SetTelescopeCapability sets the Telescope capabilities. All capabilities must be initialized. | |
| bool | CanGOTO () |
| bool | CanSync () |
| bool | CanFlip () |
| bool | CanAbort () |
| bool | CanPark () |
| bool | CanControlTrack () |
| bool | HasTime () |
| bool | HasLocation () |
| bool | HasPierSide () |
| bool | HasPierSideSimulation () |
| bool | CanTrackSatellite () |
| bool | HasPECState () |
| bool | HasTrackMode () |
| bool | HasTrackRate () |
| bool | CanHomeFind () |
| bool | CanHomeSet () |
| bool | CanHomeGo () |
| virtual void | TimerHit () override |
| Called when setTimer() time is up. | |
| void | SetParkDataType (TelescopeParkData type) |
| setParkDataType Sets the type of parking data stored in the park data file and presented to the user. | |
| bool | InitPark () |
| InitPark Loads parking data (stored in ~/.indi/ParkData.xml) that contains parking status and parking position. | |
| bool | isParked () |
| isParked is mount currently parked? | |
| virtual void | SetParked (bool isparked) |
| SetParked Change the mount parking status. The data park file (stored in ~/.indi/ParkData.xml) is updated in the process. | |
| double | GetAxis1Park () const |
| double | GetAxis1ParkDefault () const |
| double | GetAxis2Park () const |
| double | GetAxis2ParkDefault () const |
| void | SetAxis1Park (double value) |
| SetRAPark Set current RA/AZ parking position. The data park file (stored in ~/.indi/ParkData.xml) is updated in the process. | |
| void | SetAxis1ParkDefault (double steps) |
| SetRAPark Set default RA/AZ parking position. | |
| void | SetAxis2Park (double steps) |
| SetDEPark Set current DEC/ALT parking position. The data park file (stored in ~/.indi/ParkData.xml) is updated in the process. | |
| void | SetAxis2ParkDefault (double steps) |
| SetDEParkDefault Set default DEC/ALT parking position. | |
| bool | isLocked () const |
| isLocked is mount currently locked? | |
| void | setTelescopeConnection (const uint8_t &value) |
| setTelescopeConnection Set telescope connection mode. Child class should call this in the constructor before Telescope registers any connection interfaces | |
| uint8_t | getTelescopeConnection () const |
| void | setPierSide (TelescopePierSide side) |
| TelescopePierSide | getPierSide () |
| void | setPECState (TelescopePECState state) |
| TelescopePECState | getPECState () |
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 () | |
Protected Member Functions | |
| virtual bool | MoveNS (INDI_DIR_NS dir, TelescopeMotionCommand command) override |
| MoveNS — jog in Dec using a continuous offset rate. | |
| virtual bool | MoveWE (INDI_DIR_WE dir, TelescopeMotionCommand command) override |
| MoveWE — jog in RA using a continuous offset rate. | |
| virtual bool | Abort () override |
| Abort. | |
| virtual bool | updateLocation (double latitude, double longitude, double elevation) override |
| virtual bool | updateTime (ln_date *utc, double utc_offset) override |
| updateTime — PWI4 uses the host PC clock; nothing to push. | |
| virtual bool | Goto (double ra, double dec) override |
| Goto — J2000 RA/Dec (INDI convention) | |
| virtual bool | Sync (double ra, double dec) override |
| Sync — adds a pointing-model calibration point at the current position. | |
| virtual bool | SetTrackMode (uint8_t mode) override |
| SetTrackMode. | |
| virtual bool | SetTrackRate (double raRate, double deRate) override |
| SetTrackRate — called when the user changes TrackRateNP. | |
| virtual bool | SetTrackEnabled (bool enabled) override |
| SetTrackEnabled. | |
| virtual bool | SetCurrentPark () override |
| SetCurrentPark — tell PWI4 to store the current position as the park point. | |
| virtual bool | SetDefaultPark () override |
| SetDefaultPark. | |
| virtual bool | Park () override |
| Park. | |
| virtual bool | UnPark () override |
| UnPark — re-enable both motors before clearing the parked state. | |
| virtual bool | saveConfigItems (FILE *fp) override |
| saveConfigItems | |
Protected Member Functions inherited from INDI::Telescope | |
| void | NewRaDec (double ra, double dec) |
| The child class calls this function when it has updates. | |
| virtual bool | Flip (double ra, double dec) |
| Move and flip the scope to the supplied RA and DEC coordinates. | |
| virtual int | AddTrackMode (const char *name, const char *label, bool isDefault=false) |
| AddTrackMode. | |
| void | updateObserverLocation (double latitude, double longitude, double elevation) |
| Update location settings of the observer. | |
| virtual bool | SetParkPosition (double Axis1Value, double Axis2Value) |
| SetParkPosition Set desired parking position to the supplied value. This ONLY sets the desired park position value and does not perform parking. | |
| virtual IPState | ExecuteHomeAction (TelescopeHomeAction action) |
| Execute a homing action. | |
| virtual void | SyncParkStatus (bool isparked) |
| SyncParkStatus Update the state and switches for parking. | |
| virtual bool | SetSlewRate (int index) |
| SetSlewRate Set desired slew rate index. | |
| bool | callHandshake () |
| callHandshake Helper function that sets the port file descriptor before calling the actual Handshake function implenented in drivers | |
| void | processNSWE (double mag, double angle) |
| void | processJoystick (const char *joystick_n, double mag, double angle) |
| void | processAxis (const char *axis_n, double value) |
| void | processSlewPresets (double mag, double angle) |
| void | processButton (const char *button_n, ISState state) |
| TelescopePierSide | expectedPierSide (double ra) |
| Calculate the expected pier side for scopes that do not report this property themselves. | |
| std::string | GetHomeDirectory () const |
| Validate a file name. | |
| int | GetScopeConfigIndex () const |
| Get the scope config index. | |
| bool | CheckFile (const std::string &file_name, bool writable) const |
| Check if a file exists and it is readable. | |
| void | sendTimeFromSystem () |
| bool | getSimulatePierSide () const |
| void | setSimulatePierSide (bool value) |
| const char * | getPierSideStr (TelescopePierSide ps) |
| const char * | LoadParkData () |
| bool | WriteParkData () |
| bool | PurgeParkData () |
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) | |
Definition at line 33 of file planewave_mount.h.
| PlaneWave::PlaneWave | ( | ) |
Constructor / Destructor.
Definition at line 40 of file planewave_mount.cpp.
|
virtualdefault |
|
overrideprotectedvirtual |
|
overridevirtual |
Implements INDI::DefaultDevice.
Definition at line 65 of file planewave_mount.cpp.
|
overrideprotectedvirtual |
Goto — J2000 RA/Dec (INDI convention)
Reimplemented from INDI::Telescope.
Definition at line 499 of file planewave_mount.cpp.
|
overridevirtual |
Handshake — build the persistent client and verify the mount is live.
Reimplemented from INDI::Telescope.
Definition at line 268 of file planewave_mount.cpp.
|
overridevirtual |
initProperties
Reimplemented from INDI::Telescope.
Definition at line 73 of file planewave_mount.cpp.
|
overridevirtual |
ISNewNumber.
Reimplemented from INDI::Telescope.
Definition at line 901 of file planewave_mount.cpp.
|
overridevirtual |
ISNewSwitch.
Reimplemented from INDI::Telescope.
Definition at line 747 of file planewave_mount.cpp.
|
overridevirtual |
|
overrideprotectedvirtual |
MoveNS — jog in Dec using a continuous offset rate.
Reimplemented from INDI::Telescope.
Definition at line 600 of file planewave_mount.cpp.
|
overrideprotectedvirtual |
MoveWE — jog in RA using a continuous offset rate.
Reimplemented from INDI::Telescope.
Definition at line 626 of file planewave_mount.cpp.
|
overrideprotectedvirtual |
|
overridevirtual |
ReadScopeStatus — called every polling interval.
Implements INDI::Telescope.
Definition at line 345 of file planewave_mount.cpp.
|
overrideprotectedvirtual |
saveConfigItems
Reimplemented from INDI::Telescope.
Definition at line 737 of file planewave_mount.cpp.
|
overrideprotectedvirtual |
SetCurrentPark — tell PWI4 to store the current position as the park point.
Reimplemented from INDI::Telescope.
Definition at line 570 of file planewave_mount.cpp.
|
overrideprotectedvirtual |
SetDefaultPark.
Reimplemented from INDI::Telescope.
Definition at line 582 of file planewave_mount.cpp.
|
overrideprotectedvirtual |
SetTrackEnabled.
Reimplemented from INDI::Telescope.
Definition at line 721 of file planewave_mount.cpp.
|
overrideprotectedvirtual |
SetTrackMode.
Reimplemented from INDI::Telescope.
Definition at line 679 of file planewave_mount.cpp.
|
overrideprotectedvirtual |
SetTrackRate — called when the user changes TrackRateNP.
Reimplemented from INDI::Telescope.
Definition at line 708 of file planewave_mount.cpp.
|
overrideprotectedvirtual |
Sync — adds a pointing-model calibration point at the current position.
Reimplemented from INDI::Telescope.
Definition at line 516 of file planewave_mount.cpp.
|
overrideprotectedvirtual |
UnPark — re-enable both motors before clearing the parked state.
Reimplemented from INDI::Telescope.
Definition at line 548 of file planewave_mount.cpp.
|
overrideprotectedvirtual |
updateLocation — PWI4 is the authority; we just accept the INDI call and note that the actual site location is configured inside PWI4.
Reimplemented from INDI::Telescope.
Definition at line 653 of file planewave_mount.cpp.
|
overridevirtual |
updateProperties
Reimplemented from INDI::Telescope.
Definition at line 197 of file planewave_mount.cpp.
|
overrideprotectedvirtual |
updateTime — PWI4 uses the host PC clock; nothing to push.
Reimplemented from INDI::Telescope.
Definition at line 669 of file planewave_mount.cpp.