Instrument Neutral Distributed Interface INDI  1.9.2
Public Types | Public Member Functions | Protected Member Functions | Static Protected Member Functions | List of all members
Rainbow Class Reference

#include <rainbow.h>

Inheritance diagram for Rainbow:
INDI::Telescope INDI::GuiderInterface INDI::DefaultDevice INDI::BaseDevice

Public Types

enum  GotoType { Equatorial, Horizontal }
 
enum  Direction { North, South, West, East }
 
- Public Types inherited from INDI::Telescope
enum  TelescopeStatus {
  SCOPE_IDLE, SCOPE_SLEWING, SCOPE_TRACKING, SCOPE_PARKING,
  SCOPE_PARKED
}
 
enum  TelescopeMotionCommand { MOTION_START = 0, MOTION_STOP }
 
enum  TelescopeSlewRate { SLEW_GUIDE, SLEW_CENTERING, SLEW_FIND, SLEW_MAX }
 
enum  TelescopeTrackMode { TRACK_SIDEREAL, TRACK_SOLAR, TRACK_LUNAR, TRACK_CUSTOM }
 
enum  TelescopeTrackState { TRACK_ON, TRACK_OFF, TRACK_UNKNOWN }
 
enum  TelescopeParkData {
  PARK_NONE, PARK_RA_DEC, PARK_HA_DEC, PARK_AZ_ALT,
  PARK_RA_DEC_ENCODER, PARK_AZ_ALT_ENCODER
}
 
enum  TelescopeLocation { LOCATION_LATITUDE, LOCATION_LONGITUDE, LOCATION_ELEVATION }
 
enum  TelescopePierSide { PIER_UNKNOWN = -1, PIER_WEST = 0, PIER_EAST = 1 }
 
enum  TelescopePECState { PEC_UNKNOWN = -1, PEC_OFF = 0, PEC_ON = 1 }
 
enum  DomeLockingPolicy { DOME_IGNORED, DOME_LOCKS }
 
enum  { CONNECTION_NONE = 1 << 0, CONNECTION_SERIAL = 1 << 1, CONNECTION_TCP = 1 << 2 }
 
enum  {
  TELESCOPE_CAN_GOTO = 1 << 0, TELESCOPE_CAN_SYNC = 1 << 1, TELESCOPE_CAN_PARK = 1 << 2, TELESCOPE_CAN_ABORT = 1 << 3,
  TELESCOPE_HAS_TIME = 1 << 4, TELESCOPE_HAS_LOCATION = 1 << 5, TELESCOPE_HAS_PIER_SIDE = 1 << 6, TELESCOPE_HAS_PEC = 1 << 7,
  TELESCOPE_HAS_TRACK_MODE = 1 << 8, TELESCOPE_CAN_CONTROL_TRACK = 1 << 9, TELESCOPE_HAS_TRACK_RATE = 1 << 10, TELESCOPE_HAS_PIER_SIDE_SIMULATION = 1 << 11,
  TELESCOPE_CAN_TRACK_SATELLITE = 1 << 12
}
 
- Public Types inherited from INDI::BaseDevice
enum  INDI_ERROR { INDI_DEVICE_NOT_FOUND = -1, INDI_PROPERTY_INVALID = -2, INDI_PROPERTY_DUPLICATED = -3, INDI_DISPATCH_ERROR = -4 }
 
enum  { INDI_ENABLED, INDI_DISABLED }
 
enum  DRIVER_INTERFACE {
  GENERAL_INTERFACE = 0, TELESCOPE_INTERFACE = (1 << 0), CCD_INTERFACE = (1 << 1), GUIDER_INTERFACE = (1 << 2),
  FOCUSER_INTERFACE = (1 << 3), FILTER_INTERFACE = (1 << 4), DOME_INTERFACE = (1 << 5), GPS_INTERFACE = (1 << 6),
  WEATHER_INTERFACE = (1 << 7), AO_INTERFACE = (1 << 8), DUSTCAP_INTERFACE = (1 << 9), LIGHTBOX_INTERFACE = (1 << 10),
  DETECTOR_INTERFACE = (1 << 11), ROTATOR_INTERFACE = (1 << 12), SPECTROGRAPH_INTERFACE = (1 << 13), CORRELATOR_INTERFACE = (1 << 14),
  AUX_INTERFACE = (1 << 15), SENSOR_INTERFACE = SPECTROGRAPH_INTERFACE | DETECTOR_INTERFACE | CORRELATOR_INTERFACE
}
 The DRIVER_INTERFACE enum defines the class of devices the driver implements. A driver may implement one or more interfaces. More...
 
typedef INDI::Properties Properties
 

Public Member Functions

 Rainbow ()
 
const char * getDefaultName () override
 
virtual bool ISNewNumber (const char *dev, const char *name, double values[], char *names[], int n) override
 Process the client newNumber command. More...
 
virtual bool ISNewSwitch (const char *dev, const char *name, ISState *states, char *names[], int n) override
 Process the client newSwitch command. More...
 
- Public Member Functions inherited from INDI::Telescope
 Telescope ()
 
virtual ~Telescope ()
 
virtual bool ISNewText (const char *dev, const char *name, char *texts[], char *names[], int n) override
 Process the client newSwitch command. More...
 
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 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...
 
uint32_t GetTelescopeCapability () const
 GetTelescopeCapability returns the capability of the Telescope. More...
 
void SetTelescopeCapability (uint32_t cap, uint8_t slewRateCount=0)
 SetTelescopeCapability sets the Telescope capabilities. All capabilities must be initialized. More...
 
bool CanGOTO ()
 
bool CanSync ()
 
bool CanAbort ()
 
bool CanPark ()
 
bool CanControlTrack ()
 
bool HasTime ()
 
bool HasLocation ()
 
bool HasPierSide ()
 
bool HasPierSideSimulation ()
 
bool CanTrackSatellite ()
 
bool HasPECState ()
 
bool HasTrackMode ()
 
bool HasTrackRate ()
 
virtual void TimerHit () override
 Called when setTimer() time is up. More...
 
void SetParkDataType (TelescopeParkData type)
 setParkDataType Sets the type of parking data stored in the park data file and presented to the user. More...
 
bool InitPark ()
 InitPark Loads parking data (stored in ~/.indi/ParkData.xml) that contains parking status and parking position. More...
 
bool isParked ()
 isParked is mount currently parked? More...
 
void SetParked (bool isparked)
 SetParked Change the mount parking status. The data park file (stored in ~/.indi/ParkData.xml) is updated in the process. More...
 
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. More...
 
void SetAxis1ParkDefault (double steps)
 SetRAPark Set default RA/AZ parking position. More...
 
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. More...
 
void SetAxis2ParkDefault (double steps)
 SetDEParkDefault Set default DEC/ALT parking position. More...
 
bool isLocked () const
 isLocked is mount currently locked? More...
 
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 More...
 
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. 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) __attribute__((deprecated))
 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) __attribute__((deprecated))
 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) __attribute__((deprecated))
 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) __attribute__((deprecated))
 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) __attribute__((deprecated))
 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...
 
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...
 
virtual uint16_t getDriverInterface () override
 
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...
 
- Public Member Functions inherited from INDI::BaseDevice
 BaseDevice ()
 
virtual ~BaseDevice ()
 
INDI::PropertyView< INumber > * getNumber (const char *name) const
 
INDI::PropertyView< IText > * getText (const char *name) const
 
INDI::PropertyView< ISwitch > * getSwitch (const char *name) const
 
INDI::PropertyView< ILight > * getLight (const char *name) const
 
INDI::PropertyView< IBLOB > * getBLOB (const char *name) const
 
IPState getPropertyState (const char *name) const
 
IPerm getPropertyPermission (const char *name) const
 
void registerProperty (void *p, INDI_PROPERTY_TYPE type)
 
void registerProperty (ITextVectorProperty *property)
 
void registerProperty (INumberVectorProperty *property)
 
void registerProperty (ISwitchVectorProperty *property)
 
void registerProperty (ILightVectorProperty *property)
 
void registerProperty (IBLOBVectorProperty *property)
 
void registerProperty (INDI::PropertyView< IText > *property)
 
void registerProperty (INDI::PropertyView< INumber > *property)
 
void registerProperty (INDI::PropertyView< ISwitch > *property)
 
void registerProperty (INDI::PropertyView< ILight > *property)
 
void registerProperty (INDI::PropertyView< IBLOB > *property)
 
void registerProperty (INDI::Property &property)
 
int removeProperty (const char *name, char *errmsg)
 Remove a property. More...
 
void * getRawProperty (const char *name, INDI_PROPERTY_TYPE type=INDI_UNKNOWN) const
 Return a property and its type given its name. 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
 
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 isConnected () const
 
void setMediator (INDI::BaseMediator *mediator)
 Set the driver's mediator to receive notification of news devices and updated property values. More...
 
INDI::BaseMediatorgetMediator () 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
 
bool buildSkeleton (const char *filename)
 Build driver properties from a skeleton file. More...
 
int buildProp (XMLEle *root, char *errmsg)
 Build a property given the supplied XML element (defXXX) More...
 
int setValue (XMLEle *root, char *errmsg)
 handle SetXXX commands from client More...
 
int setBLOB (IBLOBVectorProperty *pp, XMLEle *root, char *errmsg)
 Parse and store BLOB in the respective vector. More...
 
- Public Member Functions inherited from INDI::GuiderInterface
virtual void GuideComplete (INDI_EQ_AXIS axis)
 Call GuideComplete once the guiding pulse is complete. More...
 

Protected Member Functions

virtual bool initProperties () override
 Called to initialize basic properties required all the time. More...
 
virtual bool updateProperties () override
 Called when connected state changes, to add/remove properties. More...
 
virtual bool Handshake () override
 perform handshake with device to check communication More...
 
virtual bool isSlewComplete ()
 Motion Functions. More...
 
virtual bool Goto (double ra, double dec) override
 Slew RA/DE. More...
 
virtual bool ReadScopeStatus () override
 Read telescope status. More...
 
virtual bool Abort () override
 Abort. More...
 
virtual bool MoveNS (INDI_DIR_NS dir, TelescopeMotionCommand command) override
 Abort. More...
 
virtual bool MoveWE (INDI_DIR_WE dir, TelescopeMotionCommand command) override
 W/E Motion. More...
 
virtual bool SetSlewRate (int index) override
 Set Slew Rate. More...
 
virtual bool Sync (double ra, double dec) override
 Sync. More...
 
bool getRA ()
 Get RA. More...
 
bool getDE ()
 Get DE. More...
 
bool setRA (double ra)
 Set Target RA. More...
 
bool setDE (double de)
 Set Target Altitude. More...
 
bool slewToEquatorialCoords (double ra, double de)
 Slew to Equatorial Coordinates. More...
 
virtual bool SetTrackEnabled (bool enabled) override
 Tracking Functions. More...
 
virtual bool SetTrackMode (uint8_t mode) override
 Set Track Mode. More...
 
bool getTrackingState ()
 
void getStartupStatus ()
 Query Functions. More...
 
bool getFirmwareVersion ()
 
virtual bool updateLocation (double latitude, double longitude, double elevation) override
 Location & Time. More...
 
virtual IPState GuideNorth (uint32_t ms) override
 Guiding. More...
 
virtual IPState GuideSouth (uint32_t ms) override
 Guide South. More...
 
virtual IPState GuideEast (uint32_t ms) override
 Guide East. More...
 
virtual IPState GuideWest (uint32_t ms) override
 Guide West. More...
 
IPState guide (Direction direction, uint32_t ms)
 Guide universal function. More...
 
void guideTimeout (Direction direction)
 Guide Timeout. More...
 
void addGuideTimer (Direction direction, uint32_t ms)
 Add guide timer. More...
 
bool setGuideRate (double rate)
 
bool getGuideRate ()
 
virtual bool Park () override
 Parking & Homing. More...
 
virtual bool UnPark () override
 Unparking. More...
 
virtual bool SetCurrentPark () override
 SetCurrentPark Set current coordinates/encoders value as the desired parking position. More...
 
virtual bool SetDefaultPark () override
 SetDefaultPark Set default coordinates/encoders value as the desired parking position. More...
 
bool findHome ()
 
bool checkHoming ()
 
bool sendScopeTime ()
 Location & Time. More...
 
bool sendScopeLocation ()
 Get Location from mount. More...
 
bool getUTFOffset (double *offset)
 GET UTC offset from mount. More...
 
bool getLocalDate (char *dateString)
 Get Date from mount. More...
 
bool getLocalTime (char *timeString)
 Get Time from mount. More...
 
bool sendCommand (const char *cmd, char *res=nullptr, int cmd_len=-1, int res_len=-1)
 Communication Functions. More...
 
void hexDump (char *buf, const char *data, int size)
 
std::vector< std::string > split (const std::string &input, const std::string &regex)
 
- Protected Member Functions inherited from INDI::Telescope
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. More...
 
void NewRaDec (double ra, double dec)
 The child class calls this function when it has updates. More...
 
virtual bool SetTrackRate (double raRate, double deRate)
 SetTrackRate Set custom tracking rates. More...
 
virtual int AddTrackMode (const char *name, const char *label, bool isDefault=false)
 AddTrackMode. More...
 
virtual bool updateTime (ln_date *utc, double utc_offset)
 Update telescope time, date, and UTC offset. More...
 
void updateObserverLocation (double latitude, double longitude, double elevation)
 Update location settings of the observer. More...
 
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. More...
 
bool callHandshake ()
 callHandshake Helper function that sets the port file descriptor before calling the actual Handshake function implenented in drivers More...
 
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. More...
 
bool LoadScopeConfig ()
 Load scope settings from XML files. More...
 
bool HasDefaultScopeConfig ()
 Load scope settings from XML files. More...
 
bool UpdateScopeConfig ()
 Save scope settings to XML files. More...
 
std::string GetHomeDirectory () const
 Validate a file name. More...
 
int GetScopeConfigIndex () const
 Get the scope config index. More...
 
bool CheckFile (const std::string &file_name, bool writable) const
 Check if a file exists and it is readable. More...
 
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. 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...
 
virtual bool saveConfig (bool silent=false, const char *property=nullptr)
 Save the current properties in a 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::InterfacegetActiveConnection ()
 
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...
 
void syncDriverInfo ()
 syncDriverInfo sends the current driver information to the client. More...
 
 DefaultDevice (DefaultDevicePrivate &dd)
 
- Protected Member Functions inherited from INDI::BaseDevice
 BaseDevice (BaseDevicePrivate &dd)
 
- Protected Member Functions inherited from INDI::GuiderInterface
 GuiderInterface ()
 
 ~GuiderInterface ()
 
void initGuiderProperties (const char *deviceName, const char *groupName)
 Initilize guider properties. It is recommended to call this function within initProperties() of your primary device. More...
 
void processGuiderProperties (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. More...
 

Static Protected Member Functions

static void guideTimeoutHelperN (void *p)
 Guide Timeout North. More...
 
static void guideTimeoutHelperS (void *p)
 Guide Timeout South. More...
 
static void guideTimeoutHelperW (void *p)
 Guide Timeout West. More...
 
static void guideTimeoutHelperE (void *p)
 Guide Timeout East. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from INDI::Telescope
static void joystickHelper (const char *joystick_n, double mag, double angle, void *context)
 
static void axisHelper (const char *axis_n, double value, void *context)
 
static void buttonHelper (const char *button_n, ISState state, void *context)
 
- Public Attributes inherited from INDI::Telescope
enum INDI::Telescope:: { ... }  TelescopeConnection
 
enum INDI::Telescope:: { ... }  TelescopeCapability
 
- Protected Types inherited from INDI::Telescope
enum  { PARK_CURRENT, PARK_DEFAULT, PARK_WRITE_DATA, PARK_PURGE_DATA }
 
enum  { MOTION_CONTROL_JOYSTICK, MOTION_CONTROL_AXES }
 
enum  { SAT_PASS_WINDOW_START, SAT_PASS_WINDOW_END, SAT_PASS_WINDOW_COUNT }
 
enum  { SAT_TRACK, SAT_HALT, SAT_TRACK_COUNT }
 
enum  {
  SCOPE_CONFIG1, SCOPE_CONFIG2, SCOPE_CONFIG3, SCOPE_CONFIG4,
  SCOPE_CONFIG5, SCOPE_CONFIG6
}
 
- Protected Attributes inherited from INDI::Telescope
IGeographicCoordinates m_Location { 0, 0, 0 }
 
TelescopeStatus TrackState {SCOPE_IDLE}
 
TelescopeStatus RememberTrackState {SCOPE_IDLE}
 RememberTrackState Remember last state of Track State to fall back to in case of errors or aborts. More...
 
INumberVectorProperty EqNP
 
INumber EqN [2]
 
INumberVectorProperty TargetNP
 
INumber TargetN [2]
 
ISwitchVectorProperty AbortSP
 
ISwitch AbortS [1]
 
ISwitchVectorProperty CoordSP
 
ISwitch CoordS [3]
 
INumberVectorProperty LocationNP
 
INumber LocationN [3]
 
ISwitchVectorProperty ParkSP
 
ISwitch ParkS [2]
 
INumber ParkPositionN [2]
 
INumberVectorProperty ParkPositionNP
 
ISwitch ParkOptionS [4]
 
ISwitchVectorProperty ParkOptionSP
 
ISwitch MovementNSS [2]
 
ISwitchVectorProperty MovementNSSP
 
ISwitch MovementWES [2]
 
ISwitchVectorProperty MovementWESP
 
ISwitchVectorProperty SlewRateSP
 
ISwitchSlewRateS {nullptr}
 
INumber ScopeParametersN [4]
 
INumberVectorProperty ScopeParametersNP
 
IText TimeT [2] {}
 
ITextVectorProperty TimeTP
 
ITextVectorProperty ActiveDeviceTP
 
IText ActiveDeviceT [2] {}
 
ISwitchVectorProperty DomePolicySP
 
ISwitch DomePolicyS [2]
 
ISwitchVectorProperty MotionControlModeTP
 
ISwitch MotionControlModeT [2]
 
ISwitch LockAxisS [2]
 
ISwitchVectorProperty LockAxisSP
 
ISwitch PierSideS [2]
 
ISwitchVectorProperty PierSideSP
 
ISwitchVectorProperty SimulatePierSideSP
 
ISwitch SimulatePierSideS [2]
 
TelescopePierSide lastPierSide
 
TelescopePierSide currentPierSide
 
ITextVectorProperty TLEtoTrackTP
 Text Vector property defining the orbital elements of an artificial satellite (TLE). Example implementation. More...
 
IText TLEtoTrackT [1] {}
 
enum INDI::Telescope:: { ... }  SatelliteWindow
 
ITextVectorProperty SatPassWindowTP
 Text Vector property defining the start and end of a satellite pass (window contains pass). Example implementation. More...
 
IText SatPassWindowT [SAT_PASS_WINDOW_COUNT] {}
 
enum INDI::Telescope:: { ... }  SatelliteTracking
 
ISwitchVectorProperty TrackSatSP
 Switch Vector property defining the state of the satellite tracking of the mount. Example implementation. More...
 
ISwitch TrackSatS [SAT_TRACK_COUNT]
 
ISwitch PECStateS [2]
 
ISwitchVectorProperty PECStateSP
 
ISwitchVectorProperty TrackModeSP
 
ISwitchTrackModeS { nullptr }
 
ISwitchVectorProperty TrackStateSP
 
ISwitch TrackStateS [2]
 
INumberVectorProperty TrackRateNP
 
INumber TrackRateN [2]
 
TelescopePECState lastPECState {PEC_UNKNOWN}
 
TelescopePECState currentPECState {PEC_UNKNOWN}
 
uint32_t capability {0}
 
int last_we_motion {-1}
 
int last_ns_motion {-1}
 
int PortFD = -1
 
Connection::SerialserialConnection = nullptr
 
Connection::TCPtcpConnection = nullptr
 
const std::string ScopeConfigRootXmlNode { "scopeconfig" }
 
const std::string ScopeConfigDeviceXmlNode { "device" }
 
const std::string ScopeConfigNameXmlNode { "name" }
 
const std::string ScopeConfigScopeFocXmlNode { "scopefoc" }
 
const std::string ScopeConfigScopeApXmlNode { "scopeap" }
 
const std::string ScopeConfigGScopeFocXmlNode { "gscopefoc" }
 
const std::string ScopeConfigGScopeApXmlNode { "gscopeap" }
 
const std::string ScopeConfigLabelApXmlNode { "label" }
 
ISwitch ScopeConfigs [6]
 
ISwitchVectorProperty ScopeConfigsSP
 
ITextVectorProperty ScopeConfigNameTP
 
IText ScopeConfigNameT [1] {}
 
const std::string ScopeConfigFileName
 The telescope/guide scope configuration file name. More...
 
- Protected Attributes inherited from INDI::BaseDevice
std::shared_ptr< BaseDevicePrivated_ptr
 
- Protected Attributes inherited from INDI::GuiderInterface
INumber GuideNSN [2]
 
INumberVectorProperty GuideNSNP
 
INumber GuideWEN [2]
 
INumberVectorProperty GuideWENP
 

Detailed Description

Definition at line 26 of file rainbow.h.

Member Enumeration Documentation

◆ Direction

Enumerator
North 
South 
West 
East 

Definition at line 36 of file rainbow.h.

◆ GotoType

Enumerator
Equatorial 
Horizontal 

Definition at line 35 of file rainbow.h.

Constructor & Destructor Documentation

◆ Rainbow()

Rainbow::Rainbow ( )

Definition at line 34 of file rainbow.cpp.

Member Function Documentation

◆ Abort()

bool Rainbow::Abort ( )
overrideprotectedvirtual

Abort.

Reimplemented from INDI::Telescope.

Definition at line 890 of file rainbow.cpp.

◆ addGuideTimer()

void Rainbow::addGuideTimer ( Direction  direction,
uint32_t  ms 
)
protected

Add guide timer.

Definition at line 1201 of file rainbow.cpp.

◆ checkHoming()

bool Rainbow::checkHoming ( )
protected

◆ findHome()

bool Rainbow::findHome ( )
protected

Definition at line 368 of file rainbow.cpp.

◆ getDE()

bool Rainbow::getDE ( )
protected

Get DE.

Definition at line 674 of file rainbow.cpp.

◆ getDefaultName()

const char * Rainbow::getDefaultName ( )
overridevirtual
Returns
Default name of the device.

Implements INDI::DefaultDevice.

Definition at line 52 of file rainbow.cpp.

◆ getFirmwareVersion()

bool Rainbow::getFirmwareVersion ( )
protected

Definition at line 326 of file rainbow.cpp.

◆ getGuideRate()

bool Rainbow::getGuideRate ( )
protected

Definition at line 386 of file rainbow.cpp.

◆ getLocalDate()

bool Rainbow::getLocalDate ( char *  dateString)
protected

Get Date from mount.

Definition at line 1251 of file rainbow.cpp.

◆ getLocalTime()

bool Rainbow::getLocalTime ( char *  timeString)
protected

Get Time from mount.

Definition at line 1223 of file rainbow.cpp.

◆ getRA()

bool Rainbow::getRA ( )
protected

Get RA.

Definition at line 661 of file rainbow.cpp.

◆ getStartupStatus()

void Rainbow::getStartupStatus ( )
protected

Query Functions.

Definition at line 242 of file rainbow.cpp.

◆ getTrackingState()

bool Rainbow::getTrackingState ( )
protected

Definition at line 351 of file rainbow.cpp.

◆ getUTFOffset()

bool Rainbow::getUTFOffset ( double *  offset)
protected

GET UTC offset from mount.

Definition at line 1288 of file rainbow.cpp.

◆ Goto()

bool Rainbow::Goto ( double  ra,
double  dec 
)
overrideprotectedvirtual

Slew RA/DE.

Reimplemented from INDI::Telescope.

Definition at line 604 of file rainbow.cpp.

◆ guide()

IPState Rainbow::guide ( Direction  direction,
uint32_t  ms 
)
protected

Guide universal function.

Definition at line 1038 of file rainbow.cpp.

◆ GuideEast()

IPState Rainbow::GuideEast ( uint32_t  ms)
overrideprotectedvirtual

Guide East.

Implements INDI::GuiderInterface.

Definition at line 1022 of file rainbow.cpp.

◆ GuideNorth()

IPState Rainbow::GuideNorth ( uint32_t  ms)
overrideprotectedvirtual

Guiding.

Guide North.

Implements INDI::GuiderInterface.

Definition at line 1006 of file rainbow.cpp.

◆ GuideSouth()

IPState Rainbow::GuideSouth ( uint32_t  ms)
overrideprotectedvirtual

Guide South.

Implements INDI::GuiderInterface.

Definition at line 1014 of file rainbow.cpp.

◆ guideTimeout()

void Rainbow::guideTimeout ( Direction  direction)
protected

Guide Timeout.

Definition at line 1166 of file rainbow.cpp.

◆ guideTimeoutHelperE()

void Rainbow::guideTimeoutHelperE ( void *  p)
staticprotected

Guide Timeout East.

Definition at line 1158 of file rainbow.cpp.

◆ guideTimeoutHelperN()

void Rainbow::guideTimeoutHelperN ( void *  p)
staticprotected

Guide Timeout North.

Definition at line 1134 of file rainbow.cpp.

◆ guideTimeoutHelperS()

void Rainbow::guideTimeoutHelperS ( void *  p)
staticprotected

Guide Timeout South.

Definition at line 1142 of file rainbow.cpp.

◆ guideTimeoutHelperW()

void Rainbow::guideTimeoutHelperW ( void *  p)
staticprotected

Guide Timeout West.

Definition at line 1150 of file rainbow.cpp.

◆ GuideWest()

IPState Rainbow::GuideWest ( uint32_t  ms)
overrideprotectedvirtual

Guide West.

Implements INDI::GuiderInterface.

Definition at line 1030 of file rainbow.cpp.

◆ Handshake()

bool Rainbow::Handshake ( )
overrideprotectedvirtual

perform handshake with device to check communication

Reimplemented from INDI::Telescope.

Definition at line 318 of file rainbow.cpp.

◆ hexDump()

void Rainbow::hexDump ( char *  buf,
const char *  data,
int  size 
)
protected

Definition at line 1523 of file rainbow.cpp.

◆ initProperties()

bool Rainbow::initProperties ( )
overrideprotectedvirtual

Called to initialize basic properties required all the time.

Reimplemented from INDI::Telescope.

Definition at line 60 of file rainbow.cpp.

◆ ISNewNumber()

bool Rainbow::ISNewNumber ( const char *  dev,
const char *  name,
double  values[],
char *  names[],
int  n 
)
overridevirtual

Process the client newNumber command.

Note
This function is called by the INDI framework, do not call it directly.
Returns
True if any property was successfully processed, false otherwise.

Reimplemented from INDI::Telescope.

Definition at line 132 of file rainbow.cpp.

◆ ISNewSwitch()

bool Rainbow::ISNewSwitch ( const char *  dev,
const char *  name,
ISState states,
char *  names[],
int  n 
)
overridevirtual

Process the client newSwitch command.

Note
This function is called by the INDI framework, do not call it directly.
Returns
True if any property was successfully processed, false otherwise.

Reimplemented from INDI::Telescope.

Definition at line 207 of file rainbow.cpp.

◆ isSlewComplete()

bool Rainbow::isSlewComplete ( )
protectedvirtual

Motion Functions.

Definition at line 464 of file rainbow.cpp.

◆ MoveNS()

bool Rainbow::MoveNS ( INDI_DIR_NS  dir,
TelescopeMotionCommand  command 
)
overrideprotectedvirtual

Abort.

Reimplemented from INDI::Telescope.

Definition at line 828 of file rainbow.cpp.

◆ MoveWE()

bool Rainbow::MoveWE ( INDI_DIR_WE  dir,
TelescopeMotionCommand  command 
)
overrideprotectedvirtual

W/E Motion.

Reimplemented from INDI::Telescope.

Definition at line 859 of file rainbow.cpp.

◆ Park()

bool Rainbow::Park ( )
overrideprotectedvirtual

Parking & Homing.

Reimplemented from INDI::Telescope.

Definition at line 424 of file rainbow.cpp.

◆ ReadScopeStatus()

bool Rainbow::ReadScopeStatus ( )
overrideprotectedvirtual

Read telescope status.

This function checks the following:

  1. Check if the link to the telescope is alive.
  2. Update telescope status: Idle, Slewing, Parking..etc.
  3. Read coordinates
Returns
True if reading scope status is OK, false if an error is encounterd.
Note
This function is not implemented in Telescope, it must be implemented in the child class

Implements INDI::Telescope.

Definition at line 505 of file rainbow.cpp.

◆ sendCommand()

bool Rainbow::sendCommand ( const char *  cmd,
char *  res = nullptr,
int  cmd_len = -1,
int  res_len = -1 
)
protected

Communication Functions.

Send Command.

Definition at line 1456 of file rainbow.cpp.

◆ sendScopeLocation()

bool Rainbow::sendScopeLocation ( )
protected

Get Location from mount.

Definition at line 1386 of file rainbow.cpp.

◆ sendScopeTime()

bool Rainbow::sendScopeTime ( )
protected

Location & Time.

Get Time and Date from mount.

Definition at line 1316 of file rainbow.cpp.

◆ SetCurrentPark()

bool Rainbow::SetCurrentPark ( )
overrideprotectedvirtual

SetCurrentPark Set current coordinates/encoders value as the desired parking position.

Returns
True if current mount coordinates are set as parking position, false on error.
Note
If not implemented by the child class, this function by default returns false with a warning message.

Reimplemented from INDI::Telescope.

Definition at line 404 of file rainbow.cpp.

◆ setDE()

bool Rainbow::setDE ( double  de)
protected

Set Target Altitude.

Definition at line 708 of file rainbow.cpp.

◆ SetDefaultPark()

bool Rainbow::SetDefaultPark ( )
overrideprotectedvirtual

SetDefaultPark Set default coordinates/encoders value as the desired parking position.

Returns
True if default park coordinates are set as parking position, false on error.
Note
If not implemented by the child class, this function by default returns false with a warning message.

Reimplemented from INDI::Telescope.

Definition at line 414 of file rainbow.cpp.

◆ setGuideRate()

bool Rainbow::setGuideRate ( double  rate)
protected

Definition at line 376 of file rainbow.cpp.

◆ setRA()

bool Rainbow::setRA ( double  ra)
protected

Set Target RA.

Definition at line 688 of file rainbow.cpp.

◆ SetSlewRate()

bool Rainbow::SetSlewRate ( int  index)
overrideprotectedvirtual

Set Slew Rate.

Reimplemented from INDI::Telescope.

Definition at line 965 of file rainbow.cpp.

◆ SetTrackEnabled()

bool Rainbow::SetTrackEnabled ( bool  enabled)
overrideprotectedvirtual

Tracking Functions.

Reimplemented from INDI::Telescope.

Definition at line 341 of file rainbow.cpp.

◆ SetTrackMode()

bool Rainbow::SetTrackMode ( uint8_t  mode)
overrideprotectedvirtual

Set Track Mode.

Reimplemented from INDI::Telescope.

Definition at line 944 of file rainbow.cpp.

◆ slewToEquatorialCoords()

bool Rainbow::slewToEquatorialCoords ( double  ra,
double  de 
)
protected

Slew to Equatorial Coordinates.

Definition at line 728 of file rainbow.cpp.

◆ split()

std::vector< std::string > Rainbow::split ( const std::string &  input,
const std::string &  regex 
)
protected

Definition at line 1535 of file rainbow.cpp.

◆ Sync()

bool Rainbow::Sync ( double  ra,
double  dec 
)
overrideprotectedvirtual

Sync.

Reimplemented from INDI::Telescope.

Definition at line 923 of file rainbow.cpp.

◆ UnPark()

bool Rainbow::UnPark ( )
overrideprotectedvirtual

Unparking.

Reimplemented from INDI::Telescope.

Definition at line 445 of file rainbow.cpp.

◆ updateLocation()

bool Rainbow::updateLocation ( double  latitude,
double  longitude,
double  elevation 
)
overrideprotectedvirtual

Location & Time.

Reimplemented from INDI::Telescope.

Definition at line 278 of file rainbow.cpp.

◆ updateProperties()

bool Rainbow::updateProperties ( )
overrideprotectedvirtual

Called when connected state changes, to add/remove properties.

Reimplemented from INDI::Telescope.

Definition at line 100 of file rainbow.cpp.


The documentation for this class was generated from the following files: