Class DigitalOutput

All Implemented Interfaces:
Sendable, AutoCloseable

public class DigitalOutput
extends DigitalSource
implements Sendable
Class to write digital outputs. This class will write digital outputs. Other devices that are implemented elsewhere will automatically allocate digital inputs and outputs as required.
  • Constructor Details

    • DigitalOutput

      public DigitalOutput​(int channel)
      Create an instance of a digital output. Create an instance of a digital output given a channel.
      channel - the DIO channel to use for the digital output. 0-9 are on-board, 10-25 are on the MXP
  • Method Details

    • close

      public void close()
      Specified by:
      close in interface AutoCloseable
      close in class DigitalSource
    • set

      public void set​(boolean value)
      Set the value of a digital output.
      value - true is on, off is false
    • get

      public boolean get()
      Gets the value being output from the Digital Output.
      the state of the digital output.
    • getChannel

      public int getChannel()
      Get the GPIO channel number that this object represents.
      Specified by:
      getChannel in class DigitalSource
      The GPIO channel number.
    • pulse

      public void pulse​(double pulseLength)
      Generate a single pulse. There can only be a single pulse going at any time.
      pulseLength - The length of the pulse.
    • isPulsing

      public boolean isPulsing()
      Determine if the pulse is still going. Determine if a previously started pulse is still going.
      true if pulsing
    • setPWMRate

      public void setPWMRate​(double rate)
      Change the PWM frequency of the PWM output on a Digital Output line.

      The valid range is from 0.6 Hz to 19 kHz. The frequency resolution is logarithmic.

      There is only one PWM frequency for all channels.

      rate - The frequency to output all digital output PWM signals.
    • enablePWM

      public void enablePWM​(double initialDutyCycle)
      Enable a PWM Output on this line.

      Allocate one of the 6 DO PWM generator resources.

      Supply the initial duty-cycle to output so as to avoid a glitch when first starting.

      The resolution of the duty cycle is 8-bit for low frequencies (1kHz or less) but is reduced the higher the frequency of the PWM signal is.

      initialDutyCycle - The duty-cycle to start generating. [0..1]
    • disablePWM

      public void disablePWM()
      Change this line from a PWM output back to a static Digital Output line.

      Free up one of the 6 DO PWM generator resources that were in use.

    • updateDutyCycle

      public void updateDutyCycle​(double dutyCycle)
      Change the duty-cycle that is being generated on the line.

      The resolution of the duty cycle is 8-bit for low frequencies (1kHz or less) but is reduced the higher the frequency of the PWM signal is.

      dutyCycle - The duty-cycle to change to. [0..1]
    • setSimDevice

      public void setSimDevice​(SimDevice device)
      Indicates this input is used by a simulated device.
      device - simulated device handle
    • initSendable

      public void initSendable​(SendableBuilder builder)
      Description copied from interface: Sendable
      Initializes this Sendable object.
      Specified by:
      initSendable in interface Sendable
      builder - sendable builder
    • isAnalogTrigger

      public boolean isAnalogTrigger()
      Is this an analog trigger.
      Specified by:
      isAnalogTrigger in class DigitalSource
      true if this is an analog trigger
    • getAnalogTriggerTypeForRouting

      Get the analog trigger type.
      Specified by:
      getAnalogTriggerTypeForRouting in class DigitalSource
    • getPortHandleForRouting

      Get the HAL Port Handle.
      Specified by:
      getPortHandleForRouting in class DigitalSource
      The HAL Handle to the specified source.