UnderAutomation
Any question?

[email protected]

Contact us
UnderAutomation
⌘Q

Common API

Types and members shared by every brand in UnderAutomation.Robotics.

  • One object, ten services
  • The same rules for every service
  • What to read next

This page describes the types and members of UnderAutomation.Robotics that are the same for every robot brand.

The ten services of RobotController, with one example call each.The ten services of RobotController, with one example call each.
The ten services of RobotController, with one example call each.

One object, ten services

The common API is one class, RobotController, of the namespace UnderAutomation.Robotics.Controllers. After Connect, each service is a property of the object, and a call is always robot.Service.Method().

ServiceWhat it does
InfoController identity and motion groups
StateOperating mode and servo power
ProgramList, start, stop and read the execution
DebugBreakpoints and step mode
VariableRead and write variables and registers
IoRead, write and simulate signals
AlarmRead and reset alarms
MotionRead the position and move the robot
FileList, transfer and delete files
PendantShow a message to the operator

The same rules for every service

  • A method that a brand does not have throws FeatureNotSupportedException. IsAvailable of the service returns false before the call. See Errors.
  • The page of each service has a Brand support table: the protocol that each method uses on each brand.
  • robot.Native gives the object of the brand SDK, on the same connections, for what the common API does not cover. See Connect to your robot.
  • robot.Routing tells which protocol each method uses on the connected controller. See Routing.

What to read next

  • How it works: the library in four diagrams.
  • Connect to your robot: the connection parameters of each brand.
  • How-to articles: one code per task, in C# and Python.