Module wpilib_sys::bindings
source · Modules
Structs
Storage for CAN Stream Messages.
Constants
Functions
Allocates a DO PWM Generator.
Attaches an asynchronous interrupt handler to the interrupt.
Attaches an asynchronous interrupt handler to the interrupt.
The base HAL initialize function. Useful if you need to ensure the DS and
base HAL functions (the ones above this declaration in HAL.h) are properly
initialized. For normal programs and executables, please use HAL_Initialize.
Calibrates the analog gyro.
Cancels the next notifier alarm.
Checks that the analog output channel number is value.
Verifies that the analog channel number is one of the legal channel numbers.
Channel numbers are 0-based.
Checks that the analog module number is valid.
Checks that the analog output channel number is value.
Gets if a compressor module is valid.
Checks if a DIO channel is valid.
Checks if a PDP channel is valid.
Checks if a PDP module is valid.
Checks if a pwm channel is valid.
Checks if a relay channel is valid.
Checks if a solenoid channel is in the valid range.
Checks if a solenoid module is in the valid range.
Frees an analog trigger.
Frees an interrupt.
Cleans a notifier.
Cleans a PDP module.
Clears all faults on a module.
Disables the down counting source to the counter.
Disables the up counting source to the counter.
Clears any PDP sticky faults.
Clears the receive buffer of the serial port.
Closes an I2C port
Closes the SPI port.
Closes a serial port.
Disables interrupts without without deallocating structures.
Disables a termination character for reads.
Enables interrupts to occur on this input.
Sets the termination character that terminates a read.
Fires a single pulse on a solenoid channel.
Flushes the serial write buffer out to the port.
Immediately forces an SPI read to happen.
Frees an analog gyro.
Frees an analog input port.
Frees an analog output port.
Frees a counter.
Frees the resource associated with a DO PWM generator.
Frees an encoder.
Frees a joystick name received with HAL_GetJoystickName
Frees a PWM port.
Frees a relay port.
Frees an SPI automatic accumulator.
Frees a solenoid port.
Gets the x-axis acceleration.
Gets the y-axis acceleration.
Gets the z-axis acceleration.
Read the number of accumulated values.
Read the accumulated value and the number of accumulated values atomically.
Read the accumulated value.
Gets the status of all solenoids on a specific module.
Gets the current alliance station ID.
Gets the number of averaging bits.
Gets a sample from the output of the oversample and average engine for the
channel.
Gets a scaled sample from the output of the oversample and average engine for
the channel.
Gets the gyro angle in degrees.
Gets the calibrated gyro center.
Gets the calibrated gyro offset.
Gets the gyro rate in degrees/second.
Gets the factory scaling least significant bit weight constant.
The least significant bit weight constant for the channel that was calibrated
in manufacturing and stored in an eeprom in the module.
Gets the factory scaling offset constant.
The offset constant for the channel that was calibrated in manufacturing and
stored in an eeprom in the module.
Gets the current analog output value.
Gets the number of oversample bits.
Gets the current sample rate.
Returns the InWindow output of the analog trigger.
Gets the state of the analog trigger output.
Returns the TriggerState output of the analog trigger.
Gets a sample straight from the channel on this module.
Gets a scaled sample straight from the channel on this module.
Converts a voltage to a raw value for a specified channel.
Gets if the system is in a browned out state.
Gets the compressor state (on or off).
Gets if the compressor is in closed loop mode.
Gets the compressor current.
Gets if the compressor is faulted because of too high of current.
Gets if a sticky fauly is triggered because of too high of current.
Gets if the compressor is not connected.
Gets if a sticky fault is triggered of the compressor not connected.
Gets the compressor pressure switch state.
Gets if the compressor is faulted because of a short.
Gets if a sticky fauly is triggered because of a short.
Gets the current control word of the driver station.
Reads the current counter value.
Gets the last direction the counter value changed.
Gets the Samples to Average which specifies the number of samples of the
timer to average when calculating the period. Perform averaging to account
for mechanical imperfections or as oversampling to increase resolution.
Determines if the clock is stopped.
Reads a digital value from a DIO channel.
Reads the direction of a DIO channel.
Gets the current counts of the encoder after encoding type scaling.
Gets the decoding scale factor of the encoder.
Gets the last direction the encoder value changed.
Gets the current distance traveled by the encoder.
Gets the user set distance per pulse of the encoder.
Gets the encoder scale value.
Gets the encoding type of the encoder.
Gets the FPGA index of the encoder.
Gets the current rate of the encoder.
Gets the raw counts of the encoder.
Gets the current samples to average value.
Determines if the clock is stopped.
Gets the error message for a specific status code.
Gets the state of the “USER” button on the roboRIO.
Returns the FPGA Revision number.
Reads the microsecond-resolution timer on the FPGA.
Returns the FPGA Version number.
Gets the filter period for the specified filter index.
Reads the filter index from the FPGA.
Gets the axes of a specific joystick.
Gets the type of a specific joystick axis.
Gets the buttons of a specific joystick.
Retrieves the Joystick Descriptor for particular slot.
Gets is a specific joystick is considered to be an XBox controller.
Gets the name of a joystick.
Gets the POVs of a specific joystick.
Gets the type of joystick connected.
Gets info about a specific match.
Returns the approximate match time.
Gets the number of analog accumulators in the current system.
Gets the number of analog inputs in the current system.
Gets the number of analog outputs in the current system.
Gets the number of analog triggers in the current system.
Gets the number of analog counters in the current system.
Gets the number of digital channels in the current system.
Gets the number of digital headers in the current system.
Gets the number of digital IO PWM outputs in the current system.
Gets the number of quadrature encoders in the current system.
Gets the number of interrupts in the current system.
Gets the number of PCM modules in the current system.
Gets the number of PDP channels in the current system.
Gets the number of PDP modules in the current system.
Gets the number of PWM channels in the current system.
Gets the number of PWM headers in the current system.
Gets the number of relay channels in the current system.
Gets the number of relay headers in the current system.
Gets the number of solenoid channels in the current system.
Gets the channels blacklisted from being enabled on a module.
Gets if a specific module has an over or under voltage fault.
Gets if a specific module has an over or under voltage sticky fault.
Gets the current of a specific PDP channel.
Gets the temperature of the PDP.
Gets the total current of the PDP.
Gets the total energy of the PDP.
Gets the total power of the PDP.
Gets the PDP input voltage.
Gets the raw pwm configuration settings for the PWM channel.
Gets the pwm starting cycle time.
Gets the current eliminate deadband value.
Gets the loop timing of the PWM system.
Gets a position value from a PWM channel.
Gets a value from a PWM channel.
Gets a scaled value from a PWM channel.
Gets a port handle for a specific channel.
Gets a port handle for a specific channel and module.
Gets the current state of the relay channel.
Gets the count of how many SPI accumulations have been missed.
Gets the stored handle for a SPI port.
Gets the number of bytes currently in the read buffer.
Gets the current solenoid output value.
Gets if the system outputs are currently active
Gets the number of FPGA system clock ticks per microsecond.
Gets the active state of the 3V3 rail.
Gets the active state of the 5V rail.
Gets the active state of the 6V rail.
Gets the 3V3 rail current.
Gets the 5V rail current.
Gets the 6V rail current.
Gets the fault count for the 3V3 rail.
Gets the fault count for the 5V rail.
Gets the fault count for the 6V rail.
Gets the 3V3 rail voltage.
Gets the 5V rail voltage.
Gets the 6V rail voltage.
Gets the roboRIO input current.
Gets the roboRIO input voltage.
Initialize the accumulator.
Initializes the SPI automatic accumulator.
Call this to start up HAL. This is required for robot programs.
Initializes an analog gyro.
Initializes the analog input port using the given port object.
Initializes the analog output port using the given port object.
Initializes an analog trigger.
Initializes a compressor on the given PCM module.
Initializes a counter.
Creates a new instance of a digital port.
Initializes the driver station communication. This will properly
handle multiple calls. However note that this CANNOT be called from a library
that interfaces with LabVIEW.
Initializes an encoder.
Initializes the I2C port.
Initializes an interrupt.
Initializes a notifier.
Initializes a Power Distribution Panel.
Initializes a PWM port.
Initializes a relay.
Initializes the SPI port. Opens the port if necessary and saves the handle.
Initializes a serial port.
Initializes a serial port with a direct name.
Initializes a solenoid port.
Is the channel attached to an accumulator.
Checks if any DIO line is currently generating a pulse.
Has a new control packet from the driver station arrived since the last
time this function was called?
Checks a DIO line to see if it is currently generating a pulse.
Forces a PWM signal to go to 0 temporarily.
Sets the autonomous enabled flag in the DS.
Sets the disabled flag in the DS.
Sets the program starting flag in the DS.
Sets the teleoperated enabled flag in the DS.
Sets the test mode flag in the DS.
Generates a single digital pulse.
Executes a read transaction with the device.
Returns the timestamp for the falling interrupt that occurred most recently.
Returns the timestamp for the rising interrupt that occurred most recently.
Executes a read from the device.
Reads data received by the SPI accumulator.
Reads data from the serial port.
Releases the DS Mutex to allow proper shutdown of any threads that are
waiting on it.
Reports a hardware usage to the HAL.
Requests interrupts on a specific digital source.
Resets the accumulator to the initial value.
Resets the analog gyro value to 0.
Resets the Counter to zero.
Reads the current encoder value.
Resets the PDP accumulated energy.
Sends an error to the driver station.
Sets the accelerometer to active or standby mode.
Sets the range of values that can be measured (either 2, 4, or 8 g-forces).
Set the center value of the accumulator.
Set the accumulator’s deadband.
Sets all channels on a specific module.
Sets the number of averaging bits.
Sets the deadband of the analog gyro.
Sets the analog gyro parameters to the specified values.
Sets the analog gyro volts per degrees per second scaling.
Sets an analog output value.
Sets the number of oversample bits.
Sets the sample rate.
Configures the analog trigger to use the averaged vs. raw values.
Configures the analog trigger to use a filtered value.
Sets the raw ADC upper and lower limits of the analog trigger.
Sets the upper and lower limits of the analog trigger.
Sets the compressor to closed loop mode.
Sets the average sample size of a counter.
Sets the source object that causes the counter to count down.
Sets the down source to either detect rising edges or falling edges.
Note that both are allowed to be set true at the same time without issues.
Sets directional counting mode on this counter.
Sets the maximum period where the device is still considered “moving”.
Configures the counter to count in up or down based on the length of the
input pulse.
Sets the Counter to return reversed sensing on the direction.
Sets the Samples to Average which specifies the number of samples of the
timer to average when calculating the period. Perform averaging to account
for mechanical imperfections or as oversampling to increase resolution.
Sets Semi-period mode on this counter.
Sets standard up / down counting mode on this counter.
Sets the source object that causes the counter to count up.
Sets the up source to either detect rising edges or falling edges.
Selects whether you want to continue updating the event timer output when
there are no samples captured.
Writes a digital value to a DIO channel.
Sets the direction of a DIO channel.
Configures the duty-cycle of the PWM generator.
Configures which DO channel the PWM signal is output on.
Changes the frequency of the DO PWM generator.
Sets the distance traveled per encoder pulse. This is used as a scaling
factor for the rate and distance calls.
Sets the source for an index pulse on the encoder.
Sets the maximum period where the device is still considered “moving”.
Sets the minimum rate to be considered moving by the encoder.
Sets if to reverse the direction of the encoder.
Sets the number of encoder samples to average when calculating encoder rate.
Sets the filter period for the specified filter index.
Writes the filter index from the FPGA.
Sets the edges to trigger the interrupt on.
Set joystick outputs.
Sets the one shot duration on a solenoid channel.
Sets the configuration settings for the PWM channel.
Sets the raw configuration settings for the PWM channel.
Sets a PWM channel to be disabled.
Sets if the FPGA should output the center value if the input value is within
the deadband.
Sets how how often the PWM signal is squelched, thus scaling the period.
Sets a PWM channel to the desired position value.
Sets a PWM channel to the desired value.
Sets a PWM channel to the desired scaled value.
Sets the state of a relay output.
Sets the data to be transmitted to the device to initiate a read.
Sets the CS Active high for a SPI port.
Sets the CS Active low for a SPI port.
Sets the stored handle for a SPI port.
Sets the SPI options.
Sets the clock speed for the SPI bus.
Sets the baud rate of a serial port.
Sets the number of data bits on a serial port.
Sets the flow control mode of a serial port.
Sets the number of parity bits on a serial port.
Sets the size of the read buffer.
Sets the number of stop bits on a serial port.
Sets the minimum serial read timeout of a port.
Sets the size of the write buffer.
Sets the write mode on a serial port.
Sets a solenoid output value.
Sets up an analog gyro with the proper offsets and settings for the KOP
analog gyro.
Sets the period for automatic SPI accumulation.
Starts the auto SPI accumulator on a specific trigger.
Stops a notifier from running.
Stops an automatic SPI accumlation.
Generic I2C read/write transaction.
Performs an SPI send/receive transaction.
Updates the trigger time for a notifier.
Waits for the newest DS packet to arrive. Note that this is a blocking call.
Waits for the newest DS packet to arrive. If timeout is <= 0, this will wait
forever. Otherwise, it will wait until either a new packet, or the timeout
time has passed.
In synchronous mode, waits for the defined interrupt to occur.
Waits for the next alarm for the specific notifier.
Executes a write transaction with the device.
Executes a write transaction with the device.
Writes data to the serial port.