Basic RT components and utilities  315.15.0
Classes | Public Types | Public Member Functions | Public Attributes | List of all members
OpenHRP::RobotHardwareService Interface Reference

import"RobotHardwareService.idl";

Classes

struct  BatteryState
 
struct  RobotState
 status of the robot More...
 
struct  RobotState2
 status of the robot More...
 
struct  TimedRobotState2
 

Public Types

enum  SwitchStatus { SWITCH_ON, SWITCH_OFF }
 
typedef sequence< octet > OctSequence
 
typedef sequence< double > DblSequence
 
typedef sequence< long > LongSequence
 
typedef sequence< string > StrSequence
 
typedef sequence< LongSequenceLongSequenceSequence
 
typedef double DblArray3[3]
 
typedef double DblArray6[6]
 
typedef sequence< double, 3 > DblSequence3
 
typedef sequence< double, 6 > DblSequence6
 

Public Member Functions

void getStatus (out RobotState rs)
 get status of the robot More...
 
boolean power (in string name, in SwitchStatus _ss)
 turn on/off power supply for motor driver More...
 
boolean servo (in string name, in SwitchStatus _ss)
 servo on/off More...
 
void setServoGainPercentage (in string name, in double percentage)
 set the parcentage to the default servo gain More...
 
void setServoErrorLimit (in string name, in double limit)
 set the maximum joint servo error angle More...
 
void calibrateInertiaSensor ()
 remove offsets on sensor outputs form gyro sensors and accelerometers. More...
 
void removeForceSensorOffset ()
 remove offsets on sensor outputs form force/torque sensors. More...
 
void initializeJointAngle (in string name, in string option)
 initialize joint angle More...
 
boolean addJointGroup (in string gname, in StrSequence jnames)
 add definition of joint group More...
 
boolean readDigitalInput (out OctSequence din)
 get digital input to robot More...
 
long lengthDigitalInput ()
 get digital input length of robot, non-applicable bits are nop More...
 
boolean writeDigitalOutput (in OctSequence dout)
 set digital output from robot More...
 
boolean writeDigitalOutputWithMask (in OctSequence dout, in OctSequence mask)
 set digital output from robot More...
 
long lengthDigitalOutput ()
 get digital output length of robot, non-applicable bits are nop More...
 
boolean readDigitalOutput (out OctSequence dOut)
 get digital output to robot More...
 
void getStatus2 (out RobotState2 rs)
 get status of the robot More...
 

Public Attributes

const unsigned long CALIB_STATE_MASK = 0x00000001
 
const unsigned long CALIB_STATE_SHIFT = 0
 
const unsigned long SERVO_STATE_MASK = 0x00000002
 
const unsigned long SERVO_STATE_SHIFT = 1
 
const unsigned long POWER_STATE_MASK = 0x00000004
 
const unsigned long POWER_STATE_SHIFT = 2
 
const unsigned long SERVO_ALARM_MASK = 0x0007fff8
 
const unsigned long SERVO_ALARM_SHIFT = 3
 
const unsigned long DRIVER_TEMP_MASK = 0xff000000
 
const unsigned long DRIVER_TEMP_SHIFT = 24
 

Member Typedef Documentation

◆ DblArray3

typedef double OpenHRP::RobotHardwareService::DblArray3[3]

◆ DblArray6

typedef double OpenHRP::RobotHardwareService::DblArray6[6]

◆ DblSequence

◆ DblSequence3

typedef sequence<double, 3> OpenHRP::RobotHardwareService::DblSequence3

◆ DblSequence6

typedef sequence<double, 6> OpenHRP::RobotHardwareService::DblSequence6

◆ LongSequence

◆ LongSequenceSequence

◆ OctSequence

◆ StrSequence

Member Enumeration Documentation

◆ SwitchStatus

Enumerator
SWITCH_ON 
SWITCH_OFF 

Member Function Documentation

◆ addJointGroup()

boolean OpenHRP::RobotHardwareService::addJointGroup ( in string  gname,
in StrSequence  jnames 
)

add definition of joint group

Parameters
gnamename of the joint group
jnameslist of joint name
Returns
true if the group is added successfully, false otherwise

◆ calibrateInertiaSensor()

void OpenHRP::RobotHardwareService::calibrateInertiaSensor ( )

remove offsets on sensor outputs form gyro sensors and accelerometers.

This function takes 10[s]. Please keep the robot static.

◆ getStatus()

void OpenHRP::RobotHardwareService::getStatus ( out RobotState  rs)

get status of the robot

Parameters
rsstatus of the robot

◆ getStatus2()

void OpenHRP::RobotHardwareService::getStatus2 ( out RobotState2  rs)

get status of the robot

Parameters
rsstatus of the robot

◆ initializeJointAngle()

void OpenHRP::RobotHardwareService::initializeJointAngle ( in string  name,
in string  option 
)

initialize joint angle

Parameters
namejoint name, part name or "all"
optionstring of joint angle initialization

◆ lengthDigitalInput()

long OpenHRP::RobotHardwareService::lengthDigitalInput ( )

get digital input length of robot, non-applicable bits are nop

Returns
length of digital input in bytes

◆ lengthDigitalOutput()

long OpenHRP::RobotHardwareService::lengthDigitalOutput ( )

get digital output length of robot, non-applicable bits are nop

Returns
length of digital output in bytes

◆ power()

boolean OpenHRP::RobotHardwareService::power ( in string  name,
in SwitchStatus  _ss 
)

turn on/off power supply for motor driver

Parameters
namejoint name, part name or "all"
_ssSWITCH_ON or SWITCH_OFF
Return values
trueif turned on/off successfully
falseotherwise

◆ readDigitalInput()

boolean OpenHRP::RobotHardwareService::readDigitalInput ( out OctSequence  din)

get digital input to robot

Parameters
dOutwill hold the input bits as an array of bytes
Returns
true if applicable, false otherwise

◆ readDigitalOutput()

boolean OpenHRP::RobotHardwareService::readDigitalOutput ( out OctSequence  dOut)

get digital output to robot

Parameters
dOutwill hold the input bits as an array of bytes
Returns
true if applicable, false otherwise

◆ removeForceSensorOffset()

void OpenHRP::RobotHardwareService::removeForceSensorOffset ( )

remove offsets on sensor outputs form force/torque sensors.

This function takes 10[s]. Please keep the robot static and make sure that robot's sensors do not contact with any objects.

◆ servo()

boolean OpenHRP::RobotHardwareService::servo ( in string  name,
in SwitchStatus  _ss 
)

servo on/off

Parameters
namejoint name, part name or "all"
_ssSWITCH_ON or SWITCH_OFF
Return values
trueif servo on/off successfully
falseotherwise

◆ setServoErrorLimit()

void OpenHRP::RobotHardwareService::setServoErrorLimit ( in string  name,
in double  limit 
)

set the maximum joint servo error angle

Parameters
namejoint name, part name or "all"
limitthe maximum joint servo error angle[rad]

◆ setServoGainPercentage()

void OpenHRP::RobotHardwareService::setServoGainPercentage ( in string  name,
in double  percentage 
)

set the parcentage to the default servo gain

Parameters
namejoint name, part name or "all"
percentageto joint servo gain[0-100]

◆ writeDigitalOutput()

boolean OpenHRP::RobotHardwareService::writeDigitalOutput ( in OctSequence  dout)

set digital output from robot

Parameters
dOutsends the output from the robot in a byte array
Returns
true if applicable, false otherwise

◆ writeDigitalOutputWithMask()

boolean OpenHRP::RobotHardwareService::writeDigitalOutputWithMask ( in OctSequence  dout,
in OctSequence  mask 
)

set digital output from robot

Parameters
dOutsends the output from the robot in a byte array
maskbinary vector which selects output to be set
Returns
true if applicable, false otherwise

Member Data Documentation

◆ CALIB_STATE_MASK

const unsigned long OpenHRP::RobotHardwareService::CALIB_STATE_MASK = 0x00000001

◆ CALIB_STATE_SHIFT

const unsigned long OpenHRP::RobotHardwareService::CALIB_STATE_SHIFT = 0

◆ DRIVER_TEMP_MASK

const unsigned long OpenHRP::RobotHardwareService::DRIVER_TEMP_MASK = 0xff000000

◆ DRIVER_TEMP_SHIFT

const unsigned long OpenHRP::RobotHardwareService::DRIVER_TEMP_SHIFT = 24

◆ POWER_STATE_MASK

const unsigned long OpenHRP::RobotHardwareService::POWER_STATE_MASK = 0x00000004

◆ POWER_STATE_SHIFT

const unsigned long OpenHRP::RobotHardwareService::POWER_STATE_SHIFT = 2

◆ SERVO_ALARM_MASK

const unsigned long OpenHRP::RobotHardwareService::SERVO_ALARM_MASK = 0x0007fff8

◆ SERVO_ALARM_SHIFT

const unsigned long OpenHRP::RobotHardwareService::SERVO_ALARM_SHIFT = 3

◆ SERVO_STATE_MASK

const unsigned long OpenHRP::RobotHardwareService::SERVO_STATE_MASK = 0x00000002

◆ SERVO_STATE_SHIFT

const unsigned long OpenHRP::RobotHardwareService::SERVO_STATE_SHIFT = 1

The documentation for this interface was generated from the following file: