Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add docs to wheel_slip_parameters_cmd.proto #227

Merged
merged 3 commits into from
Mar 12, 2022
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 35 additions & 2 deletions proto/ignition/msgs/wheel_slip_parameters_cmd.proto
Original file line number Diff line number Diff line change
Expand Up @@ -24,16 +24,49 @@ option java_outer_classname = "WheelSlipParametersCmd";
/// \interface WheelSlipParametersCmd
/// \brief Message containing a wheel slip parameters user command.

import "ignition/msgs/entity.proto";
import "ignition/msgs/header.proto";

message WheelSlipParametersCmd
{
/// \brief Optional header data
Header header = 1;

string model_name = 2;
string link_name = 3;
/// \brief Entity which wheel slip parameters are going to be modified.
///
/// The entity might be a model with at least one link or a link.
/// If the entity is a model, the wheel slip parameters of all its
/// links will be updated.
///
/// The entity name (entity.name) will be used as an scoped name.
/// For example, in this
/// hierarchy:
///
/// world_name
/// model_name
/// link_name
///
/// All these names will return the link entity:
///
/// * world_name::model_name::link_name
/// * model_name::link_name
/// * link_name
Entity entity = 2;

/// \brief Unitless lateral slip ratio.
///
/// See https://en.wikipedia.org/wiki/Slip_(vehicle_dynamics).
/// to tangential force ratio (tangential / normal force).
/// At each time step, these compliances are multiplied by
/// the linear wheel spin velocity and divided by the wheel normal force
/// parameter specified in the sdf.
double slip_compliance_lateral = 4;
/// \brief Unitless longitudinal slip ratio.
///
/// See https://en.wikipedia.org/wiki/Slip_(vehicle_dynamics).
/// to tangential force ratio (tangential / normal force).
/// At each time step, these compliances are multiplied by
/// the linear wheel spin velocity and divided by the wheel normal force
/// parameter specified in the sdf.
double slip_compliance_longitudinal = 5;
}