Package com.ctre.phoenixpro.controls

Class NeutralOut

java.lang.Object
com.ctre.phoenixpro.controls.ControlRequest
com.ctre.phoenixpro.controls.NeutralOut
@Deprecated(forRemoval=true)
public class NeutralOut
extends ControlRequest
Deprecated, for removal: This API element is subject to removal in a future version.
Classes in the phoenixpro package will be removed in 2024. Users should instead use classes from the phoenix6 package.
Request neutral output of actuator. The applied brake type is determined by the NeutralMode configuration.

  • Field Summary

    Fields 
    Modifier and Type Field Description
    double configTimeout
    Deprecated, for removal: This API element is subject to removal in a future version.
    The timeout when sending configs associated with this control
    double UpdateFreqHz
    Deprecated, for removal: This API element is subject to removal in a future version.
    The period at which this control will update at.

    Fields inherited from class com.ctre.phoenixpro.controls.ControlRequest

    requestReference

  • Constructor Summary

    Constructors 
    Constructor Description
    NeutralOut()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Classes in the phoenixpro package will be removed in 2024.

  • Method Summary

    Modifier and Type Method Description
    void forceApplyConfigs()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Forces configs to be applied the next time this is used in a setControl.
    StatusCode sendRequest​(String network, int deviceHash, boolean cancelOtherRequests)
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    String toString()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    NeutralOut withUpdateFreqHz​(double newUpdateFreqHz)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Sets the period at which this control will update at.

    Methods inherited from class com.ctre.phoenixpro.controls.ControlRequest

    getControlInfo

    Methods inherited from class java.lang.Object

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

  • Field Details

    • UpdateFreqHz

      public double UpdateFreqHz
      Deprecated, for removal: This API element is subject to removal in a future version.
      The period at which this control will update at. This is designated in Hertz, with a minimum of 20 Hz (every 50 ms) and a maximum of 1000 Hz (every 1 ms).

      If this field is set to 0 Hz, the control request will be sent immediately as a one-shot frame. This may be useful for advanced applications that require outputs to be synchronized with data acquisition. In this case, we recommend not exceeding 50 ms between control calls.

    • configTimeout

      public double configTimeout
      Deprecated, for removal: This API element is subject to removal in a future version.
      The timeout when sending configs associated with this control

  • Constructor Details

    • NeutralOut

      @Deprecated(forRemoval=true) public NeutralOut()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Classes in the phoenixpro package will be removed in 2024. Users should instead use classes from the phoenix6 package.
      Request neutral output of actuator. The applied brake type is determined by the NeutralMode configuration.

  • Method Details

    • toString

      public String toString()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Overrides:
      toString in class Object

    • sendRequest

      public StatusCode sendRequest​(String network, int deviceHash, boolean cancelOtherRequests)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Specified by:
      sendRequest in class ControlRequest

    • withUpdateFreqHz

      public NeutralOut withUpdateFreqHz​(double newUpdateFreqHz)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Sets the period at which this control will update at. This is designated in Hertz, with a minimum of 20 Hz (every 50 ms) and a maximum of 1000 Hz (every 1 ms).

      If this field is set to 0 Hz, the control request will be sent immediately as a one-shot frame. This may be useful for advanced applications that require outputs to be synchronized with data acquisition. In this case, we recommend not exceeding 50 ms between control calls.

      Parameters:
      newUpdateFreqHz - Parameter to modify
      Returns:
      Itself

    • forceApplyConfigs

      public void forceApplyConfigs()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Forces configs to be applied the next time this is used in a setControl.

      This is not necessary in the majority of cases, because Phoenix will make sure configs are properly set when they are not already set