NuRec gRPC API: common# Protobuf module documentation ← Back to packages Package common Message AABB Message APIVersion Message AvailableScenesReturn Message DynamicState Message Empty Message Pose Message PoseAtTime Message Quat Message SessionRequestStatus Message StateAtTime Message Trajectory Message Vec3 Message VersionId Messages message AABB AABB represents an axis-aligned bounding box. Field Type Description 1 size_x float The size of the box along the x-axis. 2 size_y float The size of the box along the y-axis. 3 size_z float The size of the box along the z-axis. message APIVersion (Nested in common.VersionId ) APIVersion represents the semantic version of the API. Field Type Description 1 major uint32 Major version number. 2 minor uint32 Minor version number. 3 patch uint32 Patch version number. message AvailableScenesReturn AvailableScenesReturn contains a list of available scene IDs. Field Type Description 1 scene_ids repeated string The list of available scene IDs. message DynamicState DynamicState represents the dynamic state of an object, including velocities. Field Type Description 1 angular_velocity common.Vec3 The angular velocity vector (rad/s). 2 linear_velocity common.Vec3 The linear velocity vector (m/s). message Empty Empty message used for requests or responses that do not require any parameters or return values. Field Type Description message Pose Pose represents a 3D pose with translation and rotation. Field Type Description 1 vec common.Vec3 The translation vector. Convention: translation (vec) is applied first. 2 quat common.Quat The rotation quaternion. Convention: rotation (quat) is applied after translation. message PoseAtTime PoseAtTime represents a pose at a specific timestamp. Field Type Description 1 pose common.Pose The pose at the given timestamp. 2 timestamp_us fixed64 The timestamp in microseconds. message Quat Quat represents a quaternion for 3D rotations. Field Type Description 1 w float The w (real) component of the quaternion. 2 x float The x (i) component of the quaternion. 3 y float The y (j) component of the quaternion. 4 z float The z (k) component of the quaternion. message SessionRequestStatus SessionRequestStatus is an empty message reserved for future extension of session request status. Field Type Description message StateAtTime StateAtTime represents the full state (pose and dynamic state) at a specific timestamp. Field Type Description 1 timestamp_us fixed64 The timestamp in microseconds. 2 pose common.Pose The pose at the given timestamp. 3 state common.DynamicState The dynamic state at the given timestamp. message Trajectory Trajectory represents a sequence of poses over time. Field Type Description 1 poses repeated common.PoseAtTime The list of poses at specific times. message Vec3 Vec3 represents a 3D vector. Field Type Description 1 x float The x component of the vector. 2 y float The y component of the vector. 3 z float The z component of the vector. message VersionId VersionId contains versioning information for the API and implementation. Field Type Description 1 version_id string The version identifier string (e.g., "1.2.3"). 2 git_hash string The git hash of the build. 3 grpc_api_version common.VersionId.APIVersion The gRPC API version (should be set to alpasim_grpc.API_VERSION_MESSAGE). Any additional data such as hardware config can be added here in the future.
Protobuf module documentation ← Back to packages Package common Message AABB Message APIVersion Message AvailableScenesReturn Message DynamicState Message Empty Message Pose Message PoseAtTime Message Quat Message SessionRequestStatus Message StateAtTime Message Trajectory Message Vec3 Message VersionId Messages message AABB AABB represents an axis-aligned bounding box. Field Type Description 1 size_x float The size of the box along the x-axis. 2 size_y float The size of the box along the y-axis. 3 size_z float The size of the box along the z-axis. message APIVersion (Nested in common.VersionId ) APIVersion represents the semantic version of the API. Field Type Description 1 major uint32 Major version number. 2 minor uint32 Minor version number. 3 patch uint32 Patch version number. message AvailableScenesReturn AvailableScenesReturn contains a list of available scene IDs. Field Type Description 1 scene_ids repeated string The list of available scene IDs. message DynamicState DynamicState represents the dynamic state of an object, including velocities. Field Type Description 1 angular_velocity common.Vec3 The angular velocity vector (rad/s). 2 linear_velocity common.Vec3 The linear velocity vector (m/s). message Empty Empty message used for requests or responses that do not require any parameters or return values. Field Type Description message Pose Pose represents a 3D pose with translation and rotation. Field Type Description 1 vec common.Vec3 The translation vector. Convention: translation (vec) is applied first. 2 quat common.Quat The rotation quaternion. Convention: rotation (quat) is applied after translation. message PoseAtTime PoseAtTime represents a pose at a specific timestamp. Field Type Description 1 pose common.Pose The pose at the given timestamp. 2 timestamp_us fixed64 The timestamp in microseconds. message Quat Quat represents a quaternion for 3D rotations. Field Type Description 1 w float The w (real) component of the quaternion. 2 x float The x (i) component of the quaternion. 3 y float The y (j) component of the quaternion. 4 z float The z (k) component of the quaternion. message SessionRequestStatus SessionRequestStatus is an empty message reserved for future extension of session request status. Field Type Description message StateAtTime StateAtTime represents the full state (pose and dynamic state) at a specific timestamp. Field Type Description 1 timestamp_us fixed64 The timestamp in microseconds. 2 pose common.Pose The pose at the given timestamp. 3 state common.DynamicState The dynamic state at the given timestamp. message Trajectory Trajectory represents a sequence of poses over time. Field Type Description 1 poses repeated common.PoseAtTime The list of poses at specific times. message Vec3 Vec3 represents a 3D vector. Field Type Description 1 x float The x component of the vector. 2 y float The y component of the vector. 3 z float The z component of the vector. message VersionId VersionId contains versioning information for the API and implementation. Field Type Description 1 version_id string The version identifier string (e.g., "1.2.3"). 2 git_hash string The git hash of the build. 3 grpc_api_version common.VersionId.APIVersion The gRPC API version (should be set to alpasim_grpc.API_VERSION_MESSAGE). Any additional data such as hardware config can be added here in the future.
