yarp-devices
Loading...
Searching...
No Matches
Classes | Public Member Functions | Public Attributes | List of all members
Jr3Mbed_ParamsParser Class Reference

#include <Jr3Mbed_ParamsParser.h>

Inheritance diagram for Jr3Mbed_ParamsParser:
Jr3Mbed

Classes

struct  parser_version_type
 

Public Member Functions

bool parseParams (const yarp::os::Searchable &config) override
 
std::string getDeviceClassName () const override
 
std::string getDeviceName () const override
 
std::string getDocumentationOfDeviceParams () const override
 
std::vector< std::string > getListOfParams () const override
 

Public Attributes

const std::string m_device_classname = {"Jr3Mbed"}
 
const std::string m_device_name = {"Jr3Mbed"}
 
bool m_parser_is_strict = false
 
const parser_version_type m_parser_version = {}
 
const std::string m_canId_defaultValue = {"0"}
 
const std::string m_name_defaultValue = {""}
 
const std::string m_filter_defaultValue = {"0.0"}
 
const std::string m_ackTimeout_defaultValue = {"0.25"}
 
const std::string m_fullScales_defaultValue = {""}
 
const std::string m_asyncPeriod_defaultValue = {"0.0"}
 
const std::string m_monitorPeriod_defaultValue = {"0.1"}
 
const std::string m_diagnosticsPeriod_defaultValue = {"0.0"}
 
int m_canId = {0}
 
std::string m_name = {}
 
double m_filter = {0.0}
 
double m_ackTimeout = {0.25}
 
std::vector< int > m_fullScales = {}
 
double m_asyncPeriod = {0.0}
 
double m_monitorPeriod = {0.1}
 
double m_diagnosticsPeriod = {0.0}
 

Detailed Description

This class is the parameters parser for class Jr3Mbed.

These are the used parameters:

Group name Parameter name Type Units Default Value Required Description Notes
- canId int - 0 0 CAN bus ID 1-127
- name string - - 0 sensor name -
- filter double Hz 0.0 0 cutoff frequency for low-pass filter 0.0-655.35
- ackTimeout double s 0.25 0 CAN acknowledge timeout -
- fullScales vector<int> N, daNm - 0 full scales for each axis 3*N, 3*daNm
- asyncPeriod double s 0.0 0 period of asynchronous publishing mode 0.0: disabled
- monitorPeriod double s 0.1 0 monitor thread period -
- diagnosticsPeriod double s 0.0 0 diagnostics period less than 8 seconds

The device can be launched by yarpdev using one of the following examples (with and without all optional parameters):

yarpdev --device Jr3Mbed --canId 0 --name <optional_value> --filter 0.0 --ackTimeout 0.25 --fullScales <optional_value> --asyncPeriod 0.0 --monitorPeriod 0.1 --diagnosticsPeriod 0.0
yarpdev --device Jr3Mbed

The documentation for this class was generated from the following files: