🖥
🖥
🖥
🖥
AugeLab Studio Manual
English
Ask or search…
K
Comment on page

Cycle Timer

Node_CycleTimer Documentation

The Node_CycleTimer node in AugeLab Studio is used to find the cycle time between steps. It calculates the time difference between consecutive steps based on an input signal. This documentation will provide an overview of the node's functionality and how to use it effectively.

Node Overview

The Node_CycleTimer node measures the time between steps and outputs a list of delta times. It is typically used in scenarios where you need to measure the time between consecutive occurrences of a signal, such as a rising edge.

Node Properties

  • Node Title: Cycle Timer
  • Node ID: OP_NODE_CYCLE_TIMER
  • Tooltip: Find the cycle time between steps. Use Edge Rising for input state.

Inputs

The node has one input socket labeled "Step Started?". You can connect a boolean signal to this input socket to indicate when a step has started. The time difference will be calculated based on the rising edge of this signal.

Outputs

The node has one output socket labeled "Delta Time List". It provides a list of delta times between consecutive steps. Each delta time represents the time elapsed between two successive rising edges of the input signal.

Node Widgets

The Node_CycleTimer node has the following widgets:
  • Step Size: This slider allows you to set the step size, which determines the number of steps for which the cycle time will be calculated. The range of the slider is from 2 to 30, with a step increment of 1. The default value is 5.
  • Current Step: This text widget displays the current step number, indicating the number of steps recorded so far.

Widget Configurations

The behavior of the Node_CycleTimer node can be affected by the following widget configurations:
  • Step Size:
    • Adjust the slider to set the desired step size, which determines the number of steps for which the cycle time will be calculated.
    • The step size can be any value between 2 and 30, with a step increment of 1.

Usage

  1. 1.
    Drag and drop the Node_CycleTimer node from the node library onto the canvas in AugeLab Studio.
  2. 2.
    Connect the "Step Started?" input socket to a boolean signal that indicates when a step has started. This signal is typically connected to a rising edge.
  3. 3.
    Set the desired step size using the "Step Size" slider. The step size determines the number of steps for which the cycle time will be calculated.
  4. 4.
    The current step number will be displayed in the "Current Step" text widget as steps are recorded.
  5. 5.
    The node will calculate the time difference between consecutive steps based on the rising edges of the input signal.
  6. 6.
    The calculated delta times will be output as a list through the "Delta Time List" output socket.
  7. 7.
    You can use the delta times for further analysis or processing in your project.

Example

Let's walk through an example to illustrate how the Node_CycleTimer node works.
  1. 1.
    Drag and drop the Node_CycleTimer node onto the canvas.
  2. 2.
    Connect a boolean signal that represents the rising edges of a step to the "Step Started?" input socket.
  3. 3.
    Adjust the "Step Size" slider to the desired number of steps to consider for calculating the cycle time.
  4. 4.
    As the step signal rises, the node will record the time difference between consecutive steps.
  5. 5.
    The "Current Step" text widget will display the current step number as steps are recorded.
  6. 6.
    The calculated delta times will be output as a list through the "Delta Time List" output socket.
  7. 7.
    You can use the delta times for further analysis or processing in your project.

Notes

  • The Node_CycleTimer node measures the time difference between consecutive steps based on the rising edges of the input signal.
  • The step size determines the number of steps for which the cycle time will be calculated.
  • The node outputs a list of delta times between consecutive steps, representing the time elapsed between two successive rising edges of the input signal.
That concludes the documentation for the Node_CycleTimer node in AugeLab Studio. This node provides a convenient way to measure the cycle time between steps based on an input signal.