mirror of
https://github.com/wpilibsuite/allwpilib
synced 2026-06-29 02:21:44 +00:00
Bring back the gazebo plugins (#1063)
The models and meshes are not included. We will need to find an alternate way to reintegrate these and use them. * Add simulation/gz_msgs back, and build with Gradle. * Add back in the frc simulation plugins for gazebo. * Add a new shared library, halsim_gazebo. This library will become the interface between the HAL sim layer and gazebo. * Preserve the first channel number used in created Encoders in the Sim MockData. This allows us to use the DIO channel number to connect with simulated encoders. * Have the HAL Simulator set the reverse direction on creation. This enables a simulator to be aware of the direction. * Add a drive_motor plugin. This is a bit of a 'magic' motor, which allows us to build robot models that drive in a more realistic fashion. It does this by apply forces directly to the chassis, rather than relying on the complex motion dynamics of a driven wheel. This in turn allows the model to reduce wheel friction, reducing scrub, and allowing for a more natural driving experience.
This commit is contained in:
committed by
Peter Johnson
parent
70960b0251
commit
ebd41fe0bb
@@ -0,0 +1,95 @@
|
||||
/*----------------------------------------------------------------------------*/
|
||||
/* Copyright (c) 2016-2018 FIRST. All Rights Reserved. */
|
||||
/* Open Source Software - may be modified and shared by FRC teams. The code */
|
||||
/* must be accompanied by the FIRST BSD license file in the root directory of */
|
||||
/* the project. */
|
||||
/*----------------------------------------------------------------------------*/
|
||||
|
||||
#include "pneumatic_piston.h"
|
||||
|
||||
#include <boost/algorithm/string/replace.hpp>
|
||||
#include <gazebo/physics/physics.hh>
|
||||
#include <gazebo/transport/transport.hh>
|
||||
|
||||
#ifdef _WIN32
|
||||
// Ensure that Winsock2.h is included before Windows.h, which can get
|
||||
// pulled in by anybody (e.g., Boost).
|
||||
#include <Winsock2.h>
|
||||
#endif
|
||||
|
||||
GZ_REGISTER_MODEL_PLUGIN(PneumaticPiston)
|
||||
|
||||
void PneumaticPiston::Load(gazebo::physics::ModelPtr model,
|
||||
sdf::ElementPtr sdf) {
|
||||
this->model = model;
|
||||
forward_signal = reverse_signal = false;
|
||||
|
||||
// Parse SDF properties
|
||||
joint = model->GetJoint(sdf->Get<std::string>("joint"));
|
||||
if (sdf->HasElement("topic")) {
|
||||
topic = sdf->Get<std::string>("topic");
|
||||
} else {
|
||||
topic = "~/" + sdf->GetAttribute("name")->GetAsString();
|
||||
}
|
||||
|
||||
if (sdf->HasElement("reverse-topic")) {
|
||||
reverse_topic = sdf->Get<std::string>("reverse-topic");
|
||||
} else {
|
||||
reverse_topic.clear();
|
||||
}
|
||||
|
||||
forward_force = sdf->Get<double>("forward-force");
|
||||
if (sdf->HasElement("reverse-force"))
|
||||
reverse_force = -1.0 * sdf->Get<double>("reverse-force");
|
||||
|
||||
if (sdf->HasElement("direction") &&
|
||||
sdf->Get<std::string>("direction") == "reversed") {
|
||||
forward_force = -forward_force;
|
||||
reverse_force = -reverse_force;
|
||||
}
|
||||
|
||||
gzmsg << "Initializing piston: " << topic << " joint=" << joint->GetName()
|
||||
<< " forward_force=" << forward_force
|
||||
<< " reverse_force=" << reverse_force << std::endl;
|
||||
if (!reverse_topic.empty())
|
||||
gzmsg << "Reversing on topic " << reverse_topic << std::endl;
|
||||
|
||||
// Connect to Gazebo transport for messaging
|
||||
std::string scoped_name =
|
||||
model->GetWorld()->GetName() + "::" + model->GetScopedName();
|
||||
boost::replace_all(scoped_name, "::", "/");
|
||||
node = gazebo::transport::NodePtr(new gazebo::transport::Node());
|
||||
node->Init(scoped_name);
|
||||
sub = node->Subscribe(topic, &PneumaticPiston::ForwardCallback, this);
|
||||
if (!reverse_topic.empty())
|
||||
sub_reverse =
|
||||
node->Subscribe(reverse_topic, &PneumaticPiston::ReverseCallback, this);
|
||||
|
||||
// Connect to the world update event.
|
||||
// This will trigger the Update function every Gazebo iteration
|
||||
updateConn = gazebo::event::Events::ConnectWorldUpdateBegin(
|
||||
boost::bind(&PneumaticPiston::Update, this, _1));
|
||||
}
|
||||
|
||||
void PneumaticPiston::Update(const gazebo::common::UpdateInfo& info) {
|
||||
double force = 0.0;
|
||||
if (forward_signal) {
|
||||
force = forward_force;
|
||||
} else {
|
||||
/* For DoubleSolenoids, the second signal must be present
|
||||
for us to apply the reverse force. For SingleSolenoids,
|
||||
the lack of the forward signal suffices.
|
||||
Note that a true simulation would not allow a SingleSolenoid to
|
||||
have reverse force, but we put that in the hands of the model builder.*/
|
||||
if (reverse_topic.empty() || reverse_signal) force = reverse_force;
|
||||
}
|
||||
joint->SetForce(0, force);
|
||||
}
|
||||
|
||||
void PneumaticPiston::ForwardCallback(const gazebo::msgs::ConstBoolPtr& msg) {
|
||||
forward_signal = msg->data();
|
||||
}
|
||||
|
||||
void PneumaticPiston::ReverseCallback(const gazebo::msgs::ConstBoolPtr& msg) {
|
||||
reverse_signal = msg->data();
|
||||
}
|
||||
@@ -0,0 +1,102 @@
|
||||
/*----------------------------------------------------------------------------*/
|
||||
/* Copyright (c) 2016-2018 FIRST. All Rights Reserved. */
|
||||
/* Open Source Software - may be modified and shared by FRC teams. The code */
|
||||
/* must be accompanied by the FIRST BSD license file in the root directory of */
|
||||
/* the project. */
|
||||
/*----------------------------------------------------------------------------*/
|
||||
|
||||
#pragma once
|
||||
|
||||
#include <string>
|
||||
|
||||
#include <gazebo/gazebo.hh>
|
||||
|
||||
#include "simulation/gz_msgs/msgs.h"
|
||||
|
||||
/**
|
||||
* \brief Plugin for controlling a joint with a pneumatic piston.
|
||||
*
|
||||
* This plugin subscribes to topics to get the solenoid state for a piston
|
||||
* It needs one signal for the forward signal. For a double solenoid,
|
||||
* a second signal can be sent.
|
||||
* Each signal is a boolean.
|
||||
*
|
||||
* Every physics update the joint's torque is set to reflect the
|
||||
* signal, using the configured force
|
||||
*
|
||||
* To add a pneumatic piston to your robot, add the following XML to
|
||||
* your robot model:
|
||||
*
|
||||
* <plugin name="my_piston" filename="libpneumatic_piston.so">
|
||||
* <joint>Joint Name</joint>
|
||||
* <topic>/gazebo/frc/simulator/pneumatics/1/1</topic>
|
||||
* <reverse-topic>/gazebo/frc/simulator/pneumatics/1/2</reverse-topic>
|
||||
* <direction>{forward, reversed}</direction>
|
||||
* <forward-force>Number</forward-force>
|
||||
* <reverse-force>Number</reverse-force>
|
||||
* </plugin>
|
||||
*
|
||||
* - `joint`: Name of the joint this piston is attached to.
|
||||
* - `topic`: Optional. Forward Solenoid signal name. type gazebo.msgs.Bool.
|
||||
* If not given, the name given for the plugin will be used.
|
||||
* A pattern of /gazebo/frc/simulator/pneumatics/1/n is good.
|
||||
* The first number represents the PCM module. Only 1 is supported.
|
||||
* The second number represents the channel on the PCM.
|
||||
* - `topic-reverse`: Optional. If given, represents the reverse channel.
|
||||
* Message type should be gazebo.msgs.Bool.
|
||||
* - `direction`: Optional. Defaults to forward. Reversed if the piston
|
||||
* pushes in the opposite direction of the joint axis.
|
||||
* - `forward-force`: Force to apply in the forward direction.
|
||||
* - `reverse-force`: Force to apply in the reverse direction.
|
||||
* For a single solenoid, you would expect '0',
|
||||
* but we allow model builders to provide a value.
|
||||
*
|
||||
*/
|
||||
class PneumaticPiston : public gazebo::ModelPlugin {
|
||||
public:
|
||||
/// \brief Load the pneumatic piston and configures it according to the sdf.
|
||||
void Load(gazebo::physics::ModelPtr model, sdf::ElementPtr sdf);
|
||||
|
||||
/// \brief Updat the force the piston applies on the joint.
|
||||
void Update(const gazebo::common::UpdateInfo& info);
|
||||
|
||||
private:
|
||||
/// \brief Topic to read forward control signal from.
|
||||
std::string topic;
|
||||
|
||||
/// \brief Topic to read reverse control signal from.
|
||||
std::string reverse_topic;
|
||||
|
||||
/// \brief Whether the solenoid to open forward is on
|
||||
bool forward_signal;
|
||||
|
||||
/// \brief Whether the solenoid to open in reverse is on
|
||||
bool reverse_signal;
|
||||
|
||||
/// \brief The magic force multipliers for each direction.
|
||||
double forward_force, reverse_force;
|
||||
|
||||
/// \brief The joint that this pneumatic piston actuates.
|
||||
gazebo::physics::JointPtr joint;
|
||||
|
||||
/// \brief Callback for receiving msgs and updating the solenoid state
|
||||
void ForwardCallback(const gazebo::msgs::ConstBoolPtr& msg);
|
||||
|
||||
/// \brief Callback for receiving msgs and updating the reverse solenoid state
|
||||
void ReverseCallback(const gazebo::msgs::ConstBoolPtr& msg);
|
||||
|
||||
/// \brief The model to which this is attached.
|
||||
gazebo::physics::ModelPtr model;
|
||||
|
||||
/// \brief Pointer to the world update function.
|
||||
gazebo::event::ConnectionPtr updateConn;
|
||||
|
||||
/// \brief The node on which we're advertising.
|
||||
gazebo::transport::NodePtr node;
|
||||
|
||||
/// \brief Subscriber handle.
|
||||
gazebo::transport::SubscriberPtr sub;
|
||||
|
||||
/// \brief Subscriber handle for reverse topic
|
||||
gazebo::transport::SubscriberPtr sub_reverse;
|
||||
};
|
||||
Reference in New Issue
Block a user