Common \(Python\)

This page describes the Python Common API.

RPC reference

This section describes the existing RPCs used in this API.

Class reference

This section describes the data classes used in this API.

Messages

Class	Description
Connection	Connection between a user and the robot
CountryCode	Country code
DeviceHandle	Reference to a specific device
Empty	Message used when no information needs to be exchanged between client application and robot, and vice versa
NotificationHandle	Reference to a specific notification topic
NotificationOptions	Specifies options associated to a notification
SafetyHandle	Reference to a specific safety
SafetyNotification	Notification about a single safety event
Timestamp	Timestamp based on Epoch (00:00:00 Thursday, January 1, 1970)
UARTConfiguration	UART configuration details
UARTDeviceIdentification	UART port id identification
UserProfileHandle	Reference to a user profile

Enumerators

Enumerator	Description
ArmState	Admissible robot arm states
CartesianReferenceFrame	Admissible Cartesian reference frame modes
CountryCodeIdentifier	Supported ISO3166 country identifiers
DeviceTypes	Admissible device types
NotificationType	Admissible notification types
Permission	Admissible permissions. Used as bitfields
SafetyStatusValue	Admissible safety statuses
UARTParity	Admissible UART parity mode
UARTSpeed	Admissible UART baudrates
UARTStopBits	Admissible UART stop bits
UARTWordLength	Admissible UART word lengths
Unit	Admissible units used throughout API methods