diff options
author | Andy Wortman <ixineeringeverywhere@gmail.com> | 2019-03-14 15:52:30 -0700 |
---|---|---|
committer | Andy Wortman <ixineeringeverywhere@gmail.com> | 2019-03-14 15:52:30 -0700 |
commit | 9a607474bdd66dd716635cfed7f2c832c39b4523 (patch) | |
tree | c5f65b4cecd6376a3b99646679f9714d5f9213a2 /include/qhy/solar1600.h | |
parent | ac7604616ab2e44ad12a9d8d5dd90dec15feb5cc (diff) |
add qhy headers.........
Diffstat (limited to 'include/qhy/solar1600.h')
-rw-r--r-- | include/qhy/solar1600.h | 348 |
1 files changed, 348 insertions, 0 deletions
diff --git a/include/qhy/solar1600.h b/include/qhy/solar1600.h new file mode 100644 index 0000000..b49b4b8 --- /dev/null +++ b/include/qhy/solar1600.h @@ -0,0 +1,348 @@ +/* + QHYCCD SDK + + Copyright (c) 2014 QHYCCD. + All Rights Reserved. + + This program is free software; you can redistribute it and/or modify it + under the terms of the GNU General Public License as published by the Free + Software Foundation; either version 2 of the License, or (at your option) + any later version. + + This program 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 General Public License for + more details. + + You should have received a copy of the GNU General Public License along with + this program; if not, write to the Free Software Foundation, Inc., 59 + Temple Place - Suite 330, Boston, MA 02111-1307, USA. + + The full GNU General Public License is included in this distribution in the + file called LICENSE. + */ + +/*! + * @file solar1600.h + * @brief SOLAR1600 class define + */ + +#include "qhybase.h" + +#ifdef WIN32 +#include "d5100.h" +#endif + +#ifndef __SOLAR1600DEF_H__ +#define __SOLAR1600DEF_H__ + +/** + * @brief SOLAR1600 class define + * + * include all functions for SOLAR1600 + */ +class SOLAR1600:public QHYBASE +{ +public: + SOLAR1600(); + ~SOLAR1600(); + /** + @fn uint32_t ConnectCamera(qhyccd_device *d,qhyccd_handle **h) + @brief connect to the connected camera + @param d camera deivce + @param h camera control handle + @return + success return QHYCCD_SUCCESS \n + another QHYCCD_ERROR code on other failures + */ + uint32_t ConnectCamera(qhyccd_device *d,qhyccd_handle **h); + + /** + @fn uint32_t DisConnectCamera(qhyccd_handle *h) + @brief disconnect to the connected camera + @param h camera control handle + @return + success return QHYCCD_SUCCESS \n + another QHYCCD_ERROR code on other failures + */ + uint32_t DisConnectCamera(qhyccd_handle *h); + + /** + @fn uint32_t InitChipRegs(qhyccd_handle *h) + @brief Init the registers and some other things + @param h camera control handle + @return + success return QHYCCD_SUCCESS \n + another QHYCCD_ERROR code on other failures + */ + uint32_t InitChipRegs(qhyccd_handle *h); + + /** + @fn uint32_t IsChipHasFunction(CONTROL_ID id) + @brief check the camera has the function or not + @param id function id + @return + HAVE return QHYCCD_HAVE \n + NOT HAVE return QHYCCD_NOTHAVE + */ + uint32_t IsChipHasFunction(CONTROL_ID id); + + + /** + @fn uint32_t ReSetParams2cam(qhyccd_handle *h) + @brief re set the params to camera,because some behavior will cause camera reset + @param h camera control handle + @return + success return QHYCCD_SUCCESS \n + another QHYCCD_ERROR code on other failures + */ + uint32_t ReSetParams2cam(qhyccd_handle *h); + + /** + @fn uint32_t SetChipGain(qhyccd_handle *h,double gain) + @brief set the gain to camera + @param h camera control handle + @param gain gain value + @return + success return QHYCCD_SUCCESS \n + another QHYCCD_ERROR code on other failures + */ + uint32_t SetChipGain(qhyccd_handle *h,double gain); + + /** + @fn uint32_t SetChipExposeTime(qhyccd_handle *h,double i) + @brief set the expose time to camera + @param h camera control handle + @param i expose time value + @return + success return QHYCCD_SUCCESS \n + another QHYCCD_ERROR code on other failures + */ + uint32_t SetChipExposeTime(qhyccd_handle *h,double i); + + /** + @fn uint32_t SetChipSpeed(qhyccd_handle *h,uint32_t i) + @brief set the transfer speed to camera + @param h camera control handle + @param i speed level + @return + success return QHYCCD_SUCCESS \n + another QHYCCD_ERROR code on other failures + */ + uint32_t SetChipSpeed(qhyccd_handle *h,uint32_t i); + + /** + + */ + uint32_t SetChipDepth(qhyccd_handle *h,uint32_t depth); + + /** + @fn uint32_t SetChipBinMode(qhyccd_handle *h,uint32_t wbin,uint32_t hbin) + @brief set the camera offset + @param h camera control handle + @param wbin width bin + @param hbin height bin + @return + success return QHYCCD_SUCCESS \n + another QHYCCD_ERROR code on other failures + */ + uint32_t SetChipBinMode(qhyccd_handle *h,uint32_t wbin,uint32_t hbin); + + + /** + @fn uint32_t GetControlMinMaxStepValue(CONTROL_ID controlId,double *min,double *max,double *step) + @brief get the min,max and step value for function + @param controlId the control id + @param min the min value for function + @param max the max value for function + @param step single step value for function + @return + success return QHYCCD_SUCCESS \n + another QHYCCD_ERROR code on other failures + */ + uint32_t GetControlMinMaxStepValue(CONTROL_ID controlId,double *min,double *max,double *step); + + /** + @fn uint32_t GetChipMemoryLength() + @brief get the min cost memory for the image + @return + success return the total memory space(unit:byte) \n + another QHYCCD_ERROR code on other failures + */ + uint32_t GetChipMemoryLength(); + + /** + @fn double GetChipExposeTime() + @brief get the current exposetime + @return + success return the current expose time (unit:us) \n + another QHYCCD_ERROR code on other failures + */ + double GetChipExposeTime(); + + /** + @fn double GetChipGain() + @brief get the current gain + @return + success return the current expose gain\n + another QHYCCD_ERROR code on other failures + */ + double GetChipGain(); + + /** + @fn double GetChipSpeed() + @brief get the current transfer speed + @return + success return the current speed level \n + another QHYCCD_ERROR code on other failures + */ + double GetChipSpeed(); + + + /** + @fn double GetChipBitsMode() + @brief get the current camera depth bits + @return + success return the current camera depth bits \n + another QHYCCD_ERROR code on other failures + */ + double GetChipBitsMode(); + + + /** + @fn uint32_t CorrectWH(uint32_t *w,uint32_t *h) + @brief correct width and height if the setting width or height is not correct + @param w set width + @param h set height + @return + success return QHYCCD_SUCCESS \n + another QHYCCD_ERROR code on other failures + */ + uint32_t CorrectWH(uint32_t *w,uint32_t *h); + + /** + @fn double InitBIN11Mode() + @brief init the bin11 mode setting + @return + success return QHYCCD_SUCCESS \n + another QHYCCD_ERROR code on other failures + */ + uint32_t InitBIN11Mode(); + + /** + @fn double InitBIN22Mode() + @brief init the bin22 mode setting + @return + success return QHYCCD_SUCCESS \n + another QHYCCD_ERROR code on other failures + */ + uint32_t InitBIN22Mode(); + + /** + @fn double InitBIN44Mode() + @brief init the bin44 mode setting + @return + success return QHYCCD_SUCCESS \n + another QHYCCD_ERROR code on other failures + */ + uint32_t InitBIN44Mode(); + + /** + @fn uint32_t SetChipResolution(qhyccd_handle *handle,uint32_t x,uint32_t y,uint32_t xsize,uint32_t ysize) + @brief set camera ouput resolution + @param handle camera control handle + @param x the top left position x + @param y the top left position y + @param xsize the image width + @param ysize the image height + @return + on success,return QHYCCD_SUCCESS\n + another QHYCCD_ERROR code on other failures + */ + uint32_t SetChipResolution(qhyccd_handle *handle,uint32_t x,uint32_t y,uint32_t xsize,uint32_t ysize); + + /** + @fn uint32_t BeginSingleExposure(qhyccd_handle *h) + @brief begin single exposure + @param h camera control handle + @return + success return QHYCCD_SUCCESS \n + another QHYCCD_ERROR code on other failures + */ + uint32_t BeginSingleExposure(qhyccd_handle *h); + + /** + @fn uint32_t StopSingleExposure(qhyccd_handle *h) + @brief stop single exposure + @param h camera control handle + @return + success return QHYCCD_SUCCESS \n + another QHYCCD_ERROR code on other failures + */ + uint32_t StopSingleExposure(qhyccd_handle *h); + + /** + @fn uint32_t GetSingleFrame(qhyccd_handle *h,uint32_t *pW,uint32_t *pH,uint32_t * pBpp,uint32_t *pChannels,uint8_t *ImgData) + @brief get single frame image data + @param h camera control handle + @param pW real width + @param pH real height + @param pBpp real depth bits + @param pChannels real channels + @param ImgData image data buffer + @return + success return QHYCCD_SUCCESS \n + another QHYCCD_ERROR code on other failures + */ + uint32_t GetSingleFrame(qhyccd_handle *h,uint32_t *pW,uint32_t *pH,uint32_t * pBpp,uint32_t *pChannels,uint8_t *ImgData); + + /** + @fn uint32_t BeginLiveExposure(qhyccd_handle *h) + @brief begin live exposure + @param h camera control handle + @return + success return QHYCCD_SUCCESS \n + another QHYCCD_ERROR code on other failures + */ + uint32_t BeginLiveExposure(qhyccd_handle *h); + + /** + @fn uint32_t StopLiveExposure(qhyccd_handle *h) + @brief stop live exposure + @param h camera control handle + @return + success return QHYCCD_SUCCESS \n + another QHYCCD_ERROR code on other failures + */ + uint32_t StopLiveExposure(qhyccd_handle *h); + + /** + @fn uint32_t GetLiveFrame(qhyccd_handle *h,uint32_t *pW,uint32_t *pH,uint32_t * pBpp,uint32_t *pChannels,uint8_t *ImgData) + @brief get live frame image data + @param h camera control handle + @param pW real width + @param pH real height + @param pBpp real depth bits + @param pChannels real channels + @param ImgData image data buffer + @return + success return QHYCCD_SUCCESS \n + another QHYCCD_ERROR code on other failures + */ + uint32_t GetLiveFrame(qhyccd_handle *h,uint32_t *pW,uint32_t *pH,uint32_t * pBpp,uint32_t *pChannels,uint8_t *ImgData); + + + /** @fn uint32_t SetFocusSetting(qhyccd_handle *h,uint32_t focusCenterX, uint32_t focusCenterY) + @brief Set the camera on focus mode + @param h camera control handle + @param focusCenterX + @param focusCenterY + @return + on success,return QHYCCD_SUCCESS \n + another QHYCCD_ERROR code on other failures + */ + uint32_t SetFocusSetting(qhyccd_handle *h,uint32_t focusCenterX, uint32_t focusCenterY); + +}; +#endif + |