Files
allwpilib/simulation/frc_gazebo_plugins/pneumatic_piston/src/pneumatic_piston.h
peter mitrano 29d029fa61 merged from frcsim branch
verified to work on real robots
adds sim eclipse plugins, fixed JavaGazebo, made wpilibC++Sim build on windows
 - Java and C++ simulation robot programs run on windows
 - simulation eclipse plugin delivers models and gazebo plugins
 - Java Gazebo now respects GAZEBO_IP variables and can work across networks
 - hal and network tables win32 hacked to work on windows
 - smart dashboard broken on windows due to network tables hacks
 - wpilibC++Sim, gz_msgs, and frcsim_gazebo_plugins build with CMake
 - removed constexpr for cross platform compatibility
 - msgs generated using .protos as a part of build process
 - some spare and unused cmake/pom files deleted
 - simulation ubuntu debians removed entirely
 - refactored CMake project flags and macros
 - updated to match non-sim C++ API
 - fixed and updated documentation
 - servo added to simulation

Change-Id: Ia702ff0f1fee10d77f543810ad88f56696443b05
2015-08-18 10:39:25 -04:00

76 lines
2.4 KiB
C++

#pragma once
#include "simulation/gz_msgs/msgs.h"
#include <gazebo/gazebo.hh>
using namespace gazebo;
/**
* \brief Plugin for controlling a joint with a pneumatic piston.
*
* This plugin subscribes to a topic to get a signal. It accepts three
* values:
*
* - 1: Apply the forward force to the joint.
* - 0: Maintain last applied force
* - -1: Apply the reverse force to the joint.
*
* Every physics update the joint's torque is set to reflect the
* signal.
*
* To add a pneumatic piston to your robot, add the following XML to
* your robot model:
*
* <plugin name="my_piston" filename="libgz_pneumatic_piston.so">
* <joint>Joint Name</joint>
* <topic>~/my/topic</topic>
* <direction>{forward, reversed}</direction>
* <forward-force>Number</forward-force>
* <reverse-force>Number</reverse-force>
* </plugin>
*
* - `joint`: Name of the joint this Dc motor is attached to.
* - `topic`: Optional. Message type should be gazebo.msgs.Float64.
* - `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.
*
* \todo Signal should probably be made a tri-state message.
*/
class PneumaticPiston: public ModelPlugin {
public:
PneumaticPiston();
~PneumaticPiston();
/// \brief Load the pneumatic piston and configures it according to the sdf.
void Load(physics::ModelPtr model, sdf::ElementPtr sdf);
/// \brief Updat the force the piston applies on the joint.
void Update(const common::UpdateInfo &info);
private:
/// \brief Topic to read control signal from.
std::string topic;
/// \brief The signal is one of: {-1,0,1}.
double signal;
/// \brief The magic force multipliers for each direction.
double forward_force, reverse_force;
/// \brief The joint that this pneumatic piston actuates.
physics::JointPtr joint;
/// \brief Callback for receiving msgs and updating the torque.
void Callback(const msgs::ConstFloat64Ptr &msg);
physics::ModelPtr model; ///< \brief The model that this is attached to.
event::ConnectionPtr updateConn; ///< \brief Pointer to the world update function.
transport::NodePtr node; ///< \brief The node we're advertising on.
transport::SubscriberPtr sub; ///< \brief Subscriber handle.
};