Architecture:Specification of BABEL Interfaces

From The BABEL Development Site
Revision as of 22:47, 17 May 2009 by Jlblanco (talk | contribs) (DRV_IOBOARD)
Previous: Overview Next: Modules


Interfaces

Overview

In this page we present a number of standardized interfaces (IFs) for each layer of modules in our architecture. One given module may implement only one or several such interfaces simultaneously, a specially common case in the HAD layer.

Each interface is implemented in one and only one BABEL service groups, whose services are specified here. Data types are given in the standard BABEL description language (BDL), with some small additions declared under the namespace BABEL::COMMON, as shown in this Appendix.

The input parameter "devIndex" deserves more discussion, since it solves the problem of multiple copies of hardware devices with just one software module. This parameter is a zero-based index which specifies which device is being referenced for each access. The number of different devices is stored in the RPD (see section 4). Only modules in layers 2 and 3 are supposed to know about this parameter, so high-level modules never need to worry about how many hardware devices are present on the robot.

Developers of HAD modules are strongly encouraged to do implement real support for "devIndex". For example, at module start-up, the RPD may be checked to discover how many devices are present on the robot and what are they parameters (configuration ".ini"-like text block). An internal list of objects can be hold within the BABEL module, one for each physical device, so each request is directed to the appropriate device.


Hardware Abstraction Drivers (HAD) interfaces

The next section (Modules) contains a list of existing modules and the corresponding implemented IFs.

DRV_IOBOARD

BABEL service group BABEL services to implement

DRV_IOBOARD

For devices with capabilities for at least one of the following: Controlling of sonars range sensors, servos, ADC and DAC.

<cpp>

getCountADC(

in short devIndex, out unsigned short count ) </cpp>

Returns the number of Analog-to-Digital converters (ADC) available as inputs on this device.

<cpp>

getReadingsADC(

in short devIndex, out COMMMON::SeqOfFloats readings, out boolean error ) </cpp>

Return the latest ADC readings from the device. They are given in volts and are supposed to be acquired in last few milliseconds (Max. 1 sec.). Error is true on any error.

<cpp>

getCountDAC(

in short devIndex, out unsigned short count ) </cpp>

Returns the number of Digital-to-Analog converters (DAC) available as outputs on this device.

<cpp>

setOutputDAC(

in short devIndex, in unsigned short channel, in float value, out boolean error ) </cpp>

Sets an analog output. Desired value is given in volts, first channel is 0; error is true on failure.

<cpp>

getCountSonars(

in short devIndex, out unsigned short count ) </cpp>

Returns the number of sonars-range-finders attached to this device.

<cpp>

getReadingsSonars(

in short devIndex, out COMMMON::SeqOfFloats readings, out boolean error ) </cpp>

Return the latest sonars readings from the device. They are given in meters and are supposed to be acquired in last few milliseconds (Max. 1 sec.). Error is true on any error.

<cpp>

getCountPWM(

in short devIndex, out unsigned short count ) </cpp>

Returns the number of PWM generators available as outputs on this device. They can be used to control servos.

<cpp>

setOutputPWM(

in short devIndex, in unsigned short channel, in float value, out boolean error ) </cpp>

Sets the PWM “on” period, given in seconds. Typical values are 0.0002-0.004 secs; first channel is 0; error is true on failure.

DRV_IOBOARD

BABEL service group BABEL services to implement

DRV_IOBOARD

For devices with capabilities for at least one of the following: Controlling of sonars range sensors, servos, ADC and DAC.

<cpp>

getCountADC(

in short devIndex, out unsigned short count ) </cpp>

Returns the number of Analog-to-Digital converters (ADC) available as inputs on this device.

<cpp>

getReadingsADC(

in short devIndex, out COMMMON::SeqOfFloats readings, out boolean error ) </cpp>

Return the latest ADC readings from the device. They are given in volts and are supposed to be acquired in last few milliseconds (Max. 1 sec.). Error is true on any error.

<cpp>

getCountDAC(

in short devIndex, out unsigned short count ) </cpp>

Returns the number of Digital-to-Analog converters (DAC) available as outputs on this device.

<cpp>

setOutputDAC(

in short devIndex, in unsigned short channel, in float value, out boolean error ) </cpp>

Sets an analog output. Desired value is given in volts, first channel is 0; error is true on failure.

<cpp>

getCountSonars(

in short devIndex, out unsigned short count ) </cpp>

Returns the number of sonars-range-finders attached to this device.

<cpp>

getReadingsSonars(

in short devIndex, out COMMMON::SeqOfFloats readings, out boolean error ) </cpp>

Return the latest sonars readings from the device. They are given in meters and are supposed to be acquired in last few milliseconds (Max. 1 sec.). Error is true on any error.

<cpp>

getCountPWM(

in short devIndex, out unsigned short count ) </cpp>

Returns the number of PWM generators available as outputs on this device. They can be used to control servos.

<cpp>

setOutputPWM(

in short devIndex, in unsigned short channel, in float value, out boolean error ) </cpp>

Sets the PWM “on” period, given in seconds. Typical values are 0.0002-0.004 secs; first channel is 0; error is true on failure.

Common Sensory Interface

Common Actions Interface