/usr/include/libindi/indiguiderinterface.h is in libindi-dev 1.7.1-0ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 | /*
Guider Interface
Copyright (C) 2011 Jasem Mutlaq (mutlaqja@ikarustech.com)
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public
License as published by the Free Software Foundation; either
version 2.1 of the License, or (at your option) any later version.
This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public
License along with this library; if not, write to the Free Software
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
*/
#pragma once
#include "indibase.h"
/**
* @class GuiderInterface
* @brief Provides interface to implement guider (ST4) port functionality.
*
* The child class implements GuideXXXX() functions and returns:
* IPS_OK if the guide operation is completed in the function, which is usually appropriate for
* very short guiding pulses.
* IPS_BUSY if the guide operation is in progress and will take time to complete. In this
* case, the child class must call GuideComplete() once the guiding pulse is complete.
* IPS_ALERT if the guide operation failed.
*
* \e IMPORTANT: initGuiderProperties() must be called before any other function to initialize
* the guider properties.
* \e IMPORATNT: processGuiderProperties() must be called in your driver's ISNewNumber(..)
* function. processGuiderProperties() will call the guide functions
* GuideXXXX functions according to the driver.
*
* @author Jasem Mutlaq
*/
namespace INDI
{
class GuiderInterface
{
public:
/**
* @brief Guide north for ms milliseconds. North is defined as DEC+
* @return IPS_OK if operation is completed successfully, IPS_BUSY if operation will take take to
* complete, or IPS_ALERT if operation failed.
*/
virtual IPState GuideNorth(float ms) = 0;
/**
* @brief Guide south for ms milliseconds. South is defined as DEC-
* @return IPS_OK if operation is completed successfully, IPS_BUSY if operation will take take to
* complete, or IPS_ALERT if operation failed.
*/
virtual IPState GuideSouth(float ms) = 0;
/**
* @brief Guide east for ms milliseconds. East is defined as RA+
* @return IPS_OK if operation is completed successfully, IPS_BUSY if operation will take take to
* complete, or IPS_ALERT if operation failed.
*/
virtual IPState GuideEast(float ms) = 0;
/**
* @brief Guide west for ms milliseconds. West is defined as RA-
* @return IPS_OK if operation is completed successfully, IPS_BUSY if operation will take take to
* complete, or IPS_ALERT if operation failed.
*/
virtual IPState GuideWest(float ms) = 0;
/**
* @brief Call GuideComplete once the guiding pulse is complete.
* @param axis Axis of completed guiding operation.
*/
virtual void GuideComplete(INDI_EQ_AXIS axis);
protected:
GuiderInterface();
~GuiderInterface();
/**
* @brief Initilize guider properties. It is recommended to call this function within
* initProperties() of your primary device
* @param deviceName Name of the primary device
* @param groupName Group or tab name to be used to define guider properties.
*/
void initGuiderProperties(const char *deviceName, const char *groupName);
/**
* @brief 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.
* @param name device name
* @param values value as passed by the client
* @param names names as passed by the client
* @param n number of values and names pair to process.
*/
void processGuiderProperties(const char *name, double values[], char *names[], int n);
INumber GuideNSN[2];
INumberVectorProperty GuideNSNP;
INumber GuideWEN[2];
INumberVectorProperty GuideWENP;
};
}
|