/home/ciesla/projects/svn.openrobotino.org/openrobotino1/lib/rec/robotino/com/c/PowerManagement.h File Reference

In "rec/robotino/com/c/PowerManagement.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.

Defines

#define INVALID_POWERMANAGEMENTID   -1

Typedefs

typedef int PowerManagementId

Functions

DLLEXPORT PowerManagementId PowerManagement_construct ()
DLLEXPORT BOOL PowerManagement_destroy (PowerManagementId id)
DLLEXPORT BOOL PowerManagement_setComId (PowerManagementId id, ComId comId)
DLLEXPORT float PowerManagement_current (PowerManagementId id)
DLLEXPORT float PowerManagement_voltage (PowerManagementId id)


Detailed Description

In "rec/robotino/com/c/PowerManagement.h" you can find functions for reading Robotino's bumper.

Use PowerManagement_construct() to create a new power management object. Associate the power management object with a com object using PowerManagement_setComId(). Use PowerManagement_open() to open the power management. Use PowerManagement_close() to open the power management. Use PowerManagement_isOpened() to check if the power management is opened. Use PowerManagement_isClosed() to check if the power management is closed.


Function Documentation

DLLEXPORT PowerManagementId PowerManagement_construct (  ) 

Construct an power management object

Returns:
Returns the ID of the newly constructed power management object.

DLLEXPORT float PowerManagement_current ( PowerManagementId  id  ) 

Retrieves the current power drain.

Parameters:
id The id of the power management object.
Returns:
The power drain in mA.

DLLEXPORT BOOL PowerManagement_destroy ( PowerManagementId  id  ) 

Destroy the power management object assigned to id

Parameters:
id The id of the power management object to be destroyed
Returns:
Returns TRUE (1) on success. Returns FALSE (0) if the given PowerManagementId is invalid.

DLLEXPORT BOOL PowerManagement_setComId ( PowerManagementId  id,
ComId  comId 
)

Associated a power management object with a communication interface, i.e. binding the power management to a specific Robotino

Returns:
Returns TRUE (1) on success. Returns FALSE (0) if the given PowerManagementId or ComId is invalid.

DLLEXPORT float PowerManagement_voltage ( PowerManagementId  id  ) 

Retrieves the battery voltage.

Parameters:
id The id of the power management object.
Returns:
Battery voltage in V.


Generated on Fri Aug 17 15:09:42 2012 for rec_robotino_com_c by  doxygen 1.5.5