kstars
indidevapi.h File Reference
Interface to the reference INDI C API device implementation on the Device Driver side. More...
#include "indiapi.h"
Include dependency graph for indidevapi.h:
This graph shows which files directly or indirectly include this file:
Go to the source code of this file.
Typedefs | |
typedef void( | IE_CBF )(int readfiledes, void *userpointer) |
typedef void( | IE_TCF )(void *userpointer) |
typedef void( | IE_WPF )(void *userpointer) |
Functions | |
void | fillNumber (INumber *np, const char *name, const char *label, const char *format, double min, double max, double step, double value) |
void | fillNumberVector (INumberVectorProperty *nvp, INumber *np, int nnp, const char *dev, const char *name, const char *label, const char *group, IPerm p, double timeout, IPState s) |
void | fillSwitch (ISwitch *sp, const char *name, const char *label, ISState s) |
void | fillSwitchVector (ISwitchVectorProperty *svp, ISwitch *sp, int nsp, const char *dev, const char *name, const char *label, const char *group, IPerm p, ISRule r, double timeout, IPState s) |
void | fillText (IText *tp, const char *name, const char *label, const char *initialText) |
void | fillTextVector (ITextVectorProperty *tvp, IText *tp, int ntp, const char *dev, const char *name, const char *label, const char *group, IPerm p, double timeout, IPState s) |
void | IDDefBLOB (const IBLOBVectorProperty *b, const char *msg,...) |
void | IDDefLight (const ILightVectorProperty *l, const char *msg,...) |
void | IDDefNumber (const INumberVectorProperty *n, const char *msg,...) |
void | IDDefSwitch (const ISwitchVectorProperty *s, const char *msg,...) |
void | IDDefText (const ITextVectorProperty *t, const char *msg,...) |
void | IDDelete (const char *dev, const char *name, const char *msg,...) |
void | IDLog (const char *msg,...) |
void | IDMessage (const char *dev, const char *msg,...) |
void | IDSetBLOB (const IBLOBVectorProperty *b, const char *msg,...) |
void | IDSetLight (const ILightVectorProperty *l, const char *msg,...) |
void | IDSetNumber (const INumberVectorProperty *n, const char *msg,...) |
void | IDSetSwitch (const ISwitchVectorProperty *s, const char *msg,...) |
void | IDSetText (const ITextVectorProperty *t, const char *msg,...) |
int | IEAddCallback (int readfiledes, IE_CBF *fp, void *userpointer) |
int | IEAddTimer (int millisecs, IE_TCF *fp, void *userpointer) |
int | IEAddWorkProc (IE_WPF *fp, void *userpointer) |
void | IERmCallback (int callbackid) |
void | IERmTimer (int timerid) |
void | IERmWorkProc (int workprocid) |
void | ISGetProperties (const char *dev) |
void | ISNewBLOB (const char *dev, const char *name, int sizes[], char *blobs[], char *formats[], char *names[], int n) |
void | ISNewNumber (const char *dev, const char *name, double *doubles, char *names[], int n) |
void | ISNewSwitch (const char *dev, const char *name, ISState *states, char *names[], int n) |
void | ISNewText (const char *dev, const char *name, char *texts[], char *names[], int n) |
INumber * | IUFindNumber (const INumberVectorProperty *tp, const char *name) |
ISwitch * | IUFindOnSwitch (const ISwitchVectorProperty *tp) |
ISwitch * | IUFindSwitch (const ISwitchVectorProperty *tp, const char *name) |
IText * | IUFindText (const ITextVectorProperty *tp, const char *name) |
void | IUResetSwitches (const ISwitchVectorProperty *svp) |
void | IUSaveText (IText *tp, const char *newtext) |
void | IUUpdateMinMax (INumberVectorProperty *nvp) |
int | IUUpdateNumbers (INumberVectorProperty *nvp, double values[], char *names[], int n) |
int | IUUpdateSwitches (ISwitchVectorProperty *svp, ISState *states, char *names[], int n) |
Detailed Description
Interface to the reference INDI C API device implementation on the Device Driver side.This file is divided into two main sections:
-
Functions the INDI device driver framework defines which the Driver may call:
- IDxxx functions to send messages to an INDI client.
- IExxx functions to implement the event driven model.
- IUxxx functions to perform handy utility functions.
-
Functions the INDI device driver framework calls which the Driver must define:
- ISxxx to respond to messages from a Client.
Definition in file indidevapi.h.
Function Documentation
void IDDelete | ( | const char * | dev, | |
const char * | name, | |||
const char * | msg, | |||
... | ||||
) |
Function Drivers call to inform Clients a Property is no longer available, or the entire device is gone if name is NULL.
- Parameters:
-
dev device name. If device name is NULL, the entire device will be deleted. name property name to be deleted. msg message in printf style to send to the client.
void IDLog | ( | const char * | msg, | |
... | ||||
) |
Function Drivers call to log a message locally.
The message is not sent to any Clients.
- Parameters:
-
msg message in printf style to send to the client.
void IDMessage | ( | const char * | dev, | |
const char * | msg, | |||
... | ||||
) |
Function Drivers call to send log messages to Clients.
If dev is specified the Client shall associate the message with that device; if dev is NULL the Client shall treat the message as generic from no specific Device.
- Parameters:
-
dev device name msg message in printf style to send to the client.
void ISGetProperties | ( | const char * | dev | ) |
Function defined by Drivers that is called when a Client asks for the definitions of all Properties this Driver supports for the given device.
- Parameters:
-
dev the name of the device.
Definition at line 113 of file apmount.cpp.