|
Instrument Neutral Distributed Interface INDI 2.2.5
|
The SensorDevice class provides functionality of a Sensor Device within a Sensor. More...
#include <indisensorinterface.h>
Public Types | |
| enum | { SENSOR_CAN_ABORT = 1 << 0 , SENSOR_HAS_STREAMING = 1 << 1 , SENSOR_HAS_SHUTTER = 1 << 2 , SENSOR_HAS_COOLER = 1 << 3 , SENSOR_HAS_DSP = 1 << 4 , SENSOR_MAX_CAPABILITY = 1 << 5 } |
| enum | { CONNECTION_NONE = 1 << 0 , CONNECTION_SERIAL = 1 << 1 , CONNECTION_TCP = 1 << 2 } |
Public Types inherited from INDI::ParentDevice | |
| enum | Type { Valid , Invalid } |
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 | WATCH { WATCH_NEW = 0 , WATCH_UPDATE , WATCH_NEW_OR_UPDATE } |
| 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) , OUTPUT_INTERFACE = (1 << 16) , INPUT_INTERFACE = (1 << 17) , POWER_INTERFACE = (1 << 18) , IMU_INTERFACE = (1 << 19) , PAC_INTERFACE = (1 << 20) , 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 | |
| SensorInterface () | |
| ~SensorInterface () | |
| bool | initProperties () |
| Initialize properties initial state and value. The child class must implement this function. | |
| bool | updateProperties () |
| updateProperties is called whenever there is a change in the CONNECTION status of the driver. This will enable the driver to react to changes of switching ON/OFF a device. For example, a driver may only define a set of properties after a device is connected, but not before. | |
| bool | processNumber (const char *dev, const char *name, double values[], char *names[], int n) |
| void | processProperties (const char *dev) |
| bool | processText (const char *dev, const char *name, char *texts[], char *names[], int n) |
| bool | processSwitch (const char *dev, const char *name, ISState states[], char *names[], int n) |
| bool | processBLOB (const char *dev, const char *name, int sizes[], int blobsizes[], char *blobs[], char *formats[], char *names[], int n) |
| bool | processSnoopDevice (XMLEle *root) |
| int | getBufferSize () const |
| getContinuumBufferSize Get allocated continuum buffer size to hold the Sensor integrationd stream. | |
| double | getIntegrationLeft () const |
| getIntegrationLeft Get Integration time left in seconds. | |
| double | getIntegrationTime () const |
| getIntegrationTime Get requested Integration duration for the Sensor device in seconds. | |
| const char * | getIntegrationStartTime () |
| getIntegrationStartTime | |
| uint8_t * | getBuffer () |
| getBuffer Get continuum buffer of the stream of the Sensor device. | |
| void | setBuffer (uint8_t *buffer) |
| setBuffer Set continuum frame buffer pointer. | |
| uint8_t * | getReal () |
| getBuffer Get real buffer of the stream of the Sensor device. | |
| void | setReal (uint8_t *buffer) |
| setBuffer Set real frame buffer pointer. | |
| uint8_t * | getImaginary () |
| getBuffer Get imaginary buffer of the stream of the Sensor device. | |
| void | setImaginary (uint8_t *buffer) |
| setBuffer Set imaginary frame buffer pointer. | |
| uint8_t * | getMagnitude () |
| getBuffer Get magnitude buffer of the stream of the Sensor device. | |
| void | setMagnitude (uint8_t *buffer) |
| setBuffer Set magnitude frame buffer pointer. | |
| uint8_t * | getPhase () |
| getBuffer Get phase buffer of the stream of the Sensor device. | |
| void | setPhase (uint8_t *buffer) |
| setBuffer Set phase frame buffer pointer. | |
| int | getBPS () const |
| getBPS Get Sensor depth (bits per sample). | |
| virtual void | setMinMaxStep (const char *property, const char *element, double min, double max, double step, bool sendToClient=true) |
| setMinMaxStep for a number property element | |
| void | setBufferSize (int nbuf, bool allocMem=true) |
| setBufferSize Set desired buffer size. The function will allocate memory accordingly. The frame size depends on the desired integration time, sampling frequency, and sample depth of the Sensor device (bps). You must set the frame size any time any of the prior parameters gets updated. | |
| void | setBPS (int bps) |
| setBPP Set depth of Sensor device. | |
| void | setIntegrationTime (double duration) |
| setIntegrationTime Set desired Sensor frame Integration duration for next Integration. You must call this function immediately before starting the actual Integration as it is used to calculate the timestamp used for the FITS header. | |
| void | setIntegrationLeft (double duration) |
| setIntegrationLeft Update Integration time left. Inform the client of the new Integration time left value. | |
| void | setIntegrationFailed () |
| setIntegrationFailed Alert the client that the Integration failed. | |
| int | getNAxis () const |
| void | setNAxis (int value) |
| setNAxis Set FITS number of axis | |
| void | setIntegrationFileExtension (const char *ext) |
| setIntegrationExtension Set integration extension | |
| char * | getIntegrationFileExtension () |
| bool | isCapturing () const |
| virtual int | SetTemperature (double temperature) |
| Set Sensor temperature. | |
| virtual bool | StartStreaming () |
| StartStreaming Start live video streaming. | |
| virtual bool | StopStreaming () |
| StopStreaming Stop live video streaming. | |
| virtual bool | StartIntegration (double duration) |
| Start integration from the Sensor device. | |
| virtual bool | IntegrationComplete () |
| Uploads target Device exposed buffer as FITS to the client. Derived classes should class this function when an Integration is complete. | |
| virtual bool | Handshake () |
| perform handshake with device to check communication | |
| void | setSensorConnection (const uint8_t &value) |
| setSensorConnection Set Sensor connection mode. Child class should call this in the constructor before Sensor registers any connection interfaces | |
| uint8_t | getSensorConnection () |
| virtual void | addFITSKeywords (fitsfile *fptr, uint8_t *buf, int len) |
| Add FITS keywords to a fits file. | |
| void | fits_update_key_s (fitsfile *fptr, int type, std::string name, void *p, std::string explanation, int *status) |
| int | getPortFD () |
| Connection::Serial * | getSerialConnection () |
| Connection::TCP * | getTcpConnection () |
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 void | TimerHit () |
| Callback function to be called once SetTimer duration elapses. | |
| 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 void | ISGetProperties (const char *dev) |
| 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 | ISNewSwitch (const char *dev, const char *name, ISState *states, char *names[], int n) |
| Process the client newSwitch command. | |
| virtual bool | ISNewNumber (const char *dev, const char *name, double values[], char *names[], int n) |
| Process the client newNumber command. | |
| virtual bool | ISNewText (const char *dev, const char *name, char *texts[], char *names[], int n) |
| Process the client newSwitch command. | |
| 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. | |
| virtual bool | ISSnoopDevice (XMLEle *root) |
| Process a snoop event from INDI server. This function is called when a snooped property is updated in a snooped driver. | |
| bool | ISNewProperty (INDI::Property &property, const std::string &elementName, const std::any &value) |
| Generic convenience function to update a property element as if by client request, simulating an ISNew... call. | |
| template<typename PropertyType , typename ValueType > | |
| bool | updateProperty (PropertyType &property, ValueType *values, char *names[], int n, std::function< bool()> updater, bool saveConfig=false) |
| Generic helper function to update an INDI property based on an external operation. | |
| uint32_t | getDriverInterface () const |
| void | setDriverInterface (uint32_t value) |
| setInterface Set driver interface. By default the driver interface is set to GENERAL_DEVICE. You may send an ORed list of DeviceInterface values. | |
| void | watchDevice (const char *deviceName, const std::function< void(INDI::BaseDevice)> &callback) |
| Add a device to the watch list. | |
Public Member Functions inherited from INDI::ParentDevice | |
| ParentDevice (Type type) | |
| ~ParentDevice () | |
| ParentDevice (ParentDevice &&other)=default | |
| ParentDevice & | operator= (ParentDevice &&other)=default |
Public Member Functions inherited from INDI::BaseDevice | |
| BaseDevice () | |
| virtual | ~BaseDevice () |
| void | registerProperty (const INDI::Property &property) |
| Register the property to be able to observe and update. | |
| void | registerProperty (const INDI::Property &property, INDI_PROPERTY_TYPE type) |
| int | removeProperty (const char *name, char *errmsg) |
| Remove a property. | |
| void | watchProperty (const char *name, const std::function< void(INDI::Property)> &callback, WATCH watch=WATCH_NEW) |
| Call the callback function if property is available. | |
| Property | getProperty (const char *name, INDI_PROPERTY_TYPE type=INDI_UNKNOWN) const |
| Return a property and its type given its name. | |
| Properties | getProperties () |
| Return a list of all properties in the device. | |
| const Properties | getProperties () const |
| INDI::PropertyNumber | getNumber (const char *name) const |
| INDI::PropertyText | getText (const char *name) const |
| INDI::PropertySwitch | getSwitch (const char *name) const |
| INDI::PropertyLight | getLight (const char *name) const |
| INDI::PropertyBlob | getBLOB (const char *name) const |
| IPState | getPropertyState (const char *name) const |
| IPerm | getPropertyPermission (const char *name) const |
| void * | getRawProperty (const char *name, INDI_PROPERTY_TYPE type=INDI_UNKNOWN) const |
| Return a property and its type given its name. | |
| void | addMessage (const std::string &msg) |
| Add message to the driver's message queue. | |
| void | checkMessage (XMLEle *root) |
| void | doMessage (XMLEle *msg) |
| const std::string & | messageQueue (size_t index) const |
| const std::string & | lastMessage () const |
| bool | isValid () const |
| bool | isSameDevice (const BaseDevice &other) const |
| bool | isConnected () const |
| void | attach () |
| indicates that the device is ready | |
| void | detach () |
| indicates that the device is being removed | |
| void | setMediator (INDI::BaseMediator *mediator) |
| Set the driver's mediator to receive notification of news devices and updated property values. | |
| INDI::BaseMediator * | getMediator () const |
| void | setDeviceName (const char *dev) |
| Set the device name. | |
| const char * | getDeviceName () const |
| bool | isDeviceNameMatch (const char *otherName) const |
| Check that the device name matches the argument. | |
| bool | isDeviceNameMatch (const std::string &otherName) const |
| Check that the device name matches the argument. | |
| const char * | getDriverName () const |
| const char * | getDriverExec () const |
| const char * | getDriverVersion () const |
| uint16_t | getDriverInterface () const |
| getDriverInterface returns ORed values of DRIVER_INTERFACE. It presents the device classes supported by the driver. | |
| bool | buildSkeleton (const char *filename) |
| Build driver properties from a skeleton file. | |
| int | buildProp (const INDI::LilXmlElement &root, char *errmsg, bool isDynamic=false) |
| Build a property given the supplied XML element (defXXX) | |
| int | setValue (const INDI::LilXmlElement &root, char *errmsg) |
| handle SetXXX commands from client | |
| operator BaseDevice * () | |
| BaseDevice * | operator-> () |
| bool | operator!= (std::nullptr_t) const |
| bool | operator== (std::nullptr_t) const |
| operator bool () const | |
| operator bool () | |
Public Attributes | |
| enum INDI::SensorInterface:: { ... } | SensorCapability |
| enum INDI::SensorInterface:: { ... } | SensorConnection |
Protected Types | |
| enum | { TELESCOPE_PRIMARY } |
| enum | { UPLOAD_DIR , UPLOAD_PREFIX } |
| enum | { FITS_OBSERVER , FITS_OBJECT } |
Protected Member Functions | |
| bool | HasShutter () const |
| bool | HasCooler () const |
| bool | CanAbort () const |
| bool | HasDSP () |
| bool | HasStreaming () |
| uint32_t | GetCapability () const |
| GetCapability returns the Sensor capabilities. | |
| void | SetCapability (uint32_t cap) |
| SetCapability Set the Sensor capabilities. Al fields must be initialized. | |
| virtual bool | AbortIntegration () |
| Abort ongoing Integration. | |
| virtual bool | saveConfigItems (FILE *fp) |
| saveConfigItems Save configuration items in XML file. | |
| virtual void | activeDevicesUpdated () |
| activeDevicesUpdated Inform children that ActiveDevices property was updated so they can snoop on the updated devices if desired. | |
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. | |
| virtual const char * | getDefaultName ()=0 |
| 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) | |
Friends | |
| class | StreamManager |
| Misc. | |
| class | StreamManagerPrivate |
Additional Inherited Members | |
Static Public Member Functions inherited from INDI::BaseDevice | |
| static std::string | getSharedFilePath (std::string fileName) |
The SensorDevice class provides functionality of a Sensor Device within a Sensor.
Definition at line 68 of file indisensorinterface.h.
| anonymous enum |
| Enumerator | |
|---|---|
| SENSOR_CAN_ABORT | Can the Sensor Integration be aborted? |
| SENSOR_HAS_STREAMING | Does the Sensor supports streaming? |
| SENSOR_HAS_SHUTTER | Does the Sensor have a mechanical shutter? |
| SENSOR_HAS_COOLER | Does the Sensor have a cooler and temperature control? |
| SENSOR_HAS_DSP | |
| SENSOR_MAX_CAPABILITY | Does the Sensor have a cooler and temperature control? |
Definition at line 72 of file indisensorinterface.h.
| anonymous enum |
| Enumerator | |
|---|---|
| CONNECTION_NONE | |
| CONNECTION_SERIAL | Do not use any connection plugin |
| CONNECTION_TCP | For regular serial and bluetooth connections |
Definition at line 90 of file indisensorinterface.h.
|
protected |
| Enumerator | |
|---|---|
| TELESCOPE_PRIMARY | |
Definition at line 577 of file indisensorinterface.h.
|
protected |
| Enumerator | |
|---|---|
| UPLOAD_DIR | |
| UPLOAD_PREFIX | |
Definition at line 591 of file indisensorinterface.h.
|
protected |
| Enumerator | |
|---|---|
| FITS_OBSERVER | |
| FITS_OBJECT | |
Definition at line 603 of file indisensorinterface.h.
| INDI::SensorInterface::SensorInterface | ( | ) |
Definition at line 49 of file indisensorinterface.cpp.
| INDI::SensorInterface::~SensorInterface | ( | ) |
Definition at line 83 of file indisensorinterface.cpp.
|
protectedvirtual |
Abort ongoing Integration.
Reimplemented in RTLSDR, RadioSim, and SimpleReceiver.
Definition at line 636 of file indisensorinterface.cpp.
|
inlineprotectedvirtual |
activeDevicesUpdated Inform children that ActiveDevices property was updated so they can snoop on the updated devices if desired.
Definition at line 643 of file indisensorinterface.h.
|
virtual |
Add FITS keywords to a fits file.
| fptr | pointer to a valid FITS file. |
| buf | The buffer of the fits contents. |
| len | The length of the buffer. |
To add additional information, override this function in the child class and ensure to call SensorInterface::addFITSKeywords.
Reimplemented in INDI::Detector, INDI::Receiver, and INDI::Spectrograph.
Definition at line 642 of file indisensorinterface.cpp.
|
inlineprotected |
Definition at line 503 of file indisensorinterface.h.
| void INDI::SensorInterface::fits_update_key_s | ( | fitsfile * | fptr, |
| int | type, | ||
| std::string | name, | ||
| void * | p, | ||
| std::string | explanation, | ||
| int * | status | ||
| ) |
A function to just remove GCC warnings about deprecated conversion
Definition at line 769 of file indisensorinterface.cpp.
|
inline |
getBPS Get Sensor depth (bits per sample).
Definition at line 290 of file indisensorinterface.h.
|
inline |
getBuffer Get continuum buffer of the stream of the Sensor device.
Definition at line 144 of file indisensorinterface.h.
|
inline |
getContinuumBufferSize Get allocated continuum buffer size to hold the Sensor integrationd stream.
Definition at line 111 of file indisensorinterface.h.
|
inlineprotected |
GetCapability returns the Sensor capabilities.
Definition at line 544 of file indisensorinterface.h.
|
inline |
getBuffer Get imaginary buffer of the stream of the Sensor device.
Definition at line 200 of file indisensorinterface.h.
|
inline |
Definition at line 364 of file indisensorinterface.h.
|
inline |
getIntegrationLeft Get Integration time left in seconds.
Definition at line 120 of file indisensorinterface.h.
| const char * INDI::SensorInterface::getIntegrationStartTime | ( | ) |
getIntegrationStartTime
Definition at line 601 of file indisensorinterface.cpp.
|
inline |
getIntegrationTime Get requested Integration duration for the Sensor device in seconds.
Definition at line 129 of file indisensorinterface.h.
|
inline |
getBuffer Get magnitude buffer of the stream of the Sensor device.
Definition at line 234 of file indisensorinterface.h.
| int INDI::SensorInterface::getNAxis | ( | ) | const |
Definition at line 618 of file indisensorinterface.cpp.
|
inline |
getBuffer Get phase buffer of the stream of the Sensor device.
Definition at line 262 of file indisensorinterface.h.
|
inline |
Return the connection file descriptor
Definition at line 465 of file indisensorinterface.h.
|
inline |
getBuffer Get real buffer of the stream of the Sensor device.
Definition at line 166 of file indisensorinterface.h.
|
inline |
Definition at line 436 of file indisensorinterface.h.
|
inline |
Export the serial connection object
Definition at line 471 of file indisensorinterface.h.
|
inline |
Export the TCP connection object
Definition at line 477 of file indisensorinterface.h.
|
virtual |
perform handshake with device to check communication
Reimplemented in RTLSDR.
Definition at line 1289 of file indisensorinterface.cpp.
|
inlineprotected |
Definition at line 495 of file indisensorinterface.h.
|
inlineprotected |
Definition at line 511 of file indisensorinterface.h.
|
inlineprotected |
Definition at line 487 of file indisensorinterface.h.
|
inlineprotected |
Definition at line 527 of file indisensorinterface.h.
|
virtual |
Initialize properties initial state and value. The child class must implement this function.
Reimplemented from INDI::DefaultDevice.
Reimplemented in SimpleReceiver, and INDI::Spectrograph.
Definition at line 393 of file indisensorinterface.cpp.
|
virtual |
Uploads target Device exposed buffer as FITS to the client. Derived classes should class this function when an Integration is complete.
| targetDevice | device that contains upload integration data |
Definition at line 894 of file indisensorinterface.cpp.
|
inline |
Definition at line 372 of file indisensorinterface.h.
| bool INDI::SensorInterface::processBLOB | ( | const char * | dev, |
| const char * | name, | ||
| int | sizes[], | ||
| int | blobsizes[], | ||
| char * | blobs[], | ||
| char * | formats[], | ||
| char * | names[], | ||
| int | n | ||
| ) |
Definition at line 384 of file indisensorinterface.cpp.
| bool INDI::SensorInterface::processNumber | ( | const char * | dev, |
| const char * | name, | ||
| double | values[], | ||
| char * | names[], | ||
| int | n | ||
| ) |
Definition at line 245 of file indisensorinterface.cpp.
| void INDI::SensorInterface::processProperties | ( | const char * | dev | ) |
Definition at line 150 of file indisensorinterface.cpp.
| bool INDI::SensorInterface::processSnoopDevice | ( | XMLEle * | root | ) |
Definition at line 164 of file indisensorinterface.cpp.
| bool INDI::SensorInterface::processSwitch | ( | const char * | dev, |
| const char * | name, | ||
| ISState | states[], | ||
| char * | names[], | ||
| int | n | ||
| ) |
Definition at line 313 of file indisensorinterface.cpp.
| bool INDI::SensorInterface::processText | ( | const char * | dev, |
| const char * | name, | ||
| char * | texts[], | ||
| char * | names[], | ||
| int | n | ||
| ) |
Definition at line 189 of file indisensorinterface.cpp.
|
protectedvirtual |
saveConfigItems Save configuration items in XML file.
| fp | pointer to file to write to |
Reimplemented from INDI::DefaultDevice.
Definition at line 1080 of file indisensorinterface.cpp.
| void INDI::SensorInterface::setBPS | ( | int | bps | ) |
setBPP Set depth of Sensor device.
| bpp | bits per pixel |
Definition at line 1275 of file indisensorinterface.cpp.
|
inline |
setBuffer Set continuum frame buffer pointer.
| buffer | pointer to flux buffer /note Sensor Device allocates the frame buffer internally once SetBufferSize is called with allocMem set to true which is the default behavior. If you allocated the memory yourself (i.e. allocMem is false), then you must call this function to set the pointer to the raw frame buffer. |
Definition at line 157 of file indisensorinterface.h.
| void INDI::SensorInterface::setBufferSize | ( | int | nbuf, |
| bool | allocMem = true |
||
| ) |
setBufferSize Set desired buffer size. The function will allocate memory accordingly. The frame size depends on the desired integration time, sampling frequency, and sample depth of the Sensor device (bps). You must set the frame size any time any of the prior parameters gets updated.
| nbuf | size of buffer in bytes. |
| allocMem | if True, it will allocate memory of nbut size bytes. |
Definition at line 550 of file indisensorinterface.cpp.
|
protected |
SetCapability Set the Sensor capabilities. Al fields must be initialized.
| cap | pointer to SensorCapability struct. |
Definition at line 518 of file indisensorinterface.cpp.
|
inline |
setBuffer Set imaginary frame buffer pointer.
| buffer | pointer to imaginary buffer /note Sensor Device allocates the frame buffer internally once SetBufferSize is called with allocMem set to true which is the default behavior. If you allocated the memory yourself (i.e. allocMem is false), then you must call this function to set the pointer to the raw frame buffer. |
Definition at line 213 of file indisensorinterface.h.
| void INDI::SensorInterface::setIntegrationFailed | ( | ) |
setIntegrationFailed Alert the client that the Integration failed.
Definition at line 612 of file indisensorinterface.cpp.
| void INDI::SensorInterface::setIntegrationFileExtension | ( | const char * | ext | ) |
setIntegrationExtension Set integration extension
| ext | extension (fits, jpeg, raw..etc) |
Definition at line 628 of file indisensorinterface.cpp.
| void INDI::SensorInterface::setIntegrationLeft | ( | double | duration | ) |
setIntegrationLeft Update Integration time left. Inform the client of the new Integration time left value.
| duration | Integration duration left in seconds. |
Definition at line 585 of file indisensorinterface.cpp.
| void INDI::SensorInterface::setIntegrationTime | ( | double | duration | ) |
setIntegrationTime Set desired Sensor frame Integration duration for next Integration. You must call this function immediately before starting the actual Integration as it is used to calculate the timestamp used for the FITS header.
| duration | Integration duration in seconds. |
Definition at line 592 of file indisensorinterface.cpp.
|
inline |
setBuffer Set magnitude frame buffer pointer.
| buffer | pointer to magnitude buffer /note Sensor Device allocates the frame buffer internally once SetBufferSize is called with allocMem set to true which is the default behavior. If you allocated the memory yourself (i.e. allocMem is false), then you must call this function to set the pointer to the raw frame buffer. |
Definition at line 247 of file indisensorinterface.h.
|
virtual |
setMinMaxStep for a number property element
| property | Property name |
| element | Element name |
| min | Minimum element value |
| max | Maximum element value |
| step | Element step value |
| sendToClient | If true (default), the element limits are updated and is sent to the client. If false, the element limits are updated without getting sent to the client. |
Reimplemented in INDI::Correlator, INDI::Detector, INDI::Receiver, and INDI::Spectrograph.
Definition at line 528 of file indisensorinterface.cpp.
| void INDI::SensorInterface::setNAxis | ( | int | value | ) |
setNAxis Set FITS number of axis
| value | number of axis |
Definition at line 623 of file indisensorinterface.cpp.
|
inline |
setBuffer Set phase frame buffer pointer.
| buffer | pointer to phase buffer /note Sensor Device allocates the frame buffer internally once SetBufferSize is called with allocMem set to true which is the default behavior. If you allocated the memory yourself (i.e. allocMem is false), then you must call this function to set the pointer to the raw frame buffer. |
Definition at line 275 of file indisensorinterface.h.
|
inline |
setBuffer Set real frame buffer pointer.
| buffer | pointer to real buffer /note Sensor Device allocates the frame buffer internally once SetBufferSize is called with allocMem set to true which is the default behavior. If you allocated the memory yourself (i.e. allocMem is false), then you must call this function to set the pointer to the raw frame buffer. |
Definition at line 179 of file indisensorinterface.h.
| void INDI::SensorInterface::setSensorConnection | ( | const uint8_t & | value | ) |
setSensorConnection Set Sensor connection mode. Child class should call this in the constructor before Sensor registers any connection interfaces
| value | ORed combination of SensorConnection values. |
Definition at line 1308 of file indisensorinterface.cpp.
|
virtual |
Set Sensor temperature.
| temperature | Sensor temperature in degrees celsius. |
Reimplemented in SimpleReceiver.
Definition at line 1073 of file indisensorinterface.cpp.
|
virtual |
Start integration from the Sensor device.
| duration | Duration in seconds |
Reimplemented in RTLSDR, RadioSim, SimpleReceiver, INDI::Correlator, INDI::Detector, INDI::Receiver, and INDI::Spectrograph.
Definition at line 578 of file indisensorinterface.cpp.
|
virtual |
StartStreaming Start live video streaming.
Reimplemented in RTLSDR, and RadioSim.
Definition at line 1061 of file indisensorinterface.cpp.
|
virtual |
StopStreaming Stop live video streaming.
Reimplemented in RTLSDR, and RadioSim.
Definition at line 1067 of file indisensorinterface.cpp.
|
virtual |
updateProperties is called whenever there is a change in the CONNECTION status of the driver. This will enable the driver to react to changes of switching ON/OFF a device. For example, a driver may only define a set of properties after a device is connected, but not before.
Reimplemented from INDI::DefaultDevice.
Reimplemented in SimpleReceiver, and INDI::Spectrograph.
Definition at line 99 of file indisensorinterface.cpp.
|
friend |
Misc.
Definition at line 393 of file indisensorinterface.h.
|
friend |
Definition at line 394 of file indisensorinterface.h.
|
protected |
Definition at line 568 of file indisensorinterface.h.
|
protected |
Definition at line 567 of file indisensorinterface.h.
|
protected |
Definition at line 573 of file indisensorinterface.h.
|
protected |
Definition at line 572 of file indisensorinterface.h.
|
protected |
Definition at line 630 of file indisensorinterface.h.
|
protected |
Definition at line 562 of file indisensorinterface.h.
|
protected |
Definition at line 582 of file indisensorinterface.h.
|
protected |
Definition at line 583 of file indisensorinterface.h.
|
protected |
Definition at line 620 of file indisensorinterface.h.
|
protected |
Definition at line 649 of file indisensorinterface.h.
|
protected |
Definition at line 652 of file indisensorinterface.h.
|
protected |
Definition at line 624 of file indisensorinterface.h.
|
protected |
Definition at line 619 of file indisensorinterface.h.
|
protected |
Definition at line 618 of file indisensorinterface.h.
|
protected |
Definition at line 575 of file indisensorinterface.h.
|
protected |
Definition at line 576 of file indisensorinterface.h.
|
protected |
Definition at line 570 of file indisensorinterface.h.
|
protected |
Definition at line 571 of file indisensorinterface.h.
|
protected |
Definition at line 601 of file indisensorinterface.h.
|
protected |
Definition at line 602 of file indisensorinterface.h.
|
protected |
Definition at line 565 of file indisensorinterface.h.
|
protected |
Definition at line 564 of file indisensorinterface.h.
|
protected |
Definition at line 616 of file indisensorinterface.h.
|
protected |
Definition at line 634 of file indisensorinterface.h.
|
protected |
Definition at line 624 of file indisensorinterface.h.
|
protected |
Definition at line 623 of file indisensorinterface.h.
|
protected |
Definition at line 622 of file indisensorinterface.h.
|
protected |
Definition at line 624 of file indisensorinterface.h.
|
protected |
Definition at line 637 of file indisensorinterface.h.
|
protected |
For Serial & TCP connections.
Definition at line 657 of file indisensorinterface.h.
|
protected |
Definition at line 628 of file indisensorinterface.h.
|
protected |
Definition at line 628 of file indisensorinterface.h.
|
protected |
Definition at line 620 of file indisensorinterface.h.
|
protected |
Definition at line 627 of file indisensorinterface.h.
|
protected |
Definition at line 626 of file indisensorinterface.h.
|
protected |
Definition at line 631 of file indisensorinterface.h.
| enum { ... } INDI::SensorInterface::SensorCapability |
| enum { ... } INDI::SensorInterface::SensorConnection |
|
protected |
Definition at line 653 of file indisensorinterface.h.
|
protected |
Definition at line 632 of file indisensorinterface.h.
|
protected |
Definition at line 651 of file indisensorinterface.h.
|
protected |
Definition at line 654 of file indisensorinterface.h.
|
protected |
Definition at line 597 of file indisensorinterface.h.
|
protected |
Definition at line 598 of file indisensorinterface.h.
|
protected |
Definition at line 645 of file indisensorinterface.h.
|
protected |
Definition at line 646 of file indisensorinterface.h.
|
protected |
Definition at line 586 of file indisensorinterface.h.
|
protected |
Definition at line 589 of file indisensorinterface.h.
|
protected |
Definition at line 590 of file indisensorinterface.h.
|
protected |
Definition at line 587 of file indisensorinterface.h.