|
| NAIBRDFUNC nai_status_t NAIAPI | naibrd_ENC_GetModuleRev (int32_t cardIndex, int32_t module, int32_t channel, uint32_t *outModRev) |
| | Retrieves the module revision for the specified Encoder channel.
|
| |
| NAIBRDFUNC int32_t NAIAPI | naibrd_ENC_GetChannelCount (uint32_t modid) |
| | Returns the number of channels for the specified Encoder Module ID.
|
| |
| NAIBRDFUNC float64_t NAIAPI | naibrd_ENC_GetTimeBaseLSB (uint32_t modid) |
| | Returns the LSB for the timer interval for Debounce for the specified ENC Module ID. LSB in milliseconds.
|
| |
| NAIBRDFUNC nai_status_t NAIAPI | naibrd_ENC_SetControlMode (int32_t cardIndex, int32_t module, int32_t channel, nai_enc_mode_t mode) |
| | Sets the Mode configuration for the specified Encoder channel. Channel can be configured as SSI mode, COUNTER mode or disabled. To specify SSI controller or listener mode, refer to nai_ENC_SetSSI_Mode function.
|
| |
| NAIBRDFUNC nai_status_t NAIAPI | naibrd_ENC_GetControlMode (int32_t cardIndex, int32_t module, int32_t channel, nai_enc_mode_t *outMode) |
| | Retrieves the Mode configuration for the specified Encoder channel. Channel can be configured as SSI mode, COUNTER mode or disabled. To retrieve SSI controller or listener mode, refer to nai_ENC_GetSSI_Mode function.
|
| |
| NAIBRDFUNC nai_status_t NAIAPI | naibrd_ENC_SetIOFormat (int32_t cardIndex, int32_t module, int32_t channel, nai_enc_port_t port, nai_enc_ioformat_t format) |
| | Sets the IOFormat configuration for the specified Encoder channel and port. Port pins can be configured as input or output. Port pins only need to be configured as an output when in SSI controller mode and should be configured as input for all other configurations.
|
| |
| NAIBRDFUNC nai_status_t NAIAPI | naibrd_ENC_GetIOFormat (int32_t cardIndex, int32_t module, int32_t channel, nai_enc_port_t port, nai_enc_ioformat_t *outFormat) |
| | Retrieves the IOFormat configuration for the specified Encoder channel and port. Port pins can be configured as input or output. Port pins only need to be configured as an output when in SSI controller mode and should be configured as input for all other configurations.
|
| |
| NAIBRDFUNC nai_status_t NAIAPI | naibrd_ENC_SetInputMode (int32_t cardIndex, int32_t module, int32_t channel, nai_enc_input_mode_t inputMode) |
| | Sets the Input mode configuration for the specified Encoder channel. Input mode can be configured as differential or singled ended.
|
| |
| NAIBRDFUNC nai_status_t NAIAPI | naibrd_ENC_GetInputMode (int32_t cardIndex, int32_t module, int32_t channel, nai_enc_input_mode_t *outInputMode) |
| | Gets the Input mode configuration for the specified Encoder channel. Input mode can be configured as differential or singled ended.
|
| |
| NAIBRDFUNC nai_status_t NAIAPI | naibrd_ENC_SetMultiChanRdEnable (int32_t cardIndex, int32_t module, int32_t channel, bool_t enable) |
| | Sets multi channel read to enabled or disabled for specified Encoder channel.
|
| |
| NAIBRDFUNC nai_status_t NAIAPI | naibrd_ENC_GetMultiChanRdEnable (int32_t cardIndex, int32_t module, int32_t channel, bool_t *outEnable) |
| | Retrieves multi chan read enable for specified Encoder channel.
|
| |
| NAIBRDFUNC nai_status_t NAIAPI | naibrd_ENC_TriggerMultiChanRd (int32_t cardIndex, int32_t module) |
| | Initiate multi channel read for the specified Encoder channel.
|
| |
| NAIBRDFUNC nai_status_t NAIAPI | naibrd_ENC_GetMultiChanRdStatus (int32_t cardIndex, int32_t module, nai_status_bit_t *outstatusBit) |
| | Retrieves multi channel read status bit.
|
| |
| NAIBRDFUNC nai_status_t NAIAPI | naibrd_ENC_SetInputTermination (int32_t cardIndex, int32_t module, int32_t channel, nai_enc_port_t port, nai_enc_term_t termination) |
| | Sets the Input termination for the specified Encoder channel and port. Termination can be configured to enable or disable a 120 ohm termination resistor.
|
| |
| NAIBRDFUNC nai_status_t NAIAPI | naibrd_ENC_GetInputTermination (int32_t cardIndex, int32_t module, int32_t channel, nai_enc_port_t port, nai_enc_term_t *outTermination) |
| | Retrieves the Input termination for the specified Encoder channel and port. Termination can be configured to enable or disable a 120 ohm termination resistor.
|
| |
| NAIBRDFUNC nai_status_t NAIAPI | naibrd_ENC_SetDebounceTime (int32_t cardIndex, int32_t module, int32_t channel, nai_enc_port_t port, float64_t debounceTime) |
| | Sets the debounce time for the specified Encoder channel and port. Enter time in milliseconds. When a signal reaches a logic voltage level and maintains that level for a period longer than the debounce time a logic transition is validated. Signal pulse widths less than debounce time are filtered or ignored.
|
| |
| NAIBRDFUNC nai_status_t NAIAPI | naibrd_ENC_GetDebounceTime (int32_t cardIndex, int32_t module, int32_t channel, nai_enc_port_t port, float64_t *outdebounceTime) |
| | Retrieves the debounce time for the specified Encoder channel and port. Time returned in milliseconds. When a signal reaches a logic voltage level and maintains that level for a period longer than the debounce time a logic transition is validated. Signal pulse widths less than debounce time are filtered or ignored.
|
| |
| NAIBRDFUNC nai_status_t NAIAPI | naibrd_ENC_SetDebounceTimeWord (int32_t cardIndex, int32_t module, int32_t channel, nai_enc_port_t port, uint32_t debounceWord) |
| | Sets the debounce time word for the specified Encoder channel and port. When a signal reaches a logic voltage level and maintains that level for a period longer than the debounce time a logic transition is validated. Signal pulse widths less than debounce time are filtered or ignored.
|
| |
| NAIBRDFUNC nai_status_t NAIAPI | naibrd_ENC_GetDebounceTimeWord (int32_t cardIndex, int32_t module, int32_t channel, nai_enc_port_t port, uint32_t *outdebounceWord) |
| | Retrieves the debounce time word for the specified Encoder channel and port. When a signal reaches a logic voltage level and maintains that level for a period longer than the debounce time a logic transition is validated. Signal pulse widths less than debounce time are filtered or ignored.
|
| |
| NAIBRDFUNC nai_status_t NAIAPI | naibrd_ENC_SetDebounceEnable (int32_t cardIndex, int32_t module, int32_t channel, nai_enc_port_t port, bool_t enable) |
| | Sets the debounce circuit to enabled or disabled for specified Encoder channel and port.
|
| |
| NAIBRDFUNC nai_status_t NAIAPI | naibrd_ENC_GetDebounceEnable (int32_t cardIndex, int32_t module, int32_t channel, nai_enc_port_t port, bool_t *outEnable) |
| | Retrieves the debounce enabled or disabled state for specified Encoder channel and port.
|
| |
| NAIBRDFUNC nai_status_t NAIAPI | naibrd_ENC_SetInputThreshold (int32_t cardIndex, int32_t module, int32_t channel, float64_t inputThreshold) |
| | Sets the input threshold for the specified Encoder channel. Enter threshold in volts. When a channel is set for singled ended mode, the input threshold is configured for all ports. When a channel is set for differential mode, the input threshold must be set to zero.
|
| |
| NAIBRDFUNC nai_status_t NAIAPI | naibrd_ENC_GetInputThreshold (int32_t cardIndex, int32_t module, int32_t channel, float64_t *outInputThreshold) |
| | Retrieves the input threshold for the specified Encoder channel. Threshold returned in volts. When a channel is set for singled ended mode, the input threshold is configured for all ports. When a channel is set for differential mode, the input threshold must be set to zero.
|
| |
| NAIBRDFUNC nai_status_t NAIAPI | naibrd_ENC_SetInputThresholdWord (int32_t cardIndex, int32_t module, int32_t channel, uint32_t inputThresholdWord) |
| | Sets the input threshold word for the specified Encoder channel. When a channel is set for singled ended mode, the input threshold is configured for all ports. When a channel is set for differential mode, the input threshold must be set to zero.
|
| |
| NAIBRDFUNC nai_status_t NAIAPI | naibrd_ENC_GetInputThresholdWord (int32_t cardIndex, int32_t module, int32_t channel, uint32_t *outInputThresholdWord) |
| | Retrieves the input threshold word for the specified Encoder channel. When a channel is set for singled ended mode, the input threshold is configured for all ports. When a channel is set for differential mode, the input threshold must be set to zero.
|
| |
| NAIBRDFUNC nai_status_t NAIAPI | naibrd_ENC_SetHighVoltEnable (int32_t cardIndex, int32_t module, int32_t channel, nai_enc_port_t port, bool_t enable) |
| | Enables or disables high voltage mode for the specified Encoder channel and port. When high voltage mode is enabled a 7.5kOhm resistor is put in series between the high leg of the transceiver and connector high pin. Also another 7.5kOhm resistor is put in series between the low leg of the transceiver and connector low pin.
|
| |
| NAIBRDFUNC nai_status_t NAIAPI | naibrd_ENC_GetHighVoltEnable (int32_t cardIndex, int32_t module, int32_t channel, nai_enc_port_t port, bool_t *outEnable) |
| | Retrieves high voltage config for the specified Encoder channel and port. When high voltage mode is enabled a 7.5kOhm resistor is put in series between the high leg of the transceiver and connector high pin. Also another 7.5kOhm resistor is put in series between the low leg of the transceiver and connector low pin.
|
| |
| NAIBRDFUNC nai_status_t NAIAPI | naibrd_ENC_GetSSI_Data (int32_t cardIndex, int32_t module, int32_t channel, uint32_t *outData) |
| | Retrieves SSI data from the specified Encoder channel configured as SSI interface controller or listener.
|
| |
| NAIBRDFUNC nai_status_t NAIAPI | naibrd_ENC_GetSSI_GreyData (int32_t cardIndex, int32_t module, int32_t channel, uint32_t *outData) |
| | Retrieves SSI data in Gray format from the specified Encoder channel configured as SSI interface controller or listener.
|
| |
| NAIBRDFUNC nai_status_t NAIAPI | naibrd_ENC_SSI_TriggerData (int32_t cardIndex, int32_t module, int32_t channel) |
| | Initiate SSI data transfer for the specified Encoder channel, only valid for channel configured as an SSI interface controller.
|
| |
| NAIBRDFUNC nai_status_t NAIAPI | naibrd_ENC_GetSSI_Status (int32_t cardIndex, int32_t module, int32_t channel, nai_enc_ssi_status_t type, nai_status_bit_t *outstatusBit) |
| | Retrieves SSI status bit for the specified Encoder channel and status type. Status bit corresponds to following:
|
| |
| NAIBRDFUNC nai_status_t NAIAPI | naibrd_ENC_GetSSI_RcvdParity (int32_t cardIndex, int32_t module, int32_t channel, nai_status_bit_t *outstatusBit) |
| | Retrieves SSI rcvd parity bit for the specified Encoder channel.
|
| |
| NAIBRDFUNC nai_status_t NAIAPI | naibrd_ENC_GetSSI_RcvdZeroBit (int32_t cardIndex, int32_t module, int32_t channel, nai_status_bit_t *outstatusBit) |
| | Retrieves SSI rcvd zero bit for the specified Encoder channel.
|
| |
| NAIBRDFUNC nai_status_t NAIAPI | naibrd_ENC_SetSSI_Mode (int32_t cardIndex, int32_t module, int32_t channel, nai_enc_ssi_mode_t mode) |
| | Sets the SSI Mode configuration for the specified Encoder channel. Channel can be configured as an SSI interface controller or listener.
|
| |
| NAIBRDFUNC nai_status_t NAIAPI | naibrd_ENC_GetSSI_Mode (int32_t cardIndex, int32_t module, int32_t channel, nai_enc_ssi_mode_t *outMode) |
| | Retrieves the Mode configuration for the specified Encoder channel. Channel can be configured as an SSI interface controller or listener.
|
| |
| NAIBRDFUNC nai_status_t NAIAPI | naibrd_ENC_SetSSI_ClockRate (int32_t cardIndex, int32_t module, int32_t channel, int32_t clockRate) |
| | Sets the SSI Clock rate for encoder serial clock speed in steps of 1uS. Range is configurable from steps of 1 to 32, value of 0 will stop SSI interface. In SSI listener mode clock rate setting is ignored and will be automatically detected.
|
| |
| NAIBRDFUNC nai_status_t NAIAPI | naibrd_ENC_GetSSI_ClockRate (int32_t cardIndex, int32_t module, int32_t channel, int32_t *outclockRate) |
| | Gets the SSI Clock rate for encoder serial clock speed in steps of 1uS. Range is configurable from steps of 1 to 32, value of 0 will stop SSI interface. In SSI listener mode clock rate setting is ignored and will be automatically detected.
|
| |
| NAIBRDFUNC nai_status_t NAIAPI | naibrd_ENC_SetSSI_ClockEdgeLevel (int32_t cardIndex, int32_t module, int32_t channel, nai_enc_ssi_clock_t clockEdge) |
| | Sets the Clock Edge configuration for the specified Encoder channel. Channel can be configured to clock SSI data on rising or falling edges.
|
| |
| NAIBRDFUNC nai_status_t NAIAPI | naibrd_ENC_GetSSI_ClockEdgeLevel (int32_t cardIndex, int32_t module, int32_t channel, nai_enc_ssi_clock_t *outclockEdge) |
| | Gets the Clock Edge configuration for the specified Encoder channel. Channel can be configured to clock SSI data on rising or falling edges.
|
| |
| NAIBRDFUNC nai_status_t NAIAPI | naibrd_ENC_SetSSI_DataBits (int32_t cardIndex, int32_t module, int32_t channel, int32_t dataBits) |
| | Sets the number of data bits for the specified Encoder channel, configurable from 1 to 32.
|
| |
| NAIBRDFUNC nai_status_t NAIAPI | naibrd_ENC_GetSSI_DataBits (int32_t cardIndex, int32_t module, int32_t channel, int32_t *outdataBits) |
| | Gets the number of data bits for the specified Encoder channel, configurable from 1 to 32.
|
| |
| NAIBRDFUNC nai_status_t NAIAPI | naibrd_ENC_SetSSI_Parity (int32_t cardIndex, int32_t module, int32_t channel, nai_enc_ssi_parity_t parity) |
| | Sets the Parity configuration for the specified Encoder channel. Channel can be configured for odd or even parity.
|
| |
| NAIBRDFUNC nai_status_t NAIAPI | naibrd_ENC_GetSSI_Parity (int32_t cardIndex, int32_t module, int32_t channel, nai_enc_ssi_parity_t *outParity) |
| | Gets the Parity configuration for the specified Encoder channel. Channel can be configured for odd or even parity.
|
| |
| NAIBRDFUNC nai_status_t NAIAPI | naibrd_ENC_SetSSI_ParityEnable (int32_t cardIndex, int32_t module, int32_t channel, bool_t enable) |
| | Enables or Disables Parity error detection for the specified Encoder channel.
|
| |
| NAIBRDFUNC nai_status_t NAIAPI | naibrd_ENC_GetSSI_ParityEnable (int32_t cardIndex, int32_t module, int32_t channel, bool_t *outEnable) |
| | Retrieves Parity error detection Enabled/Disabled configuration for the specified Encoder channel.
|
| |
| NAIBRDFUNC nai_status_t NAIAPI | naibrd_ENC_SetSSI_ErrorBreakEnable (int32_t cardIndex, int32_t module, int32_t channel, bool_t enable) |
| | Set error break configuration for the specified encoder channel, break on read error if enabled and ignore read errors if disabled. This feature is only available in SSI listener configuration.
|
| |
| NAIBRDFUNC nai_status_t NAIAPI | naibrd_ENC_GetSSI_ErrorBreakEnable (int32_t cardIndex, int32_t module, int32_t channel, bool_t *outEnable) |
| | Retrieves error break configuration for the specified encoder channel, break on read error if enabled and ignore read errors if disabled. This feature is only available in SSI listener mode.
|
| |
| NAIBRDFUNC nai_status_t NAIAPI | naibrd_ENC_SetSSI_ZeroBitEnable (int32_t cardIndex, int32_t module, int32_t channel, bool_t enable) |
| | Set zero bit mode to enabled/disabled for the specified encoder channel.
|
| |
| NAIBRDFUNC nai_status_t NAIAPI | naibrd_ENC_GetSSI_ZeroBitEnable (int32_t cardIndex, int32_t module, int32_t channel, bool_t *outEnable) |
| | Retrieves zero bit mode configuration for the specified encoder channel, enabled or disabled.
|
| |
| NAIBRDFUNC nai_status_t NAIAPI | naibrd_ENC_SetSSI_DwellCount (int32_t cardIndex, int32_t module, int32_t channel, int32_t dwellCount) |
| | Sets the SSI Dwell count for the specified encoder channel. Dwell count corresponds to number of bit cycles the clock will idle for after an SSI read.
|
| |
| NAIBRDFUNC nai_status_t NAIAPI | naibrd_ENC_GetSSI_DwellCount (int32_t cardIndex, int32_t module, int32_t channel, int32_t *outdwellCount) |
| | Gets the SSI Dwell count for the specified encoder channel. Dwell count corresponds to number of bit cycles the clock will idle for after an SSI read.
|
| |
| NAIBRDFUNC nai_status_t NAIAPI | naibrd_ENC_SetInterruptEnable (int32_t cardIndex, int32_t module, int32_t channel, nai_enc_interrupt_t type, bool_t intEnable) |
| | Sets the interrupt enable for the specified Encoder interrupt type and channel. Interval timer vector and multicycle read enable share the same register for all channels. Configuring the enable for these interrupt types will set the enable for all channels.
|
| |
| NAIBRDFUNC nai_status_t NAIAPI | naibrd_ENC_GetInterruptEnable (int32_t cardIndex, int32_t module, int32_t channel, nai_enc_interrupt_t type, bool_t *outintEnable) |
| | Gets the interrupt enable for the specified Encoder interrupt type and channel. Interval timer vector and multicycle read enable share the same register for all channels. Configuring the enable for these interrupt types will set the enable for all channels.
|
| |
| NAIBRDFUNC nai_status_t NAIAPI | naibrd_ENC_SetInterruptVector (int32_t cardIndex, int32_t module, int32_t channel, nai_enc_interrupt_t type, uint32_t vector) |
| | Sets the interrupt vector for the specified Encoder interrupt type and channel. Interval timer vector and multicycle read vector share the same register for all channels. Configuring the vector for these interrupt types will set the vector for all channels.
|
| |
| NAIBRDFUNC nai_status_t NAIAPI | naibrd_ENC_GetInterruptVector (int32_t cardIndex, int32_t module, int32_t channel, nai_enc_interrupt_t type, uint32_t *outVector) |
| | Gets the interrupt vector for the specified Encoder interrupt type and channel. Interval timer vector and multicycle read vector share the same register for all channels. Configuring the vector for these interrupt types will set the vector for all channels.
|
| |
| NAIBRDFUNC nai_status_t NAIAPI | naibrd_ENC_SetRaw (int32_t cardIndex, int32_t module, nai_enc_raw_module_t type, uint32_t rawData) |
| | Sets the raw data value in the register associated to the register type specified.
|
| |
| NAIBRDFUNC nai_status_t NAIAPI | naibrd_ENC_GetRaw (int32_t cardIndex, int32_t module, nai_enc_raw_module_t type, uint32_t *outrawData) |
| | Retrieves the raw data value in the register associated to the register type specified.
|
| |
| NAIBRDFUNC nai_status_t NAIAPI | naibrd_ENC_SetChannelRaw (int32_t cardIndex, int32_t module, int32_t channel, nai_enc_raw_channel_t type, uint32_t rawData) |
| | Sets the raw data value in the register associated to the channel and register type specified.
|
| |
| NAIBRDFUNC nai_status_t NAIAPI | naibrd_ENC_GetChannelRaw (int32_t cardIndex, int32_t module, int32_t channel, nai_enc_raw_channel_t type, uint32_t *outrawdata) |
| | Retrieves the raw data value in the register associated to the channel and register type specified.
|
| |
1.11.0