YAMS
Yet Another Mechanism System
Loading...
Searching...
No Matches
Pivot.hpp
Go to the documentation of this file.
1// Copyright (c) 2026 Yet Another Software Suite
2// SPDX-License-Identifier: LGPL-3.0-or-later
3
4#pragma once
5
6#include <functional>
7#include <optional>
8#include <string>
9#include <wpi/commands2/CommandPtr.hpp>
10#include <wpi/commands2/button/Trigger.hpp>
11#include <wpi/math/geometry/Pose3d.hpp>
12#include <wpi/simulation/DCMotorSim.hpp>
13#include <wpi/smartdashboard/MechanismLigament2d.hpp>
14#include <wpi/units/angle.hpp>
15
18
20
71 public:
79
80 // ---- SmartMechanism overrides ---------------------------------------------
81
83 void SimIterate() override;
84
86 void UpdateTelemetry() override;
87
89 void VisualizationUpdate() override;
90
92 std::string GetName() const override;
93
94 // ---- SmartPositionalMechanism overrides -----------------------------------
95
102 wpi::cmd::Trigger Max() override;
103
110 wpi::cmd::Trigger Min() override;
111
112 // ---- Pivot-specific interface ---------------------------------------------
113
120 wpi::cmd::CommandPtr Run(wpi::units::degree_t angle);
121
128 wpi::cmd::CommandPtr Run(std::function<wpi::units::degree_t()> angle);
129
137 wpi::cmd::CommandPtr RunTo(wpi::units::degree_t angle,
138 wpi::units::degree_t tolerance = wpi::units::degree_t{1.0});
139
151 wpi::cmd::CommandPtr RunTo(std::function<wpi::units::degree_t()> angle,
152 wpi::units::degree_t tolerance = wpi::units::degree_t{1.0});
153
159 wpi::units::degree_t GetAngle() const;
160
167 wpi::cmd::Trigger Gte(wpi::units::degree_t angle);
168
175 wpi::cmd::Trigger Lte(wpi::units::degree_t angle);
176
184 wpi::cmd::Trigger Between(wpi::units::degree_t start, wpi::units::degree_t end);
185
193 wpi::cmd::Trigger IsNear(wpi::units::degree_t angle,
194 wpi::units::degree_t within = wpi::units::degree_t{1.0});
195
202
210 wpi::math::Pose3d GetPose3d() const override;
211
217 void SetAngle(wpi::units::degree_t angle);
218
219 private:
220 config::PivotConfig* m_pivotConfig{nullptr};
221 std::string m_name{"Pivot"};
222 std::optional<wpi::sim::DCMotorSim> m_dcMotorSim;
223 wpi::MechanismLigament2d* m_setpointLigament{nullptr};
224};
225
226} // namespace yams::mechanisms::positional
Definition PivotConfig.hpp:25
std::string GetName() const override
wpi::cmd::Trigger Gte(wpi::units::degree_t angle)
wpi::units::degree_t GetAngle() const
const config::PivotConfig & GetConfig() const
void SetAngle(wpi::units::degree_t angle)
wpi::math::Pose3d GetPose3d() const override
wpi::cmd::Trigger IsNear(wpi::units::degree_t angle, wpi::units::degree_t within=wpi::units::degree_t{1.0})
wpi::cmd::Trigger Max() override
wpi::cmd::Trigger Lte(wpi::units::degree_t angle)
wpi::cmd::Trigger Min() override
wpi::cmd::CommandPtr RunTo(std::function< wpi::units::degree_t()> angle, wpi::units::degree_t tolerance=wpi::units::degree_t{1.0})
wpi::cmd::Trigger Between(wpi::units::degree_t start, wpi::units::degree_t end)
wpi::cmd::CommandPtr RunTo(wpi::units::degree_t angle, wpi::units::degree_t tolerance=wpi::units::degree_t{1.0})
wpi::cmd::CommandPtr Run(wpi::units::degree_t angle)
wpi::cmd::CommandPtr Run(std::function< wpi::units::degree_t()> angle)
Pivot(config::PivotConfig *config, motorcontrollers::SmartMotorController *smc)
SmartPositionalMechanism()
Definition SmartPositionalMechanism.hpp:23
Definition SmartMotorController.hpp:49
Definition ArmConfig.hpp:17
Definition Arm.hpp:19