|
| | LX200_OnStep () |
| |
| | ~LX200_OnStep () |
| |
| virtual const char * | getDefaultName () override |
| |
| virtual bool | initProperties () override |
| | Called to initialize basic properties required all the time.
|
| |
| 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 | updateProperties () override |
| | Called when connected state changes, to add/remove properties.
|
| |
| virtual bool | ISNewNumber (const char *dev, const char *name, double values[], char *names[], int n) override |
| | Process the client newNumber command.
|
| |
| virtual bool | ISNewSwitch (const char *dev, const char *name, ISState *states, char *names[], int n) override |
| | Process the client newSwitch command.
|
| |
| virtual bool | Handshake () override |
| | perform handshake with device to check communication
|
| |
| | LX200Generic () |
| |
| virtual | ~LX200Generic () override=default |
| |
| | LX200Telescope () |
| |
| uint32_t | getLX200Capability () const |
| |
| void | setLX200Capability (uint32_t cap) |
| |
| virtual const char * | getDriverName () override |
| |
| virtual bool | ISNewText (const char *dev, const char *name, char *texts[], char *names[], int n) override |
| | Process the client newSwitch command.
|
| |
| void | updateFocusTimer () |
| |
| | Telescope () |
| |
| virtual | ~Telescope () |
| |
| 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?
|
| |
| 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 () |
| |
| | 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 () |
| |
| 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.
|
| |
| | 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.
|
| |
| 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 () |
| |
| virtual void | GuideComplete (INDI_EQ_AXIS axis) |
| | Call GuideComplete once the guiding pulse is complete.
|
| |
| 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 () |
| |
| uint32_t | GetCapability () const |
| | GetRotatorCapability returns the capability of the Rotator.
|
| |
| void | SetCapability (uint32_t cap) |
| | SetRotatorCapability sets the Rotator capabilities. All capabilities must be initialized.
|
| |
| bool | CanAbort () |
| |
| bool | CanHome () |
| |
| bool | CanSync () |
| |
| bool | CanReverse () |
| |
| bool | HasBacklash () |
| |
|
| virtual void | getBasicData () override |
| |
| virtual bool | Park () override |
| | Park the telescope to its home position.
|
| |
| virtual bool | UnPark () override |
| | Unpark the telescope if already parked.
|
| |
| virtual bool | SetCurrentPark () override |
| | SetCurrentPark Set current coordinates/encoders value as the desired parking position.
|
| |
| virtual bool | SetDefaultPark () override |
| | SetDefaultPark Set default coordinates/encoders value as the desired parking position.
|
| |
| virtual bool | SetTrackEnabled (bool enabled) override |
| | SetTrackEnabled Engages or disengages mount tracking. If there are no tracking modes available, it is assumed sidereal. Otherwise, whatever tracking mode should be activated or deactivated accordingly.
|
| |
| virtual bool | updateLocation (double latitude, double longitude, double elevation) override |
| | Update telescope location settings.
|
| |
| virtual bool | setLocalDate (uint8_t days, uint8_t months, uint16_t years) override |
| |
| virtual bool | ReadScopeStatus () override |
| | Read telescope status.
|
| |
| virtual int | setSiteLongitude (int fd, double Long) |
| |
| virtual int | setSiteLatitude (int fd, double Long) |
| |
| virtual bool | SetTrackRate (double raRate, double deRate) override |
| | SetTrackRate Set custom tracking rates.
|
| |
| virtual void | slewError (int slewCode) override |
| |
| virtual bool | Sync (double ra, double dec) override |
| | Set the telescope current RA and DEC coordinates to the supplied RA and DEC coordinates.
|
| |
| virtual bool | MoveNS (INDI_DIR_NS dir, TelescopeMotionCommand command) override |
| | Start or Stop the telescope motion in the direction dir.
|
| |
| virtual bool | MoveWE (INDI_DIR_WE dir, TelescopeMotionCommand command) override |
| | Move the telescope in the direction dir.
|
| |
| virtual bool | saveConfigItems (FILE *fp) override |
| | saveConfigItems Save specific properties in the provide config file handler. Child class usually override this function to save their own properties and the base class saveConfigItems(fp) must be explicitly called by each child class. The Default Device saveConfigItems(fp) only save Debug properties options in the config file.
|
| |
| virtual void | Init_Outputs () |
| |
| virtual bool | sendScopeTime () override |
| |
| virtual bool | sendScopeLocation () override |
| |
| virtual bool | setUTCOffset (double offset) override |
| |
| virtual bool | Goto (double ra, double dec) override |
| | Move the scope to the supplied RA and DEC coordinates.
|
| |
| IPState | MoveFocuser (FocusDirection dir, int speed, uint16_t duration) override |
| | MoveFocuser the focuser in a particular direction with a specific speed for a finite duration.
|
| |
| IPState | MoveAbsFocuser (uint32_t targetTicks) override |
| | MoveFocuser the focuser to an absolute position.
|
| |
| IPState | MoveRelFocuser (FocusDirection dir, uint32_t ticks) override |
| | MoveFocuser the focuser to an relative position.
|
| |
| bool | AbortFocuser () override |
| | AbortFocuser all focus motion.
|
| |
| IPState | MoveRotator (double angle) override |
| | MoveRotator Go to specific angle.
|
| |
| IPState | HomeRotator () override |
| | HomeRotator Go to home position.
|
| |
| bool | AbortRotator () override |
| | AbortRotator Abort all motion.
|
| |
| bool | SetRotatorBacklash (int32_t steps) override |
| | SetRotatorBacklash Set the Rotatorer backlash compensation value.
|
| |
| bool | SetRotatorBacklashEnabled (bool enabled) override |
| | SetRotatorBacklashEnabled Enables or disables the Rotator backlash compensation.
|
| |
| virtual IPState | ExecuteHomeAction (TelescopeHomeAction action) override |
| | Execute a homing action.
|
| |
| IPState | StopPECPlayback (int axis) |
| |
| IPState | StartPECPlayback (int axis) |
| |
| IPState | ClearPECBuffer (int axis) |
| |
| IPState | StartPECRecord (int axis) |
| |
| IPState | SavePECBuffer (int axis) |
| |
| IPState | PECStatus (int axis) |
| |
| IPState | ReadPECBuffer (int axis) |
| |
| IPState | WritePECBuffer (int axis) |
| |
| bool | ISPECRecorded (int axis) |
| |
| IPState | AlignStartGeometric (int stars) |
| |
| IPState | AlignAddStar () |
| | AlignStartGeometric starts the OnStep Multistar align process.
|
| |
| IPState | AlignDone () |
| |
| IPState | AlignWrite () |
| |
| virtual bool | UpdateAlignStatus () |
| |
| virtual bool | UpdateAlignErr () |
| |
| IPState | OSEnableOutput (int output) |
| |
| IPState | OSDisableOutput (int output) |
| |
| bool | OSGetOutputState (int output) |
| |
| void | initSlewRates () |
| |
| bool | sendOnStepCommand (const char *cmd) |
| |
| bool | sendOnStepCommandBlind (const char *cmd) |
| |
| int | flushIO (int fd) |
| |
| int | getCommandSingleCharResponse (int fd, char *data, const char *cmd) |
| |
| int | getCommandSingleCharErrorOrLongResponse (int fd, char *data, const char *cmd) |
| |
| int | getCommandDoubleResponse (int fd, double *value, char *data, const char *cmd) |
| |
| int | getCommandIntResponse (int fd, int *value, char *data, const char *cmd) |
| |
| int | setMinElevationLimit (int fd, int min) |
| |
| int | OSUpdateFocuser () |
| |
| int | OSUpdateRotator () |
| |
| virtual IPState | updateWeather () override |
| | updateWeather Update weather conditions from device or service. The function should not change the state of any property in the device as this is handled by Weather. It should only update the raw values.
|
| |
| virtual void | SyncParkStatus (bool isparked) override |
| | SyncParkStatus Update the state and switches for parking.
|
| |
| virtual void | SetParked (bool isparked) override |
| | SetParked Change the mount parking status. The data park file (stored in ~/.indi/ParkData.xml) is updated in the process.
|
| |
| void | PrintTrackState () |
| | PrintTrackState will print to the debug log the status of TrackState if DEBUG_TRACKSTATE is defined otherwise it will simply return.
|
| |
| virtual bool | SetSlewRate (int index) override |
| | SetSlewRate Set desired slew rate index.
|
| |
| virtual bool | SetTrackMode (uint8_t mode) override |
| | SetTrackMode Set active tracking mode. Do not change track state.
|
| |
| virtual bool | Abort () override |
| | Abort any telescope motion including tracking if possible.
|
| |
| virtual bool | updateTime (ln_date *utc, double utc_offset) override |
| | Update telescope time, date, and UTC offset.
|
| |
| virtual IPState | GuideNorth (uint32_t ms) override |
| | Guide north for ms milliseconds. North is defined as DEC+.
|
| |
| virtual IPState | GuideSouth (uint32_t ms) override |
| | Guide south for ms milliseconds. South is defined as DEC-.
|
| |
| virtual IPState | GuideEast (uint32_t ms) override |
| | Guide east for ms milliseconds. East is defined as RA+.
|
| |
| virtual IPState | GuideWest (uint32_t ms) override |
| | Guide west for ms milliseconds. West is defined as RA-.
|
| |
| virtual int | SendPulseCmd (int8_t direction, uint32_t duration_msec) |
| |
| virtual bool | isSlewComplete () |
| |
| virtual bool | checkConnection () |
| |
| virtual void | debugTriggered (bool enable) override |
| | 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 bool | getLocalDate (char *dateString) |
| |
| virtual bool | getLocalTime (char *timeString) |
| |
| virtual bool | setLocalTime24 (uint8_t hour, uint8_t minute, uint8_t second) |
| |
| virtual bool | getUTFOffset (double *offset) |
| |
| void | getAlignment () |
| |
| bool | updateSlewRate (int index) |
| |
| void | mountSim () |
| |
| virtual bool | ReverseFocuser (bool enabled) override |
| | ReverseFocuser Reverse focuser motion direction.
|
| |
| virtual bool | SetFocuserSpeed (int speed) override |
| | SetFocuserSpeed Set Focuser speed.
|
| |
| void | guideTimeoutNS () |
| |
| void | guideTimeoutWE () |
| |
| 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.
|
| |
| 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 () |
| |
| 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 | 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) |
| |
| | ParentDevice (const std::shared_ptr< ParentDevicePrivate > &dd) |
| |
| | BaseDevice (BaseDevicePrivate &dd) |
| |
| | BaseDevice (const std::shared_ptr< BaseDevicePrivate > &dd) |
| |
| | GuiderInterface (DefaultDevice *defaultDevice) |
| |
| | ~GuiderInterface () |
| |
| void | initProperties (const char *groupName) |
| | Initialize guider 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) |
| | Call this function whenever client updates GuideNSNP or GuideWSP properties in the primary device. This function then takes care of issuing the corresponding GuideXXXX function accordingly.
|
| |
| | 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 | SyncFocuser (uint32_t ticks) |
| | SyncFocuser Set current position to ticks without moving the focuser.
|
| |
| virtual bool | SetFocuserMaxPosition (uint32_t ticks) |
| | SetFocuserMaxPosition Set Focuser Maximum position limit in the hardware.
|
| |
| 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
|
| |
| | WeatherInterface (DefaultDevice *defaultDevice) |
| |
| virtual | ~WeatherInterface () |
| |
| void | initProperties (const char *statusGroup, const char *paramsGroup) |
| | 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 weather number properties.
|
| |
| bool | processSwitch (const char *dev, const char *name, ISState *states, char *names[], int n) |
| | Process weather switch properties.
|
| |
| void | checkWeatherUpdate () |
| | checkWeatherUpdate Calls updateWeather and update critical parameters accordingly.
|
| |
| void | addParameter (std::string name, std::string label, double numMinOk, double numMaxOk, double percWarning, bool flipWarning=false) |
| | Add a physical weather measurable parameter to the weather driver.
|
| |
| bool | setCriticalParameter (std::string name) |
| | setCriticalParameter Set parameter that is considered critical to the operation of the observatory. The parameter state can affect the overall weather driver state which signals the client to take appropriate action depending on the severity of the state.
|
| |
| void | setParameterValue (std::string name, double value) |
| | setParameterValue Update weather parameter value
|
| |
| IPState | checkParameterState (const std::string ¶m) const |
| | Checks the given parameter against the defined bounds.
|
| |
| bool | syncCriticalParameters () |
| | Synchronize and update the state of all critical parameters.
|
| |
| | RotatorInterface (DefaultDevice *defaultDevice) |
| |
| void | initProperties (const char *groupName) |
| | Initialize Rotator 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 Rotator number properties.
|
| |
| bool | processSwitch (const char *dev, const char *name, ISState *states, char *names[], int n) |
| | Process Rotator switch properties.
|
| |
| virtual bool | SyncRotator (double angle) |
| | SyncRotator Set current angle as the supplied angle without moving the rotator.
|
| |
| virtual bool | ReverseRotator (bool enabled) |
| | ReverseRotator Reverse the direction of the rotator. CW is usually the normal direction, and CCW is the reversed direction.
|
| |
| bool | saveConfigItems (FILE *fp) |
| | saveConfigItems save focuser properties defined in the interface in config file
|
| |
Public Member Functions inherited from LX200Generic