Explorecam cameras support various kinds of APIs (Application Program Interface), namely Native C/C++, .NET/C#/VB.NET, Python, Java, DirectShow, Twain, LabView, MabLab and so on. Compared with other APIs, Native C/C++ API, as a low level API, don't depend any other runtime libraries. Besides, this interface is simple, flexible and easy to be integrated into the customized applications. The SDK zip file contains all of the necessary resources and information:
explore.h, C/C++ head file
explore.cs, for C#. The explore.cs use P/Invoke to call into explore.dll. Please copy explore.cs to your C# project to use it.
explore.vb, for VB.NET. The explore.vb use P/Invoke to call into explore.dll. Please copy explore.vb to your VB.NET project to use it.
explore.lib, lib file for x86
explore.dll, dll file for x86
democpp.exe, x86 C++ demo exe file
explore.lib, lib file for x64
explore.dll, dll file for x64
democpp.exe, x64 C++ demo exe file
explore.lib, lib file for arm
explore.dll, dll file for arm
explore.lib, lib file for arm64
explore.dll, dll file for arm64
DLL files for WinRT / UWP (Universal Windows Platform) / Windows Store App.
These dll files are compatible with Windows Runtime, and can be consumed from a Universal Windows Platform app.
If use C# to develop the UWP, explore.cs wrapper class can be used to P/Invoke into explore.dll.
Please pay attation to:1. uwp must use winusb, cannot use the proprietary driver. If the proprietary driver has already been installed, please uninstall it in the device manager, after this, Windows will use winusb automatically.
2. DeviceCapability of uwp, see: How to add USB device capabilities to the app manifest. (It seems that microsoft limits the number of Device items to 100)
ExecWait '"$INSTDIR\drivers\x64\DPInst.exe" /SA /SW /PATH "$INSTDIR\drivers\x64"' |
Explorecam offers two modes to obtain image data: Pull Mode and Push Mode. The former is recommended since it's simpler and the application seldom gets stuck in multithreading conditions, especially when using windows message to notify the events.
There are to ways to notify applications:
a) Use Windows message: Start pull mode by using the function Explorecam_StartPullModeWithWndMsg. When event occurs, explore will post message (PostMessage) to the specified window. Parameter WPARAM is the event type, refer to the definition of EXPLORE_EVENT_xxxx. This model avoids the multithreading issues, so it's the most simple way. (Obviously, this is only supported in Windows systems, and not supported in Linux and macOS.)
b) Use Callback function: Start pull mode by using the function Explorecam_StartPullModeWithCallback. When event occurs, explore will callback the function PEXPLORE_EVENT_CALLBACK.
In Pull Mode, the SDK could not only notify the application that the image data or still image are available for 'PULL', but also inform you of the other events, such as:
EXPLORE_EVENT_EXPOSURE exposure time changed EXPLORE_EVENT_TEMPTINT white balance changed. Temp/Tint Mode, please see here. EXPLORE_EVENT_WBGAIN white balance changed. RGB Gain Mode, please see here. EXPLORE_EVENT_IMAGE Video image data arrives. Use Explorecam_PullImage(V2) to 'pull' the image data EXPLORE_EVENT_STILLIMAGE Still image which is triggered by function Explorecam_Snap or Explorecam_SnapN arrives. Use Explorecam_PullStillImage(V2) to 'pull' the image data EXPLORE_EVENT_ERROR Generic error, data acquisition cannot continue EXPLORE_EVENT_DISCONNECTED Camera disconnected, maybe has been pulled out EXPLORE_EVENT_NOFRAMETIMEOUT Grab image no frame timeout error, data acquisition cannot continue EXPLORE_EVENT_NOPACKETIMEOUT Grab image no packet timeout EXPLORE_EVENT_TRIGGERFAIL trigger failed (for example, bad frame data or timeout) EXPLORE_EVENT_BLACK black balance changed EXPLORE_EVENT_FFC flat field correction status changed EXPLORE_EVENT_DFC dark field correction status changed EXPLORE_EVENT_ROI roi changed EXPLORE_EVENT_LEVELRANGE level range changed EXPLORE_EVENT_AUTOEXPO_FINISH auto exposure once mode finish EXPLORE_EVENT_EXPO_START hardware event: exposure start EXPLORE_EVENT_EXPO_STOP hardware event: exposure stop EXPLORE_EVENT_TRIGGER_ALLOW hardware event: next trigger allow EXPLORE_EVENT_HEARTBEAT hardware event: heartbeat, can be used to monitor whether the camera is alive EXPLORE_EVENT_FACTORY restore factory settings. Please note that restoring factory settings may cause resolution changes.
Most cameras support the so-called still capture capability. This function switches the camera to another resolution temporarily when the camera is in preview mode, after a "still" image in the new resolution is captured and then switch back to the original resolution and resume preview mode.
For example, UCMOS05100KPA support 3 resolutions and the current one in preview mode is 1280 * 960. Call Explorecam_Snap(h, 0) to "still capture" an image in 2592 * 1944 resolution. To realize this function, the camera will temporarily switch to 2592 * 1944 firstly, get an image in 2592 * 1944 resolution and then switch back to 1280 * 960 and resume preview.
a) In pull mode operation, after the still capture, EXPLORE_EVENT_STILLIMAGE will be sent out for external acknowledgement. The external application should call Explorecam_PullStillImage(V2) to get the still captured image.
b) In push mode operation, after the still capture, the callback function PEXPLORE_DATA_CALLBACK_V3 will be called with bSnap parameter setting TRUE. The image information including the resolution information will be obtained via the parameter pHeader.
To check whether the camera have the still capture capability, call Explorecam_get_StillResolutionNumber function or check the still field of the struct ExplorecamModelV2.
Explorecam supports two data formats: RGB format (default) and RAW format. RAW format could be enabled by assigning EXPLORE_OPTION_RAW parameter to 1 when calling Explorecam_put_Option function.
Users could switch these two format by calling Explorecam_put_Option function with different value setting to EXPLORE_OPTION_RAW. You must call this function BEFORE the camera start function (Explorecam_StartPullModeWithWndMsg or Explorecam_StartPullModeWithCallback or Explorecam_StartPushMode).
1. Explorecam sdk supports two independent modes for white balance: a) Temp/Tint Mode; b) RGB Gain Mode
a) Temp/Tint mode is the default white balance mode. In this mode, temp and tint are the parameters that could be used to control the white balance. Explorecam_get_TempTint function is used to acquire the temp and tint values and Explorecam_put_TempTint is used to set the temp and tint values. Function Explorecam_AwbOnce is used to execute the auto white balance. When the white balance parameters change, EXPLORE_EVENT_TEMPTINT event will be notified for external use.
b) In RGB Gain mode, the while balace is controled by the gain values of the R,G,B channels. Explorecam_get_WhiteBalanceGain is used to acquire the parameters and Explorecam_put_WhiteBalanceGain is used to set the white balance parameters. Explorecam_AwbInit is used to execute the execute the auto white balance. When the white balance parameters change, EXPLORE_EVENT_WBGAIN event will be notified for external use.
The functions for these two modes cannot be misused:
a) In Temp/Tint mode, please use Explorecam_get_TempTint and Explorecam_put_TempTint and Explorecam_AwbOnce. Explorecam_get_WhiteBalanceGain and Explorecam_put_WhiteBalanceGain and Explorecam_AwbInit cannot be used, they always return E_NOTIMPL.
b) In RGB Gain mode, please use Explorecam_get_WhiteBalanceGain and Explorecam_put_WhiteBalanceGain and Explorecam_AwbInit. Explorecam_get_TempTint and Explorecam_put_TempTint and Explorecam_AwbOnce cannot be used, they always return E_NOTIMPL
When calling Explorecam_Open function, whether to add a '@' character at the beginning of the id parameter will determine the white balance mode. Add a '@' character at the beginning of the id parameter means the RGB gain mode. If you want to use the RGB Gain mode, for example, if the id parameter is "abcdef", please call the Explorecam_Open function with the id parameter "@abcdef".
2. There are two auto white balance mechanisms available in this field: one is continuous auto white balance and the other is a "once" auto white balance. The white balance parameters will be always calculated and updated for the continuous auto white balance mechanism. For "once" auto white balance mechanism, the white balance parameters will be calculated and updated only when triggered. Explorecam cameras support "once" auto white balance mechanism since it is more accurate and propriate for the microscope application, especially when the background is in pure color. Continuous white balance mechanism will encounter some problem in some cases.
3. Monochromatic camera does not support white balance. The functions metioned above always return E_NOTIMPL.
1. What is Trigger Mode
Explorecam camera has two working modes: video mode and trigger mode. When in trigger mode, no images will be available until the trigger conditions are met. Cameras have 2 types for triggering according to the types of trigger source, including software trigger mode, external trigger mode and simulated trigger mode.
2. The Difference between Trigger and Snap
Trigger mode is designed for accurate control of the camera and images would be acquired only when the conditions are met. Users could get the images by controlling the trigger conditions. Trigger mode must be pre-specified. Once the trigger mode is entered, no images will come out from the camera until the trigger conditions are met. The triggered images will stay the same property as the pre-specified resolution. Snap is designed to acquire the images from the camera in video mode. The resolution of the snapped image could be the same resolution as the video or could be different.
3. Software Trigger Mode
Camera could be triggered by software. In software trigger mode, images burst out only when users trigger the camera from the software. Numbers of the images of the triggering could also be controlled by software.
4. External Trigger Mode
Camera could be triggered by external trigger signal. By now Explorecam camera only supports positive-edge trigger mode.
5. Mix Trigger Mode
Both external and software trigger are enabled.
6. Simulated Trigger Mode
For cameras that do not support software trigger and external trigger, simulated trigger mode could be available. When in simulated trigger mode, the camera hardware actually works in the same mode as the video mode. But the up-level software will not obtain any images from the camera. The software buffer will stay empty until the user set the trigger conditions by software.
7. How to Enter the Trigger Mode
After the numeration of the connected camera, you can check the flag and find out what trigger mode does the camera support according to the following definition.Function Explorecam_put_Option(HExplorecam h, unsigned iOption, int iValue) could be used to set the camera to trigger mode when assign EXPLORE_OPTION_TRIGGER to the iOption parameter. iValue is used to specify the types of the trigger modes. Please see the following for reference.
8. How to Trigger the camera
Function Explorecam_Trigger(HExplorecam h, unsigned short nNumber) could be used to trigger the camera. Assigning different value to nNumber means different:nNumber = 0 means stop the trigger.If the EXPLORE_FLAG_TRIGGER_SINGLE flag is checked, the nNumber parameter must be assigned to 1 and 1 image will come out from the camera when Explorecam_Trigger is called.
nNumber = 0xFFFF means trigger continuously, the same as video mode;
nNumber = other valid values means nNumber images will come out from the camera.
Enter the trigger mode first and then call Explorecam_Trigger function to trigger the camera.
9. Trigger timeout
The timeout is recommended for not less than (Exposure Time * 102% + 4 Seconds).
HRESULT is not uncommon on the Windows platform. It's borrowed to macOS and Linux, see the table:
Please note that the return value >=0 means success (especially S_FALSE is also successful, indicating that the internal value and the value set by the user is equivalent, which means "no operation"). Therefore, the SUCCEEDED and FAILED macros should generally be used to determine whether the return value is successful or failed.
(Unless there are special needs, do not use "==S_OK" or "==0" to judge the return value)
| Name | Description | Value |
| S_OK | Operation successful | 0x00000000 |
| S_FALSE | Operation successful, nothing changed | 0x00000001 |
| E_FAIL | Unspecified failure | 0x80004005 |
| E_ACCESSDENIED | General access denied error | 0x80070005 |
| E_INVALIDARG | One or more arguments are not valid | 0x80070057 |
| E_NOTIMPL | Not supported or not implemented | 0x80004001 |
| E_POINTER | Pointer that is not valid | 0x80004003 |
| E_UNEXPECTED | Unexpected failure | 0x8000FFFF |
| E_WRONG_THREAD | Called in wrong thread | 0x8001010E |
| E_GEN_FAILURE | Device not functioning | 0x8007001F |
| E_PENDING | The data necessary to complete this operation is not yet available | 0x8000000a |
#define SUCCEEDED(hr) (((HRESULT)(hr)) >= 0) #define FAILED(hr) (((HRESULT)(hr)) < 0) |
Win: __stdcall, please see here
macOS, Linux and Android: __cdecl
These callback functions are called back from the internal thread in explore.dll, so great attention should be paid to multithread issue.
Please ensure that the callback funcion is simple and return quickly.
Otherwise, in callback mode, EXPLORE_OPTION_CALLBACK_THREAD can be setted to use a dedicated thread for callback.
There are limitations in the callback context:
(a) Do NOT call Explorecam_Stop and Explorecam_Close in this callback function, otherwise, deadlocks.
(b) Do NOT call Explorecam_put_Option with EXPLORE_OPTION_TRIGGER, EXPLORE_OPTION_BITDEPTH, EXPLORE_OPTION_PIXEL_FORMAT, EXPLORE_OPTION_BINNING, EXPLORE_OPTION_ROTATE, the return value is E_WRONG_THREAD.
Functions with coordinate parameters, such as Explorecam_put_Roi, Explorecam_put_AEAuxRect, etc., the coordinate is always relative to the original resolution, even that the video has been flipped, rotated, digital binning, ROIed, or combination of the previous operations.
If the image is upsize down (see here), the coordinate must be also upsize down.
Return value: non-negative integer, enumerated camera number
Parameters:
ExplorecamDeviceV2 pti[EXPLORE_MAX]: ExplorecamDeviceV2 buffer
Remarks: call this function to enumerate Explorecam cameras that are currently connected to computer and when it is returned, ExplorecamDeviceV2 buffer contains the information of each camera instance enumerated.If we don't care about that multiple cameras connect to the computer simultaneously, it's optional to call this function to enumerate the camera instances.
The code snippet shows as below:
ExplorecamDeviceV2 arr[EXPLORE_MAX];
unsigned cnt = Explorecam_EnumV2(arr);
for (unsigned i = 0; i < cnt; ++i)
...... |
typedef struct{
#ifdef _WIN32
const wchar_t* name; /* model name */
#else
const char* name;
#endif
unsigned long long flag; /* EXPLORE_FLAG_xxx */
unsigned maxspeed; /* maximum speed level, Explorecam_get_MaxSpeed, the speed range = [0, maxspeed], closed interval */
unsigned preview; /* number of preview resolution, Explorecam_get_ResolutionNumber */
unsigned still; /* number of still resolution, Explorecam_get_StillResolutionNumber */
unsigned maxfanspeed; /* maximum fan speed */
ExplorecamResolution res[EXPLORE_MAX];
}ExplorecamModelV2; |
| name | The name of this model | |
| flag | Bitwise flag | |
| EXPLORE_FLAG_CMOS | cmos sensor | |
| EXPLORE_FLAG_CCD_PROGRESSIVE | progressive ccd sensor | |
| EXPLORE_FLAG_CCD_INTERLACED | interlaced ccd sensor | |
| EXPLORE_FLAG_ROI_HARDWARE | support hardware ROI. Hardware ROI means only the ROI part of image is output from the sensor and the software cropping operation is not required. Higher frame rate is achieved when using hardware ROI method. Software ROI means the image with the complete field of view of the sensor will be output and software cropping operation is required to obtain the ROI image. | |
| EXPLORE_FLAG_MONO | monochromatic sensor | |
| EXPLORE_FLAG_BINSKIP_SUPPORTED | support bin/skip mode, see Explorecam_put_Mode and Explorecam_get_Mode | |
| EXPLORE_FLAG_USB30 | usb3.0 | |
| EXPLORE_FLAG_TEC | Thermoelectric Cooler | |
| EXPLORE_FLAG_USB30_OVER_USB20 | usb3.0 camera connected to usb2.0 port | |
| EXPLORE_FLAG_ST4 | ST4 port | |
| EXPLORE_FLAG_GETTEMPERATURE | support to get the temperature of the sensor, Explorecam_get_Temperature | |
| EXPLORE_FLAG_RAW10 | Pixel format, RAW 10 bits | |
| EXPLORE_FLAG_RAW12 | Pixel format, RAW 12 bits | |
| EXPLORE_FLAG_RAW14 | Pixel format, RAW 14 bits | |
| EXPLORE_FLAG_RAW16 | Pixel format, RAW 16 bits | |
| EXPLORE_FLAG_FAN | cooling fan | |
| EXPLORE_FLAG_TEC_ONOFF | Thermoelectric Cooler can be turn on or off, target temperature of TEC, see: EXPLORE_OPTION_TEC EXPLORE_OPTION_TECTARGET |
|
| EXPLORE_FLAG_ISP | ISP (Image Signal Processing) chip | |
| EXPLORE_FLAG_TRIGGER_SOFTWARE | support software trigger | |
| EXPLORE_FLAG_TRIGGER_EXTERNAL | support external trigger | |
| EXPLORE_FLAG_TRIGGER_SINGLE | only support trigger single, one trigger, one image | |
| EXPLORE_FLAG_BLACKLEVEL | support set and get the black level | |
| EXPLORE_FLAG_FOCUSMOTOR | support focus motor | |
| EXPLORE_FLAG_AUTO_FOCUS | support auto focus | |
| EXPLORE_FLAG_BUFFER | frame buffer | |
| EXPLORE_FLAG_DDR | use very large capacity DDR (Double Data Rate SDRAM) for frame buffer. The capacity is not less than one full frame. | |
| EXPLORE_FLAG_CG | Conversion Gain: LCG, HCG | |
| EXPLORE_FLAG_CGHDR | Conversion Gain: LCG, HCG, HDR | |
| EXPLORE_FLAG_EVENT_HARDWARE | hardware event, such as exposure start & stop. see here and here | |
| EXPLORE_FLAG_YUV411 | pixel format, yuv411 | |
| EXPLORE_FLAG_YUV422 | pixel format, yuv422 | |
| EXPLORE_FLAG_YUV444 | pixel format, yuv444 | |
| EXPLORE_FLAG_RGB888 | pixel format, RGB888 | |
| EXPLORE_FLAG_RAW8 | pixel format, RAW 8 bits | |
| EXPLORE_FLAG_GMCY8 | pixel format, GMCY, 8bits | |
| EXPLORE_FLAG_GMCY12 | pixel format, GMCY, 12 btis | |
| EXPLORE_FLAG_GLOBALSHUTTER | global shutter | |
| EXPLORE_FLAG_PRECISE_FRAMERATE | support precise framerate & bandwidth, see EXPLORE_OPTION_PRECISE_FRAMERATE & EXPLORE_OPTION_BANDWIDTH | |
| EXPLORE_FLAG_HEAT | support heat to prevent fogging up, see EXPLORE_OPTION_HEAT & EXPLORE_OPTION_HEAT_MAX | |
| EXPLORE_FLAG_LOW_NOISE | support low noise mode, see EXPLORE_OPTION_LOW_NOISE | |
| EXPLORE_FLAG_LEVELRANGE_HARDWARE | hardware level range | |
| EXPLORE_FLAG_LIGHTSOURCE | light source | |
| maxspeed | Maximum speed level, same with Explorecam_get_MaxSpeed. The speed range is [0, maxspeed]. see Explorecam_put_Speed and Explorecam_get_Speed | |
| preview | Number of preview resolution. Same with Explorecam_get_ResolutionNumber | |
| still | Number of still resolution, zero means still capture is not supported. Same with Explorecam_get_StillResolutionNumber | |
| res | Resolution, width and height | |
Return value: NA
Parameters:
PEXPLORE_HOTPLUG pHotPlugCallback: callback function
void* pCallbackCtx: callback context
Remarks:
This function is only available on macOS, Linux and Android.
To process the device plug in / pull out in Windows, please refer to the MSDN(Device Management, Detecting Media Insertion or Removal).
To process the device plug in / pull out in Linux/macOS/Android, please call this function to register the callback function. When the device is inserted or pulled out, you will be notified by the callback funcion, and then call Explorecam_EnumV2(...) again to enum the cameras.
On macOS, IONotificationPortCreate series APIs can also be used as an alternative.
Recommendation: for better rubustness, when notify of device insertion arrives, don't open handle of this device immediately, but open it after delaying a short time (e.g., 200 milliseconds).
Return value: HExplorecam handle. Return NULL when fails (Such as the device has been pulled out).
Parameters:
id: Explorecam camera instance, enumerated by Explorecam_EnumV2. If id is NULL, Explorecam_Open will open the first camera which connects to the computer. So, if we don't care about that multiple cameras connect to the computer simultaneously, Explorecam_EnumV2 is optional, we can simply use NULL as the parameter.
Remarks: open the camera instance.
Camera Configuration:No parameter is required after id parameter if automatic parameter saving or loading is not required.
Add the specific parameters after the id parameter when automatic parameter saving (when closing the camera) or loading (when starting the camera) is required, for example, Explorecam_Open(L"0-1010;registry=").
Please refer to the following description for details:
| Registry (Windows only) | ;registry=xxxx\yyyy | use the registry that the camera parameters are saved to or load from. Empty after “=” means that the default registry location will be used |
| ini file | ;ini=x:\yyyy\zzzz.ini | indicates that x:\yyyy\zzzz.ini is the file where camera parameters are saved to or load from. Complete directory must be specified and empty is not allowed. Please Make sure that the target directory exists and is readable and writeable |
| json file | ;json=x:\yyyy\zzzz.json | indicates that x:\yyyy\zzzz.json is the file where camera parameters are saved to or load from. Complete directory must be specified and empty is not allowed. Please Make sure that the target directory exists and is readable and writeable |
| EEPROM | ;eeprom=xxxx | indicates that EEPROM is the device where the camera parameters are saved to or load from. xxxx is the starting address in EEPROM and empty means the starting address is 0 |
Return value: void
Parameters:
HExplorecam h: camera instance handle
Remarks: close the camera instance. After it is closed, never use the HExplorecam handle any more.
Return value: HRESULT type means "success / failure"
Parameters:
HExplorecam h: instance handle opened by Explorecam_Open
HWND hWnd: event occurs, message will be posted in this window
UINT nMsg: Windows custom message type. Its WPARAM parameter means event type EXPLORE_EVENT_xxxx, LPARAM is useless (always zero)
PEXPLORE_EVENT_CALLBACK pEventCallback, void* pCallbackContext: callback function specified by user's application and callback context parameter.
see here.
Remarks: Obviously, Explorecam_StartPullModeWithWndMsg is only supported in Windows OS.
Return value: HRESULT type means "success/ failure". Return E_PENDING when there isn't image ready for pull.
Parameters:
HExplorecam h: instance handle opened by Explorecam_Open
void* pImageData: Data buffer. Users have to make sure that the data buffer capacity is enough to save the image data, data buffer capacity must >= rowPitch * nHeight.
int bits: 24, 32, 48, 8, 16, means RGB24, RGB32, RGB48, 8 bits gray or 16 bits gray images. This parameter is ignored in RAW mode.
int rowPitch: the distance from one row to the next row. rowPitch = 0 means using the default row pitch. rowPitch = -1 means zero padding
unsigned* pnWidth, unsigned* pnHeight: out parameter. width and height of image.
ExplorecamFrameInfoV2* pInfo: out parameter, frame info. Some cameras support frame sequence and frame timestamp, for other unsigned cameras, sequence and timestamp are always 0
Remarks: when pImageData is NULL, while pnWidth and pnHeight are not NULL, you can "peek" the width and height of images.
Please ensure that the pImageData buffer is large enough to hold the entire frame data, see the table below:
Format =0 means Default Row Pitch =-1 means zero paddding RGB RGB24 TDIBWIDTHBYTES(24 * Width) Width * 3 RGB32 Width * 4 Width * 4 RGB48 TDIBWIDTHBYTES(48 * Width) Width * 6 GREY8 grey image TDIBWIDTHBYTES(8 * Width) Width GREY16 grey image TDIBWIDTHBYTES(16 * Width) Width * 2 RAW 8bits Mode Width Width 10bits, 12bits, 14bits, 16bits Mode Width * 2 Width * 2
#ifndef TDIBWIDTHBYTES
#define TDIBWIDTHBYTES(bits) ((unsigned)(((bits) + 31) & (~31)) / 8)
#endif
Return value: HRESULT type means success or failure
Parameters:
HExplorecam h: instance handle opened by Explorecam.
PEXPLORE_DATA_CALLBACK_V3 pDataCallback, void* pDataCallbackCtx: the callback function and callback context parameters that are specified by the user's program. Explorecam.dll gets image data from the camera, then calls back this function.
typedef void (*PEXPLORE_DATA_CALLBACK_V3)(const void* pData, const ExplorecamFrameInfoV2* pInfo, int bSnap, void* pCallbackCtx); see here.
when calls back, if Parameter pData == NULL, then internal error occurs (eg: the camera is pulled out suddenly).
The row pitch of pData is always the default value.
For parameter int bSnap, TRUE means still image snap by Explorecam_Snap or Explorecam_SnapN function, FALSE means ordinary previewed pictures / videos.
Remarks: start camera instance.
Return value: HRESULT type means success or failure
Parameters:
HExplorecam handle
Remarks: stop the camera instance. After stopped, it can be restart again. For example, switching the video resolution:
Step 1: call Explorecam_Stop to stop
Step 2: call Explorecam_put_Size or Explorecam_put_eSize to set the new resolution
Step 3: call Explorecam_StartPullModeWithWndMsg or Explorecam_StartPullModeWithCallback or Explorecam_StartPushModeV3 to restart
Return value: HRESULT type means success or failure
Parameters:
HExplorecam h: camera instance handle
Remarks: pause/continue camera instance.
Return value: HRESULT type means success or failure
Parameters:
HExplorecam h: camera instance handle
unsigned nResolutionIndex: resolution index.
Remarks: snap 'still' image, please see here. When snap successfully:
a) If we use Pull Mode, it will be notified by EXPLORE_EVENT_STILLIMAGE.
b) If we use Push Mode, the image will be returned by callback function PEXPLORE_DATA_CALLBACK_V3 with the parameter int bSnap is TRUE.
Most cameras can snap still image with different resolutions under continuous preview. For example, UCMOS03100KPA's previewed resolution is 1024*768, if we call Explorecam_Snap(h, 0), we get so called "still image" with 2048*1536 resolution.
Some cameras hasn't this ability, so nResolutionIndex must be equal the preview resolution which is set by Explorecam_put_Size, or Explorecam_put_eSize.
Whether it supports "still snap" or not, see "still" domain in ExplorecamModelV2.Explorecam_Snap(h, index) == Explorecam_SnapN(h, index, 1)
Return value: HRESULT type means success or failure.
Parameters:
HExplorecam h: camera instance handle
unsigned short nNumber: 0xffff(trigger continuously), 0(stop / cancel trigger), others(number of images to be triggered)
Remarks: in trigger mode, call this function to trigger an image:
a) If we use Pull Mode, it will be notified by EXPLORE_EVENT_IMAGE.
b) If we use Push Mode, the image will be returned by callback function PEXPLORE_DATA_CALLBACK_V3 with the parameter int bSnap is FALSE.
Return value: HRESULT type means success or failure
Parameters:
HExplorecam h: camera instance handle
unsigned nResolutionIndex: current/present resolution index
int nWidth, int nHeight: width and height of current resolution index
Remarks: set/get current resolution
Set resolution before running Explorecam_StartPullModeWithWndMsg or Explorecam_StartPullModeWithCallback or Explorecam_StartPushModeV3
There are two ways to set current resolution: one is by resolution index, the other by width/height. Both ways are equivalent. For example, UCMOS03100KPA supports the following three kinds of resolution:
Index 0: 2048, 1536
Index 1: 1024, 768
Index 2: 680, 510
So Explorecam_put_Size(h, 1024, 768) is as effective as Explorecam_put_eSize(h, 1)
Return value: HRESULT type means success or failure.
Parameters:
HExplorecam h: camera instance handle
unsigned xOffset: x offset, must be even number
unsigned yOffset: y offset, must be even number
unsigned xWidth: width, must be even number and must not be less than 16
unsigned yHeight: height, must be even number and must not be less than 16
Remarks: set/get the ROI. Explorecam_put_Roi(h, 0, 0, 0, 0) means to clear the ROI and restore the original size.
Important: It is forbidden to call Explorecam_put_Roi in the callback context of PEXPLORE_EVENT_CALLBACK and PEXPLORE_DATA_CALLBACK_V3, the return value is E_WRONG_THREAD.
Pay attention to that the coordinate is always relative to the original resolution, see here.
The second resolution of UHCCD03100KPB, UHCCD05000KPA, UHCCD05100KPA don't support ROI, so the return value is E_NOTIMPL.
Return value: HRESULT type means success or failure
Parameters:
HExplorecam h: camera instance handle
unsigned nResolutionIndex: resolution index
int* pWidth, int* pHeight: width/height
Remarks: Explorecam_get_ResolutionNumber means the number of resolution supported. Take UCMOS03100KPA as an example, if we call the function Explorecam_get_ResolutionNumber and get "3", which means it can support three kinds of resolution. Explorecam_get_Resolution gets the width/height of each kind of resolution.
These parameters have also been contained in ExplorecamModelV2.
Return value: HRESULT type means success or failure
Parameters:
HExplorecam h: camera instance handle
unsigned* nFourCC: raw format, see the table below
unsigned* bitdepth: bit depth, such as 8, 10, 12, 14, 16
#ifndef MAKEFOURCC
#define MAKEFOURCC(a, b, c, d) ((unsigned)(unsigned char)(a) | ((unsigned)(unsigned char)(b) << 8) | ((unsigned)(unsigned char)(c) << 16) | ((unsigned)(unsigned char)(d) << 24))
#endif
MAKEFOURCC('G', 'B', 'R', 'G') GBGBGB...
RGRGRG...
GBGBGB...
RGRGRG...
...
see hereMAKEFOURCC('R', 'G', 'G', 'B') RGRGRG...
GBGBGB...
RGRGRG...
GBGBGB...
...MAKEFOURCC('B', 'G', 'G', 'R') BGBGBG...
GRGRGR...
BGBGBG...
GRGRGR...
...MAKEFOURCC('G', 'R', 'B', 'G') GRGRGR...
BGBGBG...
GRGRGR...
BGBGBG...
...MAKEFOURCC('V', 'U', 'Y', 'Y') YUV4:2:2, please see: http://www.fourcc.org MAKEFOURCC('U', 'Y', 'V', 'Y') YUV4:2:2 MAKEFOURCC('Y', 'Y', 'Y', 'Y') Black / White camera
Return value: HRESULT type means success or failure
Parameters:
HExplorecam h: camera instance handle
unsigned iOption: see the table
int iValue: see the table
Option Description Default The value can be changed after Explorecam_StartPullModeWithWndMsg or Explorecam_StartPullModeWithCallback or Explorecam_StartPushModeV3?
The value can be changed on-the-fly?EXPLORE_OPTION_RAW 0 means RGB mode.
1 means RAW mode, read the CMOS or CCD raw data.0 No
(The return value is E_UNEXPECTED when set this option after the camera is started)EXPLORE_OPTION_BITDEPTH Some cameras support the bit depth which is more than 8 such as 10, 12, 14, 16.
0 = use 8 bits depth.
1 = use the maximum bits depth of this camera.NA Yes.
But not recommended to modify frequently after starting the camera, it is best to set it up before starting.EXPLORE_OPTION_FAN Some cameras support the cooling fan.
0 = turn off the cooling fan
[1, max] = fan speedNA Yes EXPLORE_OPTION_TEC Some cameras support to turn on or off the thermoelectric cooler.
0 = turn off the thermoelectric cooler
1 = turn on the thermoelectric cooler1 Yes EXPLORE_OPTION_TRIGGER 0 = video mode
1 = software or simulated trigger mode
2 = external trigger mode
3 = external + software trigger0 Yes EXPLORE_OPTION_RGB 0 = RGB24
1 = enable RGB48 format when bitdepth > 8
2 = RGB32
3 = 8 bits gray (only for mono camera)
4 = 16 bits gray (only for mono camera and bitdepth > 8)0 No
(The return value is E_UNEXPECTED when set this option after the camera is started)EXPLORE_OPTION_BYTEORDER Byte order:
1: BGR
0: RGBWin: 1
Linux/MacOS/Android: 0Yes.
But not recommended to modify frequently after starting the camera, it is best to set it up before starting.EXPLORE_OPTION_UPSIDE_DOWN Upside down:
1: yes
0: no
Please distinguish it from Explorecam_put_VFlip, which requires the CPU to perform data moving work on each frame of dataWin: 1
Linux/MacOS/Android: 0Yes EXPLORE_OPTION_TECTARGET get or set the target temperature of the thermoelectric cooler, in 0.1℃. For example, 125 means 12.5℃, -35 means -3.5℃ NA Yes EXPLORE_OPTION_AUTOEXP_POLICY Auto Exposure Policy:
0: Exposure Only
1: Exposure Preferred
2: Gain Only
3: Gain Preferred1 Yes EXPLORE_OPTION_AUTOEXP_THRESHOLD threshold of auto exposure, range: [2~15] 5 Yes EXPLORE_OPTION_FRAMERATE limit the frame rate, range=[0, 63].
frame rate control is disabled automatically in trigger mode.0
(means no limit)No
(The return value is E_UNEXPECTED when set this option after the camera is started)EXPLORE_OPTION_BLACKLEVEL Black Level
Always return E_NOTIMPL for camera that don't support black level.0 Yes EXPLORE_OPTION_MULTITHREAD multithread image processing 1 No
(The return value is E_UNEXPECTED when set this option after the camera is started)EXPLORE_OPTION_BINNING digital binning:
0x01 (no binning)
0x02 (add, 2*2)
0x03 (add, 3*3)
0x04 (add, 4*4)
0x05 (add, 5*5)
0x06 (add, 6*6)
0x07 (add, 7*7)
0x08 (add, 8*8)
0x82 (average, 2*2)
0x83 (average, 3*3)
0x84 (average, 4*4)
0x85 (average, 5*5)
0x86 (average, 6*6)
0x87 (average, 7*7)
0x88 (average, 8*8)
The final image size is rounded down to an even number, such as 640/3 to get 2121 Yes EXPLORE_OPTION_ROTATE rotate clockwise: 0, 90, 180, 270 0 Yes EXPLORE_OPTION_CG Conversion Gain:
0: LCG
1: HCG
2: HDRNA Yes EXPLORE_OPTION_PIXEL_FORMAT pixel format NA Yes.
But not recommended to modify frequently after starting the camera, it is best to set it up before starting.EXPLORE_OPTION_DDR_DEPTH the number of the frames that DDR can cache:
1: DDR cache only one frame
0: Auto:->one for video mode when auto exposure is enabled->full capacity for others-1: DDR can cache frames to full capacity0 Yes EXPLORE_OPTION_FFC Flat Field Correction:
set:0: disable1: enable-1: reset(0xff000000 | n): set the average number to n, [1~255]get:(val & 0xff): 0 -> disable, 1 -> enable, 2 -> inited((val & 0xff00) >> 8): sequence((val & 0xff0000) >> 8): average number0 Yes EXPLORE_OPTION_DFC Dark Field Correction:
set:0: disable1: enable-1: reset(0xff000000 | n): set the average number to n, [1~255]get:(val & 0xff): 0 -> disable, 1 -> enable, 2 -> inited((val & 0xff00) >> 8): sequence((val & 0xff0000) >> 8): average number0 Yes EXPLORE_OPTION_SHARPENING Sharpening, (threshold << 24) | (radius << 16) | strength)
strength: [0, 500], default: 0 (disable)radius: [1, 10]threshold: [0, 255]0 Yes EXPLORE_OPTION_FACTORY restore the factory settings Always 0 Yes EXPLORE_OPTION_TEC_VOLTAGE get the current TEC voltage in 0.1V, 59 mean 5.9V;
Please do not get this value too frequently, the recommended interval is 2 seconds or moreNA NA EXPLORE_OPTION_TEC_VOLTAGE_MAX get the TEC maximum voltage in 0.1V NA NA EXPLORE_OPTION_POWER get power consumption, unit: milliwatt NA NA EXPLORE_OPTION_GLOBAL_RESET_MODE global reset mode 0 Yes EXPLORE_OPTION_DEVICE_RESET reset usb device, simulate a replug NA NA EXPLORE_OPTION_FOCUSPOS focus positon NA Yes EXPLORE_OPTION_AFMODE auto focus mode:
0: manul focus
1: auto focus
2: once focus
3: conjugate calibrationNA Yes EXPLORE_OPTION_AFZONE auto focus zone NA Yes EXPLORE_OPTION_AFFEEDBACK auto focus information feedback:
0: unknown
1: focused
2: focusing
3: defocus
4: up
5: downNA Yes EXPLORE_OPTION_TESTPATTERN test pattern:
0: TestPattern Off
3: monochrome diagonal stripes
5: monochrome vertical stripes
7: monochrome horizontal stripes
9: chromatic diagonal stripes0 Yes EXPLORE_OPTION_NOFRAME_TIMEOUT Report error if cannot grab frame in maximum exposure time.
1 = enable this feature;
0 = disable this feature.0 Yes EXPLORE_OPTION_NOPACKET_TIMEOUT Report event if cannot grab packet in the set time.
0 = disable this feature
positive value = timeout milliseconds0 Yes EXPLORE_OPTION_BANDWIDTH bandwidth, range:[1-100]%
After setting the bandwidth, get the accurate frame rate range, and then set the precise frame rate90% Yes EXPLORE_OPTION_MAX_PRECISE_FRAMERATE get the precise frame maximum value in 0.1fps, such as 115 means 11.5fps
the maximum value depends the bandwidth/resolution/bitdepth/ROI, etc
E_NOTIMPL means not supportedNA NA EXPLORE_OPTION_MIN_PRECISE_FRAMERATE get the precise frame minimum value in 0.1fps, such as 15 means 1.5fps
the minimum value depends the bandwidth/resolution/bitdepth/ROI, etc
E_NOTIMPL means not supportedNA NA EXPLORE_OPTION_PRECISE_FRAMERATE in 0.1fps, such as 115 means 11.5fps. range:[1~maximum] 90% of the maximum Yes EXPLORE_OPTION_RELOAD Reload the last frame in the trigger mode
get return value S_OK means supporting this feature, E_NOTIMPL means not supportedNA Yes EXPLORE_OPTION_CALLBACK_THREAD dedicated thread for callback, only available in pull mode 0 No EXPLORE_OPTION_FRONTEND_DEQUE_LENGTH
or
EXPLORE_OPTION_FRAME_DEQUE_LENGTHfrontend frame deque length, range: [2, 1024]
All the memory will be pre-allocated when the camera starts, so, please attention to memory usage4 No EXPLORE_OPTION_BACKEND_DEQUE_LENGTH backend frame deque length (Only available in pull mode), range: [2, 1024]
All the memory will be pre-allocated when the camera starts, so, please attention to memory usage3 No EXPLORE_OPTION_SEQUENCER_ONOFF sequencer trigger: on/off 0 Yes EXPLORE_OPTION_SEQUENCER_NUMBER sequencer trigger: number, range = [1, 255] NA Yes EXPLORE_OPTION_SEQUENCER_EXPOTIME sequencer trigger: exposure time
iOption = EXPLORE_OPTION_SEQUENCER_EXPOTIME | index
iValue = exposure time (no 50/60 HZ constraint)
For example, to set the exposure time of the third group to 50ms, call
Explorecam_put_Option(EXPLORE_OPTION_SEQUENCER_EXPOTIME | 3, 50000)NA Yes EXPLORE_OPTION_SEQUENCER_EXPOGAIN sequencer trigger: exposure gain
iOption = EXPLORE_OPTION_SEQUENCER_EXPOGAIN | index
iValue = gainNA Yes EXPLORE_OPTION_DENOISE Denoise
strength range: [0, 100], 0 means disable0 Yes EXPLORE_OPTION_HEAT_MAX get maximum level: heat to prevent fogging up
[0, max], 0 means offNA NA EXPLORE_OPTION_HEAT heat to prevent fogging up max level Yes EXPLORE_OPTION_LIGHTSOURCE_MAX get maximum level: light source
[0, max], 0 means offNA NA EXPLORE_OPTION_LIGHTSOURCE light source level 50% max level Yes EXPLORE_OPTION_HEARTBEAT Heartbeat interval in millisecond
range: [EXPLORE_HEARTBEAT_MIN, EXPLORE_HEARTBEAT_MAX]
0: disabledisable Yes TOUCPAM_OPTION_EVENT_HARDWARE enable or disable hardware event: iOption = TOUCPAM_OPTION_EVENT_HARDWARE | (event type), iValue = 1 (enable), 0 (disable)
see here and heredisable Yes EXPLORE_OPTION_LOW_NOISE low noise mode (Higher signal noise ratio, lower frame rate) 0 Yes EXPLORE_OPTION_DEFECT_PIXEL Defect Pixel Correction
0 => disable, 1 => enableenable (1) Yes EXPLORE_OPTION_THREAD_PRIORITY set the priority of the internal thread which grab data from the usb device.
Win:0 = THREAD_PRIORITY_NORMAL;Linux & macOS:
1 = THREAD_PRIORITY_ABOVE_NORMAL;
2 = THREAD_PRIORITY_HIGHEST;
3 = THREAD_PRIORITY_TIME_CRITICAL;
Please refer to SetThreadPriorityThe high 16 bits for the scheduling policy, and the low 16 bits for the priority.
Please refer to pthread_setschedparamWin: 1
Linux / macOS: NAYes EXPLORE_OPTION_LINEAR 0 = turn off the builtin linear tone mapping
1 = turn on the builtin linear tone mapping1 Yes EXPLORE_OPTION_CURVE 0 = turn off the builtin curve tone mapping
1 = turn on the builtin polynomial curve tone mapping
2 = turn on the builtin logarithmic curve tone mapping2 Yes EXPLORE_OPTION_COLORMATIX 0 = turn off the builtin color matrix
1 = turn on the builtin color matrix1 Yes EXPLORE_OPTION_WBGAIN 0 = turn off the builtin white balance gain
1 = turn on the builtin white balance gain1 Yes EXPLORE_OPTION_DEMOSAIC Demosaic mothod for both video and still image: (Please refrence https://en.wikipedia.org/wiki/Demosaicing)
0 = BILINEAR
1 = VNG(Variable Number of Gradients)
2 = PPG(Patterned Pixel Grouping)
3 = AHD(Adaptive Homogeneity Directed)
4 = EA(Edge Aware)
Always return E_NOTIMPL for monochromatic camera.0 Yes EXPLORE_OPTION_DEMOSAIC_VIDEO Demosaic mothod for video 0 Yes EXPLORE_OPTION_DEMOSAIC_STILL Demosaic mothod for still image 0 Yes EXPLORE_OPTION_OPEN_USB_ERRORCODE get the open usb error code NA NA EXPLORE_OPTION_FLUSH 1: hard flush, discard frames cached by camera DDR (if any)
2: soft flush, discard frames cached by explore.dll (if any)
3: both
Explorecam_Flush means 'both'NA NA EXPLORE_OPTION_NUMBER_DROP_FRAME get the number of frames that have been grabbed from the USB but dropped by the software NA NA EXPLORE_OPTION_DUMP_CFG explicitly dump configuration to ini, json, or EEPROM. when camera is closed, it will dump configuration automatically NA NA EXPLORE_OPTION_FRONTEND_DEQUE_CURRENT get the current number in frontend deque NA NA EXPLORE_OPTION_BACKEND_DEQUE_CURRENT get the current number in backend deque NA NA EXPLORE_OPTION_PACKET_NUMBER get the received packet number NA NA EXPLORE_OPTION_LINUX_USB_ZEROCOPY global option for linux platform:
enable or disable usb zerocopy (helps to reduce memory copy and improve efficiency. Requires kernel version >= 4.6 and hardware platform support).
if the image is wrong, this indicates that the hardware platform does not support this feature, please disable it when the program starts:
Explorecam_put_Option((this is a global option, the camera handle parameter is not required, use nullptr), EXPLORE_OPTION_LINUX_USB_ZEROCOPY, 0)disable(0): android or arm
enable(1): othersNo
(Must be set before open camera (Explorecam_Open))
Important:
a. Some options cannot be changed after the camera is started. This is to say the option cannot be changed on-the-fly.
b. It is forbidden to call Explorecam_put_Option with EXPLORE_OPTION_TRIGGER, EXPLORE_OPTION_BITDEPTH, EXPLORE_OPTION_PIXEL_FORMAT, EXPLORE_OPTION_BINNING, EXPLORE_OPTION_ROTATE in the callback context of PEXPLORE_EVENT_CALLBACK and PEXPLORE_DATA_CALLBACK_V3, the return value is E_WRONG_THREAD.
c. The second resolution of UHCCD03100KPB, UHCCD05000KPA, UHCCD05100KPA don't support RAW mode.
Return value: HRESULT type means success or failure
Parameters:
HExplorecam h: camera instance handle
int val:
0: stop grab frame when frame buffer deque is full, until the frames in the queue are pulled away and the queue is not full
1: realtime
use minimum frame buffer. When new frame arrive, drop all the pending frame regardless of whether the frame buffer is full
If DDR present, also limit the DDR frame buffer to only one frame. 2: soft realtime
Drop the oldest frame when the queue is full and then enqueue the new frame
Remarks: If you set RealTime mode as 1, then you get shorter frame delay but lower frame rate which damages fluency. The default value is 0.
Return value: HRESULT type means success or failure
Parameters:
HExplorecam h: camera instance handle
int bAutoExposure:
0: disable auto exposure
1: auto exposure continue mode
2: auto exposure once modeunsigned short Target: auto-exposure target
unsigned maxTime, unsigned short maxAGain: the maximum time and maximum gain of auto exposure. The default values are 350ms and 500.
unsigned minTime, unsigned short minAGain: the minimal time and minimal gain of auto exposure. The default values are 0 and 100.
Remarks: If auto exposure is enabled, the exposure time and gain are controlled by software to make the average brightness of the target rectangle as close as possible to the auto exposure target. The auto exposure target value is the target brightness of the target rectangle (see Explorecam_put_AEAuxRect, Explorecam_get_AEAuxRect).
Return value: HRESULT type means success or failure
Parameters:
HExplorecam h: camera instance handle
unsigned Time: exposure time, unit: microsecond
unsigned* nMin, unsigned* nMax, unsigned* nDef: the minimum, maximum and default value of exposure time.
Remarks: exposure time related. Explorecam_get_RealExpoTime get the real exposure time based on 50HZ/60HZ.
Return value: HRESULT type means success or failure
Parameters:
HExplorecam h: camera instance handle
unsigned short AGain: gain, shown in percentage, eg, 200 means the gain is 200%
unsigned short* nMin, unsigned short* nMax, unsigned short* nDef: the minimum, maximum and default value of gain.
Remarks: gain related.
Return value: HRESULT type means success or failure
Parameters:
HExplorecam h: camera instance handle
Remarks: set or get hue, saturation, brightness, contrast and gamma.
Return value: HRESULT type means success or failure
Parameters:
HExplorecam h: camera instance handle
int bChrome: TRUE or FALSE
Remarks: color or gray mode
Return value: HRESULT type means success or failure
Parameters: HExplorecam h: camera instance handle
Remarks: vertical/horizontal flip.
Return value: HRESULT type means success or failure
Parameters:
HExplorecam h: camera instance handle
unsigned short nSpeed: frame rate level
Remarks: the minimum frame rate level is "0", the maximum one can be achieved through Function "Explorecam_get_MaxSpeed" which equals to maxspeed in ExplorecamModelV2.
For some cameras that support the so-called precise frame rate, it is recommended to use precise frame rate control. In order to maintain compatibility, Speed is still valid, and the mapping mechanism is: MaxSpeed is 9 (10 levels in total), corresponding to the maximum frame rate when Bandwidth is from 10% to 100%. For example, set the speed to 8, which is equivalent to: The precise frame rate is set to the maximum frame rate with bandwith is set to 90%.
Return value: HRESULT type means success or failure
Parameters:
HExplorecam h: camera instance handle
int nHZ: 0: 60Hz alternating current, 1: 50Hz alternating current, 2: direct current
Remarks: set the light source power frequency
Return value: HRESULT type means success or failure, E_NOTIMPL means not supporting get or set the temperature
Parameters:
HExplorecam h: camera instance handle
short nTemperature: in 0.1℃ (32 means 3.2℃, -35 means -3.5℃).
Remarks: get the temperature of the sensor. see EXPLORE_FLAG_GETTEMPERATURE.
set the target temperature of the sensor, equivalent to Explorecam_put_Option(, EXPLORE_OPTION_TECTARGET, ).
Return value: HRESULT type means success or failure
Parameters:
HExplorecam h: camera instance handle
int bSkip: Bin mode or Skip mode.
Remarks: set Bin mode or Skip mode. Cameras with higher resolution can support two sampling modes, one is Bin mode (Neighborhood averaging), the other is Skip (sampling extraction). In comparison, the former is with better image effect but decreasing frame rate while the latter is just the reverse.
Return value: HRESULT type means success or failure. Works int Temp/Tint mode. Does not work int RGB Gain mode, E_NOTIMPL will be return.
Parameters:
HExplorecam h: camera instance handle
int nTemp, int nTint: color temperature and Tint
Remarks: set/get the color temperature and Tint parameters of white balance (Temp/Tint Mode, please see here).
Return value: HRESULT type means success or failure. Works int Temp/Tint mode. Does not work int RGB Gain mode, E_NOTIMPL will be return.
Parameters:
HExplorecam h: camera instance handle
PIEXPLORE_TEMPTINT_CALLBACK fnTTProc, void* pTTCtx: callback function and callback context when the automatic white balance completes.
Remarks: Call this function to perform one "auto white balance" in Temp/Tint Mode. When the "auto white balance" completes, EXPLORE_EVENT_TEMPTINT event notify the application (In Pull Mode) and callback happens. In pull mode, this callback is useless, set it to NULL.
Return value: HRESULT type means success or failure. Works int RGB Gain mode. Does not work int Temp/Tint Gain mode, E_NOTIMPL will be return.
Parameters:
HExplorecam h: camera instance handle
int aGain[3]: RGB Gain
Remarks: set/get the RGB gain parameters of white balance (RGB Gain Mode, please see here).
Return value: HRESULT type means success or failure. Works int RGB Gain mode. Does not work int Temp/Tint mode, E_NOTIMPL will be return.
Parameters:
HExplorecam h: camera instance handle
PIEXPLORE_WHITEBALANCE_CALLBACK fnWBProc, void* pWBCtx: callback function and callback context when the automatic white balance completes.
Remarks: Call this function to perform one "auto white balance" in RGB Gain Mode. When the "auto white balance" completes, EXPLORE_EVENT_WBGAIN event notify the application (In Pull Mode) and callback happens. In pull mode, this callback is useless, set it to NULL.
Return value: HRESULT type means success or failure.
Parameters:
HExplorecam h: camera instance handle
PIEXPLORE_BLACKBALANCE_CALLBACK fnBBProc, void* pBBCtx: callback function and callback context when the automatic black balance completes.
Remarks: Call this function to perform one "auto black balance". When the "auto black balance" completes, EXPLORE_EVENT_BLACK event notify the application (In Pull Mode) and callback happens. In pull mode, this callback is useless, set it to NULL.
Return value: HRESULT type means success or failure.
Parameters:
HExplorecam h: camera instance handle
unsigned short aSub[3]: RGB Offset
Remarks: set/get the RGB offset parameters of black balance.
Return value: HRESULT type means success or failure
Parameters:
HExplorecam h: camera instance handle
Remarks: set/get the rectangle of automatic white balance and auto-exposure and automatic black balance. The default Rectangle is in the center of the image, its width is 20% image with, its height is 20% image height.
Pay attention to that the coordinate is always relative to the original resolution, see here.
Return value: S_OK means mono mode, S_FALSE means color mode
Parameters:
Explorecam h: camera instance handle
Remarks: gray camera or not, find the flag in ExplorecamModelV2: EXPLORE_FLAG_MONO
Return value: the maximum bit depth this camera supports.
Parameters:
HExplorecam h: camera instance handle
Remarks: Some cameras support the bit depth which is more than 8 such as 10, 12, 14, 16.
Return value: HRESULT type means success or failure
Parameters:
HExplorecam h: camera instance handle
unsigned nResolutionIndex: resolution index
int* pWidth, int* pHeight: width/height
Remarks: Explorecam_get_StillResolutionNumber means the number of supported still resolution. Take UCMOS03100KPA as an example, if we call the function Explorecam_get_StillResolutionNumber and get "3", which means it can support three kinds of resolution. If it doesn't support "still snap", then we get "0". Explorecam_get_Resolution gs the width/height of each kind of resolution.
Return value: HRESULT type means success or failure
Parameters:
HExplorecam h: camera instance handle
char sn[32]: buffer to the serial number, such as: TP110826145730ABCD1234FEDC56787
char fwver[16]: buffer to the firmware version, such as: 3.2.1.20140922
char hwver[16]: buffer to the hardware version, such as: 3.12
char pdate[10]: buffer to the production date, such as: 20150327
unsigned short pRevision: revision
Remarks: each camera has a unique serial number with 31 letters.
Return value: HRESULT type means success or failure
Parameters:
HExplorecam h: camera instance handle
unsigned nResolutionIndex: resolution index
float* x, float* y: physical pixel size(µm)
Return value: HRESULT type means success or failure
Parameters:
HExplorecam h: camera instance handle
unsigned short iLed: the index of LED light
unsigned short iState: LED status, 1 -> Ever bright; 2 -> Flashing; other -> Off
unsigned short iPeriod: Flashing Period (>= 500ms)
Remarks: One or more LED lights installed on some camera. This function controls the status of these lights.
Return value: HRESULT type means failure or byte(s) transferred
Parameters:
HExplorecam h: camera instance handle
unsigned addr: EEPROM address
const unsigned char* pBuffer: data buffer to be written
unsigned char* pBuffer: read EEPROM to buffer
unsigned nBufferLen: buffer length
Remarks: In some cameras, EEPROM is available for read and write. If failed to read or write, a negative HRESULT error code will be return, when success, the bytes number has been read or written will be return.
Return value: HRESULT type means success or failure
Parameters:
HExplorecam h: camera instance handle
unsigned ioLineNumber:
0-> Opto-isolated input
1-> Opto-isolated output
2-> GPIO0
3-> GPIO1unsigned nType: type of control
int outVal: output control value
int* inVal: input control value
EXPLORE_IOCONTROLTYPE_GET_SUPPORTEDMODE get the supported mode:
0x01->Input
0x02->Output
(0x01 | 0x02)->support both Input and OutputEXPLORE_IOCONTROLTYPE_GET_GPIODIR 0x00->Input, 0x01->Output EXPLORE_IOCONTROLTYPE_SET_GPIODIR EXPLORE_IOCONTROLTYPE_GET_FORMAT format:
0x00->not connected
0x01->Tri-state
0x02->TTL
0x03->LVDS
0x04->RS422
0x05->Opto-coupledEXPLORE_IOCONTROLTYPE_SET_FORMAT EXPLORE_IOCONTROLTYPE_GET_OUTPUTINVERTER boolean, only support output signal EXPLORE_IOCONTROLTYPE_SET_OUTPUTINVERTER EXPLORE_IOCONTROLTYPE_GET_INPUTACTIVATION 0x00->Positive, 0x01->Negative EXPLORE_IOCONTROLTYPE_SET_INPUTACTIVATION EXPLORE_IOCONTROLTYPE_GET_DEBOUNCERTIME debouncer time in microseconds, [0, 20000] EXPLORE_IOCONTROLTYPE_SET_DEBOUNCERTIME EXPLORE_IOCONTROLTYPE_GET_TRIGGERSOURCE 0x00-> Opto-isolated input
0x01-> GPIO0
0x02-> GPIO1
0x03-> Counter
0x04-> PWM
0x05-> SoftwareEXPLORE_IOCONTROLTYPE_SET_TRIGGERSOURCE EXPLORE_IOCONTROLTYPE_GET_TRIGGERDELAY Trigger delay time in microseconds, [0, 5000000] EXPLORE_IOCONTROLTYPE_SET_TRIGGERDELAY EXPLORE_IOCONTROLTYPE_GET_BURSTCOUNTER Burst Counter, range: [1 ~ 65535] EXPLORE_IOCONTROLTYPE_SET_BURSTCOUNTER EXPLORE_IOCONTROLTYPE_GET_COUNTERSOURCE 0x00-> Opto-isolated input
0x01-> GPIO0
0x02-> GPIO1EXPLORE_IOCONTROLTYPE_SET_COUNTERSOURCE EXPLORE_IOCONTROLTYPE_GET_COUNTERVALUE Counter Value, range: [1 ~ 65535] EXPLORE_IOCONTROLTYPE_SET_COUNTERVALUE EXPLORE_IOCONTROLTYPE_SET_RESETCOUNTER EXPLORE_IOCONTROLTYPE_GET_PWMSOURCE 0x00-> Opto-isolated input
0x01-> GPIO0
0x02-> GPIO1EXPLORE_IOCONTROLTYPE_SET_PWMSOURCE EXPLORE_IOCONTROLTYPE_GET_OUTPUTMODE 0x00-> Frame Trigger Wait
0x01-> Exposure Active
0x02-> Strobe
0x03-> User outputEXPLORE_IOCONTROLTYPE_SET_OUTPUTMODE EXPLORE_IOCONTROLTYPE_GET_STROBEDELAYMODE boolean, 0-> pre-delay, 1-> delay; compared to exposure active signal EXPLORE_IOCONTROLTYPE_SET_STROBEDELAYMODE EXPLORE_IOCONTROLTYPE_GET_STROBEDELAYTIME Strobe delay or pre-delay time in microseconds, [0, 5000000] EXPLORE_IOCONTROLTYPE_SET_STROBEDELAYTIME EXPLORE_IOCONTROLTYPE_GET_STROBEDURATION Strobe duration time in microseconds, [0, 5000000] EXPLORE_IOCONTROLTYPE_SET_STROBEDURATION EXPLORE_IOCONTROLTYPE_GET_USERVALUE bit0-> Opto-isolated output
bit1-> GPIO0 output
bit2-> GPIO1 outputEXPLORE_IOCONTROLTYPE_SET_USERVALUE EXPLORE_IOCONTROLTYPE_GET_UART_ENABLE UART enable: 1-> on; 0-> off EXPLORE_IOCONTROLTYPE_SET_UART_ENABLE EXPLORE_IOCONTROLTYPE_GET_UART_BAUDRATE baud rate:
0-> 9600
1-> 19200
2-> 38400
3-> 57600
4-> 115200EXPLORE_IOCONTROLTYPE_SET_UART_BAUDRATE EXPLORE_IOCONTROLTYPE_GET_UART_LINEMODE Line Mode:
0->TX(GPIO_0)/RX(GPIO_1)
1->TX(GPIO_1)/RX(GPIO_0)EXPLORE_IOCONTROLTYPE_SET_UART_LINEMODE
Return value: HRESULT type means failure or byte(s) transferred
Parameters:
HExplorecam h: camera instance handle
const unsigned char* pBuffer: data buffer to be written
unsigned char* pBuffer: read buffer
unsigned nBufferLen: buffer length
Remarks: If failed to read or write, a negative HRESULT error code will be return, when success, the bytes number has been read or written will be return.
Return value: HRESULT type means success or failure
Parameters:
HExplorecam h: camera instance handle
Return value: HRESULT type means success or failure
Parameters:
HExplorecam h: camera instance handle
Return value: HRESULT type means success or failure
Parameters:
HExplorecam h: camera instance handle
Remarks: auto Level Range.
Return value: HRESULT type means success or failure
Parameters:
HExplorecam h: camera instance handle
unsigned short aLow[4], unsigned short aHigh[4]: Level Range of R, G, B, and Gray. RGB is only available for color image, and gray is only available for gray image.
Remarks: level range related.
Return value: HRESULT type means success or failure
Parameters:
HExplorecam h: camera instance handle
unsigned short mode:
EXPLORE_LEVELRANGE_MANUAL Manual mode EXPLORE_LEVELRANGE_ONCE Once EXPLORE_LEVELRANGE_CONTINUE Continue mode EXPLORE_LEVELRANGE_ROI Update the ROI rectangle RECT* pRoiRect: ROI rectangle
unsigned short aLow[4], unsigned short aHigh[4]: Level Range of R, G, B, and Gray. RGB is only available for color image, and gray is only available for gray image.
Remarks: level range related.
Return value: HRESULT type means success or failure
Parameters:
camId: camera ID
filePath: ufw file full path
pFun, pCtx: progress percent callback
Remarks: firmware update. Please do not unplug the camera or lost power during the upgrade process, this is very very important. Once an unplugging or power outage occurs during the upgrade process, the camera will no longer be available and can only be returned to the factory for repair.
Return value: >0: the number of device has been replug; = 0: no device found; E_ACCESSDENIED: no UAC Administrator privileges
Parameters:
id: camera ID
Remarks: simulate replug. for each device found, it will take about 3 seconds.
Return value: HRESULT type means success or failure
Parameters:
HExplorecam h: camera instance handle
PIEXPLORE_HISTOGRAM_CALLBACK fnHistogramProc, void* pHistogramCtx: callback function and callback context of histogram data.
Remarks: get histogram data.
Parameters Range Default value Get Set Auto Auto Exposure Target 16~220 120 Explorecam_get_AutoExpoTarget Explorecam_put_AutoExpoTarget White Balance Temp/Tint Mode Color Temperature 2000~15000 6503 Explorecam_get_TempTint Explorecam_put_TempTint Explorecam_AwbOnce Tint 200~2500 1000 RGB Gain Mode Red Gain -127~127 0 Explorecam_get_WhiteBalanceGain Explorecam_put_WhiteBalanceGain Explorecam_AwbInit Green Gain Blue Gain LevelRange Software 0~255 Low = 0
High = 255Explorecam_get_LevelRange Explorecam_put_LevelRange Explorecam_LevelRangeAuto Hardware Explorecam_get_LevelRangeV2 Explorecam_put_LevelRangeV2 Contrast -100~100 0 Explorecam_get_Contrast Explorecam_put_Contrast Hue -180~180 0 Explorecam_get_Hue Explorecam_put_Hue Saturation 0~255 128 Explorecam_get_Saturation Explorecam_put_Saturation Brightness -64~64 0 Explorecam_get_Brightness Explorecam_put_Brightness Gamma 20~180 100 Explorecam_get_Gamma Explorecam_put_Gamma Black Level 0~31 (bit depth=8)
0~31 * 4 (bit depth=10)
0~31 * 16 (bit depth=12)
0~31 * 64 (bit depth=14)
0~31 * 256 (bit depth=16)Explorecam_get_Option Explorecam_put_Option Auto Exposure Max Exposure Time 350ms Explorecam_get_MaxAutoExpoTimeAGain Explorecam_put_MaxAutoExpoTimeAGain Gain 500 Min Exposure Time 0 Explorecam_get_MinAutoExpoTimeAGain Explorecam_put_MinAutoExpoTimeAGain Gain 100 TEC Target -300 ~ 300
-30℃ ~ 30℃0 EXPLORE_OPTION_TECTARGET EXPLORE_OPTION_TECTARGET
Explorecam does support .NET development environment (C# and VB.NET).
explore.cs use P/Invoke to call into explore.dll. Copy explore.cs to your C# project, please reference demowinformcs1, demowinformcs2 and demowinformcs3 in the samples directory.
Please pay attation to that the object of the C# class Explorecam. Explorecam must be obtained by static mothod Open or OpenByIndex, it cannot be obtained by obj = new Explorecam (The constructor is private on purpose).
Most properties and methods of the Explorecam class P/Invoke into the corresponding Explorecam_xxxx functions of explore.dll/so. So, the descriptions of the Explorecam_xxxx function are also applicable for the corresponding C# properties or methods. For example, the C# Snap method call the function Explorecam_Snap, the descriptions of the Explorecam_Snap function is applicable for C# Snap method:
[DllImport("explore.dll", ExactSpelling = true, CallingConvention = CallingConvention.StdCall)]
private static extern int Explorecam_Snap(SafeHExplorecamHandle h, uint nResolutionIndex);
public bool Snap(uint nResolutionIndex)
{
if (_handle == null || _handle.IsInvalid || _handle.IsClosed)
return false;
return (Explorecam_Snap(_handle, nResolutionIndex) >= 0);
} |
VB.NET is similar with C#, not otherwise specified.
Explorecam does support Python (version 3.0 or above), please import explore to use explore.py and reference the sample code simplest.py and qt.py.
Please pay attation to that the object of the python class explore.Explorecam must be obtained by classmethod Open or OpenByIndex, it cannot be obtained by obj = explore.Explorecam()
Most methods of the Explorecam class use ctypes to call into the corresponding Explorecam_xxxx functions of explore.dll/so/dylib. So, the descriptions of the Explorecam_xxxx function are also applicable for the corresponding python methods.
Please reference __errcheck in explore.py, the original HRESULT return code is mapped to HRESULTException exception (in win32 it's inherited from OSError).
Please make sure the explore dll/so/dylib library file is in the same directory with explore.py.
Explorecam does support Java, explore.java use JNA (https://github.com/java-native-access/jna) to call into explore.dll/so/dylib. Copy explore.java to your java project, please reference the sample code simplest.java (Console), javafx.java, swing.java.
Please pay attation to that the object of the java class explore must be obtained by static method Open or OpenByIndex, it cannot be obtained by obj = new explore()(The constructor is private on purpose).
Most methods of the explore class use JNA to call into the corresponding Explorecam_xxxx functions of explore.dll/so/dylib. So, the descriptions of the Explorecam_xxxx function are also applicable for the corresponding java methods.
Please reference errcheck in explore.java, the original HRESULT return code is mapped to HRESULTException exception.
Remark: (1) Download jna-*.jar from github; (2) Make sure explore.dll/so/dylib is placed in the correct directory.
| Name | Platform | Language | Dependency | UI | Description | |
| demosimplest | Win32, Linux, macOS, Android | C++ | console | simplest sample, about 60 lines of code. snapshot. | ||
| demoraw | raw data and snap still image, about 120 lines of code. snapshot. | |||||
| demoqt | Win32, Linux, macOS | Qt | GUI | Qt sample, snapshot. Enumerate device, open device, video preview, (still) image capture, preview resolution, image save to file, etc. This sample use Pull Mode, StartPullModeWithCallback. |
||
| democpp | Win32 | ATL/WTL | snapshot. demonstrates to enumerate device, open device, video preview, image capture, preview resolution, trigger, image saving multi-format (.bmp, .jpg, .png, etc), wmv format video recording, trigger mode, IO control, etc. This sample use Pull Mode. To keep the code clean, this sample uses the WTL library which can be downloaded from http://sourceforge.net/projects/wtl | |||
| democallback | snapshot. use Pull Mode, StartPullModeWithCallback | |||||
| demopush | snapshot. use Push Mode, StartPushModeV3 | |||||
| demomono | demonstrates to use mono camera with 8 or 16 bits | |||||
| demomfc | MFC | snapshot. use MFC as the GUI library. It demonstrates to open device, video preview, image capture, set the preview resolution, multi-format image saving (.bmp, .jpg, .png, etc). This sample use Pull Mode | ||||
| autotest | snapshot. auto test tool used to automatically test, such as open/close the camera, change the resolution, snap, ROI, bitdepth, etc | |||||
| demowpf | .NET | C# | WPF | WPF sample, snapshot. Enum camera, open camera, preview video, captuare (still) image, save image to file, auto exposure, white balance, calculate fps (frame per second), etc. This sample use Pull Mode, StartPullModeWithCallback |
||
| demowinformcs1 | WinForm | winform sample, snapshot. Enum camera, open camera, preview video, captuare (still) image, save image to file, auto exposure, white balance, calculate fps (frame per second), etc. This sample use Pull Mode, StartPullModeWithCallback |
||||
| demowinformcs2 | winform sample, snapshot. Enum camera, open camera, preview video, captuare (still) image, save image to file, auto exposure, white balance, calculate fps (frame per second), etc. This sample use Pull Mode, StartPullModeWithWndMsg |
|||||
| demowinformcs3 | winform sample, snapshot. Enum camera, open camera, preview video, captuare (still) image, save image to file, auto exposure, white balance, calculate fps (frame per second), etc. This sample use Push Mode, StartPushModeV3 |
|||||
| demowinformvb | VB.NET | winform sample, snapshot. Enum camera, open camera, preview video, captuare (still) image, save image to file, auto exposure, white balance, calculate fps (frame per second), etc. This sample use Pull Mode, StartPullModeWithCallback |
||||
| demouwp | WinRT | C# | Universal Windows Platform simple demo, before build and run this demo, please change the value of vidpid in file Package.appxmanifest | |||
| demoandroid | Android | C++, Java | Android sample | |||
| demojava | simplest | Win32, Linux, macOS | Java | jna | console | simplest java sample |
| javafx | GUI | javafx sample | ||||
| swing | swing sample | |||||
| demopython | simplest | Python | console | simplest python sample | ||
| qt | PyQt | GUI | PyQt sample, snapshot. | |||
| demodshow | Win32 DirectShow | C++ | MFC | DirectShow sample | ||
| amcap | copy from Microsoft DirectShow SDK | |||||
v51: Add support auto exposure "once" mode. Please see here
v50: SIMD optimize in Windows(x86/x64), Linux(x64) and Android(x64)
frontend and backend deque length: EXPLORE_OPTION_FRONTEND_DEQUE_LENGTH, EXPLORE_OPTION_BACKEND_DEQUE_LENGTH
v49: Add support to save & load configuration. Please see here
v48: hardware event. Please see here, here and here
v47: hardware level range. Please see here and here
v46: Add support denose. Please see here
v45: Add sequencer trigger, UART, mix trigger (external and software trigger both are enabled)
v44: Extend the realtime mode, Please see here
Add EXPLORE_OPTION_CALLBACK_THREAD and EXPLORE_OPTION_FRAME_DEQUE_LENGTH
v43: Reload the last frame in the trigger mode. Please see EXPLORE_OPTION_RELOAD
v42: Precise frame rate and bandwidth. Please see here and EXPLORE_FLAG_PRECISE_FRAMERATE
v41: no packet timeout. Please see here
v40: Auto test tool, see samples\autotest
v39: Update C#/VB.NET/Java/Python
v38: Add support to byte order, change BGR/RGB. Please see here
v37: Add Android support
Add Explorecam_StartPushModeV3 (Explorecam_StartPushModeV2 and Explorecam_StartPushMode are obsoleted)
v36: Add Java support. Please see here
v35: Add Python support. Please see here
v34: Auto Focus and Focus Motor
v33: extend EXPLORE_OPTION_AGAIN to EXPLORE_OPTION_AUTOEXP_POLICY, support more options. Please see here
v32: Addd support to Windows 10 on ARM and ARM64, both desktop and WinRT
v31: Add Explorecam_deBayerV2, support RGB48 and RGB64
v30: Add EXPLORE_FLAG_CGHDR
v29: Add ExplorecamFrameInfoV2, a group of functions (PullImageV2 and StartPushModeV2), some cameras support frame sequence number and timestamp. Please see here
v28: Add Explorecam_read_Pipe, Explorecam_write_Pipe, Explorecam_feed_Pipe
v27: Add Explorecam_SnapN, support to snap multiple images, please see here and democpp
v26: Add support to restore factory settings, EXPLORE_OPTION_FACTORY
v25: Add sharpening, EXPLORE_OPTION_SHARPENING
v24: Add support to Exposure time with the 50/60 HZ constraint
v23: Add support to Linux armhf, armel and arm64
Add FFC and DFC, please see here and here
v22: Add EXPLORE_OPTION_DDR_DEPTH, please see here
v21: Add Explorecam_IoControl
v20: Add Explorecam_EnumV2, ExplorecamModelV2, ExplorecamDeviceV2; (Explorecam_Enum, ExplorecamModel and ExplorecamDevice are obsoleted)
Add Pixel Format, see EXPLORE_OPTION_PIXEL_FORMAT; (EXPLORE_OPTION_PIXEL_FORMAT is the super set of EXPLORE_OPTION_BITDEPTH)
Add Flat Field Correction
v19: Add Black Balance: please see here
v18: Add Explorecam_get_Revision
v17: Add EXPLORE_OPTION_ROTATE
v16: Add EXPLORE_FLAG_DDR, use very large capacity DDR (Double Data Rate SDRAM) for frame buffer
v15: Add EXPLORE_OPTION_BINNING
v14: Add support to WinRT / UWP (Universal Windows Platform) / Windows Store App
v13: support row pitch, please see Explorecam_PullImageWithRowPitch and Explorecam_PullStillImageWithRowPitch
v12: support RGB32, 8 bits Gray, 16 bits Gray, please see here
v11: black level: please see here
v10: demosaic method: please see here
v9: change the histogram data type from double to float
v8: support simulated trigger, please see here
v7: support RGB48 when bit depth > 8, please see here
v6: support trigger mode, please see here
v5: White Balance: Temp/Tint Mode vs RGB Gain Mode, please see here
v4: ROI (Region Of Interest) supported: please see here
v3: more bit depth supported: 10bits, 12bits, 14bits, 16bits
v2: support RAW format, please see here and here; support Linux and macOS
v1: initial release
