/home/ciesla/projects/svn.openrobotino.org/openrobotino1/lib/rec/robotino/com/c/EncoderInput.h File Reference
In "rec/robotino/com/c/EncoderInput.h" you can find functions for reading Robotino's bumper.
More...
#include "rec/robotino/com/c/globals.h"
#include "rec/robotino/com/c/Com.h"
Go to the source code of this file.
Detailed Description
In "rec/robotino/com/c/EncoderInput.h" you can find functions for reading Robotino's bumper.
Use EncoderInput_construct() to create a new encoder input object. Associate the bumper object with a com object using EncoderInput_setComId(). Use EncoderInput_value() to read the encoder input's state.
Function Documentation
DLLEXPORT EncoderInputId EncoderInput_construct |
( |
|
) |
|
Construct an encoder input object
- Returns:
- Returns the ID of the newly constructed encoder input object.
DLLEXPORT BOOL EncoderInput_destroy |
( |
EncoderInputId |
id |
) |
|
Destroy the encoder input object assigned to id
- Parameters:
-
| id | The id of the encoder input object to be destroyed |
- Returns:
- Returns TRUE (1) on success. Returns FALSE (0) if the given EncoderInputId is invalid.
DLLEXPORT int EncoderInput_position |
( |
EncoderInputId |
id |
) |
|
- Parameters:
-
| id | The id of the encoder input object to be read |
- Returns:
- Actual position in ticks since power on or EncoderInput_resetPosition
DLLEXPORT BOOL EncoderInput_resetPosition |
( |
EncoderInputId |
id |
) |
|
Set the current position to zero.
- Parameters:
-
| id | The id of the encoder input object to be read |
- Returns:
- Returns TRUE (1) on success. Returns FALSE (0) if the given EncoderInputId is invalid.
DLLEXPORT BOOL EncoderInput_setComId |
( |
EncoderInputId |
id, |
|
|
ComId |
comId | |
|
) |
| | |
Associated a encoder input object with a communication interface, i.e. binding the encoder input to a specific Robotino
- Returns:
- Returns TRUE (1) on success. Returns FALSE (0) if the given EncoderInputId or ComId is invalid.
DLLEXPORT int EncoderInput_velocity |
( |
EncoderInputId |
id |
) |
|
- Parameters:
-
| id | The id of the encoder input object to be read |
- Returns:
- The actual velocity in ticks/s