RobotSystem-Lite
Loading...
Searching...
No Matches
robot.h
Go to the documentation of this file.
1
2// //
3// Copyright (c) 2016-2025 Leonardo Consoni <leonardojc@protonmail.com> //
4// //
5// This file is part of RobotSystem-Lite. //
6// //
7// RobotSystem-Lite is free software: you can redistribute it and/or modify //
8// it under the terms of the GNU Lesser General Public License as published //
9// by the Free Software Foundation, either version 3 of the License, or //
10// (at your option) any later version. //
11// //
12// RobotSystem-Lite is distributed in the hope that it will be useful, //
13// but WITHOUT ANY WARRANTY; without even the implied warranty of //
14// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the //
15// GNU Lesser General Public License for more details. //
16// //
17// You should have received a copy of the GNU Lesser General Public License //
18// along with RobotSystem-Lite. If not, see <http://www.gnu.org/licenses/>. //
19// //
21
22
29
65
66#ifndef ROBOT_H
67#define ROBOT_H
68
69#include "robot_control/robot_control.h"
70
71#include <stdbool.h>
72#include <stddef.h>
73
74
78bool Robot_Init( const char* configPathName );
79
81void Robot_End();
82
86
90
94bool Robot_SetControlState( enum ControlState controlState );
95
99const char* Robot_GetJointName( size_t jointIndex );
100
104const char* Robot_GetAxisName( size_t axisIndex );
105
110bool Robot_GetJointMeasures( size_t jointIndex, DoFVariables* ref_measures );
111
116bool Robot_GetAxisMeasures( size_t axisIndex, DoFVariables* ref_measures );
117
121void Robot_SetAxisSetpoints( size_t axisIndex, DoFVariables* ref_setpoints );
122
126
130
131
132#endif // ROBOT_H
bool Robot_SetControlState(enum ControlState controlState)
Change control state of given robot actuators and underlying (plugin) control implementation.
bool Robot_GetJointMeasures(size_t jointIndex, DoFVariables *ref_measures)
Gets current value of specified joint measurements (see joint_axis_rationale)
bool Robot_Init(const char *configPathName)
Creates and initializes robot data structure based on given information.
bool Robot_Enable()
Initializes (if not running) update/operation thread for the given robot.
const char * Robot_GetAxisName(size_t axisIndex)
Calls underlying (plugin) implementation to get string identifier for specified axis in given robot.
void Robot_End()
Deallocates internal data of given robot.
bool Robot_GetAxisMeasures(size_t axisIndex, DoFVariables *ref_measures)
Gets current value of specified axis measurements (see joint_axis_rationale)
bool Robot_Disable()
Terminates (if running) update/operation thread for the given robot.
const char * Robot_GetJointName(size_t jointIndex)
Calls underlying (plugin) implementation to get string identifier for specified joint in given robot.
size_t Robot_GetJointsNumber()
Calls underlying (plugin) implementation to get number of joint degrees-of-freedom for given robot.
void Robot_SetAxisSetpoints(size_t axisIndex, DoFVariables *ref_setpoints)
Sets value of specified setpoint for given axis.
size_t Robot_GetAxesNumber()
Calls underlying (plugin) implementation to get number of axis degrees-of-freedom for given robot.