 |
Software Library API naibrd 1.62
See all documentation at naii.docs.com
|
|
Software Library API naibrd 1.62
See all documentation at naii.docs.com
|
#include "functions/naibrd_dl.h"#include "maps/nai_map_dl.h"#include "naibrd_config.h"Functions | |
| NAIBRDFUNC int32_t NAIAPI | naibrd_DL_GetChannelCount (uint32_t modid) |
| Returns the number of channels for the specified D/L Module based on its module id. | |
| NAIBRDFUNC nai_status_t NAIAPI | naibrd_DL_SetPosition (int32_t cardIndex, int32_t module, int32_t channel, nai_dl_subchannel_t subchannel, float64_t position) |
| Sets position on a DLV module for a specified subchannel and channel. Use nai_dl_subchannel_t to select the specified subchannel to be written to the DLV module. | |
| NAIBRDFUNC nai_status_t NAIAPI | naibrd_DL_GetPosition (int32_t cardIndex, int32_t module, int32_t channel, nai_dl_subchannel_t subchannel, float64_t *outPosition) |
| Gets position on a DLV module from a specified subchannel and channel. Use nai_dl_subchannel_t to select the specified subchannel to be read from the DLV module. | |
| NAIBRDFUNC nai_status_t NAIAPI | naibrd_DL_SetConfigurationValue (int32_t cardIndex, int32_t module, int32_t channel, nai_dl_configuration_type_t opMode, float64_t opValue) |
| Sets various configuration values on a DLV module for a specified channel. use nai_dl_configuration_type_t to select the specified configuration type to be written to the DLV module. | |
| NAIBRDFUNC nai_status_t NAIAPI | naibrd_DL_GetConfigurationValue (int32_t cardIndex, int32_t module, int32_t channel, nai_dl_configuration_type_t opMode, float64_t *opValue) |
| Gets various configuration values on a DLV module for a specified channel. use nai_dl_configuration_type_t to select the specified configuration type to be read from the DLV module. | |
| NAIBRDFUNC nai_status_t NAIAPI | naibrd_DL_SetChanStatusEnable (int32_t cardIndex, int32_t module, int32_t channel, bool_t enable) |
| Enables/disables the specified channel. | |
| NAIBRDFUNC nai_status_t NAIAPI | naibrd_DL_GetChanStatusEnable (int32_t cardIndex, int32_t module, int32_t channel, bool_t *outenable) |
| Retrieves the enabled/disabled state the specified channel. | |
| NAIBRDFUNC nai_status_t NAIAPI | naibrd_DL_SetWireMode (int32_t cardIndex, int32_t module, int32_t channel, nai_dl_wire_mode_type_t mode) |
| Sets the wire mode (4-wire or 2-wire) for the specified channel. | |
| NAIBRDFUNC nai_status_t NAIAPI | naibrd_DL_GetWireMode (int32_t cardIndex, int32_t module, int32_t channel, nai_dl_wire_mode_type_t *outmode) |
| Retrieves the wire mode (4-wire or 2-wire) for the specified channel. | |
| NAIBRDFUNC nai_status_t NAIAPI | naibrd_DL_SetOutputMode (int32_t cardIndex, int32_t module, int32_t channel, nai_dl_vll_mode_type_t mode) |
| Sets the output mode (ratio mode or fixed mode) for the specified channel. | |
| NAIBRDFUNC nai_status_t NAIAPI | naibrd_DL_GetOutputMode (int32_t cardIndex, int32_t module, int32_t channel, nai_dl_vll_mode_type_t *outmode) |
| Retrieves the output mode (ratio mode or fixed mode) for the specified channel. | |
| NAIBRDFUNC nai_status_t NAIAPI | naibrd_DL_SetFloatingPointAttributes (int32_t cardIndex, int32_t module, int32_t channel, nai_dl_floating_point_attributes_type_t attrType, float64_t attrValue) |
| Sets the floating-point attribute value of the specified attribute type for the specified DLV channel. Valid attribute types are Position A Offset, Position B Offset, Position A Scale, and Position B Scale. | |
| NAIBRDFUNC nai_status_t NAIAPI | naibrd_DL_GetFloatingPointAttributes (int32_t cardIndex, int32_t module, int32_t channel, nai_dl_floating_point_attributes_type_t attrType, float64_t *outAttrValue) |
| Retrieves the floating-point attribute value of the specified attribute type for the specified DLV channel. Valid attribute types are Position A Offset, Position B Offset, Position A Scale, and Position B Scale. | |
| NAIBRDFUNC nai_status_t NAIAPI | naibrd_DL_GetMeasuredValue (int32_t cardIndex, int32_t module, int32_t channel, nai_dl_measured_value_type_t opMode, float64_t *opValue) |
| Gets a measured value for the specified DLV channel. | |
| NAIBRDFUNC nai_status_t NAIAPI | naibrd_DL_GetStatus (int32_t cardIndex, int32_t module, int32_t channel, nai_dl_status_type_t statusType, nai_dl_module_status_t *outStatus) |
| Retrieves the module status for a specific channel from the DLV module (retrieves the latched status for Gen 5 modules). | |
| NAIBRDFUNC nai_status_t NAIAPI | naibrd_DL_ClearStatus (int32_t cardIndex, int32_t module, int32_t channel, nai_dl_status_type_t statusType) |
| Clears the module status for a specific channel from the DLV module (clears the latched status for Gen 5 modules). | |
| NAIBRDFUNC nai_status_t NAIAPI | naibrd_DL_GetStatusRealtime (int32_t cardIndex, int32_t module, int32_t channel, nai_dl_status_type_t statusType, nai_dl_module_status_t *outStatus) |
| Retrieves the module realtime status for a specific channel from the DLV module (used for Gen5 modules only). | |
| NAIBRDFUNC nai_status_t NAIAPI | naibrd_DL_SetPowerSupplyState (int32_t cardIndex, int32_t module, int32_t channel, nai_dl_on_off_t setting) |
| Sets the Power Supply State for the specified DLV channel. | |
| NAIBRDFUNC nai_status_t NAIAPI | naibrd_DL_GetPowerSupplyState (int32_t cardIndex, int32_t module, int32_t channel, nai_dl_on_off_t *outSetting) |
| Gets the Power Supply State for the specified DLV channel. | |
| NAIBRDFUNC nai_status_t NAIAPI | naibrd_DL_SetTestEnable (int32_t cardIndex, int32_t module, nai_dl_test_type_t type, bool_t inTestEnable) |
| Sets the test enable state for D0, on-line(D2), or off-line(D3) test for a DLV module. | |
| NAIBRDFUNC nai_status_t NAIAPI | naibrd_DL_GetTestEnable (int32_t cardIndex, int32_t module, nai_dl_test_type_t type, bool_t *outTestEnable) |
| Gets the test enable state for D0, on-line(D2), or off-line(D3) test for a DLV module. | |
| NAIBRDFUNC nai_status_t NAIAPI | naibrd_DL_SetD2TestVerifyValue (int32_t cardIndex, int32_t module, uint32_t inValue) |
| Sets the D2 Test Verify value. When the D2 test is enabled, the board will set the D2 Test Verify register to 0x55. An external application can write a value to the D2 Test Verify register and then read it after 30 seconds to verify that the background bit testing (D2 test) is activated. | |
| NAIBRDFUNC nai_status_t NAIAPI | naibrd_DL_GetD2TestVerifyValue (int32_t cardIndex, int32_t module, uint32_t *outValue) |
| Retrieves the D2 Test Verify value. When the D2 test is enabled, the board will set the D2 Test Verify register to 0x55. An external application can write a value to the D2 Test Verify register and then read it after 30 seconds to verify that the background bit testing (D2 test) is activated. | |
| NAIBRDFUNC nai_status_t NAIAPI | naibrd_DL_SetOnBoardOSC (int32_t cardIndex, uint32_t module, nai_dl_onBoardOsc_type_t opMode, float64_t opValue) |
| Sets either the on board voltage or on board Frequency to the dlv module. Use nai_dl_onBoardOsc_type_t to select the specified configuration type to be written to the DLV module. | |
| NAIBRDFUNC nai_status_t NAIAPI | naibrd_DL_GetOnBoardOSC (int32_t cardIndex, uint32_t module, nai_dl_onBoardOsc_type_t opMode, float64_t *opValue) |
| Gets either the on board voltage or on board Frequency from the dlv module. Use nai_dl_onBoardOsc_type_t to select the specified configuration type to be read from the DLV module. | |
| NAIBRDFUNC nai_status_t NAIAPI | naibrd_DL_SetStatusIntEnable (int32_t cardIndex, int32_t module, int32_t channel, nai_dl_status_type_t statusType, uint32_t inStatusInt) |
| Sets the Interrupt Enable associated with the Status Type for the specified channel. By default, interrupts are disabled. | |
| NAIBRDFUNC nai_status_t NAIAPI | naibrd_DL_GetStatusIntEnable (int32_t cardIndex, int32_t module, int32_t channel, nai_dl_status_type_t statusType, uint32_t *outStatusInt) |
| Sets the Interrupt Edge/Level property for the specified channel and interrupt status type. | |
| NAIBRDFUNC nai_status_t NAIAPI | naibrd_DL_SetStatusVector (int32_t cardIndex, int32_t module, nai_dl_status_type_t statusType, uint32_t inIntVector) |
| Sets the Interrupt Vector associated with the Status Type for the specified channel. | |
| NAIBRDFUNC nai_status_t NAIAPI | naibrd_DL_GetStatusVector (int32_t cardIndex, int32_t module, nai_dl_status_type_t statusType, uint32_t *outIntVector) |
| Retrieves the Interrupt Vector associated with the Status Type from the specified channel. | |
| NAIBRDFUNC nai_status_t NAIAPI | naibrd_DL_SetRawValueByChannel (int32_t cardIndex, int32_t module, int32_t channel, nai_dl_rawByChannel_type_t opMode, uint32_t opValue) |
| Writes a raw value to a register based on channel. | |
| NAIBRDFUNC nai_status_t NAIAPI | naibrd_DL_GetRawValueByChannel (int32_t cardIndex, int32_t module, int32_t channel, nai_dl_rawByChannel_type_t opMode, uint32_t *opValue) |
| Reads a raw value from a register based on channel. | |
| NAIBRDFUNC nai_status_t NAIAPI | naibrd_DL_SetRawValue (int32_t cardIndex, int32_t module, nai_dl_raw_type_t opMode, uint32_t opValue) |
| Writes the raw value to a register. | |
| NAIBRDFUNC nai_status_t NAIAPI | naibrd_DL_GetRawValue (int32_t cardIndex, int32_t module, nai_dl_raw_type_t opMode, uint32_t *opValue) |
| Reads the raw value from a register. | |
| nai_status_t | naibrd_DL_ConvertRawToPosition (uint32_t rawdata, float64_t *outPosition) |
| Converts raw value to position value. | |
| nai_status_t | naibrd_DL_ConvertPositionToRaw (float64_t inPosition, int32_t *outRawData) |
| Converts position to raw position value. | |
| nai_status_t | naibrd_DL_ConvertRawToPhase (uint32_t modid, uint32_t rawdata, float64_t *outPhase) |
| Converts raw value to phase value. | |
| nai_status_t | naibrd_DL_ConvertPhaseToRaw (uint32_t modid, float64_t inPhase, uint32_t *outRawData) |
| Converts phase to raw phase value. | |
1.11.0