YARP
Yet Another Robot Platform
 
Loading...
Searching...
No Matches
IControlMode.h
Go to the documentation of this file.
1/*
2 * SPDX-FileCopyrightText: 2006-2021 Istituto Italiano di Tecnologia (IIT)
3 * SPDX-License-Identifier: BSD-3-Clause
4 */
5
6#ifndef YARP_DEV_ICONTROLMODE_H
7#define YARP_DEV_ICONTROLMODE_H
8
9#include <vector>
10#include <yarp/os/Vocab.h>
11#include <yarp/dev/api.h>
13
14namespace yarp::dev {
15class IControlModeRaw;
16class IControlMode;
17
33
35{
43 VOCAB_CM_PWM = yarp::os::createVocab32('i','p','w','m'),
44 VOCAB_CM_IMPEDANCE_POS = yarp::os::createVocab32('i','m','p','o'), // deprecated
45 VOCAB_CM_IMPEDANCE_VEL = yarp::os::createVocab32('i','m','v','e'), // deprecated
49 VOCAB_CM_CALIBRATING = yarp::os::createVocab32('c','a','l'), // the joint is calibrating
50 VOCAB_CM_CALIB_DONE = yarp::os::createVocab32('c','a','l','d'), // calibration successfully completed
51 VOCAB_CM_NOT_CONFIGURED = yarp::os::createVocab32('c','f','g','n'), // missing initial configuration (default value at start-up)
52 VOCAB_CM_CONFIGURED = yarp::os::createVocab32('c','f','g','y'), // initial configuration completed, if any
54};
55}
56
57#define ALLOW_OLD_CONTROL_MODE_INTERFACE 1
58
65{
66public:
67 virtual ~IControlMode(){}
68
75 virtual yarp::dev::ReturnValue getAvailableControlModes(int j, std::vector<yarp::dev::SelectableControlModeEnum>& avail)=0;
76
84#if ALLOW_OLD_CONTROL_MODE_INTERFACE
85 virtual yarp::dev::ReturnValue getControlMode(int j, int *mode)
86 {
89 *mode = static_cast<int>(mode_e);
90 return ret;
91 }
92#endif
93
99 virtual yarp::dev::ReturnValue getControlModes(std::vector<yarp::dev::ControlModeEnum>& mode)=0;
100
113 virtual yarp::dev::ReturnValue getControlModes(const std::vector<int>& joints, std::vector<yarp::dev::ControlModeEnum>& mode)=0;
114
123#if ALLOW_OLD_CONTROL_MODE_INTERFACE
124 virtual yarp::dev::ReturnValue setControlMode(const int j, const int mode)
125 {
128 return ret;
129 }
130#endif
131
146 virtual yarp::dev::ReturnValue setControlModes(const std::vector<int>& joints, const std::vector<yarp::dev::SelectableControlModeEnum>& mode)=0;
147
155 virtual yarp::dev::ReturnValue setControlModes(const std::vector<yarp::dev::SelectableControlModeEnum>& mode)=0;
156
157};
158
159
167{
168public:
170 virtual yarp::dev::ReturnValue getAvailableControlModesRaw(int j, std::vector<yarp::dev::SelectableControlModeEnum>& avail)=0;
171
173 virtual yarp::dev::ReturnValue getControlModesRaw(std::vector<yarp::dev::ControlModeEnum>& mode)=0;
174 virtual yarp::dev::ReturnValue getControlModesRaw(const std::vector<int>& joints, std::vector<yarp::dev::ControlModeEnum>& mode)=0;
175
177 virtual yarp::dev::ReturnValue setControlModesRaw(const std::vector<int>& joints, const std::vector<yarp::dev::SelectableControlModeEnum>& mode)=0;
178 virtual yarp::dev::ReturnValue setControlModesRaw(const std::vector<yarp::dev::SelectableControlModeEnum>& mode)=0;
179};
180
181
182// new style VOCABS
183// Interface
185// Methods
189
190// Values
191// Read / Write
202
203// Values
204// Read / Write
206
207// Write only (only from high level toward the joint)
209
210// Read only (imposed by the board on special events)
212constexpr yarp::conf::vocab32_t VOCAB_CM_CALIBRATING = yarp::os::createVocab32('c','a','l'); // the joint is calibrating
213constexpr yarp::conf::vocab32_t VOCAB_CM_CALIB_DONE = yarp::os::createVocab32('c','a','l','d'); // calibration successfully completed
214constexpr yarp::conf::vocab32_t VOCAB_CM_NOT_CONFIGURED = yarp::os::createVocab32('c','f','g','n'); // missing initial configuration (default value at start-up)
215constexpr yarp::conf::vocab32_t VOCAB_CM_CONFIGURED = yarp::os::createVocab32('c','f','g','y'); // initial configuration completed, if any
216
217// Read only (cannot be set from user)
219
220#endif // YARP_DEV_ICONTROLMODE_H
constexpr yarp::conf::vocab32_t VOCAB_CM_CONTROL_MODE_GROUP
constexpr yarp::conf::vocab32_t VOCAB_CM_UNKNOWN
constexpr yarp::conf::vocab32_t VOCAB_CM_MIXED
constexpr yarp::conf::vocab32_t VOCAB_CM_TORQUE
constexpr yarp::conf::vocab32_t VOCAB_CM_PWM
constexpr yarp::conf::vocab32_t VOCAB_CM_HW_FAULT
constexpr yarp::conf::vocab32_t VOCAB_CM_IMPEDANCE_VEL
constexpr yarp::conf::vocab32_t VOCAB_CM_VELOCITY_DIRECT
constexpr yarp::conf::vocab32_t VOCAB_CM_IDLE
constexpr yarp::conf::vocab32_t VOCAB_CM_CALIB_DONE
constexpr yarp::conf::vocab32_t VOCAB_CM_NOT_CONFIGURED
constexpr yarp::conf::vocab32_t VOCAB_CM_POSITION
constexpr yarp::conf::vocab32_t VOCAB_CM_CONTROL_MODES
constexpr yarp::conf::vocab32_t VOCAB_CM_CONFIGURED
constexpr yarp::conf::vocab32_t VOCAB_CM_CURRENT
constexpr yarp::conf::vocab32_t VOCAB_CM_IMPEDANCE_POS
constexpr yarp::conf::vocab32_t VOCAB_CM_CONTROL_MODE
constexpr yarp::conf::vocab32_t VOCAB_CM_POSITION_DIRECT
constexpr yarp::conf::vocab32_t VOCAB_ICONTROLMODE
constexpr yarp::conf::vocab32_t VOCAB_CM_VELOCITY
constexpr yarp::conf::vocab32_t VOCAB_CM_FORCE_IDLE
constexpr yarp::conf::vocab32_t VOCAB_CM_CALIBRATING
Interface for setting control mode in control board.
virtual yarp::dev::ReturnValue setControlModesRaw(const std::vector< yarp::dev::SelectableControlModeEnum > &mode)=0
virtual yarp::dev::ReturnValue getControlModesRaw(std::vector< yarp::dev::ControlModeEnum > &mode)=0
virtual yarp::dev::ReturnValue getControlModesRaw(const std::vector< int > &joints, std::vector< yarp::dev::ControlModeEnum > &mode)=0
virtual yarp::dev::ReturnValue setControlModeRaw(int j, yarp::dev::SelectableControlModeEnum mode)=0
virtual yarp::dev::ReturnValue getAvailableControlModesRaw(int j, std::vector< yarp::dev::SelectableControlModeEnum > &avail)=0
virtual yarp::dev::ReturnValue setControlModesRaw(const std::vector< int > &joints, const std::vector< yarp::dev::SelectableControlModeEnum > &mode)=0
virtual yarp::dev::ReturnValue getControlModeRaw(int j, yarp::dev::ControlModeEnum &mode)=0
Interface for setting control mode in control board.
virtual yarp::dev::ReturnValue getControlMode(int j, int *mode)
virtual yarp::dev::ReturnValue getControlModes(const std::vector< int > &joints, std::vector< yarp::dev::ControlModeEnum > &mode)=0
Get the current control mode for a subset of axes.
virtual yarp::dev::ReturnValue getControlMode(int j, yarp::dev::ControlModeEnum &mode)=0
Get the current control mode.
virtual yarp::dev::ReturnValue setControlModes(const std::vector< yarp::dev::SelectableControlModeEnum > &mode)=0
Set the current control mode (multiple joints).
virtual yarp::dev::ReturnValue getControlModes(std::vector< yarp::dev::ControlModeEnum > &mode)=0
Get the current control mode (multiple joints).
virtual yarp::dev::ReturnValue setControlMode(const int j, const int mode)
virtual yarp::dev::ReturnValue setControlModes(const std::vector< int > &joints, const std::vector< yarp::dev::SelectableControlModeEnum > &mode)=0
Set the current control mode for a subset of axes.
virtual yarp::dev::ReturnValue setControlMode(int j, yarp::dev::SelectableControlModeEnum mode)=0
Set the current control mode.
virtual yarp::dev::ReturnValue getAvailableControlModes(int j, std::vector< yarp::dev::SelectableControlModeEnum > &avail)=0
Return a list of available control mode for the given joint.
std::int32_t vocab32_t
Definition numeric.h:78
For streams capable of holding different kinds of content, check what they actually have.
SelectableControlModeEnum
constexpr yarp::conf::vocab32_t createVocab32(char a, char b=0, char c=0, char d=0)
Create a vocab from chars.
Definition Vocab32.h:27
The main, catch-all namespace for YARP.
Definition dirs.h:16
#define YARP_dev_API
Definition api.h:18