CreOS SDK
The CreOS SDK allows you to interact with Avular robots
 
Loading...
Searching...
No Matches
creos_messages Namespace Reference

The messages that are used in the communication between the agent and the client. More...

Namespaces

namespace  enter_low_power_mode
 The messages that are used in the communication between the agent and the client.
 

Classes

struct  Accel
 The Accel message contains the linear and angular acceleration of the robot. More...
 
struct  AccelStamped
 The AccelStamped message contains the linear and angular acceleration of the robot with a timestamp. More...
 
struct  AccelWithCovariance
 The AccelWithCovariance message contains the linear and angular acceleration of the robot with a covariance matrix. More...
 
struct  AccelWithCovarianceStamped
 The AccelWithCovarianceStamped message contains the linear and angular acceleration of the robot with a covariance matrix and a timestamp. More...
 
struct  Barometer
 Barometer message containing the pressure and temperature. More...
 
struct  BatteryStatus
 BatteryStatus message contains the current battery state. More...
 
struct  CallableInfo
 SDK information message containing information about the callable functions. More...
 
struct  Command
 Command message containing the command to send to the robot. More...
 
struct  CommandStamped
 Command message containing the command to send to the robot, with a timestamp. More...
 
struct  ComponentVersion
 A component with its version. More...
 
struct  ControllerState
 Remote control message containing the remote controller state. More...
 
struct  DataSourceSinkInfo
 SDK information message containing information about the data sources and sinks. More...
 
struct  Error
 Error message to communicate that contains an error code and a message. More...
 
struct  Gnss
 The GNSS message contains the GNSS data of the robot. More...
 
struct  GnssCoordinate
 A coordinate in the GNSS system. More...
 
struct  GnssHeading
 The heading of the GNSS sensor. More...
 
struct  GnssPosition
 The GNSS message contains the GNSS data of the robot. More...
 
struct  Imu
 IMU message containing the orientation, angular velocity and linear acceleration. More...
 
struct  InterfaceGroupInfo
 SDK information message containing information about an interface group. More...
 
struct  InterfaceInfo
 SDK information message containing information about the entire interface. More...
 
struct  MagneticField
 Magnetic field message containing the magnetic field strength. More...
 
class  Matrix
 Matrix template for a 2D array of type T. More...
 
struct  Odometry
 The Odometry message contains the estimated position, orientation and velocity of the robot. More...
 
struct  Point
 Point message containing a x, y and z of type double. More...
 
struct  PointCloud2
 The PointCloud2 message contains a 3D point cloud. More...
 
struct  PointCloud2FieldDescription
 The PointCloud2FieldDescription message describes a single field of the point cloud. More...
 
struct  Pose
 The Pose message contains a position and orientation. More...
 
struct  PoseStamped
 The PoseStamped message contains a position and orientation with a timestamp. More...
 
struct  PoseWithCovariance
 The PoseWithCovariance message contains a position and orientation with a covariance matrix. More...
 
struct  PoseWithCovarianceStamped
 The PoseWithCovarianceStamped message contains a position and orientation with a covariance matrix and a timestamp. More...
 
struct  Quaterniond
 Quaternion message containing the x, y, z and w components as doubles. More...
 
struct  Quaternionf
 Quaternion message containing the x, y, z and w components as floats. More...
 
struct  Range
 Range message containing the range measurement of a sensor. More...
 
struct  State
 The state of the robot. More...
 
struct  StateReference
 State reference message containing the pose, velocity and acceleration of the robot. More...
 
struct  SystemInfo
 System info message containing information about the connected system. More...
 
struct  Transform
 The Transform message contains a transformation between two coordinate frames. More...
 
struct  TransformStamped
 The TransformStamped message contains a transformation between two coordinate frames with a timestamp. More...
 
struct  TransformStampedList
 The TransformStampedList message contains a list of transformations between two coordinate frames. More...
 
struct  Twist
 The Twist message contains the linear and angular velocity of the robot. More...
 
struct  TwistStamped
 The TwistStamped message contains the linear and angular velocity of the robot with a timestamp. More...
 
struct  TwistWithCovariance
 The TwistWithCovariance message contains the linear and angular velocity of the robot with a covariance matrix. More...
 
struct  TwistWithCovarianceStamped
 The TwistWithCovarianceStamped message contains the linear and angular velocity of the robot with a covariance matrix and a timestamp. More...
 
struct  UserEvent
 An event meant for a robot user. More...
 
struct  Vector3d
 Vector3d message containing a x, y and z of type double. More...
 
struct  Vector3f
 Vector3f message containing a x, y and z of type float. More...
 
struct  WheelState
 Wheel state message containing the position and velocity of one wheel. More...
 
struct  WheelStates
 Wheel state message containing the position and velocity of the wheels. More...
 

Typedefs

template<std::size_t n_rows, std::size_t n_cols>
using Matrixd = Matrix<double, n_rows, n_cols>
 Matrix template for a 2D array of doubles.
 
template<std::size_t n_rows, std::size_t n_cols>
using Matrixf = Matrix<float, n_rows, n_cols>
 Matrix template for a 2D array of floats.
 

Enumerations

enum class  ControlSource { kDisabled , kManual , kAutonomous , kUser }
 Control source message containing the control source of the robot. More...
 
enum class  ErrorCode {
  kUnknown = 0 , kSuccess = 1 , kTimeout = 2 , kTransportError = 3 ,
  kInvalidRequest = 4 , kNotExecuted = 5
}
 Error codes that indicate what went wrong. More...
 
enum class  ImuId { kBody }
 IMU sensor id. More...
 
enum class  MagneticFieldId { kBody }
 The MagneticFieldId enum contains the different magnetic field sensors that can be used. More...
 
enum class  Lidar3dId { kFront }
 The Lidar3dId enum class contains the different lidar 3D sensors. More...
 
enum class  RangeSensorId { kDownwardsLidar = 0 }
 Range sensor id. More...
 

Detailed Description

The messages that are used in the communication between the agent and the client.

Message definitions

The messages are defined in the creos_messages namespace.

Enumeration Type Documentation

◆ ControlSource

enum class creos_messages::ControlSource
strong

Control source message containing the control source of the robot.

Enumerator
kDisabled 

The robot is disabled.

kManual 

The robot is controlled manually.

kAutonomous 

The robot is controlled autonomously.

kUser 

The robot is controlled by a user.

◆ ErrorCode

enum class creos_messages::ErrorCode
strong

Error codes that indicate what went wrong.

Enumerator
kUnknown 

Unknown error.

kSuccess 

Success (no error)

kTimeout 

The request timed out.

kTransportError 

There was an error while transporting the message to the other side.

kInvalidRequest 

The request was invalid, probably indicates a bug in the client.

kNotExecuted 

The request was not executed. Try looking at the message for more information.

◆ ImuId

enum class creos_messages::ImuId
strong

IMU sensor id.

Enumerator
kBody 

IMU sensor on the body of the robot.

◆ Lidar3dId

enum class creos_messages::Lidar3dId
strong

The Lidar3dId enum class contains the different lidar 3D sensors.

Enumerator
kFront 

The front lidar 3D sensor.

◆ MagneticFieldId

The MagneticFieldId enum contains the different magnetic field sensors that can be used.

Enumerator
kBody 

Magnetic field sensor on the body of the robot.

◆ RangeSensorId

enum class creos_messages::RangeSensorId
strong

Range sensor id.

Enumerator
kDownwardsLidar 

Downwards facing lidar.