Skip to main content
Version: Development (main)

:::tip Experimental This documents unreleased main — not a released, committed API. See the API stability policy and use Stable instead. :::

Connection & Configuration

How a Gripper is configured, and the state of its connection.

Members​

Classes
structConnectionConfig

Connection parameters for a gripper: the serial link plus the Modbus addressing. More...

structSerialConfig

Serial link parameters, fixed at construction of a Serial implementation. More...

Enumerations
enum classConnectionState { ... }
Functions
constexpr std::string_viewtoString (ConnectionState state)
Variables
constexpr uint8_tkDefaultModbusSlaveAddress = 0x09

The gripper's factory-set Modbus slave address. More...

Enumerations​

ConnectionState​

enum class Robotiq::ConnectionState
strong
Enumeration values
Disconnectedreserved: the link is closed or lost
Connectingreserved: will be used for automatic reconnection
Operationalexchanges are succeeding; the process image is live
Faulted

The state of a Gripper's background exchange cycle; see Gripper::connectionState().

Functions​

toString()​

constexpr std::string_view Robotiq::toString(ConnectionStatestate
)
constexpr
Parameters
state

The gripper's connection state, from Gripper::connectionState().

Returns

A short name for state.

Variables​

kDefaultModbusSlaveAddress​

constexpr uint8_t Robotiq::kDefaultModbusSlaveAddress = 0x09
constexpr

The gripper's factory-set Modbus slave address.


Generated via doxygen2docusaurus 2.2.2 by Doxygen 1.9.8.