mytakepic/README-func
2015-07-23 13:51:09 +03:00

158 lines
5.8 KiB
Plaintext
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

// ÐÅÒÅÍÅÎÎÙÅ, ÔÉÐÙ
flidomain_t = METHOD | DEVICE;
// METHOD: FLIDOMAIN_PARALLEL_PORT, FLIDOMAIN_USB, FLIDOMAIN_SERIAL, FLIDOMAIN_INET;
// DEVICE: FLIDEVICE_CAMERA, FLIDOMAIN_FILTERWHEEL, FLIDOMAIN_FOCUSER.
fliframe_t = FLI_FRAME_TYPE_NORMAL ÉÌÉ FLI_FRAME_TYPE_DARK.
flibitdepth_t = FLI_MODE_8BIT ÉÌÉ FLI_MODE_16BIT.
flishutter_t = FLI_SHUTTER_CLOSE, FLI_SHUTTER_OPEN, FLI_SHUTTER_EXTERNAL_TRIGGER,
FLI_SHUTTER_EXTERNAL_TRIGGER_LOW, and FLI_SHUTTER_EXTERNAL_TRIGGER HIGH.
flibgflush_t = FLI_BGFLUSH_STOP and FLI_BGFLUSH_START.
flichannel_t = FLI_TEMPERATURE_INTERNAL and FLI_TEMPERATURE_EXTERNAL.
flidebug_t = FLIDEBUG_NONE, FLIDEBUG_INFO, FLIDEBUG_WARN, and FLIDEBUG_FAIL.
// ÆÕÎËÃÉÉ
LIBFLIAPI FLICancelExposure(flidev_t dev); // ÏÔÍÅÎÁ ÜËÓÐÏÚÉÃÉÉ
// return: 0 - ÕÓÐÅÈ, !0 - ÎÅÕÄÁÞÁ
LIBFLIAPI FLIClose(flidev_t dev); // ÚÁËÒÙÔØ ÕÓÔÒÏÊÓÔ×Ï
LIBFLIAPI FLIGetArrayArea(flidev_t dev,
long* ul_x, long* ul_y, long* lr_x, long* lr_y); // ÐÏÌÕÞÉÔØ ÒÁÚÍÅÒ ÆÒÅÊÍÁ
// ul_x, ul_y - ËÏÏÒÄÉÎÁÔÙ ×ÅÒÈÎÅÇÏ ÌÅ×ÏÇÏ ÕÇÌÁ
// lr_x, lr_y - Ë-ÔÙ ÐÒÁ×ÏÇÏ ÎÉÖÎÅÇÏ ÕÇÌÁ
LIBFLIAPI FLIFlushRow(flidev_t dev, long rows, long repeat); // ÓÂÒÏÓ ÒÑÄÏ×
// rows - ËÏÌ-×Ï ÒÑÄÏ× ÄÌÑ ÓÂÒÏÓÁ, repeat - ÓËÏÌØËÏ ÒÁÚ ÐÏÄÒÑÄ ÓÂÒÏÓÉÔØ
LIBFLIAPI FLIGetFWRevision(flidev_t dev, long* fwrev); // ×ÅÒÓÉÑ ÐÒÏÛÉ×ËÉ
LIBFLIAPI FLIGetHWRevision(flidev_t dev, long* hwrev); // ×ÅÒÓÉÑ ÖÅÌÅÚÁ
// fwrev - ×ÅÒÓÉÑ ÐÒÏÛÉ×ËÉ, hwrev - ×ÅÒÓÉÑ ÖÅÌÅÚÁ
LIBFLIAPI FLIGetLibVersion(char* ver, size_t len); // ×ÅÒÓÉÑ ÂÉÂÌÉÏÔÅËÉ
// ver - ÂÕÆÅÒ ÄÌÑ ×ÅÒÓÉÉ, len - ÅÇÏ ÄÌÉÎÁ
LIBFLIAPI FLIGetModel(flidev_t dev, char* model, size_t len); // ÉÍÑ ÍÏÄÅÌÉ
// model - ÂÕÆÅÒ, len - ÅÇÏ ÄÌÉÎÁ
LIBFLIAPI FLIGetPixelSize(flidev_t dev,
double* pixel x, double* pixel y); // ÒÁÚÍÅÒ ÐÉËÓÅÌÑ × ÍËÍ
LIBFLIAPI FLIGetVisibleArea(flidev_t dev,
long* ul_x, long* ul_y, long* lr_x, long* lr_y); // Ò-Ò ×ÉÄÉÍÏÊ ÏÂÌÁÓÔÉ
// Ë-ÔÙ ÁÎÁÌÏÇÉÞÎÏ FLIGetArrayArea
LIBFLIAPI FLIOpen(flidev_t* dev, char* name, flidomain_t domain); // ÏÔËÒÙÔØ
// name - ÉÍÑ ÉÝ FLIList()
LIBFLIAPI FLISetDebugLevel(char* host, flidebug_t level); // ÕÒÏ×ÅÎØ ÏÔÌÁÄËÉ
// host ÉÇÎÏÒÉÒÕÅÔÓÑ
LIBFLIAPI FLISetExposureTime(flidev_t dev, long exptime); // ×ÒÅÍÑ ÜËÓÐÏÚÉÃÉÉ
// exptime - × ÍÉÌÌÉÓÅËÕÎÄÁÈ
LIBFLIAPI FLISetHBin(flidev_t dev, long hbin); // ÇÏÒÉÚ. ÂÉÎÎÉÎÇ
LIBFLIAPI FLISetVBin(flidev_t dev, long vbin); // ×ÅÒÔ. ÂÉÎÎÉÎÇ
// hbin = 1..16, vbin = 1..16
LIBFLIAPI FLISetFrameType(flidev_t dev, fliframe_t frametype); // ÔÅÍÎÏ×ÏÊ ÉÌÉ ÏÂÙÞÎÙÊ
LIBFLIAPI FLISetImageArea(flidev_t dev,
long ul_x, long ul_y, long lr_x, long lr_y); // ÕÓÔÁÎÏ×ÉÔØ ÏÂÌÁÓÔØ Ë-Ô
// lr_x = ul_x+(lrx-ul_x)/hbin;
// lr_y = ul_y+(lry-ul_y)/vbin;
// lrx, lry - ÁÂÓ. ËÏÏÒÄÉÎÁÔÙ × ÖÅÌÁÅÍÏÊ ÏÂÌÁÓÔÉ
LIBFLIAPI FLIGetExposureStatus(flidev_t dev, long* timeleft);
// ×ÒÅÍÑ ÄÏ ÏËÏÎÞÁÎÉÑ ÜËÓÐÏÚÉÃÉÉ
LIBFLIAPI FLISetTemperature(flidev_t dev, double temperature); // ÚÁÄÁÔØ ô
// temperature - × ÇÒÁÄÕÓÁÈ ãÅÌØÓÉÑ, ÏÔ -55 ÄÏ +45
LIBFLIAPI FLIGetTemperature(flidev_t dev, double* temperature); // ÕÚÎÁÔØ ô
LIBFLIAPI FLIGrabRow(flidev_t dev, void* buff, size_t width); // ÓÞÉÔÁÔØ ÒÑÄ
// buff - ÂÕÆÅÒ, width - ÍÁËÓ. ÛÉÒÉÎÁ ÒÑÄÁ (ÒÁÚÍÅÒ ÂÕÆÅÒÁ)
// ÓÞÉÔÙ×ÁÅÔ ÏÞÅÒÅÄÎÏÊ ÒÑÄ Ó ËÁÍÅÒÙ
LIBFLIAPI FLIExposeFrame(flidev_t dev); // ÎÁÞÁÔØ ÎÁËÏÐÌÅÎÉÅ
LIBFLIAPI FLISetBitDepth(flidev_t dev, flibitdepth_t bitdepth); // ÚÁÄÁÔØ ÒÁÚÒÑÄÎÏÓÔØ
LIBFLIAPI FLISetNFlushes(flidev_t dev, long nflushes); // ÚÁÄÁÔØ ËÏÌ-×Ï ÓÂÒÏÓÏ×
// ÐÅÒÅÄ ÜËÓÐÏÚÉÃÉÅÊ
LIBFLIAPI FLIReadIOPort(flidev_t dev, long* ioportset); // ÓÞÉÔÁÔØ ÐÏÒÔ io
// ioportset - ÓÞÉÔÁÎÎÙÅ ÄÁÎÎÙÅ
LIBFLIAPI FLIWriteIOPort(flidev_t dev, long ioportset); // ÚÁÐÉÓÁÔØ × io
LIBFLIAPI FLIConfigureIOPort(flidev_t dev, long ioportset); // ÎÁÓÔÒÏÊËÁ
// ÆÕÎËÃÉÏÎÁÌ ËÁÖÄÏÇÏ ËÏÎÔÁËÔÁ ÐÏÒÔÁ io ÚÁ×ÉÓÉÔ ÏÔ ÚÎÁÞÅÎÉÑ ioportset
// 1 - ×ÙÈÏÄ, 0 - ×ÈÏÄ
LIBFLIAPI FLILockDevice(flidev_t dev); // ÂÌÏËÉÒÏ×ËÁ ÕÓÔÒÏÊÓÔ×Á
// ÄÌÑ ÏÂÅÓÐÅÞÅÎÉÑ ÍÏÎÏÐÏÌØÎÏÇÏ ÄÏÓÔÕÐÁ
LIBFLIAPI FLIUnlockDevice(flidev_t dev);
LIBFLIAPI FLIControlShutter(flidev_t dev, flishutter_t shutter); // ÚÁÔ×ÏÒ
// FLI_SHUTTER_EXTERNAL_TRIGGER_LOW É FLI_SHUTTER_EXTERNAL_TRIGGER
// ÚÁÐÕÓËÁÀÔ ÜËÓÐÏÚÉÃÉÀ ÐÒÉ ÎÁÌÉÞÉÉ ÌÏÇ. ÎÕÌÑ ÎÁ io0
// FLI_SHUTTER_EXTERNAL_TRIGGER_HIGH - ÚÁÐÕÓË ÜËÓÐ. ÎÁ ÌÏÇ1 ÎÁ io0
LIBFLIAPI FLIControlBackgroundFlush(flidev_t dev, flibgflush_t bgflush);
// ÆÏÎÏ×ÙÊ ÓÂÒÏÓ
LIBFLIAPI FLIList(flidomain_t domain, char*** names);
// ÓÐÉÓÏË ÕÓÔÒÏÊÓÔ× ÉÚ ÄÏÍÅÎÁ domain
LIBFLIAPI FLIFreeList(char** names); // ÏÞÉÓÔÉÔØ ÓÐÉÓÏË names
LIBFLIAPI FLISetFilterPos(flidev_t dev, long filter);
// ÕÓÔÁÎÏ×ÉÔØ ÆÉÌØÔÒ × ÐÏÚÉÃÉÀ filter
LIBFLIAPI FLIGetFilterPos(flidev_t dev, long* filter);
// ÔÅËÕÝÅÅ ÐÏÌÏÖÅÎÉÅ ÆÉÌØÔÒÁ
LIBFLIAPI FLIGetStepsRemaining(flidev_t dev, long* steps);
// ËÏÌÉÞÅÓÔ×Ï ÛÁÇÏ×, ÏÓÔÁ×ÛÉÈÓÑ ÄÏ ÎÁÚÎÁÞÅÎÎÏÊ ÐÏÚÉÃÉÉ
LIBFLIAPI FLIGetFilterCount(flidev_t dev, long* filter);
// ÕÚÎÁÔØ ËÏÌ-×Ï ÆÉÌØÔÒÏ×
LIBFLIAPI FLIStepMotorAsync(flidev_t dev, long steps);
LIBFLIAPI FLIStepMotor(flidev_t dev, long steps);
// ÐÅÒÅÄ×ÉÎÕÔØ ÔÕÒÅÌØ ÎÁ ÚÁÄÁÎÎÏÅ ËÏÌ-×Ï ÛÁÇÏ×
LIBFLIAPI FLIGetStepperPosition(flidev_t dev, long* position);
// ÔÅËÕÝÅÅ ÐÏÌÏÖÅÎÉÅ ûä
// ÆÕÎËÃÉÉ ÄÌÑ ÒÁÂÏÔÙ Ó ÆÏËÕÓÉÒÕÀÝÉÍ ÕÓÔÒÏÊÓÔ×ÏÍ
LIBFLIAPI FLIHomeFocuser(flidev_t dev);
LIBFLIAPI FLIGetFocuserExtent(flidev_t dev, long* extent);
LIBFLIAPI FLIReadTemperature(flidev_t dev, flichannel_t channel,
double* temperature);
LIBFLIAPI FLICreateList(flidomain_t domain); // ÓÏÚÄÁÔØ ÓÐÉÓÏË
LIBFLIAPI FLIDeleteList(void); // ÕÄÁÌÉÔØ ÓÐÉÓÏË
LIBFLIAPI FLIListFirst(flidomain_t* domain, char* filename,
size_t fnlen, char* name, size_t namelen); // ÐÏÌÕÞÉÔØ ÐÅÒ×ÏÅ ÕÓÔÒÏÊÓÔ×Ï ÉÚ ÓÐÉÓËÁ
// domain - ÄÏÍÅÎ ÕÓÔÒ-×Á;
// filename - ÉÍÑ ÆÁÊÌÁ ÕÓÔÒ-×Á;
// fnlen - ÄÌÉÎÁ ÂÕÆÅÒÁ ÉÍÅÎÉ ÆÁÊÌÁ;
// name - ÎÁÚ×ÁÎÉÅ ÕÓÔÒ-×Á;
// namelen - ÄÌÉÎÁ ÂÕÆÅÒÁ ÎÁÚ×ÁÎÉÑ
LIBFLIAPI FLIListNext(flidomain_t* domain, char* filename,
size_t fnlen, char* name, size_t namelen); // ÐÏÌÕÞÉÔØ ÓÌÅÄÕÀÝÅÅ ÕÓÔÒ-×Ï