Introduction
    • 10 Jul 2024
    • 1 Minute to read
    • PDF

    Introduction

    • PDF

    Article summary

    Conventions used in this manual

    Styles

    Notification

    To ease the use of the document and to clearly indicate the type of the used data different colors for the different elements are used. Three different colors are used when displaying elements in tables:

    Enumerations:

    For example:

    csiEventType

    Defines events which can be received from the SDK

    Definition

    typedef enum csiEventType {

    CSI_EVT_NEWIMAGEDATA = 0x00,

    CSI_EVT_ERROR = 0x01,

    CSI_EVT_MODULE = 0x02,

    CSI_EVT_CUSTOM = 0x1000

    } csiEventType;

    Elements

    CSI_EVT_NEWIMAGEDATA: New image data received

    CSI_EVT_ERROR: Error occurred in the SDK

    CSI_EVT_MODULE: General event notification

    CSI_EVT_CUSTOM: A custom event was triggered

    Structures:

    For example:

    Struct-name

    csiDiscoveryInfo

    -

    Variable type

    Element name

    Description

    uint32_t

    numDevices

    -

    double

    progress

    -

    bool

    discoveryRunning

    -

    Functions:

    For example:

    Function-name

    Description

    csiDiscoverDevices

    Searches for the devices currently connected to the system

    Syntax

    csiErr csiDiscoverDevices(csiDiscoveryInfoOut,

    uint64_t timeoutMilliseconds,

    csiDiscoveryInfoCallbackFunc discCallbackFunc = NULL,

    const char* additionalSearchPaths = NULL,

    bool overrideSearchPath = CSI_DEFAULT_PARAM_FALSE);

    Parameters

    timeoutMilliSeconds: The amount of time to search in a specific transport layer for a device

    discoverCallbackFunc: Pointer to a callback function which gets called when a result was received

    AdditionalSearchPaths: As default only the paths given in the system variable "GENICAM_GENTL64_PATH" are being searched for the used transport layers

    overrideSearchPath: If set, only the given path is searched for transport layers to use

    discoveryInfoOut: The structure will be filled with the available devices

    Return value

    Returns csiSuccess or an error defined in the csiErr-Enum.

    Comments

    -


    Was this article helpful?

    ESC

    Eddy AI, facilitating knowledge discovery through conversational intelligence