The following Built-in Functions are currently restricted in simulation.

• compile
• dir
• eval
• exec
• globals
• input
• locals
• memoryview
• object
• open
• vars

The following Modules are allowed in simulation.

• machinelogic
• time
• math
• copy
• json
• abc
• random
• numpy

• Description Retrieves an Actuator by name.
  • Parameters
    • name
      • Description The name of the Actuator.
      • Type str
  • Returns
    • Description The Actuator that was found.
    • Type IActuator
  • Raises
    • Type MachineException
      • Description If we cannot find the Actuator.

from machinelogic import Machine, MachineException

machine = Machine()

try:
    actuator = machine.get_actuator("New actuator")  # Returns the actuator or throws
    # ...Use the actuator here

    # Home the actuator
    actuator.home()
except MachineException as err:
    print(f"Failed to find actuator with name 'New Actuator'. Reason: {str(err)}")

• Description Retrieves an Input by name.
  • Parameters
    • name
      • Description The name of the Input.
      • Type str
  • Returns
    • Description The Input that was found.
    • Type IInput
  • Raises
    • Type MachineException
      • Description If we cannot find the Input.

from machinelogic import Machine, MachineException

machine = Machine()

try:
    machine_input = machine.get_input("Input #1")  # Returns the input or throws
    # ...Use the input here

    # Check if the input is active
    active_input = machine_input.is_active()
except MachineException as err:
    print(f"Failed to find Input with name 'Input #1'. Reason: {str(err)}")

• Description Retrieves an IMachineMotion instance by name.
  • Parameters
    • name
      • Description The name of the MachineMotion.
      • Type str
  • Returns
    • Description The MachineMotion that was found.
    • Type IMachineMotion
  • Raises
    • Type MachineException
      • Description If we cannot find the MachineMotion.

from machinelogic import Machine, MachineException

machine = Machine()

try:
    machine_motion = machine.get_machine_motion(
        "Controller #1"
    )  # Returns the MachineMotion or throws
    # ...Use the MachineMotion here

    # Get a pneumatic from the machine motion
    pneumatic = machine_motion.get_pneumatic("Pneumatic #1")
except MachineException as err:
    print(
        f"Failed to find Machine Motion with name 'Controller #1'. Reason: {str(err)}"
    )

• Description Retrieves an Output by name.
  • Parameters
    • name
      • Description The name of the Output
      • Type str
  • Returns
    • Description The Output that was found.
    • Type IOutput
  • Raises
    • Type MachineException
      • Description If we cannot find the Output.

from machinelogic import Machine, MachineException

machine = Machine()

try:
    machine_output = machine.get_output("Output #1")  # Returns the output or throws
    # ...Use the output here

    # Write the raw value to the output
    machine_output.write(True)
except MachineException as err:
    print(f"Failed to find Output with name 'Output #1'. Reason: {str(err)}")

• Description MachineMotionConfiguration: The representation of the configuraiton associated with this MachineMotion.

• Description ActuatorConfiguration: The representation of the configuraiton associated with this MachineMotion.

• Description Home the Actuator synchronously.
  • Parameters
    • timeout
      • Description The timeout in seconds.
      • Type float
  • Raises
    • Type ActuatorException
      • Description If the home was unsuccessful or request timed out.

from machinelogic import Machine, ActuatorException, MachineException

machine = Machine()

try:
    # We are assuming here that Actuator #1 is in the MachineLogic configuration.
    # We are also assuming that Actuator #1 is a Timing Belt.
    actuator = machine.get_actuator("Actuator #1")
except MachineException as err:
    print(f"Failed to find actuator named Actuator #1. Reason: {str(err)}")
    raise SystemExit

try:
    # Home the actuator synchronously. This will wait for motion to complete on the actuator
    # before returning. If the actuator fails to home within time_to_wait_seconds, an ActuatorException
    # will be raised. If the homing fails for any other reason, an ActuatorException will also be raised. 
    TIME_TO_WAIT_SECONDS = 10.0
    actuator.home(TIME_TO_WAIT_SECONDS) 
except ActuatorException as err:
    print(
        f"Failed to home Actuator with name 'Actuator #1' or request timed out. Reason: {str(err)}"
    )

• Description Moves absolute synchronously to the specified position.
  • Parameters
    • position
      • Description The position to move to.
      • Type float
    • timeout
      • Description The timeout in seconds.
      • Type float
  • Raises
    • Type ActuatorException
      • Description If the move was unsuccessful.

from machinelogic import Machine, ActuatorException,MachineException

machine = Machine()

try:
    # We are assuming here that Actuator #1 is in the MachineLogic configuration.
    # We are also assuming that Actuator #1 is a Timing Belt.
    actuator = machine.get_actuator("Actuator #1")
except MachineException as err:
    print(f"Failed to find actuator named Actuator #1. Reason: {str(err)}")
    raise SystemExit

try:
    actuator.home()  # It is recommended that you home your actuator before moving it in any way.

    # Move the actuator to DESIRED_POSITION synchronously. This method will wait for motion to complete
    # before returning. If the actuator fails to arrive at DESIRED_POSITION within TIMEOUT_SECONDS, 
    # then an ActuatorException will be raised. If the move fails for any other reason,
    # then an ActuatorException will be thrown.
    DESIRED_POSITION = 100.0  # Position in mm to move to
    TIMEOUT_SECONDS = 10.0  # Timeout within which the move must complete or else an exception will be thrown.
    actuator.move_absolute(DESIRED_POSITION, TIMEOUT_SECONDS)
except ActuatorException as err:
    print(f"Failed to move Actuator with name 'Actuator #1'. Reason: {str(err)}")

• Description Moves absolute asynchronously.
  • Parameters
    • position
      • Description The position to move to.
      • Type float
  • Raises
    • Type ActuatorException
      • Description If the move was unsuccessful.

from machinelogic import Machine, ActuatorException,MachineException

machine = Machine()

try:
    # We are assuming here that Actuator #1 is in the MachineLogic configuration.
    # We are also assuming that Actuator #1 is a Timing Belt.
    actuator = machine.get_actuator("Actuator #1")
except MachineException as err:
    print(f"Failed to find actuator named Actuator #1. Reason: {str(err)}")
    raise SystemExit

try:
    actuator.home()  # It is recommended that you home your actuator before moving it in any way.

    # Move the actuator to DESIRED_POSITION asynchronously. This method will return immediately (it will
    # NOT wait for motion to complete). If the move fails for any reason, then an ActuatorException will be thrown.
    DESIRED_POSITION = 100.0  # Position in mm to move to
    actuator.move_absolute_async(DESIRED_POSITION)

    print("This print will happen IMMEDIATELY after the move_absolute begins")
except ActuatorException as err:
    print(f"Failed to move Actuator with name 'Actuator #1'. Reason: {str(err)}")

• Description Moves relative synchronously by the specified distance.
  • Parameters
    • distance
      • Description The distance to move.
      • Type float
    • timeout
      • Description The timeout in seconds.
      • Type float
  • Raises
    • Type ActuatorException
      • Description If the move was unsuccessful.

from machinelogic import Machine, ActuatorException,MachineException

machine = Machine()

try:
    # We are assuming here that Actuator #1 is in the MachineLogic configuration.
    # We are also assuming that Actuator #1 is a Timing Belt.
    actuator = machine.get_actuator("Actuator #1")
except MachineException as err:
    print(f"Failed to find actuator named Actuator #1. Reason: {str(err)}")
    raise SystemExit

try:
    actuator.home()  # It is recommended that you home your actuator before moving it in any way.

    # Move the actuator relative by DISTANCE synchronously. This method will wait for motion to complete
    # before returning.
    # If the actuator fails to move within TIMEOUT_SECONDS, then an ActuatorException will be raised.
    # If the move fails for any other reason, then an ActuatorException will be thrown.
    DISTANCE = 100.0  # Distance to move by in mm
    TIMEOUT_SECONDS = 10.0  # Timeout within which the move must complete or else an exception will be thrown.
    actuator.move_relative(DISTANCE, TIMEOUT_SECONDS)
except ActuatorException as err:
    print(f"Failed to move Actuator with name 'Actuator #1'. Reason: {str(err)}")

• Description Moves relative asynchronously by the specified distance.
  • Parameters
    • distance
      • Description The distance to move.
      • Type float
  • Raises
    • Type ActuatorException
      • Description If the move was unsuccessful.

from machinelogic import Machine, ActuatorException,MachineException

machine = Machine()

try:
    # We are assuming here that Actuator #1 is in the MachineLogic configuration.
    # We are also assuming that Actuator #1 is a Timing Belt.
    actuator = machine.get_actuator("Actuator #1")
except MachineException as err:
    print(f"Failed to find actuator named Actuator #1. Reason: {str(err)}")
    raise SystemExit

try:
    actuator.home()  # It is recommended that you home your actuator before moving it in any way.

    # Move the actuator by DISTANCE asynchronously. This method will return immediately (it will
    # NOT wait for motion to complete). If the move fails for any reason, then an ActuatorException will be thrown.
    DISTANCE = 100.0  # Distance to move by in mm
    actuator.move_relative_async(DISTANCE)

    print("This print will happen IMMEDIATELY after the move_absolute begins")
except ActuatorException as err:
    print(f"Failed to move Actuator with name 'Actuator #1'. Reason: {str(err)}")

• Description Sets the max acceleration for the Actuator.
  • Parameters
    • acceleration
      • Description The new acceleration.
      • Type float
  • Raises
    • Type ActuatorException
      • Description If the request was unsuccessful.

from machinelogic import Machine, ActuatorException,MachineException

machine = Machine()

try:
    # We are assuming here that Actuator #1 is in the MachineLogic configuration.
    # We are also assuming that Actuator #1 is a Timing Belt.
    actuator = machine.get_actuator("Actuator #1")
except MachineException as err:
    print(f"Failed to find actuator named Actuator #1. Reason: {str(err)}")
    raise SystemExit

try:
    actuator.home()  # It is recommended that you home your actuator before moving it in any way.

    # Set the acceleration for the actuator.
    # If the request fails, an ActuatorException will be thrown.
    ACCELERATION_MM_S2 = 100.0
    actuator.set_acceleration(ACCELERATION_MM_S2)

    print(actuator.configuration.acceleration)  # This should equal ACCELERATION_MM_S2
except ActuatorException as err:
    print(f"Failed to move Actuator with name 'Actuator #1'. Reason: {str(err)}")

• Description Sets the max speed for the Actuator.
  • Parameters
    • speed
      • Description The new speed.
      • Type float
  • Raises
    • Type ActuatorException
      • Description If the request was unsuccessful.

from machinelogic import Machine, ActuatorException,MachineException

machine = Machine()

try:
    # We are assuming here that Actuator #1 is in the MachineLogic configuration.
    # We are also assuming that Actuator #1 is a Timing Belt.
    actuator = machine.get_actuator("Actuator #1")
except MachineException as err:
    print(f"Failed to find actuator named Actuator #1. Reason: {str(err)}")
    raise SystemExit

try:
    actuator.home()  # It is recommended that you home your actuator before moving it in any way.

    # Set the speed for the actuator.
    # If the request fails, an ActuatorException will be thrown.
    SPEED_MM_S = 100.0
    actuator.set_speed(SPEED_MM_S)

    print(actuator.configuration.speed)  # This should equal SPEED_MM_S
except ActuatorException as err:
    print(f"Failed to move Actuator with name 'Actuator #1'. Reason: {str(err)}")

• Description ActuatorState: The representation of the current state of this MachineMotion.

• Description Stops movement on this Actuator.
  • Parameters
    • acceleration
      • Description Deceleration speed. Defaults to 100.0.
      • Type float
      • Default 100.0
  • Raises
    • Type ActuatorException
      • Description If the Actuator failed to stop.

• Description Waits for motion to complete before commencing the next action.
  • Parameters
    • timeout
      • Description The timeout in seconds, after which an exception will be thrown.
      • Type float
  • Raises
    • Type ActuatorException
      • Description If the request fails or the move did not complete in the allocated amount of time.

from machinelogic import Machine, ActuatorException,MachineException
from time import sleep

machine = Machine()

try:
    # We are assuming here that Actuator #1 is in the MachineLogic configuration.
    # We are also assuming that Actuator #1 is a Timing Belt.
    actuator = machine.get_actuator("Actuator #1")
except MachineException as err:
    print(f"Failed to find actuator named Actuator #1. Reason: {str(err)}")
    raise SystemExit

try:
    actuator.home()  # It is recommended that you home your actuator before moving it in any way.

    # Move the actuator by DISTANCE asynchronously.
    DISTANCE = 100.0  # Distance to move by in mm
    actuator.move_relative_async(DISTANCE)

    sleep(5)  # Sleep for 5 seconds to simulate other work.

    # Perhaps in the next section, we want to make sure that actuator is not in motion
    # before we use it again. That's when we would use wait_for_move_completion!
    # If the actuator does not complete movement within TIMEOUT_SECONDS, then an
    # ActuatorException will be raised.
    TIMEOUT_SECONDS = 10
    actuator.wait_for_move_completion(TIMEOUT_SECONDS)

except ActuatorException as err:
    print(f"Failed to move Actuator with name 'Actuator #1'. Reason: {str(err)}")

• Description float: The current brake of the Actuator. Set to 1 if locked, otherwise 0.

• Description float: The current effort of the Actuator.

• Description Tuple[bool, bool]: A tuple representing the state of the [ home, end ] sensors.

• Description bool: The boolean is True if a move is in progress, otherwise False.

• Description float: The current position of the Actuator.

• Description float: The current speed of the Actuator.

• Description float: The acceleration of the Actuator.

• Description ActuatorType: The type of the Actuator.

• Description Literal[“A”, “B”]: The home sensor port, either A or B.

• Description str: The IP address of the Actuator.

• Description str: The name of the Actuator.

• Description float: The max speed of the Actuator.

• Description Literal[“deg”, “mm”]: The units that the Actuator functions in.

• Description str: The ID of the Actuator.

• Description ActuatorGroupConfiguration: The configuration of the ActuatorGroup.

• Description Moves absolute synchronously to the tuple of positions.
  • Parameters
    • position
      • Description The positions to move to. Each value corresponds 1-to-1 with the actuators tuple provided to the constructor.
      • Type Tuple[float, …]
    • timeout
      • Description The timeout in seconds after which an exception is thrown. Defaults to DEFAULT_MOVEMENT_TIMEOUT_SECONDS.
      • Type float
      • Default DEFAULT_MOVEMENT_TIMEOUT_SECONDS
  • Raises
    • Type ActuatorGroupException
      • Description If the request fails or the timeout occurs.

from machinelogic import (
    ActuatorGroup,
    ActuatorGroupException,
    Machine,
    MachineException,
)

machine = Machine()

try:
    # We are assuming here that Actuator #1 is in the MachineLogic configuration
    # We are also assuming that Actuator #1 is a Timing Belt
    actuator1 = machine.get_actuator("Actuator #1")
except MachineException as err:
    print(f"Failed to find actuator named Actuator #1. Reason: {str(err)}")
    raise SystemExit

try:
    # We are assuming here that Actuator #2 is in the MachineLogic configuration
    # We are also assuming that Actuator #2 is a Timing Belt
    actuator2 = machine.get_actuator("Actuator #2")
except MachineException as err:
    print(f"Failed to find actuator named Actuator #2. Reason: {str(err)}")
    raise SystemExit

# Adding the actuators into the group
actuator_group = ActuatorGroup(actuator1, actuator2)

try:
    # Move the actuator group to DESIRED_POSITION synchronously. This method will wait for motion to complete
    # before returning. If the actuator fails to arrive at DESIRED_POSITION within TIMEOUT_SECONDS,
    # then an ActuatorGroupException will be raised. If the move fails for any other reason,
    # then an ActuatorGroupException will be thrown.
    DESIRED_POSITION = 100.0  # Position in mm to move to
    TIMEOUT_SECONDS = 10.0  # Timeout within which the move must complete or else an exception will be thrown.
    actuator_group.move_absolute(
        ((DESIRED_POSITION, DESIRED_POSITION), TIMEOUT_SECONDS)
    )
except ActuatorGroupException as err:
    print(f"Request failed or timed out. Reason: {str(err)}")

• Description Moves absolute asynchronously to the tuple of positions.
  • Parameters
    • position
      • Description The positions to move to. Each value corresponds 1-to-1 with the actuators tuple provided to the constructor.
      • Type Tuple[float, …]
  • Raises
    • Type ActuatorGroupException
      • Description If the request fails.

from machinelogic import ActuatorGroup, ActuatorGroupException, Machine, MachineException

machine = Machine()

try:
    # We are assuming here that Actuator #1 is in the MachineLogic configuration
    # We are also assuming that Actuator #1 is a Timing Belt
    actuator1 = machine.get_actuator("Actuator #1")
except MachineException as err:
    print(f"Failed to find actuator named Actuator #1. Reason: {str(err)}")
    raise SystemExit

try:
    # We are assuming here that Actuator #2 is in the MachineLogic configuration
    # We are also assuming that Actuator #2 is a Timing Belt
    actuator2 = machine.get_actuator("Actuator #2")
except MachineException as err:
    print(f"Failed to find actuator named Actuator #2. Reason: {str(err)}")
    raise SystemExit

# Adding the actuators into the group
actuator_group = ActuatorGroup(actuator1, actuator2)

try:
    # Move the actuator group to DESIRED_POSITION asynchronously. This method will return immediately (it will
    # NOT wait for motion to complete). If the move fails for any reason, then an ActuatorGroupException will be thrown.
    DESIRED_POSITION = 100.0  # Position in mm to move to
    actuator_group.move_absolute_async((DESIRED_POSITION, DESIRED_POSITION))
except ActuatorGroupException as err:
    print(f"Request failed or timed out. Reason: {str(err)}")

• Description Moves relative synchronously by the tuple of distances.
  • Parameters
    • distance
      • Description The distances to move each Actuator. Each value corresponds 1-to-1 with the actuators tuple provided to the constructor.
      • Type Tuple[float, …]
    • timeout
      • Description The timeout in seconds after which an exception is thrown. Defaults to DEFAULT_MOVEMENT_TIMEOUT_SECONDS.
      • Type float
      • Default DEFAULT_MOVEMENT_TIMEOUT_SECONDS
  • Raises
    • Type ActuatorGroupException
      • Description If the request fails or the timeout occurs

from machinelogic import (
    ActuatorGroup,
    ActuatorGroupException,
    Machine,
    MachineException,
)

machine = Machine()

try:
    # We are assuming here that Actuator #1 is in the MachineLogic configuration
    # We are also assuming that Actuator #1 is a Timing Belt
    actuator1 = machine.get_actuator("Actuator #1")
except MachineException as err:
    print(f"Failed to find actuator named Actuator #1. Reason: {str(err)}")
    raise SystemExit

try:
    # We are assuming here that Actuator #2 is in the MachineLogic configuration
    # We are also assuming that Actuator #2 is a Timing Belt
    actuator2 = machine.get_actuator("Actuator #2")
except MachineException as err:
    print(f"Failed to find actuator named Actuator #2. Reason: {str(err)}")
    raise SystemExit

# Adding the actuators into the group
actuator_group = ActuatorGroup(actuator1, actuator2)

try:
    # Move the actuator group relative by DISTANCE synchronously. This method will wait for motion to complete
    # before returning.
    # If the actuator fails to move within TIMEOUT_SECONDS, then an ActuatorGroupException will be raised.
    # If the move fails for any other reason, then an ActuatorGroupException will be thrown.
    DISTANCE = 100.0  # Distance to move by in mm
    TIMEOUT_SECONDS = 10.0  # Timeout within which the move must complete or else an exception will be thrown.

    actuator_group.move_relative((DISTANCE, DISTANCE), TIMEOUT_SECONDS)
except ActuatorGroupException as err:
    print(f"Request failed or timed out. Reason: {str(err)}")

• Description Moves relative asynchronously by the tuple of distances.
  • Parameters
    • distance
      • Description The distances to move each Actuator. Each value corresponds 1-to-1 with the actuators tuple provided to the constructor.
      • Type Tuple[float, …]
  • Raises
    • Type ActuatorGroupException
      • Description If the request fails.

from machinelogic import ActuatorGroup, ActuatorGroupException, Machine, MachineException

machine = Machine()

try:
    # We are assuming here that Actuator #1 is in the MachineLogic configuration
    # We are also assuming that Actuator #1 is a Timing Belt
    actuator1 = machine.get_actuator("Actuator #1")
except MachineException as err:
    print(f"Failed to find actuator named Actuator #1. Reason: {str(err)}")
    raise SystemExit

try:
    # We are assuming here that Actuator #2 is in the MachineLogic configuration
    # We are also assuming that Actuator #2 is a Timing Belt
    actuator2 = machine.get_actuator("Actuator #2")
except MachineException as err:
    print(f"Failed to find actuator named Actuator #2. Reason: {str(err)}")
    raise SystemExit

# Adding the actuators into the group
actuator_group = ActuatorGroup(actuator1, actuator2)

try:
    # Move the actuator group by DISTANCE asynchronously. This method will return immediately (it will
    # NOT wait for motion to complete). If the move fails for any reason, then an ActuatorGroupException will be thrown.
    DISTANCE = 100.0  # Distance to move by in mm
    actuator_group.move_relative_async((DISTANCE, DISTANCE))
except ActuatorGroupException as err:
    print(f"Request failed or timed out. Reason: {str(err)}")

• Description ActuatorGroupState: The state of the ActuatorGroup.

• Description Waits for motion to complete on all Actuators in the group.
  • Parameters
    • timeout
      • Description The timeout in seconds, after which an exception will be thrown.
      • Type float
  • Raises
    • Type ActuatorGroupException
      • Description If the request fails or the move did not complete in the allocated amount of time.

from machinelogic import ActuatorGroup, ActuatorGroupException, Machine, MachineException

machine = Machine()

try:
    # We are assuming here that Actuator #1 is in the MachineLogic configuration
    # We are also assuming that Actuator #1 is a Timing Belt
    actuator1 = machine.get_actuator("Actuator #1")
except MachineException as err:
    print(f"Failed to find actuator named Actuator #1. Reason: {str(err)}")
    raise SystemExit

try:
    # We are assuming here that Actuator #2 is in the MachineLogic configuration
    # We are also assuming that Actuator #2 is a Timing Belt
    actuator2 = machine.get_actuator("Actuator #2")
except MachineException as err:
    print(f"Failed to find actuator named Actuator #2. Reason: {str(err)}")
    raise SystemExit

# Adding the actuators into the group
actuator_group = ActuatorGroup(actuator1, actuator2)
TIMEOUT_SECONDS = 5.5

try:
    actuator_group.wait_for_move_completion(
        TIMEOUT_SECONDS
    )  # Wait for motion to complete on all actuators in the group in the provided time
       # In our example, after 5.5 seconds have elapsed, an ActuatorGroupException will be thrown
except ActuatorGroupException as err:
    print(
        f"Request failed or move did not complete in the allocated amount of time. Reason: {str(err)}"
    )

• Description InputConfiguration: The configuration of the Input.

• Description Determines if the Input is active based on its value and the configured active_high value.
  • Returns
    • Description True if the Input value matches the active_high configuration, False otherwise.
    • Type bool

from machinelogic import Machine, MachineException

machine = Machine()

try:
    # We are assuming here that New Input is in the MachineLogic configuration
    # We are also assuming that New Input is a PushButton
    input1 = machine.get_input("New Input")
except MachineException as err:
    print(f"Unable to find Input named 'New Input'. Reason={str(err)}")
    raise SystemExit

is_active = input1.is_active()  # Check if the input is active

• Description InputState: The state of the Input.

• Description bool: The current value of the Input. True means high, while False means low. This is different from active/inactive, which depends on the active_high configuration.

• Description bool: The value that needs to be set to consider the Input as active.

• Description int: The device number of the Input.

• Description str: The ip address of the Input.

• Description str: The name of the Input.

• Description int: The port number of the Input.

• Description str: The unique ID of the Input.

• Description OutputConfiguration: The configuration of the Output.

• Description OutputState: The state of the Output.

• Description Writes the value into the Output, with True being high and False being low.
  • Parameters
    • value
      • Description The value to write to the Output.
      • Type bool
  • Raises
    • Type OutputException
      • Description If we fail to write the value to the Output.

from machinelogic import Machine, MachineException, OutputException

machine = Machine()

try:
    # We are assuming here that New Output is in the MachineLogic configuration
    # We are also assuming that New Output is a Power Switch
    output1 = machine.get_output("New Output")
except MachineException as err:
    print(f"Unable to find Output named 'New Output'. Reason={str(err)}")
    raise SystemExit

# Manually change the Output to either True or False. You should prefer
# Output.trigger and Output.clear over Output.write
try:
    output1.write(True) # Write "true" to the Output
    output1.write(False) # Write "false" to the Output
except OutputException as err:
    print(f"Unable to write output. Reason={str(err)}")
    raise SystemExit

• Description bool: The current value of the Output. True means high, while False means low. This is different from active/inactive, which depends on the active_high configuration.

• Description bool: The value that needs to be set to consider the Output as active.

• Description int: The device number of the Output.

• Description str: The ip address of the Output.

• Description str: The name of the Output.

• Description int: The port number of the Output.

• Description str: The unique ID of the Output.