AUBO SDK  0.26.0
Loading...
Searching...
No Matches
arcs::common_interface::IoControl Class Reference

The IoControl class provides a series of interfaces for configuring and reading the robot's standard digital and analog IO, as well as setting output states. More...

#include <io_control.h>

Public Member Functions

 IoControl ()
 
virtual ~IoControl ()
 
int getStandardDigitalInputNum ()
 Get the number of standard digital inputs.
 
int getToolDigitalInputNum ()
 Get the number of tool digital IOs (including digital inputs and outputs).
 
int getConfigurableDigitalInputNum ()
 Get the number of configurable digital inputs.
 
int getStandardDigitalOutputNum ()
 Get the number of standard digital outputs.
 
int getToolDigitalOutputNum ()
 Get the number of tool digital IOs (including digital inputs and outputs).
 
int setToolIoInput (int index, bool input)
 Set the specified tool digital IO as input or output.
 
bool isToolIoInput (int index)
 Determine whether the specified tool digital IO is configured as input.
 
int getConfigurableDigitalOutputNum ()
 Get the number of configurable digital outputs.
 
int getStandardAnalogInputNum ()
 Get the number of standard analog inputs.
 
int getToolAnalogInputNum ()
 Get the number of tool analog inputs.
 
int getStandardAnalogOutputNum ()
 Get the number of standard analog outputs.
 
int getToolAnalogOutputNum ()
 Get the number of tool analog outputs.
 
int setDigitalInputActionDefault ()
 Set all digital input actions to no trigger.
 
int setStandardDigitalInputAction (int index, StandardInputAction action)
 Set the trigger action for standard digital input.
 
int setToolDigitalInputAction (int index, StandardInputAction action)
 Set the trigger action for tool digital input.
 
int setConfigurableDigitalInputAction (int index, StandardInputAction action)
 Set the trigger action for configurable digital input.
 
StandardInputAction getStandardDigitalInputAction (int index)
 Get the trigger action for standard digital input.
 
StandardInputAction getToolDigitalInputAction (int index)
 Get the trigger action for tool digital input.
 
StandardInputAction getConfigurableDigitalInputAction (int index)
 Get the trigger action for configurable digital input.
 
int setDigitalOutputRunstateDefault ()
 Set all digital output runstates to None.
 
int setStandardDigitalOutputRunstate (int index, StandardOutputRunState runstate)
 Set the runstate for standard digital output.
 
int setToolDigitalOutputRunstate (int index, StandardOutputRunState runstate)
 Set the runstate for tool digital output.
 
int setConfigurableDigitalOutputRunstate (int index, StandardOutputRunState runstate)
 Set the runstate for configurable digital output.
 
StandardOutputRunState getStandardDigitalOutputRunstate (int index)
 Get the runstate for standard digital output.
 
StandardOutputRunState getToolDigitalOutputRunstate (int index)
 Get the runstate for tool digital output.
 
StandardOutputRunState getConfigurableDigitalOutputRunstate (int index)
 Get the runstate for configurable digital output.
 
int setStandardAnalogOutputRunstate (int index, StandardOutputRunState runstate)
 Set the runstate for standard analog output.
 
int setToolAnalogOutputRunstate (int index, StandardOutputRunState runstate)
 Set the runstate for tool analog output.
 
StandardOutputRunState getStandardAnalogOutputRunstate (int index)
 Get the runstate for standard analog output.
 
StandardOutputRunState getToolAnalogOutputRunstate (int index)
 Get the runstate for tool analog output.
 
int setStandardAnalogInputDomain (int index, int domain)
 Set the range of standard analog input.
 
int setToolAnalogInputDomain (int index, int domain)
 Set the range of tool analog input.
 
int getStandardAnalogInputDomain (int index)
 Get the domain of standard analog input.
 
int getToolAnalogInputDomain (int index)
 Get the domain of tool analog input.
 
int setStandardAnalogOutputDomain (int index, int domain)
 Set the range of standard analog output.
 
int setToolAnalogOutputDomain (int index, int domain)
 Set the range of tool analog output.
 
int getStandardAnalogOutputDomain (int index)
 Get the domain of standard analog output.
 
int getToolAnalogOutputDomain (int index)
 Get the domain of tool analog output.
 
int setToolVoltageOutputDomain (int domain)
 Set the tool voltage output value (unit: V)
 
int getToolVoltageOutputDomain ()
 Get the tool voltage output value (unit: V)
 
int setStandardDigitalOutput (int index, bool value)
 Set the value of a standard digital output.
 
int setStandardDigitalOutputPulse (int index, bool value, double duration)
 Set digital output pulse.
 
int setToolDigitalOutput (int index, bool value)
 Set the value of tool digital output.
 
int setToolDigitalOutputPulse (int index, bool value, double duration)
 Set tool digital output pulse.
 
int setConfigurableDigitalOutput (int index, bool value)
 Set the value of configurable digital output.
 
int setConfigurableDigitalOutputPulse (int index, bool value, double duration)
 Set configurable digital output pulse.
 
int setStandardAnalogOutput (int index, double value)
 Set the value of standard analog output.
 
int setToolAnalogOutput (int index, double value)
 Set the value of tool analog output.
 
bool getStandardDigitalInput (int index)
 Get the value of a standard digital input.
 
uint32_t getStandardDigitalInputs ()
 Get all standard digital input values.
 
bool getToolDigitalInput (int index)
 Get the value of tool digital input.
 
uint32_t getToolDigitalInputs ()
 Get all tool digital input values.
 
bool getConfigurableDigitalInput (int index)
 Get the value of configurable digital input.
 
uint32_t getConfigurableDigitalInputs ()
 Get all configurable digital input values.
 
bool getStandardDigitalOutput (int index)
 Get the value of a standard digital output.
 
uint32_t getStandardDigitalOutputs ()
 Get all standard digital output values.
 
bool getToolDigitalOutput (int index)
 Get the value of tool digital output.
 
uint32_t getToolDigitalOutputs ()
 Get all tool digital output values.
 
bool getConfigurableDigitalOutput (int index)
 Get the value of configurable digital output.
 
uint32_t getConfigurableDigitalOutputs ()
 Get all configurable digital output values.
 
double getStandardAnalogInput (int index)
 Get the value of standard analog input.
 
double getToolAnalogInput (int index)
 Get the value of tool analog input.
 
double getStandardAnalogOutput (int index)
 Get the value of standard analog output.
 
double getToolAnalogOutput (int index)
 Get the value of tool analog output.
 
int getStaticLinkInputNum ()
 Get the number of static link inputs.
 
int getStaticLinkOutputNum ()
 Get the number of static link outputs.
 
uint32_t getStaticLinkInputs ()
 Get all static link input values.
 
uint32_t getStaticLinkOutputs ()
 Get all static link output values.
 
bool hasEncoderSensor ()
 Whether the robot is equipped with an encoder.
 
int setEncDecoderType (int type, int range_id)
 Set the decoding method of the integrated encoder.
 
int setEncTickCount (int tick)
 Set the tick count of the integrated encoder.
 
int getEncDecoderType ()
 Get the decoder type of the encoder.
 
int getEncTickCount ()
 Get the tick count
 
int unwindEncDeltaTickCount (int delta_count)
 Prevent counting errors when the count exceeds the range
 
bool getToolButtonStatus ()
 Get the status of the tool button.
 
uint32_t getHandleIoStatus ()
 Get the status of handle buttons.
 
int getHandleType ()
 Get the handle type.
 

Protected Attributes

void * d_
 

Detailed Description

The IoControl class provides a series of interfaces for configuring and reading the robot's standard digital and analog IO, as well as setting output states.

  1. Get the number of various IOs
  2. Configure IO input/output functions
  3. Configuration of configurable IOs
  4. Set and read the input/output range of analog IOs

Standard digital input/output: Standard IOs on the control cabinet IO panel
Tool digital input/output: Digital IOs exposed via the tool-end connector
Configurable input/output: Can be configured as safety IO or general digital IO

Definition at line 42 of file io_control.h.

Constructor & Destructor Documentation

◆ IoControl()

arcs::common_interface::IoControl::IoControl ( )

◆ ~IoControl()

virtual arcs::common_interface::IoControl::~IoControl ( )
virtual

Member Function Documentation

◆ getConfigurableDigitalInput()

bool arcs::common_interface::IoControl::getConfigurableDigitalInput ( int  index)

Get the value of configurable digital input.

Note
Can be used to get the value of safety IO.
Parameters
indexIndicates the IO pin, starting from 0. For example, 0 means the first pin.
Returns
Returns true for high level; false for low level.
Exceptions
arcs::common_interface::AuboException
Python function prototype
getConfigurableDigitalInput(self: pyaubo_sdk.IoControl, arg0: int) -> bool
Lua function prototype
getConfigurableDigitalInput(index: number) -> boolean
Lua example
status = getConfigurableDigitalInput(0)
JSON-RPC request example
{"jsonrpc":"2.0","method":"rob1.IoControl.getConfigurableDigitalInput","params":[0],"id":1}
JSON-RPC response example
{"id":1,"jsonrpc":"2.0","result":false}

◆ getConfigurableDigitalInputAction()

StandardInputAction arcs::common_interface::IoControl::getConfigurableDigitalInputAction ( int  index)

Get the trigger action for configurable digital input.

Parameters
indexIndicates the IO pin, starting from 0. For example, 0 means the first pin.
Returns
Returns the input trigger action.
Python function prototype
getConfigurableDigitalInputAction(self: pyaubo_sdk.IoControl, arg0: int) -> arcs::common_interface::StandardInputAction
Lua function prototype
getConfigurableDigitalInputAction(index: number) -> number
Lua example
num = getConfigurableDigitalInputAction(0)
JSON-RPC request example
{"jsonrpc":"2.0","method":"rob1.IoControl.getConfigurableDigitalInputAction","params":[0],"id":1}
JSON-RPC response example
{"id":1,"jsonrpc":"2.0","result":"Default"}

◆ getConfigurableDigitalInputNum()

int arcs::common_interface::IoControl::getConfigurableDigitalInputNum ( )

Get the number of configurable digital inputs.

Returns
Number of configurable digital inputs.
Exceptions
arcs::common_interface::AuboException
Python function prototype
getConfigurableDigitalInputNum(self: pyaubo_sdk.IoControl) -> int
Lua function prototype
getConfigurableDigitalInputNum() -> number
Lua example
num = getConfigurableDigitalInputNum()
JSON-RPC request example
{"jsonrpc":"2.0","method":"rob1.IoControl.getConfigurableDigitalInputNum","params":[],"id":1}
JSON-RPC response example
{"id":1,"jsonrpc":"2.0","result":16}

◆ getConfigurableDigitalInputs()

uint32_t arcs::common_interface::IoControl::getConfigurableDigitalInputs ( )

Get all configurable digital input values.

Note
Can be used to get the value of safety IO.
Returns
All configurable digital input values.
For example, if the return value is 2863267846, its binary representation is 10101010101010100000000000000110. The lower 16 bits represent the status of all input pins, the least significant bit indicates the input status of pin 0, the second least significant bit indicates pin 1, and so on.
1 means high level, 0 means low level.
Exceptions
arcs::common_interface::AuboException
Python function prototype
getConfigurableDigitalInputs(self: pyaubo_sdk.IoControl) -> int
Lua function prototype
getConfigurableDigitalInputs() -> number
Lua example
num = getConfigurableDigitalInputs()
JSON-RPC request example
{"jsonrpc":"2.0","method":"rob1.IoControl.getConfigurableDigitalInputs","params":[],"id":1}
JSON-RPC response example
{"id":1,"jsonrpc":"2.0","result":0}

◆ getConfigurableDigitalOutput()

bool arcs::common_interface::IoControl::getConfigurableDigitalOutput ( int  index)

Get the value of configurable digital output.

Note
Can be used to get the value of safety IO.
Parameters
indexIndicates the IO pin, starting from 0. For example, 0 means the first pin.
Returns
Returns true for high level; false for low level.
Exceptions
arcs::common_interface::AuboException
Python function prototype
getConfigurableDigitalOutput(self: pyaubo_sdk.IoControl, arg0: int) -> bool
Lua function prototype
getConfigurableDigitalOutput(index: number) -> boolean
Lua example
status = getConfigurableDigitalOutput(0)
JSON-RPC request example
{"jsonrpc":"2.0","method":"rob1.IoControl.getConfigurableDigitalOutput","params":[0],"id":1}
JSON-RPC response example
{"id":1,"jsonrpc":"2.0","result":true}

◆ getConfigurableDigitalOutputNum()

int arcs::common_interface::IoControl::getConfigurableDigitalOutputNum ( )

Get the number of configurable digital outputs.

Returns
Number of configurable digital outputs.
Exceptions
arcs::common_interface::AuboException
Python function prototype
getConfigurableDigitalOutputNum(self: pyaubo_sdk.IoControl) -> int
Lua function prototype
getConfigurableDigitalOutputNum() -> number
Lua example
num = getConfigurableDigitalOutputNum()
JSON-RPC request example
{"jsonrpc":"2.0","method":"rob1.IoControl.getConfigurableDigitalOutputNum","params":[],"id":1}
JSON-RPC response example
{"id":1,"jsonrpc":"2.0","result":16}

◆ getConfigurableDigitalOutputRunstate()

StandardOutputRunState arcs::common_interface::IoControl::getConfigurableDigitalOutputRunstate ( int  index)

Get the runstate for configurable digital output.

Parameters
indexIndicates the IO pin, starting from 0. For example, 0 means the first pin.
Returns
Output runstate selection
Exceptions
arcs::common_interface::AuboException
Python function prototype
getConfigurableDigitalOutputRunstate(self: pyaubo_sdk.IoControl, arg0: int) -> arcs::common_interface::StandardOutputRunState
Lua function prototype
getConfigurableDigitalOutputRunstate(index: number) -> number
Lua example
num = getConfigurableDigitalOutputRunstate(0)
JSON-RPC request example
{"jsonrpc":"2.0","method":"rob1.IoControl.getConfigurableDigitalOutputRunstate","params":[0],"id":1}
JSON-RPC response example
{"id":1,"jsonrpc":"2.0","result":"None"}

◆ getConfigurableDigitalOutputs()

uint32_t arcs::common_interface::IoControl::getConfigurableDigitalOutputs ( )

Get all configurable digital output values.

Note
Can be used to get the value of safety IO.
Returns
All configurable digital output values.
For example, if the return value is 2863267846, its binary representation is 10101010101010100000000000000110. The lower 16 bits represent the status of all output pins, the least significant bit indicates the output status of pin 0, the second least significant bit indicates pin 1, and so on.
1 means high level, 0 means low level.
Exceptions
arcs::common_interface::AuboException
Python function prototype
getConfigurableDigitalOutputs(self: pyaubo_sdk.IoControl) -> int
Lua function prototype
getConfigurableDigitalOutputs() -> number
Lua example
num = getConfigurableDigitalOutputs()
JSON-RPC request example
{"jsonrpc":"2.0","method":"rob1.IoControl.getConfigurableDigitalOutputs","params":[],"id":1}
JSON-RPC response example
{"id":1,"jsonrpc":"2.0","result":1}

◆ getEncDecoderType()

int arcs::common_interface::IoControl::getEncDecoderType ( )

Get the decoder type of the encoder.

Returns
Returns 0 on success; error code on failure. AUBO_NO_ACCESS AUBO_BUSY AUBO_BAD_STATE -AUBO_BAD_STATE
Exceptions
arcs::common_interface::AuboException
JSON-RPC request example
{"jsonrpc":"2.0","method":"rob1.IoControl.getEncDecoderType","params":[],"id":1}
JSON-RPC response example
{"id":1,"jsonrpc":"2.0","result":0}

◆ getEncTickCount()

int arcs::common_interface::IoControl::getEncTickCount ( )

Get the tick count

Returns
Returns 0 on success; error code on failure. AUBO_NO_ACCESS AUBO_BUSY AUBO_BAD_STATE -AUBO_BAD_STATE
Exceptions
arcs::common_interface::AuboException
JSON-RPC request example
{"jsonrpc":"2.0","method":"rob1.IoControl.getEncTickCount","params":[],"id":1}
JSON-RPC response example
{"id":1,"jsonrpc":"2.0","result":0}

◆ getHandleIoStatus()

uint32_t arcs::common_interface::IoControl::getHandleIoStatus ( )

Get the status of handle buttons.

Note
Get the status of handle buttons.
Returns
All handle button input values.
For example, if the return value is 2863267846, its binary representation is 10101010101010100000000000000110. The lower 16 bits represent the status of all input pins, the least significant bit indicates the input status of pin 0, the second least significant bit indicates pin 1, and so on.
1 means high level, 0 means low level.
Exceptions
arcs::common_interface::AuboException
Python function prototype
getHandleIoStatus(self: pyaubo_sdk.IoControl) -> int
Lua function prototype
getHandleIoStatus() -> number
Lua example
num = getHandleIoStatus()
JSON-RPC request example
{"jsonrpc":"2.0","method":"rob1.IoControl.getHandleIoStatus","params":[],"id":1}
JSON-RPC response example
{"id":1,"jsonrpc":"2.0","result":0}

◆ getHandleType()

int arcs::common_interface::IoControl::getHandleType ( )

Get the handle type.

Returns
type
Exceptions
arcs::common_interface::AuboException
Python function prototype
getHandleType() -> int
Lua function prototype
getHandleType() -> int
Lua example
int_num = getHandleType()
JSON-RPC request example
{"jsonrpc":"2.0","method":"rob1.IoControl.getHandleType","params":[],"id":1}
JSON-RPC response example
{"id":1,"jsonrpc":"2.0","result":0}

◆ getStandardAnalogInput()

double arcs::common_interface::IoControl::getStandardAnalogInput ( int  index)

Get the value of standard analog input.

Parameters
indexIndicates the IO pin, starting from 0. For example, 0 means the first pin.
Returns
Standard analog input value.
Exceptions
arcs::common_interface::AuboException
Python function prototype
getStandardAnalogInput(self: pyaubo_sdk.IoControl, arg0: int) -> float
Lua function prototype
getStandardAnalogInput(index: number) -> number
Lua example
getStandardAnalogInput(0)
JSON-RPC request example
{"jsonrpc":"2.0","method":"rob1.IoControl.getStandardAnalogInput","params":[0],"id":1}
JSON-RPC response example
{"id":1,"jsonrpc":"2.0","result":0.0}

◆ getStandardAnalogInputDomain()

int arcs::common_interface::IoControl::getStandardAnalogInputDomain ( int  index)

Get the domain of standard analog input.

Parameters
indexIndicates the IO pin, starting from 0. For example, 0 means the first pin.
Returns
Standard analog input domain
Exceptions
arcs::common_interface::AuboException
Python function prototype
getStandardAnalogInputDomain(self: pyaubo_sdk.IoControl, arg0: int) -> int
Lua function prototype
getStandardAnalogInputDomain(index: number) -> number
Lua example
num = getStandardAnalogInputDomain(0)
JSON-RPC request example
{"jsonrpc":"2.0","method":"rob1.IoControl.getStandardAnalogInputDomain","params":[0],"id":1}
JSON-RPC response example
{"id":1,"jsonrpc":"2.0","result":0}

◆ getStandardAnalogInputNum()

int arcs::common_interface::IoControl::getStandardAnalogInputNum ( )

Get the number of standard analog inputs.

Returns
Number of standard analog inputs.
Exceptions
arcs::common_interface::AuboException
Python function prototype
getStandardAnalogInputNum(self: pyaubo_sdk.IoControl) -> int
Lua function prototype
getStandardAnalogInputNum() -> number
Lua example
num = getStandardAnalogInputNum()
JSON-RPC request example
{"jsonrpc":"2.0","method":"rob1.IoControl.getStandardAnalogInputNum","params":[],"id":1}
JSON-RPC response example
{"id":1,"jsonrpc":"2.0","result":2}

◆ getStandardAnalogOutput()

double arcs::common_interface::IoControl::getStandardAnalogOutput ( int  index)

Get the value of standard analog output.

Parameters
indexIndicates the IO pin, starting from 0. For example, 0 means the first pin.
Returns
Standard analog output value.
Exceptions
arcs::common_interface::AuboException
Python function prototype
getStandardAnalogOutput(self: pyaubo_sdk.IoControl, arg0: int) -> float
Lua function prototype
getStandardAnalogOutput(index: number) -> number
Lua example
num = getStandardAnalogOutput(0)
JSON-RPC request example
{"jsonrpc":"2.0","method":"rob1.IoControl.getStandardAnalogOutput","params":[0],"id":1}
JSON-RPC response example
{"id":1,"jsonrpc":"2.0","result":0.0}

◆ getStandardAnalogOutputDomain()

int arcs::common_interface::IoControl::getStandardAnalogOutputDomain ( int  index)

Get the domain of standard analog output.

Parameters
indexIndicates the IO pin, starting from 0. For example, 0 means the first pin.
Returns
Standard analog output domain
Exceptions
arcs::common_interface::AuboException
Python function prototype
getStandardAnalogOutputDomain(self: pyaubo_sdk.IoControl, arg0: int) -> int
Lua function prototype
getStandardAnalogOutputDomain(index: number) -> number
Lua example
num = getStandardAnalogOutputDomain(0)
JSON-RPC request example
{"jsonrpc":"2.0","method":"rob1.IoControl.getStandardAnalogOutputDomain","params":[0],"id":1}
JSON-RPC response example
{"id":1,"jsonrpc":"2.0","result":0}

◆ getStandardAnalogOutputNum()

int arcs::common_interface::IoControl::getStandardAnalogOutputNum ( )

Get the number of standard analog outputs.

Returns
Number of standard analog outputs.
Exceptions
arcs::common_interface::AuboException
Python function prototype
getStandardAnalogOutputNum(self: pyaubo_sdk.IoControl) -> int
Lua function prototype
getStandardAnalogOutputNum() -> number
Lua example
num = getStandardAnalogOutputNum()
JSON-RPC request example
{"jsonrpc":"2.0","method":"rob1.IoControl.getStandardAnalogOutputNum","params":[],"id":1}
JSON-RPC response example
{"id":1,"jsonrpc":"2.0","result":2}

◆ getStandardAnalogOutputRunstate()

StandardOutputRunState arcs::common_interface::IoControl::getStandardAnalogOutputRunstate ( int  index)

Get the runstate for standard analog output.

Parameters
indexIndicates the IO pin, starting from 0. For example, 0 means the first pin.
Returns
Standard analog output runstate selection
Exceptions
arcs::common_interface::AuboException
Python function prototype
getStandardAnalogOutputRunstate(self: pyaubo_sdk.IoControl, arg0: int) -> arcs::common_interface::StandardOutputRunState
Lua function prototype
getStandardAnalogOutputRunstate(index: number) -> number
Lua example
num = getStandardAnalogOutputRunstate(0)
JSON-RPC request example
{"jsonrpc":"2.0","method":"rob1.IoControl.getStandardAnalogOutputRunstate","params":[0],"id":1}
JSON-RPC response example
{"id":1,"jsonrpc":"2.0","result":"None"}

◆ getStandardDigitalInput()

bool arcs::common_interface::IoControl::getStandardDigitalInput ( int  index)

Get the value of a standard digital input.

Parameters
indexIndicates the IO pin, starting from 0. For example, 0 means the first pin.
Returns
Returns true for high level; false for low level.
Exceptions
arcs::common_interface::AuboException
Python function prototype
getStandardDigitalInput(self: pyaubo_sdk.IoControl, arg0: int) -> bool
Lua function prototype
getStandardDigitalInput(index: number) -> boolean
Lua example
status = getStandardDigitalInput(0)
JSON-RPC request example
{"jsonrpc":"2.0","method":"rob1.IoControl.getStandardDigitalInput","params":[0],"id":1}
JSON-RPC response example
{"id":1,"jsonrpc":"2.0","result":false}

◆ getStandardDigitalInputAction()

StandardInputAction arcs::common_interface::IoControl::getStandardDigitalInputAction ( int  index)

Get the trigger action for standard digital input.

Parameters
indexIndicates the IO pin, starting from 0. For example, 0 means the first pin.
Returns
Standard digital input trigger action
Python function prototype
getStandardDigitalInputAction(self: pyaubo_sdk.IoControl, arg0: int) -> arcs::common_interface::StandardInputAction
Lua function prototype
getStandardDigitalInputAction(index: number) -> number
Lua example
num = getStandardDigitalInputAction(0)
JSON-RPC request example
{"jsonrpc":"2.0","method":"rob1.IoControl.getStandardDigitalInputAction","params":[0],"id":1}
JSON-RPC response example
{"id":1,"jsonrpc":"2.0","result":"Default"}

◆ getStandardDigitalInputNum()

int arcs::common_interface::IoControl::getStandardDigitalInputNum ( )

Get the number of standard digital inputs.

Returns
Number of standard digital inputs.
Exceptions
arcs::common_interface::AuboException
Python function prototype
getStandardDigitalInputNum(self: pyaubo_sdk.IoControl) -> int
Lua function prototype
getStandardDigitalInputNum() -> number
Lua example
num = getStandardDigitalInputNum()
JSON-RPC request example
{"jsonrpc":"2.0","method":"rob1.IoControl.getStandardDigitalInputNum","params":[],"id":1}
JSON-RPC response example
{"id":1,"jsonrpc":"2.0","result":16}

◆ getStandardDigitalInputs()

uint32_t arcs::common_interface::IoControl::getStandardDigitalInputs ( )

Get all standard digital input values.

Returns
All standard digital input values.
For example, if the return value is 2863267846, its binary representation is 10101010101010100000000000000110. The lower 16 bits represent the status of all standard digital inputs, the least significant bit indicates the input status of DI00, the second least significant bit indicates DI01, and so on.
1 means high level, 0 means low level.
Exceptions
arcs::common_interface::AuboException
Python function prototype
getStandardDigitalInputs(self: pyaubo_sdk.IoControl) -> int
Lua function prototype
getStandardDigitalInputs() -> number
Lua example
num = getStandardDigitalInputs()
JSON-RPC request example
{"jsonrpc":"2.0","method":"rob1.IoControl.getStandardDigitalInputs","params":[],"id":1}
JSON-RPC response example
{"id":1,"jsonrpc":"2.0","result":0}

◆ getStandardDigitalOutput()

bool arcs::common_interface::IoControl::getStandardDigitalOutput ( int  index)

Get the value of a standard digital output.

Parameters
indexIndicates the IO pin, starting from 0. For example, 0 means the first pin.
Returns
Returns true for high level; false for low level.
Exceptions
arcs::common_interface::AuboException
Python function prototype
getStandardDigitalOutput(self: pyaubo_sdk.IoControl, arg0: int) -> bool
Lua function prototype
getStandardDigitalOutput(index: number) -> boolean
Lua example
status = getStandardDigitalOutput(0)
JSON-RPC request example
{"jsonrpc":"2.0","method":"rob1.IoControl.getStandardDigitalOutput","params":[0],"id":1}
JSON-RPC response example
{"id":1,"jsonrpc":"2.0","result":true}

◆ getStandardDigitalOutputNum()

int arcs::common_interface::IoControl::getStandardDigitalOutputNum ( )

Get the number of standard digital outputs.

Returns
Number of standard digital outputs.
Exceptions
arcs::common_interface::AuboException
Python function prototype
getStandardDigitalOutputNum(self: pyaubo_sdk.IoControl) -> int
Lua function prototype
getStandardDigitalOutputNum() -> number
Lua example
num = getStandardDigitalOutputNum()
JSON-RPC request example
{"jsonrpc":"2.0","method":"rob1.IoControl.getStandardDigitalOutputNum","params":[],"id":1}
JSON-RPC response example
{"id":1,"jsonrpc":"2.0","result":8}

◆ getStandardDigitalOutputRunstate()

StandardOutputRunState arcs::common_interface::IoControl::getStandardDigitalOutputRunstate ( int  index)

Get the runstate for standard digital output.

Parameters
indexIndicates the IO pin, starting from 0. For example, 0 means the first pin.
Returns
Output runstate selection
Exceptions
arcs::common_interface::AuboException
Python function prototype
getStandardDigitalOutputRunstate(self: pyaubo_sdk.IoControl, arg0: int) -> arcs::common_interface::StandardOutputRunState
Lua function prototype
getStandardDigitalOutputRunstate(index: number) -> number
Lua example
num = getStandardDigitalOutputRunstate(0)
JSON-RPC request example
{"jsonrpc":"2.0","method":"rob1.IoControl.getStandardDigitalOutputRunstate","params":[0],"id":1}
JSON-RPC response example
{"id":1,"jsonrpc":"2.0","result":"None"}

◆ getStandardDigitalOutputs()

uint32_t arcs::common_interface::IoControl::getStandardDigitalOutputs ( )

Get all standard digital output values.

Returns
All standard digital output values.
For example, if the return value is 2863267846, its binary representation is 10101010101010100000000000000110. The lower 16 bits represent the status of all standard digital outputs, the least significant bit indicates the output status of DO00, the second least significant bit indicates DO01, and so on.
1 means high level, 0 means low level.
Exceptions
arcs::common_interface::AuboException
Python function prototype
getStandardDigitalOutputs(self: pyaubo_sdk.IoControl) -> int
Lua function prototype
getStandardDigitalOutputs() -> number
Lua example
num = getStandardDigitalOutputs()
JSON-RPC request example
{"jsonrpc":"2.0","method":"rob1.IoControl.getStandardDigitalOutputs","params":[],"id":1}
JSON-RPC response example
{"id":1,"jsonrpc":"2.0","result":69}

◆ getStaticLinkInputNum()

int arcs::common_interface::IoControl::getStaticLinkInputNum ( )

Get the number of static link inputs.

Returns
Number of static link inputs.
Exceptions
arcs::common_interface::AuboException
Python function prototype
getStaticLinkInputNum(self: pyaubo_sdk.IoControl) -> int
Lua function prototype
getStaticLinkInputNum() -> number
Lua example
num = getStaticLinkInputNum()
JSON-RPC request example
{"jsonrpc":"2.0","method":"rob1.IoControl.getStaticLinkInputNum","params":[],"id":1}
JSON-RPC response example
{"id":1,"jsonrpc":"2.0","result":8}

◆ getStaticLinkInputs()

uint32_t arcs::common_interface::IoControl::getStaticLinkInputs ( )

Get all static link input values.

Returns
All static link input values.
For example, if the return value is 2863267846, its binary representation is 10101010101010100000000000000110. The lower 16 bits represent the status of all static link inputs, the least significant bit indicates the input status of pin 0, the second least significant bit indicates pin 1, and so on.
1 means high level, 0 means low level.
Exceptions
arcs::common_interface::AuboException
Python function prototype
getStaticLinkInputs(self: pyaubo_sdk.IoControl) -> int
Lua function prototype
getStaticLinkInputs() -> number
Lua example
num = getStaticLinkInputs()
JSON-RPC request example
{"jsonrpc":"2.0","method":"rob1.IoControl.getStaticLinkInputs","params":[],"id":1}
JSON-RPC response example
{"id":1,"jsonrpc":"2.0","result":0}

◆ getStaticLinkOutputNum()

int arcs::common_interface::IoControl::getStaticLinkOutputNum ( )

Get the number of static link outputs.

Returns
Number of static link outputs.
Exceptions
arcs::common_interface::AuboException
Python function prototype
getStaticLinkOutputNum(self: pyaubo_sdk.IoControl) -> int
Lua function prototype
getStaticLinkOutputNum() -> number
Lua example
num = getStaticLinkOutputNum()
JSON-RPC request example
{"jsonrpc":"2.0","method":"rob1.IoControl.getStaticLinkOutputNum","params":[],"id":1}
JSON-RPC response example
{"id":1,"jsonrpc":"2.0","result":0}

◆ getStaticLinkOutputs()

uint32_t arcs::common_interface::IoControl::getStaticLinkOutputs ( )

Get all static link output values.

Returns
Returns all static link output values.
For example, if the return value is 2863267846, its binary representation is 10101010101010100000000000000110. The lower 16 bits represent the status of all static link outputs, the least significant bit indicates the output status of pin 0, the second least significant bit indicates pin 1, and so on.
1 means high level, 0 means low level.
Exceptions
arcs::common_interface::AuboException
Python function prototype
getStaticLinkOutputs(self: pyaubo_sdk.IoControl) -> int
Lua function prototype
getStaticLinkOutputs() -> number
Lua example
num = getStaticLinkOutputs()
JSON-RPC request example
{"jsonrpc":"2.0","method":"rob1.IoControl.getStaticLinkOutputs","params":[],"id":1}
JSON-RPC response example
{"id":1,"jsonrpc":"2.0","result":0}

◆ getToolAnalogInput()

double arcs::common_interface::IoControl::getToolAnalogInput ( int  index)

Get the value of tool analog input.

Parameters
indexIndicates the IO pin, starting from 0. For example, 0 means the first pin.
Returns
Tool analog input value.
Exceptions
arcs::common_interface::AuboException
Python function prototype
getToolAnalogInput(self: pyaubo_sdk.IoControl, arg0: int) -> float
Lua function prototype
getToolAnalogInput(index: number) -> number
Lua example
num = getToolAnalogInput(0)
JSON-RPC request example
{"jsonrpc":"2.0","method":"rob1.IoControl.getToolAnalogInput","params":[0],"id":1}
JSON-RPC response example
{"id":1,"jsonrpc":"2.0","result":0.0}

◆ getToolAnalogInputDomain()

int arcs::common_interface::IoControl::getToolAnalogInputDomain ( int  index)

Get the domain of tool analog input.

Parameters
indexIndicates the IO pin, starting from 0. For example, 0 means the first pin.
Returns
Tool analog input domain
Exceptions
arcs::common_interface::AuboException
Python function prototype
getToolAnalogInputDomain(self: pyaubo_sdk.IoControl, arg0: int) -> int
Lua function prototype
getToolAnalogInputDomain(index: number) -> number
Lua example
num = getToolAnalogInputDomain(0)
JSON-RPC request example
{"jsonrpc":"2.0","method":"rob1.IoControl.getToolAnalogInputDomain","params":[0],"id":1}
JSON-RPC response example
{"id":1,"jsonrpc":"2.0","result":10}

◆ getToolAnalogInputNum()

int arcs::common_interface::IoControl::getToolAnalogInputNum ( )

Get the number of tool analog inputs.

Returns
Number of tool analog inputs.
Exceptions
arcs::common_interface::AuboException
Python function prototype
getToolAnalogInputNum(self: pyaubo_sdk.IoControl) -> int
Lua function prototype
getToolAnalogInputNum() -> number
Lua example
num = getToolAnalogInputNum()
JSON-RPC request example
{"jsonrpc":"2.0","method":"rob1.IoControl.getToolAnalogInputNum","params":[],"id":1}
JSON-RPC response example
{"id":1,"jsonrpc":"2.0","result":2}

◆ getToolAnalogOutput()

double arcs::common_interface::IoControl::getToolAnalogOutput ( int  index)

Get the value of tool analog output.

Parameters
indexIndicates the IO pin, starting from 0. For example, 0 means the first pin.
Returns
Tool analog output value.
Exceptions
arcs::common_interface::AuboException
Python function prototype
getToolAnalogOutput(self: pyaubo_sdk.IoControl, arg0: int) -> float
Lua function prototype
getToolAnalogOutput(index: number) -> number
Lua example
num = getToolAnalogOutput(0)
JSON-RPC request example
{"jsonrpc":"2.0","method":"rob1.IoControl.getToolAnalogOutput","params":[0],"id":1}
JSON-RPC response example
{"id":1,"jsonrpc":"2.0","result":0.0}

◆ getToolAnalogOutputDomain()

int arcs::common_interface::IoControl::getToolAnalogOutputDomain ( int  index)

Get the domain of tool analog output.

Parameters
indexIndicates the IO pin, starting from 0. For example, 0 means the first pin.
Returns
Tool analog output domain
Exceptions
arcs::common_interface::AuboException
Python function prototype
getToolAnalogOutputDomain(self: pyaubo_sdk.IoControl, arg0: int) -> int
Lua function prototype
getToolAnalogOutputDomain(index: number) -> number
Lua example
num = getToolAnalogOutputDomain(0)
JSON-RPC request example
{"jsonrpc":"2.0","method":"rob1.IoControl.getToolAnalogOutputDomain","params":[0],"id":1}
JSON-RPC response example
{"id":1,"jsonrpc":"2.0","result":0}

◆ getToolAnalogOutputNum()

int arcs::common_interface::IoControl::getToolAnalogOutputNum ( )

Get the number of tool analog outputs.

Returns
Number of tool analog outputs.
Exceptions
arcs::common_interface::AuboException
Python function prototype
getToolAnalogOutputNum(self: pyaubo_sdk.IoControl) -> int
Lua function prototype
getToolAnalogOutputNum() -> number
Lua example
num = getToolAnalogOutputNum()
JSON-RPC request example
{"jsonrpc":"2.0","method":"rob1.IoControl.getToolAnalogOutputNum","params":[],"id":1}
JSON-RPC response example
{"id":1,"jsonrpc":"2.0","result":0}

◆ getToolAnalogOutputRunstate()

StandardOutputRunState arcs::common_interface::IoControl::getToolAnalogOutputRunstate ( int  index)

Get the runstate for tool analog output.

Parameters
indexIndicates the IO pin, starting from 0. For example, 0 means the first pin.
Returns
Tool analog output runstate selection
Exceptions
arcs::common_interface::AuboException
Python function prototype
getToolAnalogOutputRunstate(self: pyaubo_sdk.IoControl, arg0: int) -> arcs::common_interface::StandardOutputRunState
Lua function prototype
getToolAnalogOutputRunstate(index: number) -> number
Lua example
num = getToolAnalogOutputRunstate(0)
JSON-RPC request example
{"jsonrpc":"2.0","method":"rob1.IoControl.getToolAnalogOutputRunstate","params":[0],"id":1}
JSON-RPC response example
{"id":1,"jsonrpc":"2.0","result":"None"}

◆ getToolButtonStatus()

bool arcs::common_interface::IoControl::getToolButtonStatus ( )

Get the status of the tool button.

Returns
Returns true if pressed; otherwise false.
Exceptions
arcs::common_interface::AuboException
Python function prototype
getToolButtonStatus() -> bool
Lua function prototype
getToolButtonStatus() -> boolean
Lua example
status = getToolButtonStatus()
JSON-RPC request example
{"jsonrpc":"2.0","method":"rob1.IoControl.getToolButtonStatus","params":[],"id":1}
JSON-RPC response example
{"id":1,"jsonrpc":"2.0","result":false}

◆ getToolDigitalInput()

bool arcs::common_interface::IoControl::getToolDigitalInput ( int  index)

Get the value of tool digital input.

Parameters
indexIndicates the IO pin, starting from 0. For example, 0 means the first pin.
Returns
Returns true for high level; false for low level.
Exceptions
arcs::common_interface::AuboException
Python function prototype
getToolDigitalInput(self: pyaubo_sdk.IoControl, arg0: int) -> bool
Lua function prototype
getToolDigitalInput(index: number) -> boolean
Lua example
status = getToolDigitalInput(0)
JSON-RPC request example
{"jsonrpc":"2.0","method":"rob1.IoControl.getToolDigitalInput","params":[0],"id":1}
JSON-RPC response example
{"id":1,"jsonrpc":"2.0","result":false}

◆ getToolDigitalInputAction()

StandardInputAction arcs::common_interface::IoControl::getToolDigitalInputAction ( int  index)

Get the trigger action for tool digital input.

Parameters
indexIndicates the IO pin, starting from 0. For example, 0 means the first pin.
Returns
Tool digital input trigger action
Python function prototype
getToolDigitalInputAction(self: pyaubo_sdk.IoControl, arg0: int) -> arcs::common_interface::StandardInputAction
Lua function prototype
getToolDigitalInputAction(index: number) -> number
Lua example
getToolDigitalInputAction(0)
JSON-RPC request example
{"jsonrpc":"2.0","method":"rob1.IoControl.getToolDigitalInputAction","params":[0],"id":1}
JSON-RPC response example
{"id":1,"jsonrpc":"2.0","result":"Default"}

◆ getToolDigitalInputNum()

int arcs::common_interface::IoControl::getToolDigitalInputNum ( )

Get the number of tool digital IOs (including digital inputs and outputs).

Returns
Number of tool digital IOs (including digital inputs and outputs).
Exceptions
arcs::common_interface::AuboException
Python function prototype
getToolDigitalInputNum(self: pyaubo_sdk.IoControl) -> int
Lua function prototype
getToolDigitalInputNum() -> number
Lua example
num = getStandardDigitalInputNum()
JSON-RPC request example
{"jsonrpc":"2.0","method":"rob1.IoControl.getToolDigitalInputNum","params":[],"id":1}
JSON-RPC response example
{"id":1,"jsonrpc":"2.0","result":4}

◆ getToolDigitalInputs()

uint32_t arcs::common_interface::IoControl::getToolDigitalInputs ( )

Get all tool digital input values.

Returns
Returns all tool digital input values.
Exceptions
arcs::common_interface::AuboException
Python function prototype
getToolDigitalInputs(self: pyaubo_sdk.IoControl) -> int
Lua function prototype
getToolDigitalInputs() -> number
Lua example
num = getToolDigitalInputs()
JSON-RPC request example
{"jsonrpc":"2.0","method":"rob1.IoControl.getToolDigitalInputs","params":[],"id":1}
JSON-RPC response example
{"id":1,"jsonrpc":"2.0","result":0}

◆ getToolDigitalOutput()

bool arcs::common_interface::IoControl::getToolDigitalOutput ( int  index)

Get the value of tool digital output.

Parameters
indexIndicates the IO pin, starting from 0. For example, 0 means the first pin.
Returns
Returns true for high level; false for low level.
Exceptions
arcs::common_interface::AuboException
Python function prototype
getToolDigitalOutput(self: pyaubo_sdk.IoControl, arg0: int) -> bool
Lua function prototype
getToolDigitalOutput(index: number) -> boolean
Lua example
status = getToolDigitalOutput(0)
JSON-RPC request example
{"jsonrpc":"2.0","method":"rob1.IoControl.getToolDigitalOutput","params":[0],"id":1}
JSON-RPC response example
{"id":1,"jsonrpc":"2.0","result":false}

◆ getToolDigitalOutputNum()

int arcs::common_interface::IoControl::getToolDigitalOutputNum ( )

Get the number of tool digital IOs (including digital inputs and outputs).

Returns
Number of tool digital IOs (including digital inputs and outputs).
Exceptions
arcs::common_interface::AuboException
Python function prototype
getToolDigitalOutputNum(self: pyaubo_sdk.IoControl) -> int
Lua function prototype
getToolDigitalOutputNum() -> number
Lua example
num = getToolDigitalOutputNum()
JSON-RPC request example
{"jsonrpc":"2.0","method":"rob1.IoControl.getToolDigitalOutputNum","params":[],"id":1}
JSON-RPC response example
{"id":1,"jsonrpc":"2.0","result":4}

◆ getToolDigitalOutputRunstate()

StandardOutputRunState arcs::common_interface::IoControl::getToolDigitalOutputRunstate ( int  index)

Get the runstate for tool digital output.

Parameters
indexIndicates the IO pin, starting from 0. For example, 0 means the first pin.
Returns
Output runstate selection
Exceptions
arcs::common_interface::AuboException
Python function prototype
getToolDigitalOutputRunstate(self: pyaubo_sdk.IoControl, arg0: int) -> arcs::common_interface::StandardOutputRunState
Lua function prototype
getToolDigitalOutputRunstate(index: number) -> number
Lua example
num = getToolDigitalOutputRunstate(0)
JSON-RPC request example
{"jsonrpc":"2.0","method":"rob1.IoControl.getToolDigitalOutputRunstate","params":[0],"id":1}
JSON-RPC response example
{"id":1,"jsonrpc":"2.0","result":"None"}

◆ getToolDigitalOutputs()

uint32_t arcs::common_interface::IoControl::getToolDigitalOutputs ( )

Get all tool digital output values.

Returns
All tool digital output values.
Exceptions
arcs::common_interface::AuboException
Python function prototype
getToolDigitalOutputs(self: pyaubo_sdk.IoControl) -> int
Lua function prototype
getToolDigitalOutputs() -> number
Lua example
num = getToolDigitalOutputs()
JSON-RPC request example
{"jsonrpc":"2.0","method":"rob1.IoControl.getToolDigitalOutputs","params":[],"id":1}
JSON-RPC response example
{"id":1,"jsonrpc":"2.0","result":9}

◆ getToolVoltageOutputDomain()

int arcs::common_interface::IoControl::getToolVoltageOutputDomain ( )

Get the tool voltage output value (unit: V)

Returns
Tool voltage output value (unit: V)
Exceptions
arcs::common_interface::AuboException
Python function prototype
getToolVoltageOutputDomain(self: pyaubo_sdk.IoControl) -> int
Lua function prototype
getToolVoltageOutputDomain() -> number
Lua example
num = getToolVoltageOutputDomain()
JSON-RPC request example
{"jsonrpc":"2.0","method":"rob1.IoControl.getToolVoltageOutputDomain","params":[],"id":1}
JSON-RPC response example
{"id":1,"jsonrpc":"2.0","result":0}

◆ hasEncoderSensor()

bool arcs::common_interface::IoControl::hasEncoderSensor ( )

Whether the robot is equipped with an encoder.

The integrated encoder number is 0.

Returns
Returns true if the robot is equipped with an encoder, otherwise false.
Exceptions
arcs::common_interface::AuboException
JSON-RPC request example
{"jsonrpc":"2.0","method":"rob1.IoControl.hasEncoderSensor","params":[],"id":1}
JSON-RPC response example
{"id":1,"jsonrpc":"2.0","result":true}

◆ isToolIoInput()

bool arcs::common_interface::IoControl::isToolIoInput ( int  index)

Determine whether the specified tool digital IO is configured as input.

Parameters
indexIndicates the IO pin, starting from 0. For example, 0 means the first pin.
Returns
Returns true if the specified IO is input, otherwise false.
Exceptions
arcs::common_interface::AuboException
Python function prototype
isToolIoInput(self: pyaubo_sdk.IoControl, arg0: int) -> bool
Lua function prototype
isToolIoInput(index: number) -> boolean
Lua example
status = isToolIoInput(0)
JSON-RPC request example
{"jsonrpc":"2.0","method":"rob1.IoControl.isToolIoInput","params":[0],"id":1}
JSON-RPC response example
{"id":1,"jsonrpc":"2.0","result":true}

◆ setConfigurableDigitalInputAction()

int arcs::common_interface::IoControl::setConfigurableDigitalInputAction ( int  index,
StandardInputAction  action 
)

Set the trigger action for configurable digital input.

Parameters
indexIndicates the IO pin, starting from 0. For example, 0 means the first pin.
actionTrigger action
Returns
Returns 0 on success; error code on failure. AUBO_REQUEST_IGNORE AUBO_BUSY AUBO_BAD_STATE -AUBO_INVL_ARGUMENT -AUBO_BAD_STATE
Exceptions
arcs::common_interface::AuboException
Note
This function takes effect only when the safety input action of the configurable input is set to SafetyInputAction::Unassigned.
Python function prototype
setConfigurableDigitalInputAction(self: pyaubo_sdk.IoControl, arg0: int, arg1: arcs::common_interface::StandardInputAction) -> int
Lua function prototype
setConfigurableDigitalInputAction(index: number, action: number) -> nil
Lua example
setConfigurableDigitalInputAction(0,1)
JSON-RPC request example
{"jsonrpc":"2.0","method":"rob1.IoControl.setConfigurableDigitalInputAction","params":[0,"Handguide"],"id":1}
JSON-RPC response example
{"id":1,"jsonrpc":"2.0","result":0}

◆ setConfigurableDigitalOutput()

int arcs::common_interface::IoControl::setConfigurableDigitalOutput ( int  index,
bool  value 
)

Set the value of configurable digital output.

Parameters
indexIndicates the IO pin, starting from 0. For example, 0 means the first pin.
valueOutput value.
Returns
Returns 0 on success; error code on failure. AUBO_REQUEST_IGNORE AUBO_BUSY AUBO_BAD_STATE -AUBO_INVL_ARGUMENT -AUBO_BAD_STATE
Exceptions
arcs::common_interface::AuboException
Python function prototype
setConfigurableDigitalOutput(self: pyaubo_sdk.IoControl, arg0: int, arg1: bool) -> int
Lua function prototype
setConfigurableDigitalOutput(index: number, value: boolean) -> nil
Lua example
setConfigurableDigitalOutput(0,true)
JSON-RPC request example
{"jsonrpc":"2.0","method":"rob1.IoControl.setConfigurableDigitalOutput","params":[0,true],"id":1}
JSON-RPC response example
{"id":1,"jsonrpc":"2.0","result":0}

◆ setConfigurableDigitalOutputPulse()

int arcs::common_interface::IoControl::setConfigurableDigitalOutputPulse ( int  index,
bool  value,
double  duration 
)

Set configurable digital output pulse.

Parameters
index
value
duration
Returns
Returns 0 on success; error code on failure. AUBO_REQUEST_IGNORE AUBO_BUSY AUBO_BAD_STATE -AUBO_INVL_ARGUMENT -AUBO_BAD_STATE
Exceptions
arcs::common_interface::AuboException
Python function prototype
setConfigurableDigitalOutputPulse(self: pyaubo_sdk.IoControl, arg0: int, arg1: bool, arg2: float) -> int
Lua function prototype
setConfigurableDigitalOutputPulse(index: number, value: boolean, duration: number) -> nil
Lua example
setConfigurableDigitalOutputPulse(0,true,2.3)
JSON-RPC request example
{"jsonrpc":"2.0","method":"rob1.IoControl.setConfigurableDigitalOutputPulse","params":[0,true,0.5],"id":1}
JSON-RPC response example
{"id":1,"jsonrpc":"2.0","result":0}

◆ setConfigurableDigitalOutputRunstate()

int arcs::common_interface::IoControl::setConfigurableDigitalOutputRunstate ( int  index,
StandardOutputRunState  runstate 
)

Set the runstate for configurable digital output.

Parameters
indexIndicates the IO pin, starting from 0. For example, 0 means the first pin.
runstateOutput runstate selection
Returns
Returns 0 on success; error code on failure. AUBO_REQUEST_IGNORE AUBO_BUSY AUBO_BAD_STATE -AUBO_INVL_ARGUMENT -AUBO_BAD_STATE
Exceptions
arcs::common_interface::AuboException
Python function prototype
setConfigurableDigitalOutputRunstate(self: pyaubo_sdk.IoControl, arg0: int, arg1: arcs::common_interface::StandardOutputRunState) -> int
Lua function prototype
setConfigurableDigitalOutputRunstate(index: number, runstate: number) -> nil
Lua example
setConfigurableDigitalOutputRunstate(0,1)
JSON-RPC request example
{"jsonrpc":"2.0","method":"rob1.IoControl.setConfigurableDigitalOutputRunstate","params":[0,"None"],"id":1}
JSON-RPC response example
{"id":1,"jsonrpc":"2.0","result":0}

◆ setDigitalInputActionDefault()

int arcs::common_interface::IoControl::setDigitalInputActionDefault ( )

Set all digital input actions to no trigger.

Note
When the input action is set to no trigger, setting the digital input value to high will not trigger any robot action.
Returns
Returns 0 on success; error code on failure. AUBO_BUSY AUBO_BAD_STATE -AUBO_BAD_STATE
Exceptions
arcs::common_interface::AuboException
Python function prototype
setDigitalInputActionDefault(self: pyaubo_sdk.IoControl) -> int
Lua function prototype
setDigitalInputActionDefault() -> nil
Lua example
setDigitalInputActionDefault()
JSON-RPC request example
{"jsonrpc":"2.0","method":"rob1.IoControl.setDigitalInputActionDefault","params":[],"id":1}
JSON-RPC response example
{"id":1,"jsonrpc":"2.0","result":0}

◆ setDigitalOutputRunstateDefault()

int arcs::common_interface::IoControl::setDigitalOutputRunstateDefault ( )

Set all digital output runstates to None.

Note
When the output runstate is set to None (StandardOutputRunState::None), users can set the digital output value.
When the output runstate is set, users cannot set the digital output value, and the controller will set it automatically.
For example, when DO0's output runstate is set to indicate hand-guiding (StandardOutputRunState::Handguiding), the robot enters hand-guiding mode and DO0 will automatically become high. When the robot exits hand-guiding, DO0 will automatically become low.
Returns
Returns 0 on success; error code on failure. AUBO_BUSY AUBO_BAD_STATE -AUBO_BAD_STATE
Exceptions
arcs::common_interface::AuboException
Python function prototype
setDigitalOutputRunstateDefault(self: pyaubo_sdk.IoControl) -> int
Lua function prototype
setDigitalOutputRunstateDefault() -> nil
Lua example
setDigitalOutputRunstateDefault()
JSON-RPC request example
{"jsonrpc":"2.0","method":"rob1.IoControl.setDigitalOutputRunstateDefault","params":[],"id":1}
JSON-RPC response example
{"id":1,"jsonrpc":"2.0","result":0}

◆ setEncDecoderType()

int arcs::common_interface::IoControl::setEncDecoderType ( int  type,
int  range_id 
)

Set the decoding method of the integrated encoder.

Parameters
type0 - Disable encoder 1 - AB quadrature 2 - AB quadrature + Z 3 - AB differential quadrature 4 - AB differential quadrature + Z differential
range_id0 is a 32-bit signed encoder, range [-2147483648, 2147483647] 1 is an 8-bit unsigned encoder, range [0, 255] 2 is a 16-bit unsigned encoder, range [0, 65535] 3 is a 24-bit unsigned encoder, range [0, 16777215] 4 is a 32-bit unsigned encoder, range [0, 4294967295]
Returns
Returns 0 on success; error code on failure. AUBO_NO_ACCESS AUBO_BUSY AUBO_BAD_STATE -AUBO_INVL_ARGUMENT -AUBO_BAD_STATE
Exceptions
arcs::common_interface::AuboException

◆ setEncTickCount()

int arcs::common_interface::IoControl::setEncTickCount ( int  tick)

Set the tick count of the integrated encoder.

Parameters
tickTick count
Returns
Returns 0 on success; error code on failure. AUBO_NO_ACCESS AUBO_BUSY AUBO_BAD_STATE -AUBO_INVL_ARGUMENT -AUBO_BAD_STATE
Exceptions
arcs::common_interface::AuboException

◆ setStandardAnalogInputDomain()

int arcs::common_interface::IoControl::setStandardAnalogInputDomain ( int  index,
int  domain 
)

Set the range of standard analog input.

Parameters
indexIndicates the IO pin, starting from 0. For example, 0 means the first pin.
domainInput range
Returns
Returns 0 on success; error code on failure. AUBO_REQUEST_IGNORE AUBO_BUSY AUBO_BAD_STATE -AUBO_INVL_ARGUMENT -AUBO_BAD_STATE
Exceptions
arcs::common_interface::AuboException
Python function prototype
setStandardAnalogInputDomain(self: pyaubo_sdk.IoControl, arg0: int, arg1: int) -> int
Lua function prototype
setStandardAnalogInputDomain(index: number, domain: number) -> nil
Lua example
setStandardAnalogInputDomain(0,1)
JSON-RPC request example
{"jsonrpc":"2.0","method":"rob1.IoControl.setStandardAnalogInputDomain","params":[0,8],"id":1}
JSON-RPC response example
{"id":1,"jsonrpc":"2.0","result":0}

◆ setStandardAnalogOutput()

int arcs::common_interface::IoControl::setStandardAnalogOutput ( int  index,
double  value 
)

Set the value of standard analog output.

Parameters
indexIndicates the IO pin, starting from 0. For example, 0 means the first pin.
valueOutput value.
Returns
Returns 0 on success; error code on failure. AUBO_REQUEST_IGNORE AUBO_BUSY AUBO_BAD_STATE -AUBO_INVL_ARGUMENT -AUBO_BAD_STATE
Exceptions
arcs::common_interface::AuboException
Python function prototype
setStandardAnalogOutput(self: pyaubo_sdk.IoControl, arg0: int, arg1: float) -> int
Lua function prototype
setStandardAnalogOutput(index: number, value: number) -> nil
Lua example
setStandardAnalogOutput(0,5.4)

◆ setStandardAnalogOutputDomain()

int arcs::common_interface::IoControl::setStandardAnalogOutputDomain ( int  index,
int  domain 
)

Set the range of standard analog output.

Parameters
indexIndicates the IO pin, starting from 0. For example, 0 means the first pin.
domainOutput range
Returns
Returns 0 on success; error code on failure. AUBO_REQUEST_IGNORE AUBO_BUSY AUBO_BAD_STATE -AUBO_INVL_ARGUMENT -AUBO_BAD_STATE
Exceptions
arcs::common_interface::AuboException
Python function prototype
setStandardAnalogOutputDomain(self: pyaubo_sdk.IoControl, arg0: int, arg1: int) -> int
Lua function prototype
setStandardAnalogOutputDomain(index: number, domain: number) -> nil
Lua example
setStandardAnalogOutputDomain(0,1)
JSON-RPC request example
{"jsonrpc":"2.0","method":"rob1.IoControl.setStandardAnalogOutputDomain","params":[0,8],"id":1}
JSON-RPC response example
{"id":1,"jsonrpc":"2.0","result":0}

◆ setStandardAnalogOutputRunstate()

int arcs::common_interface::IoControl::setStandardAnalogOutputRunstate ( int  index,
StandardOutputRunState  runstate 
)

Set the runstate for standard analog output.

Note
When the output runstate is set to None (StandardOutputRunState::None), users can set the analog output value.
When the output runstate is set, users cannot set the analog output value, and the controller will set it automatically.
For example, when AO0's output runstate is set to indicate hand-guiding (StandardOutputRunState::Handguiding), the robot enters hand-guiding mode and AO0 will automatically become the maximum value. When the robot exits hand-guiding, AO0 will automatically become 0.
Parameters
indexIndicates the IO pin, starting from 0. For example, 0 means the first pin.
runstateOutput runstate selection
Returns
Returns 0 on success; error code on failure. AUBO_REQUEST_IGNORE AUBO_BUSY AUBO_BAD_STATE -AUBO_INVL_ARGUMENT -AUBO_BAD_STATE
Exceptions
arcs::common_interface::AuboException
Python function prototype
setStandardAnalogOutputRunstate(self: pyaubo_sdk.IoControl, arg0: int, arg1: arcs::common_interface::StandardOutputRunState) -> int
Lua function prototype
setStandardAnalogOutputRunstate(index: number, runstate: number) -> nil
Lua example
setStandardAnalogOutputRunstate(0,6)
JSON-RPC request example
{"jsonrpc":"2.0","method":"rob1.IoControl.setStandardAnalogOutputRunstate","params":[0,"None"],"id":1}
JSON-RPC response example
{"id":1,"jsonrpc":"2.0","result":0}

◆ setStandardDigitalInputAction()

int arcs::common_interface::IoControl::setStandardDigitalInputAction ( int  index,
StandardInputAction  action 
)

Set the trigger action for standard digital input.

Note
When the input is set to no trigger action (StandardInputAction::Default), setting the digital input value to high will not trigger any robot action.
When a trigger action is set, setting the digital input value to high will trigger the corresponding robot action.
For example, if DI0 is set to trigger Handguide (StandardInputAction::Handguide), setting DI0 to high will enable hand-guiding mode. Setting DI0 to low will exit hand-guiding mode.
Parameters
indexIndicates the IO pin, starting from 0. For example, 0 means the first pin.
actionTrigger action
Returns
Returns 0 on success; error code on failure. AUBO_REQUEST_IGNORE AUBO_BUSY AUBO_BAD_STATE -AUBO_INVL_ARGUMENT -AUBO_BAD_STATE
Exceptions
arcs::common_interface::AuboException
Python function prototype
setStandardDigitalInputAction(self: pyaubo_sdk.IoControl, arg0: int, arg1: arcs::common_interface::StandardInputAction) -> int
Lua function prototype
setStandardDigitalInputAction(index: number, action: number) -> nil
Lua example
setStandardDigitalInputAction(0,1)
JSON-RPC request example
{"jsonrpc":"2.0","method":"rob1.IoControl.setStandardDigitalInputAction","params":[0,"Handguide"],"id":1}
JSON-RPC response example
{"id":1,"jsonrpc":"2.0","result":0}

◆ setStandardDigitalOutput()

int arcs::common_interface::IoControl::setStandardDigitalOutput ( int  index,
bool  value 
)

Set the value of a standard digital output.

Parameters
indexIndicates the IO pin.
valueOutput value.
Returns
Returns 0 on success; error code on failure. AUBO_REQUEST_IGNORE AUBO_BUSY AUBO_BAD_STATE -AUBO_INVL_ARGUMENT -AUBO_BAD_STATE
Exceptions
arcs::common_interface::AuboException
Python function prototype
setStandardDigitalOutput(self: pyaubo_sdk.IoControl, arg0: int, arg1: bool) -> int
Lua function prototype
setStandardDigitalOutput(index: number, value: boolean) -> nil
Lua example
setStandardDigitalOutput(0,true)
JSON-RPC request example
{"jsonrpc":"2.0","method":"rob1.IoControl.setStandardDigitalOutput","params":[0,true],"id":1}
JSON-RPC response example
{"id":1,"jsonrpc":"2.0","result":0}

◆ setStandardDigitalOutputPulse()

int arcs::common_interface::IoControl::setStandardDigitalOutputPulse ( int  index,
bool  value,
double  duration 
)

Set digital output pulse.

Parameters
index
value
duration
Returns
Returns 0 on success; error code on failure. AUBO_REQUEST_IGNORE AUBO_BUSY AUBO_BAD_STATE -AUBO_INVL_ARGUMENT -AUBO_BAD_STATE
Exceptions
arcs::common_interface::AuboException
Python function prototype
setStandardDigitalOutputPulse(self: pyaubo_sdk.IoControl, arg0: int, arg1: bool, arg2: float) -> int
Lua function prototype
setStandardDigitalOutputPulse(index: number, value: boolean, duration: number) -> nil
Lua example
setStandardDigitalOutputPulse(0,true,2.5)
JSON-RPC request example
{"jsonrpc":"2.0","method":"rob1.IoControl.setStandardDigitalOutputPulse","params":[0,true,0.5],"id":1}
JSON-RPC response example
{"id":1,"jsonrpc":"2.0","result":0}

◆ setStandardDigitalOutputRunstate()

int arcs::common_interface::IoControl::setStandardDigitalOutputRunstate ( int  index,
StandardOutputRunState  runstate 
)

Set the runstate for standard digital output.

Note
When the output runstate is set to None (StandardOutputRunState::None), users can set the digital output value.
When the output runstate is set, users cannot set the digital output value, and the controller will set it automatically.
For example, when DO0's output runstate is set to indicate hand-guiding (StandardOutputRunState::Handguiding), the robot enters hand-guiding mode and DO0 will automatically become high. When the robot exits hand-guiding, DO0 will automatically become low.
Parameters
indexIndicates the IO pin, starting from 0. For example, 0 means the first pin.
runstateOutput runstate selection
Returns
Returns 0 on success; error code on failure. AUBO_REQUEST_IGNORE AUBO_BUSY AUBO_BAD_STATE -AUBO_INVL_ARGUMENT -AUBO_BAD_STATE
Exceptions
arcs::common_interface::AuboException
Python function prototype
setStandardDigitalOutputRunstate(self: pyaubo_sdk.IoControl, arg0: int, arg1: arcs::common_interface::StandardOutputRunState) -> int
Lua function prototype
setStandardDigitalOutputRunstate(index: number, runstate: number) -> nil
Lua example
setStandardDigitalOutputRunstate(0,1)
JSON-RPC request example
{"jsonrpc":"2.0","method":"rob1.IoControl.setStandardDigitalOutputRunstate","params":[0,"PowerOn"],"id":1}
JSON-RPC response example
{"id":1,"jsonrpc":"2.0","result":0}

◆ setToolAnalogInputDomain()

int arcs::common_interface::IoControl::setToolAnalogInputDomain ( int  index,
int  domain 
)

Set the range of tool analog input.

Parameters
indexIndicates the IO pin, starting from 0. For example, 0 means the first pin.
domainInput range
Returns
Returns 0 on success; error code on failure. AUBO_REQUEST_IGNORE AUBO_BUSY AUBO_BAD_STATE -AUBO_INVL_ARGUMENT -AUBO_BAD_STATE
Exceptions
arcs::common_interface::AuboException
Python function prototype
setToolAnalogInputDomain(self: pyaubo_sdk.IoControl, arg0: int, arg1: int) -> int
Lua function prototype
setToolAnalogInputDomain(index: number, domain: number) -> nil
Lua example
setToolAnalogInputDomain(0,1)
JSON-RPC request example
{"jsonrpc":"2.0","method":"rob1.IoControl.setToolAnalogInputDomain","params":[0,8],"id":1}
JSON-RPC response example
{"id":1,"jsonrpc":"2.0","result":0}

◆ setToolAnalogOutput()

int arcs::common_interface::IoControl::setToolAnalogOutput ( int  index,
double  value 
)

Set the value of tool analog output.

Parameters
indexIndicates the IO pin, starting from 0. For example, 0 means the first pin.
valueOutput value.
Returns
Returns 0 on success; error code on failure. AUBO_REQUEST_IGNORE AUBO_BUSY AUBO_BAD_STATE -AUBO_INVL_ARGUMENT -AUBO_BAD_STATE
Exceptions
arcs::common_interface::AuboException
Python function prototype
setToolAnalogOutput(self: pyaubo_sdk.IoControl, arg0: int, arg1: float) -> int
Lua function prototype
setToolAnalogOutput(index: number, value: number) -> nil
Lua example
setToolAnalogOutput(0,1.2)
JSON-RPC request example
{"jsonrpc":"2.0","method":"rob1.IoControl.setToolAnalogOutput","params":[0,0.5],"id":1}
JSON-RPC response example
{"id":1,"jsonrpc":"2.0","result":13}

◆ setToolAnalogOutputDomain()

int arcs::common_interface::IoControl::setToolAnalogOutputDomain ( int  index,
int  domain 
)

Set the range of tool analog output.

Parameters
indexIndicates the IO pin, starting from 0. For example, 0 means the first pin.
domainOutput range
Returns
Returns 0 on success; error code on failure. AUBO_REQUEST_IGNORE AUBO_BUSY AUBO_BAD_STATE -AUBO_INVL_ARGUMENT -AUBO_BAD_STATE
Exceptions
arcs::common_interface::AuboException
Python function prototype
setToolAnalogOutputDomain(self: pyaubo_sdk.IoControl, arg0: int, arg1: int) -> int
Lua function prototype
setToolAnalogOutputDomain(index: number, domain: number) -> nil
Lua example
setToolAnalogOutputDomain(0,1)

◆ setToolAnalogOutputRunstate()

int arcs::common_interface::IoControl::setToolAnalogOutputRunstate ( int  index,
StandardOutputRunState  runstate 
)

Set the runstate for tool analog output.

Parameters
indexIndicates the IO pin, starting from 0. For example, 0 means the first pin.
runstateOutput runstate selection
Returns
Returns 0 on success; error code on failure. AUBO_REQUEST_IGNORE AUBO_BUSY AUBO_BAD_STATE -AUBO_INVL_ARGUMENT -AUBO_BAD_STATE
Exceptions
arcs::common_interface::AuboException
Python function prototype
setToolAnalogOutputRunstate(self: pyaubo_sdk.IoControl, arg0: int, arg1: arcs::common_interface::StandardOutputRunState) -> int
Lua function prototype
setToolAnalogOutputRunstate(index: number, runstate: number) -> nil
Lua example
setToolAnalogOutputRunstate(0,1)
JSON-RPC request example
{"jsonrpc":"2.0","method":"rob1.IoControl.setToolAnalogOutputRunstate","params":[0,"None"],"id":1}
JSON-RPC response example
{"id":1,"jsonrpc":"2.0","result":0}

◆ setToolDigitalInputAction()

int arcs::common_interface::IoControl::setToolDigitalInputAction ( int  index,
StandardInputAction  action 
)

Set the trigger action for tool digital input.

Note
When the input is set to no trigger action (StandardInputAction::Default), setting the tool digital input value to high will not trigger any robot action.
When a trigger action is set, setting the tool digital input value to high will trigger the corresponding robot action.
For example, if TOOL_IO[0] is set as input and its trigger action is Handguide (StandardInputAction::Handguide), setting TOOL_IO[0] to high will enable hand-guiding mode. Setting TOOL_IO[0] to low will exit hand-guiding mode.
Parameters
indexIndicates the IO pin, starting from 0. For example, 0 means the first pin.
actionTrigger action
Returns
Returns 0 on success; error code on failure. AUBO_REQUEST_IGNORE AUBO_BUSY AUBO_BAD_STATE -AUBO_INVL_ARGUMENT -AUBO_BAD_STATE
Exceptions
arcs::common_interface::AuboException
Python function prototype
setToolDigitalInputAction(self: pyaubo_sdk.IoControl, arg0: int, arg1: arcs::common_interface::StandardInputAction) -> int
Lua function prototype
setToolDigitalInputAction(index: number, action: number) -> nil
Lua example
setToolDigitalInputAction(0,1)
JSON-RPC request example
{"jsonrpc":"2.0","method":"rob1.IoControl.setToolDigitalInputAction","params":[0,"Handguide"],"id":1}
JSON-RPC response example
{"id":1,"jsonrpc":"2.0","result":0}

◆ setToolDigitalOutput()

int arcs::common_interface::IoControl::setToolDigitalOutput ( int  index,
bool  value 
)

Set the value of tool digital output.

Parameters
indexIndicates the IO pin, starting from 0. For example, 0 means the first pin.
valueOutput value.
Returns
Returns 0 on success; error code on failure. AUBO_REQUEST_IGNORE AUBO_BUSY AUBO_BAD_STATE -AUBO_INVL_ARGUMENT -AUBO_BAD_STATE
Exceptions
arcs::common_interface::AuboException
Python function prototype
setToolDigitalOutput(self: pyaubo_sdk.IoControl, arg0: int, arg1: bool) -> int
Lua function prototype
setToolDigitalOutput(index: number, value: boolean) -> nil
Lua example
setToolDigitalOutput(0,true)
JSON-RPC request example
{"jsonrpc":"2.0","method":"rob1.IoControl.setToolDigitalOutput","params":[0,true],"id":1}
JSON-RPC response example
{"id":1,"jsonrpc":"2.0","result":0}

◆ setToolDigitalOutputPulse()

int arcs::common_interface::IoControl::setToolDigitalOutputPulse ( int  index,
bool  value,
double  duration 
)

Set tool digital output pulse.

Parameters
index
value
duration
Returns
Returns 0 on success; error code on failure. AUBO_REQUEST_IGNORE AUBO_BUSY AUBO_BAD_STATE -AUBO_INVL_ARGUMENT -AUBO_BAD_STATE
Exceptions
arcs::common_interface::AuboException
Python function prototype
setToolDigitalOutputPulse(self: pyaubo_sdk.IoControl, arg0: int, arg1: bool, arg2: float) -> int
Lua function prototype
setToolDigitalOutputPulse(index: number, value: boolean, duration: number) -> nil
Lua example
setToolDigitalOutputPulse(0,true,2)
JSON-RPC request example
{"jsonrpc":"2.0","method":"rob1.IoControl.setToolDigitalOutputPulse","params":[0,true,0.5],"id":1}
JSON-RPC response example
{"id":1,"jsonrpc":"2.0","result":0}

◆ setToolDigitalOutputRunstate()

int arcs::common_interface::IoControl::setToolDigitalOutputRunstate ( int  index,
StandardOutputRunState  runstate 
)

Set the runstate for tool digital output.

Note
When the output runstate is set to None (StandardOutputRunState::None), users can set the digital output value.
When the output runstate is set, users cannot set the digital output value, and the controller will set it automatically.
For example, when TOOL_IO[0] is set as output and its runstate is set to indicate hand-guiding (StandardOutputRunState::Handguiding), the robot enters hand-guiding mode and TOOL_IO[0] will automatically become high. When the robot exits hand-guiding, TOOL_IO[0] will automatically become low.
Parameters
indexIndicates the IO pin, starting from 0. For example, 0 means the first pin.
runstateOutput runstate selection
Returns
Returns 0 on success; error code on failure. AUBO_REQUEST_IGNORE AUBO_BUSY AUBO_BAD_STATE -AUBO_INVL_ARGUMENT -AUBO_BAD_STATE
Exceptions
arcs::common_interface::AuboException
Python function prototype
setToolDigitalOutputRunstate(self: pyaubo_sdk.IoControl, arg0: int, arg1: arcs::common_interface::StandardOutputRunState) -> int
Lua function prototype
setToolDigitalOutputRunstate(index: number, runstate: number) -> nil
Lua example
setToolDigitalOutputRunstate(0,1)
JSON-RPC request example
{"jsonrpc":"2.0","method":"rob1.IoControl.setToolDigitalOutputRunstate","params":[0,"None"],"id":1}
JSON-RPC response example
{"id":1,"jsonrpc":"2.0","result":0}

◆ setToolIoInput()

int arcs::common_interface::IoControl::setToolIoInput ( int  index,
bool  input 
)

Set the specified tool digital IO as input or output.

Tool digital IOs are special and can be configured as input or output.

Parameters
indexIndicates the IO pin, starting from 0. For example, 0 means the first pin.
inputIndicates whether the specified IO is input. If input is true, set the IO as input; otherwise, set as output.
Returns
Returns 0 on success; error code on failure. AUBO_BUSY AUBO_BAD_STATE -AUBO_INVL_ARGUMENT -AUBO_BAD_STATE
Exceptions
arcs::common_interface::AuboException
Python function prototype
setToolIoInput(self: pyaubo_sdk.IoControl, arg0: int, arg1: bool) -> int
Lua function prototype
setToolIoInput(index: number, input: boolean) -> nil
Lua example
setToolIoInput(0,true)
JSON-RPC request example
{"jsonrpc":"2.0","method":"rob1.IoControl.setToolIoInput","params":[0,true],"id":1}
JSON-RPC response example
{"id":1,"jsonrpc":"2.0","result":0}

◆ setToolVoltageOutputDomain()

int arcs::common_interface::IoControl::setToolVoltageOutputDomain ( int  domain)

Set the tool voltage output value (unit: V)

Parameters
domainTool voltage output value, can be 0, 12, or 24.
0 means 0V, 12 means 12V, 24 means 24V.
Returns
Returns 0 on success; error code on failure. AUBO_REQUEST_IGNORE AUBO_BUSY AUBO_BAD_STATE -AUBO_INVL_ARGUMENT -AUBO_BAD_STATE
Exceptions
arcs::common_interface::AuboException
Python function prototype
setToolVoltageOutputDomain(self: pyaubo_sdk.IoControl, arg0: int) -> int
Lua function prototype
setToolVoltageOutputDomain(domain: number) -> nil
Lua example
setToolVoltageOutputDomain(24)
JSON-RPC request example
{"jsonrpc":"2.0","method":"rob1.IoControl.setToolVoltageOutputDomain","params":[24],"id":1}
JSON-RPC response example
{"id":1,"jsonrpc":"2.0","result":0}

◆ unwindEncDeltaTickCount()

int arcs::common_interface::IoControl::unwindEncDeltaTickCount ( int  delta_count)

Prevent counting errors when the count exceeds the range

Parameters
delta_count
Returns
Returns 0 on success; error code on failure. AUBO_NO_ACCESS AUBO_BUSY AUBO_BAD_STATE -AUBO_BAD_STATE
Exceptions
arcs::common_interface::AuboException

Member Data Documentation

◆ d_

void* arcs::common_interface::IoControl::d_
protected

Definition at line 4561 of file io_control.h.


The documentation for this class was generated from the following file: