CTRE Phoenix 6 C++ 24.2.0
Diff_DutyCycleOut_Velocity.hpp
Go to the documentation of this file.
1/*
2 * Copyright (C) Cross The Road Electronics.  All rights reserved.
3 * License information can be found in CTRE_LICENSE.txt
4 * For support and suggestions contact support@ctr-electronics.com or file
5 * an issue tracker at https://github.com/CrossTheRoadElec/Phoenix-Releases
6 */
7#pragma once
8
12#include <sstream>
15#include <units/frequency.h>
16#include <units/time.h>
17
18
19namespace ctre {
20namespace phoenix6 {
21namespace controls {
22namespace compound {
23
24/**
25 * \private
26 * Requires Phoenix Pro and CANivore;
27 * Differential control with duty cycle average target and velocity difference
28 * target.
29 */
30class Diff_DutyCycleOut_Velocity : public ControlRequest
31{
32 ctre::phoenix::StatusCode SendRequest(const char *network, uint32_t deviceHash, bool cancelOtherRequests, std::shared_ptr<ControlRequest> &req) override
33 {
34 if (req.get() != this)
35 {
36 auto const reqCast = dynamic_cast<Diff_DutyCycleOut_Velocity *>(req.get());
37 if (reqCast != nullptr)
38 {
39 *reqCast = *this;
40 }
41 else
42 {
43 req = std::make_shared<Diff_DutyCycleOut_Velocity>(*this);
44 }
45 }
46
47 return c_ctre_phoenix6_RequestControlDiff_DutyCycleOut_Velocity(network, deviceHash, UpdateFreqHz.to<double>(), cancelOtherRequests, AverageRequest.Output.to<double>(), AverageRequest.EnableFOC, AverageRequest.OverrideBrakeDurNeutral, AverageRequest.LimitForwardMotion, AverageRequest.LimitReverseMotion, DifferentialRequest.Velocity.to<double>(), DifferentialRequest.Acceleration.to<double>(), DifferentialRequest.EnableFOC, DifferentialRequest.FeedForward.to<double>(), DifferentialRequest.Slot, DifferentialRequest.OverrideBrakeDurNeutral, DifferentialRequest.LimitForwardMotion, DifferentialRequest.LimitReverseMotion);
48 }
49
50public:
51 /**
52 * Average DutyCycleOut request of the mechanism.
53 */
54 DutyCycleOut AverageRequest;
55 /**
56 * Differential VelocityDutyCycle request of the mechanism.
57 */
58 VelocityDutyCycle DifferentialRequest;
59
60 /**
61 * \brief The period at which this control will update at.
62 * This is designated in Hertz, with a minimum of 20 Hz
63 * (every 50 ms) and a maximum of 1000 Hz (every 1 ms).
64 *
65 * If this field is set to 0 Hz, the control request will
66 * be sent immediately as a one-shot frame. This may be useful
67 * for advanced applications that require outputs to be
68 * synchronized with data acquisition. In this case, we
69 * recommend not exceeding 50 ms between control calls.
70 */
71 units::frequency::hertz_t UpdateFreqHz{100_Hz}; // Default to 100_Hz
72
73 /**
74 * \brief Requires Phoenix Pro and CANivore;
75 * Differential control with duty
76 * cycle average target and velocity difference target.
77 *
78 * \param AverageRequest Average DutyCycleOut request of the mechanism.
79 * \param DifferentialRequest Differential VelocityDutyCycle request of the
80 * mechanism.
81 */
82 Diff_DutyCycleOut_Velocity(DutyCycleOut AverageRequest, VelocityDutyCycle DifferentialRequest) : ControlRequest{"Diff_DutyCycleOut_Velocity"},
83 AverageRequest{std::move(AverageRequest)},
84 DifferentialRequest{std::move(DifferentialRequest)}
85 {}
86
87 /**
88 * \brief Modifies this Control Request's AverageRequest parameter and returns itself for
89 * method-chaining and easier to use request API.
90 * \param newAverageRequest Parameter to modify
91 * \returns Itself
92 */
93 Diff_DutyCycleOut_Velocity& WithAverageRequest(DutyCycleOut newAverageRequest)
94 {
95 AverageRequest = std::move(newAverageRequest);
96 return *this;
97 }
98
99 /**
100 * \brief Modifies this Control Request's DifferentialRequest parameter and returns itself for
101 * method-chaining and easier to use request API.
102 * \param newDifferentialRequest Parameter to modify
103 * \returns Itself
104 */
105 Diff_DutyCycleOut_Velocity& WithDifferentialRequest(VelocityDutyCycle newDifferentialRequest)
106 {
107 DifferentialRequest = std::move(newDifferentialRequest);
108 return *this;
109 }
110 /**
111 * \brief Sets the period at which this control will update at.
112 * This is designated in Hertz, with a minimum of 20 Hz
113 * (every 50 ms) and a maximum of 1000 Hz (every 1 ms).
114 *
115 * If this field is set to 0 Hz, the control request will
116 * be sent immediately as a one-shot frame. This may be useful
117 * for advanced applications that require outputs to be
118 * synchronized with data acquisition. In this case, we
119 * recommend not exceeding 50 ms between control calls.
120 *
121 * \param newUpdateFreqHz Parameter to modify
122 * \returns Itself
123 */
124 Diff_DutyCycleOut_Velocity &WithUpdateFreqHz(units::frequency::hertz_t newUpdateFreqHz)
125 {
126 UpdateFreqHz = newUpdateFreqHz;
127 return *this;
128 }
129 /**
130 * Returns a string representation of the object.
131 *
132 * \returns a string representation of the object.
133 */
134 std::string ToString() const override
135 {
136 std::stringstream ss;
137 ss << "class: Diff_DutyCycleOut_Velocity" << std::endl;
138 ss << "AverageRequest:" << std::endl;
139 ss << " Output: " << AverageRequest.Output.to<double>() << std::endl;
140 ss << " EnableFOC: " << AverageRequest.EnableFOC << std::endl;
141 ss << " OverrideBrakeDurNeutral: " << AverageRequest.OverrideBrakeDurNeutral << std::endl;
142 ss << " LimitForwardMotion: " << AverageRequest.LimitForwardMotion << std::endl;
143 ss << " LimitReverseMotion: " << AverageRequest.LimitReverseMotion << std::endl;
144 ss << "DifferentialRequest:" << std::endl;
145 ss << " Velocity: " << DifferentialRequest.Velocity.to<double>() << std::endl;
146 ss << " Acceleration: " << DifferentialRequest.Acceleration.to<double>() << std::endl;
147 ss << " EnableFOC: " << DifferentialRequest.EnableFOC << std::endl;
148 ss << " FeedForward: " << DifferentialRequest.FeedForward.to<double>() << std::endl;
149 ss << " Slot: " << DifferentialRequest.Slot << std::endl;
150 ss << " OverrideBrakeDurNeutral: " << DifferentialRequest.OverrideBrakeDurNeutral << std::endl;
151 ss << " LimitForwardMotion: " << DifferentialRequest.LimitForwardMotion << std::endl;
152 ss << " LimitReverseMotion: " << DifferentialRequest.LimitReverseMotion << std::endl;
153 return ss.str();
154 }
155
156 /**
157 * \brief Gets information about this control request.
158 *
159 * \returns Map of control parameter names and corresponding applied values
160 */
161 std::map<std::string, std::string> GetControlInfo() const override
162 {
163 std::map<std::string, std::string> controlInfo;
164 std::stringstream ss;
165 controlInfo["Name"] = GetName();
166 ss << AverageRequest.ToString(); controlInfo["AverageRequest"] = ss.str(); ss.str(std::string{});
167 ss << DifferentialRequest.ToString(); controlInfo["DifferentialRequest"] = ss.str(); ss.str(std::string{});
168 return controlInfo;
169 }
170};
171
172}
173}
174}
175}
176
CTREXPORT int c_ctre_phoenix6_RequestControlDiff_DutyCycleOut_Velocity(const char *canbus, uint32_t ecuEncoding, double updateTime, bool cancelOtherRequests, double AverageRequest_Output, bool AverageRequest_EnableFOC, bool AverageRequest_OverrideBrakeDurNeutral, bool AverageRequest_LimitForwardMotion, bool AverageRequest_LimitReverseMotion, double DifferentialRequest_Velocity, double DifferentialRequest_Acceleration, bool DifferentialRequest_EnableFOC, double DifferentialRequest_FeedForward, int DifferentialRequest_Slot, bool DifferentialRequest_OverrideBrakeDurNeutral, bool DifferentialRequest_LimitForwardMotion, bool DifferentialRequest_LimitReverseMotion)
std::string const & GetName() const
Definition: ControlRequest.hpp:51
ControlRequest(ControlRequest const &)=default
Definition: RcManualEvent.hpp:12