TwiceAsNice  2019-02-18
Macros | Functions
inovasdk.h File Reference
This graph shows which files directly or indirectly include this file:

Macros

#define INOVASDK_VERSION   1.3.5
 
#define RESOLUTION_FULL   0
 
#define RESOLUTION_ROI   1
 
#define RESOLUTION_BIN   2
 
#define FRAME_SPEED_LOW   0
 
#define FRAME_SPEED_NORMAL   1
 
#define FRAME_SPEED_HIGH   2
 
#define FRAME_SPEED_TEST   5
 
#define BAUD_RATE_9600   0
 
#define BAUD_RATE_115200   1
 
#define SENSOR_ID_NONE   -1
 
#define SENSOR_ID_ICX618AL   0
 
#define SENSOR_ID_ICX098BQ   1
 
#define SENSOR_ID_ICX204AK   2
 
#define SENSOR_ID_ICX445AL   3
 
#define SENSOR_ID_ICX445AQ   4
 
#define SENSOR_ID_ICX098BLE   5
 
#define SENSOR_ID_ICX204AL   6
 
#define SENSOR_ID_ICX205AK   7
 
#define SENSOR_ID_ICX205AL   8
 
#define SENSOR_ID_ICX674ALA   9
 
#define SENSOR_ID_ICX265ALA   10
 
#define SENSOR_ID_MT9M001   11
 
#define SENSOR_ID_MT9M034   12
 
#define SENSOR_ID_MT9M034M   13
 
#define SENSOR_ID_IMX185   16
 
#define DIRECTION_NONE   0x0F,
 
#define DIRECTION_NORTH   0x0D,
 
#define DIRECTION_WEST   0x07,
 
#define DIRECTION_SOUTH   0x0B,
 
#define DIRECTION_EAST   0x0E
 
#define DATA_WIDTH_8   0
 
#define DATA_WIDTH_10   1
 
#define DATA_WIDTH_12   2
 
#define ROI_MIN_WIDTH   8
 
#define ROI_MIN_HEIGHT   192
 
#define ROI_WIDTH_MASK   0xfff8
 
#define ROI_HEIGHT_MASK   0xfffe
 
#define DLL_EXPORT   CXX_EXPORT
 

Functions

DLL_EXPORT int iNovaSDK_MaxCamera ()
 Returns the number of cameras connected. More...
 
DLL_EXPORT void iNovaSDK_CloseCamera ()
 Closes the current camera. More...
 
DLL_EXPORT const char * iNovaSDK_OpenCamera (int n)
 Detects and opens the selected camera. More...
 
DLL_EXPORT const char * iNovaSDK_SensorName ()
 Returns the camera's sensor name. More...
 
DLL_EXPORT int iNovaSDK_SensorID ()
 Returns the camera's sensor code. More...
 
DLL_EXPORT int iNovaSDK_GetArraySize ()
 Returns the size of the frame in pixels. More...
 
DLL_EXPORT const char * iNovaSDK_SerialNumber ()
 Returns the camera's serial number. More...
 
DLL_EXPORT const char * iNovaSDK_GetName ()
 Returns the camera's commercial name. More...
 
DLL_EXPORT const char * iNovaSDK_RecvUartData ()
 Reads data from camera's serial port. More...
 
DLL_EXPORT bool iNovaSDK_SendUartData (unsigned char *Buffer, int len)
 Sends data from camera's serial port. More...
 
DLL_EXPORT void iNovaSDK_InitUart (int BaudRate)
 Inits serial port. More...
 
DLL_EXPORT bool iNovaSDK_InitCamera (int resolution)
 Inits the camera, in BIN mode resolution is halfed respect FULL resolution, but intensities are doubled. More...
 
DLL_EXPORT void iNovaSDK_OpenVideo ()
 Starts video capture, must be called after camera initialization. More...
 
DLL_EXPORT void iNovaSDK_CloseVideo ()
 Stops video capture. More...
 
DLL_EXPORT unsigned char * iNovaSDK_GrabFrame ()
 Returns the frame grabbed, or NULL if the frame is not ready. In FAST mode the frame is ordered in 8bit words, in NORMAL and LOW speed modes it is ordered in 16bit words (pay attention to the endianness!). More...
 
DLL_EXPORT double iNovaSDK_GetRowTime ()
 Returns the horizontal sync time in microseconds. More...
 
DLL_EXPORT double iNovaSDK_GetExpTime ()
 Returns the exposure time in milliseconds. More...
 
DLL_EXPORT void iNovaSDK_SetExpTime (double x)
 Sets exposure time. More...
 
DLL_EXPORT void iNovaSDK_CancelLongExpTime ()
 Cancel current exposure. More...
 
DLL_EXPORT int iNovaSDK_GetAnalogGain ()
 Returns the analog gain value. More...
 
DLL_EXPORT void iNovaSDK_SetAnalogGain (int AnalogGain)
 Sets analog gain. More...
 
DLL_EXPORT int iNovaSDK_MaxImageHeight ()
 Returns the maximum Y resolution in pixels. More...
 
DLL_EXPORT int iNovaSDK_MaxImageWidth ()
 Returns the maximum X resolution in pixels. More...
 
DLL_EXPORT int iNovaSDK_GetImageHeight ()
 Returns the current Y resolution in pixels. More...
 
DLL_EXPORT int iNovaSDK_GetImageWidth ()
 Returns the current X resolution in pixels. More...
 
DLL_EXPORT void iNovaSDK_SetROI (int HOff, int VOff, int Width, int Height)
 Sets ROI rectangle. More...
 
DLL_EXPORT int iNovaSDK_GetBinX ()
 Returns the X binning value. More...
 
DLL_EXPORT void iNovaSDK_SetBinX (int bin)
 Sets X binning value. More...
 
DLL_EXPORT int iNovaSDK_GetBinY ()
 Returns the Y binning value. More...
 
DLL_EXPORT void iNovaSDK_SetBinY (int bin)
 Sets Y binning value. More...
 
DLL_EXPORT int iNovaSDK_GetFrameSpeed ()
 Returns the frame speed. More...
 
DLL_EXPORT void iNovaSDK_SetFrameSpeed (int speed)
 Sets frame speed. More...
 
DLL_EXPORT int iNovaSDK_GetBlackLevel ()
 Returns the Black level. More...
 
DLL_EXPORT void iNovaSDK_SetBlackLevel (int Level)
 Sets black level. More...
 
DLL_EXPORT int iNovaSDK_GetDataWide ()
 Returns the data width (bit depth). More...
 
DLL_EXPORT void iNovaSDK_SetDataWide (int WordWidth)
 Sets Bit depht. More...
 
DLL_EXPORT void iNovaSDK_SensorPowerDown ()
 Powers off the imaging sensor. More...
 
DLL_EXPORT void iNovaSDK_SendST4 (int value)
 Sends direction to autoguider port. More...
 
DLL_EXPORT void iNovaSDK_InitST4 ()
 Inits autoguider port. More...
 
DLL_EXPORT void iNovaSDK_SetHB (int pHB)
 Sets horizontal blanking (CMOS sensors only). More...
 
DLL_EXPORT void iNovaSDK_SetVB (int pVB)
 Sets vertical blanking (CMOS sensors only). More...
 
DLL_EXPORT int iNovaSDK_GetHB ()
 Returns the horizontal blanking (CMOS sensors only). More...
 
DLL_EXPORT int iNovaSDK_GetVB ()
 Returns the vertical blanking (CMOS sensors only). More...
 
DLL_EXPORT void iNovaSDK_SetPixClock (int Pck)
 Sets pixel clock (Aptina MT9M034/MT9M034M sensors only). More...
 
DLL_EXPORT int iNovaSDK_GetPixClock ()
 Returns the pixel clock (Aptina MT9M034/MT9M034M sensors only). More...
 
DLL_EXPORT double iNovaSDK_GetSensorTemperature ()
 Returns the sensor's temperature (Aptina MT9M034/MT9M034M sensors only). More...
 
DLL_EXPORT bool iNovaSDK_HasST4 ()
 Returns the availability of an autoguider port. More...
 
DLL_EXPORT bool iNovaSDK_HasUART ()
 Returns the availability of a serial port. More...
 
DLL_EXPORT bool iNovaSDK_HasColorSensor ()
 Returns the type of sensor. More...
 
DLL_EXPORT double iNovaSDK_GetPixelSizeX ()
 Returns the X size of the single pixel in microns. More...
 
DLL_EXPORT double iNovaSDK_GetPixelSizeY ()
 Returns the Y size of the single pixel in microns. More...
 
DLL_EXPORT timeval iNovaSDK_GetLastFrameTime ()
 Returns the milliseconds elapsed from Epoch to the last frame taken. More...
 

Macro Definition Documentation

◆ BAUD_RATE_115200

#define BAUD_RATE_115200   1

115200 Bps, for UART

◆ BAUD_RATE_9600

#define BAUD_RATE_9600   0

9600 Bps, for UART

◆ DATA_WIDTH_10

#define DATA_WIDTH_10   1

10bpp, used for PLC-M

◆ DATA_WIDTH_12

#define DATA_WIDTH_12   2

12/10bpp, used for FRAME_SPEED_NORMAL and FRAME_SPEED_LOW

◆ DATA_WIDTH_8

#define DATA_WIDTH_8   0

8bpp, used for FRAME_SPEED_HIGH

◆ DIRECTION_EAST

#define DIRECTION_EAST   0x0E

East direction, for ST4

◆ DIRECTION_NONE

#define DIRECTION_NONE   0x0F,

no direction, for ST4

◆ DIRECTION_NORTH

#define DIRECTION_NORTH   0x0D,

North direction, for ST4

◆ DIRECTION_SOUTH

#define DIRECTION_SOUTH   0x0B,

South direction, for ST4

◆ DIRECTION_WEST

#define DIRECTION_WEST   0x07,

West direction, for ST4

◆ DLL_EXPORT

#define DLL_EXPORT   CXX_EXPORT

◆ FRAME_SPEED_HIGH

#define FRAME_SPEED_HIGH   2

Maximum frame speed, 8bit depht, at full FPS

◆ FRAME_SPEED_LOW

#define FRAME_SPEED_LOW   0

Low Frame speed, 12bit depht, for long exposures

◆ FRAME_SPEED_NORMAL

#define FRAME_SPEED_NORMAL   1

Normal frame speed, 12bit depht, at higher frame rates

◆ FRAME_SPEED_TEST

#define FRAME_SPEED_TEST   5

Maximum frame speed, 12bit depht, at full FPS

◆ INOVASDK_VERSION

#define INOVASDK_VERSION   1.3.5

Current SDK version

◆ RESOLUTION_BIN

#define RESOLUTION_BIN   2

BIN 2x2 resolution

◆ RESOLUTION_FULL

#define RESOLUTION_FULL   0

Full Resolution

◆ RESOLUTION_ROI

#define RESOLUTION_ROI   1

ROI resolution

◆ ROI_HEIGHT_MASK

#define ROI_HEIGHT_MASK   0xfffe

◆ ROI_MIN_HEIGHT

#define ROI_MIN_HEIGHT   192

◆ ROI_MIN_WIDTH

#define ROI_MIN_WIDTH   8

◆ ROI_WIDTH_MASK

#define ROI_WIDTH_MASK   0xfff8

◆ SENSOR_ID_ICX098BLE

#define SENSOR_ID_ICX098BLE   5

SONY ICX098BLE - Color

◆ SENSOR_ID_ICX098BQ

#define SENSOR_ID_ICX098BQ   1

SONY ICX098BQ - Color

◆ SENSOR_ID_ICX204AK

#define SENSOR_ID_ICX204AK   2

SONY ICX204AL - Mono

◆ SENSOR_ID_ICX204AL

#define SENSOR_ID_ICX204AL   6

SONY ICX204AL - Mono

◆ SENSOR_ID_ICX205AK

#define SENSOR_ID_ICX205AK   7

SONY ICX205AK - Mono

◆ SENSOR_ID_ICX205AL

#define SENSOR_ID_ICX205AL   8

SONY ICX205AL - Mono

◆ SENSOR_ID_ICX265ALA

#define SENSOR_ID_ICX265ALA   10

SONY ICX265ALA - Mono

◆ SENSOR_ID_ICX445AL

#define SENSOR_ID_ICX445AL   3

SONY ICX445AL - Mono

◆ SENSOR_ID_ICX445AQ

#define SENSOR_ID_ICX445AQ   4

SONY ICX445AQ - Color

◆ SENSOR_ID_ICX618AL

#define SENSOR_ID_ICX618AL   0

SONY ICX618AL - Mono

◆ SENSOR_ID_ICX674ALA

#define SENSOR_ID_ICX674ALA   9

SONY ICX674ALA - Mono

◆ SENSOR_ID_IMX185

#define SENSOR_ID_IMX185   16

SONY IMX185 - Mono

◆ SENSOR_ID_MT9M001

#define SENSOR_ID_MT9M001   11

Aptina MT9M001 - Mono

◆ SENSOR_ID_MT9M034

#define SENSOR_ID_MT9M034   12

Aptina MT9M034 - Color

◆ SENSOR_ID_MT9M034M

#define SENSOR_ID_MT9M034M   13

Aptina MT9M034M - Mono

◆ SENSOR_ID_NONE

#define SENSOR_ID_NONE   -1

No sensor at all

Function Documentation

◆ iNovaSDK_CancelLongExpTime()

void iNovaSDK_CancelLongExpTime ( )

Cancel current exposure.

Returns
no return value

◆ iNovaSDK_CloseCamera()

void iNovaSDK_CloseCamera ( )

Closes the current camera.

◆ iNovaSDK_CloseVideo()

void iNovaSDK_CloseVideo ( )

Stops video capture.

Returns
no return value

◆ iNovaSDK_GetAnalogGain()

unsigned int iNovaSDK_GetAnalogGain ( )

Returns the analog gain value.

Returns
Analog gain value

◆ iNovaSDK_GetArraySize()

int iNovaSDK_GetArraySize ( )

Returns the size of the frame in pixels.

Returns
Size current number of pixels.

◆ iNovaSDK_GetBinX()

int iNovaSDK_GetBinX ( )

Returns the X binning value.

Returns
int BinX value.

◆ iNovaSDK_GetBinY()

int iNovaSDK_GetBinY ( )

Returns the Y binning value.

Returns
int BinY value.

◆ iNovaSDK_GetBlackLevel()

unsigned char iNovaSDK_GetBlackLevel ( )

Returns the Black level.

Returns
Black level value

◆ iNovaSDK_GetDataWide()

int iNovaSDK_GetDataWide ( )

Returns the data width (bit depth).

Returns
DATA_WIDTH_12 for 12/10bpp, DATA_WIDTH_8 for 8bpp

◆ iNovaSDK_GetExpTime()

int iNovaSDK_GetExpTime ( )

Returns the exposure time in milliseconds.

Returns
the total integration time.

◆ iNovaSDK_GetFrameSpeed()

int iNovaSDK_GetFrameSpeed ( )

Returns the frame speed.

Returns
int speed frame speed.

◆ iNovaSDK_GetHB()

void iNovaSDK_GetHB ( )

Returns the horizontal blanking (CMOS sensors only).

Returns
horizontal blanking

◆ iNovaSDK_GetImageHeight()

void iNovaSDK_GetImageHeight ( )

Returns the current Y resolution in pixels.

Returns
Height image height

◆ iNovaSDK_GetImageWidth()

void iNovaSDK_GetImageWidth ( )

Returns the current X resolution in pixels.

Returns
Height image width

◆ iNovaSDK_GetLastFrameTime()

void iNovaSDK_GetLastFrameTime ( )

Returns the milliseconds elapsed from Epoch to the last frame taken.

◆ iNovaSDK_GetName()

char * iNovaSDK_GetName ( )

Returns the camera's commercial name.

Returns
Current camera's commercial name.

◆ iNovaSDK_GetPixClock()

void iNovaSDK_GetPixClock ( )

Returns the pixel clock (Aptina MT9M034/MT9M034M sensors only).

Returns
pixel clock

◆ iNovaSDK_GetPixelSizeX()

void iNovaSDK_GetPixelSizeX ( )

Returns the X size of the single pixel in microns.

Returns
double X size of pixel

◆ iNovaSDK_GetPixelSizeY()

void iNovaSDK_GetPixelSizeY ( )

Returns the Y size of the single pixel in microns.

Returns
double Y size of pixel

◆ iNovaSDK_GetRowTime()

void iNovaSDK_GetRowTime ( )

Returns the horizontal sync time in microseconds.

Returns
the line time in microseconds.

◆ iNovaSDK_GetSensorTemperature()

void iNovaSDK_GetSensorTemperature ( )

Returns the sensor's temperature (Aptina MT9M034/MT9M034M sensors only).

Returns
sensor's temperature

◆ iNovaSDK_GetVB()

void iNovaSDK_GetVB ( )

Returns the vertical blanking (CMOS sensors only).

Returns
vertical blanking

◆ iNovaSDK_GrabFrame()

unsigned char * iNovaSDK_GrabFrame ( )

Returns the frame grabbed, or NULL if the frame is not ready. In FAST mode the frame is ordered in 8bit words, in NORMAL and LOW speed modes it is ordered in 16bit words (pay attention to the endianness!).

Returns
the image array, or NULL.

◆ iNovaSDK_HasColorSensor()

void iNovaSDK_HasColorSensor ( )

Returns the type of sensor.

Returns
true if bayer color sensor, false if monochrome

◆ iNovaSDK_HasST4()

void iNovaSDK_HasST4 ( )

Returns the availability of an autoguider port.

Returns
true if ST4 port available, false if none

◆ iNovaSDK_HasUART()

void iNovaSDK_HasUART ( )

Returns the availability of a serial port.

Returns
true if serial port available, false if none

◆ iNovaSDK_InitCamera()

bool iNovaSDK_InitCamera ( int  Resolution)

Inits the camera, in BIN mode resolution is halfed respect FULL resolution, but intensities are doubled.

Parameters
Resolutionthe resolution to use.
Returns
true if success, false if error.

◆ iNovaSDK_InitST4()

void iNovaSDK_InitST4 ( )

Inits autoguider port.

Returns
no return value

◆ iNovaSDK_InitUart()

void iNovaSDK_InitUart ( int  BaudRate)

Inits serial port.

Parameters
BaudRatespeed of the serial port.
Returns
no return value

◆ iNovaSDK_MaxCamera()

void iNovaSDK_MaxCamera ( )

Returns the number of cameras connected.

◆ iNovaSDK_MaxImageHeight()

void iNovaSDK_MaxImageHeight ( )

Returns the maximum Y resolution in pixels.

Returns
Height max image height

◆ iNovaSDK_MaxImageWidth()

void iNovaSDK_MaxImageWidth ( )

Returns the maximum X resolution in pixels.

Returns
Width max image width

◆ iNovaSDK_OpenCamera()

void iNovaSDK_OpenCamera ( int  n)

Detects and opens the selected camera.

Parameters
nselected camera.
Returns
Serial number

◆ iNovaSDK_OpenVideo()

void iNovaSDK_OpenVideo ( )

Starts video capture, must be called after camera initialization.

Returns
no return value

◆ iNovaSDK_RecvUartData()

char * iNovaSDK_RecvUartData ( )

Reads data from camera's serial port.

Returns
Received data.

◆ iNovaSDK_SendST4()

void iNovaSDK_SendST4 ( int  value)

Sends direction to autoguider port.

Parameters
valuedirection for autoguider port.
Returns
no return value

◆ iNovaSDK_SendUartData()

bool iNovaSDK_SendUartData ( unsigned char *  Buffer,
int  len 
)

Sends data from camera's serial port.

Parameters
Bufferstring to be sent.
lenLength of the string sent.
Returns
true if success, false if error.

◆ iNovaSDK_SensorID()

int iNovaSDK_SensorID ( )

Returns the camera's sensor code.

Returns
INOVA_SENSOR_ID Sensor code.

◆ iNovaSDK_SensorName()

int iNovaSDK_SensorName ( )

Returns the camera's sensor name.

Returns
Sensor name.

◆ iNovaSDK_SensorPowerDown()

void iNovaSDK_SensorPowerDown ( )

Powers off the imaging sensor.

Returns
no return value

◆ iNovaSDK_SerialNumber()

char * iNovaSDK_SerialNumber ( )

Returns the camera's serial number.

Returns
serial number.

◆ iNovaSDK_SetAnalogGain()

void iNovaSDK_SetAnalogGain ( int  Gain)

Sets analog gain.

Parameters
Gainanalog gain value.
Returns
no return value

◆ iNovaSDK_SetBinX()

void iNovaSDK_SetBinX ( int  bin)

Sets X binning value.

Parameters
binBinX value.
Returns
no return value

◆ iNovaSDK_SetBinY()

void iNovaSDK_SetBinY ( int  bin)

Sets Y binning value.

Parameters
binBinY value.
Returns
no return value

◆ iNovaSDK_SetBlackLevel()

void iNovaSDK_SetBlackLevel ( int  Level)

Sets black level.

Parameters
Levelvalue of black level.
Returns
no return value

◆ iNovaSDK_SetDataWide()

void iNovaSDK_SetDataWide ( int  WordWidth)

Sets Bit depht.

Parameters
WordWidthbit depht.
Returns
no return value

◆ iNovaSDK_SetExpTime()

void iNovaSDK_SetExpTime ( double  x)

Sets exposure time.

Parameters
xExposure time.
Returns
no return value

◆ iNovaSDK_SetFrameSpeed()

void iNovaSDK_SetFrameSpeed ( int  speed)

Sets frame speed.

Parameters
speedFrame speed.
Returns
no return value

◆ iNovaSDK_SetHB()

void iNovaSDK_SetHB ( int  HB)

Sets horizontal blanking (CMOS sensors only).

Parameters
HBhorizontal blanking.
Returns
no return value

◆ iNovaSDK_SetPixClock()

void iNovaSDK_SetPixClock ( int  PixClock)

Sets pixel clock (Aptina MT9M034/MT9M034M sensors only).

Parameters
PixClockpixel clock.
Returns
no return value

◆ iNovaSDK_SetROI()

void iNovaSDK_SetROI ( int  HOff,
int  VOff,
int  Width,
int  Height 
)

Sets ROI rectangle.

Parameters
HOffX start offset.
VOffY start offset.
Widthwidth of the rectangle in pixels.
Heightheight of the rectangle in pixels.
Returns
no return value

◆ iNovaSDK_SetVB()

void iNovaSDK_SetVB ( int  VB)

Sets vertical blanking (CMOS sensors only).

Parameters
VBvertical blanking.
Returns
no return value