
SC5412A Operating & Programming Manual
Rev 1.1.0
12
S C 5 4 1 2 A
P
R O G R A M M I N G
I
N T E R F A C E
Device Drivers
The SC5412A is programmed by writing to its set of configuration registers, and its data is read back
through its set of query registers. The user may program directly at register level or through the API
library functions provided. These API library functions are wrapper functions of the registers that
simplify the task of configuring the register bytes. The register specifics are covered in the next section.
Writing to and reading from the device at the register level through the API involves calls to the
sc5412a_RegWrite
and
sc5412a_RegRead
functions respectively.
The SC5412A is programmed by writing to its set of configuration registers, and its status read back
through its set of query registers. The user may choose to program directly at register level or through
the API library functions provided. These API library functions are wrapper functions of the registers that
simplify the task of configuring of the register bytes. The register specifics are covered in the next
section. Writing to and reading from the device at the register level through the API involves calls to the
sc5412a_RegWrite
and
sc5412a_RegRead
functions respectively.
For Microsoft Windows
TM
operating systems, The SC5412A API is provided as a dynamic linked library,
sc5412a.dll
. This API uses
NI-VISA
TM
to communicate with the device. Inclusion of the NI-VISA driver is
required for code development in programming languages such C, C++, or LabVIEW
TM
. For LabVIEW
TM
support, an additional LabVIEW API, sc5412a.llb, is also provided. The functions in the LabVIEW API are
primarily LabVIEW VI wrappers to the standard API functions.
NI-VISA
TM
is available from National
Instruments Corporation (
For other operating systems or VISA implementations such as Agilent VISA, users will need to access the
device through their own proprietary PXIe driver. The VISA-based driver code is available to our
customers by request. This code can be compiled with Agilent VISA with minimal or no code change.
Should the user require assistance in writing an appropriate API other than that provided, please contact
SignalCore for additional example code and hardware details.
Using the Application Programming Interface (API)
The SC5412A API library functions make it easy for the user to communicate with the device. Using the
API removes the need to understand register-level details - their configuration, address, data format,
etc., and the additional layer between the PXIe bridge and the onboard microcontroller that must be
configured prior to writing the device registers. Using the API, commands to control the device are
greatly simplified. For example, to obtain the device temperature, the user simply calls the function
sc5412a_GetDeviceTemperature
, or calls
sc5412a_SetFrequency
to tune the frequency. The software
API is covered in detail in the “
Software API Library Functions
” section.