Class DutyCycleJNI

java.lang.Object

org.wpilib.hardware.hal.JNIWrapper

org.wpilib.hardware.hal.DutyCycleJNI

public class DutyCycleJNI
extends JNIWrapper

DutyCycle HAL JNI functions.

See Also:

• "wpi/hal/DutyCycle.h"

Nested Class Summary

Nested classes/interfaces inherited from class JNIWrapper

JNIWrapper.Helper

Method Summary

Modifier and Type	Method	Description
static void	free(int handle)	Free a DutyCycle.
static double	getFrequency(int handle)	Get the frequency of the duty cycle signal.
static int	getHighTime(int handle)	Get the raw high time of the duty cycle signal.
static double	getOutput(int handle)	Get the output ratio of the duty cycle signal.
static int	initialize(int channel)	Initialize a DutyCycle input.

Methods inherited from class JNIWrapper

forceLoad, suppressUnused

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

initialize

public static int initialize(int channel)

Initialize a DutyCycle input.

Parameters:

channel - the smartio channel

Returns:

the created duty cycle handle

See Also:

• "HAL_InitializeDutyCycle"

free

public static void free(int handle)

Free a DutyCycle.

Parameters:

handle - the duty cycle handle

See Also:

• "HAL_FreeDutyCycle"

getFrequency

public static double getFrequency(int handle)

Get the frequency of the duty cycle signal.

Parameters:

handle - the duty cycle handle

Returns:

frequency in Hertz

See Also:

• "HAL_GetDutyCycleFrequency"

getOutput

public static double getOutput(int handle)

Get the output ratio of the duty cycle signal.

0 means always low, 1 means always high.

Parameters:

handle - the duty cycle handle

Returns:

output ratio between 0 and 1

See Also:

• "HAL_GetDutyCycleOutput"

getHighTime

public static int getHighTime(int handle)

Get the raw high time of the duty cycle signal.

Parameters:

handle - the duty cycle handle

Returns:

high time of last pulse in nanoseconds

See Also:

• "HAL_GetDutyCycleHighTime"