beautypg.com

Return value, Portability, Functions for accessing the hardware monitor – Rockwell Automation 6182 SDK User Manual

Page 80

background image

4–40

RAC6182-Specific Extensions to the CE API

Publication 6182-UM002B-EN-P

Return Value
Possible return values are represented by macros defined in usertimers.h:

USER_TIMER_OK - Successfully claimed or released timer

USER_TIMER_INVALID_TIMER - Timer number not present on

system

USER_TIMER_NOT_CLAIMED - Another application already has

claimed the timer so this application could not claim it

USER_TIMER_INVALID_PARAMETER - Invalid value

Portability
This function is specific to the RAC6182 hardware.

The RAC6182 platform provides a hardware monitor driver that can be
called by applications to monitor the status of various board parameters,
to set "warning levels", for these parameters, and to receive warning
event signals when values of the monitored parameters fall outside the
warning levels. In addition, functions for power-fail monitoring, board
reset and reboot are provided here.

The parameters that can be monitored are:

12-Volt power supply voltage

5-Volt power supply voltage

3.3-Volt power supply voltage

3-Volt battery voltage

Board temperature

Power fail

Note that some of the monitored parameters are of fundamentally
different types. Therefore the units of the parameters, will vary
according to the parameter being monitored. For example, when an
application sets the warning levels for the 5V-power supply monitor, the
units of the levels specified in HardwareMonitor API functions will be
Volts. However, when an application sets board temperature warning
levels, the application must specified temperature in degrees Celsius.
Parameter units are described in more detail below for each API
function.

Functions for Accessing

the Hardware Monitor

This manual is related to the following products: