Functions |
DLL_RESULT | TC4GetWatchdogActive (unsigned int *pWatchdogActive) |
| This function checks if watchdog is active. The watchdog is active when this parameter and the "WatchdogEnable" parameter are set to 1.
|
DLL_RESULT | TC4GetWatchdogAutoActiveTime (double *pTimeInSeconds) |
| This function gets the time, at which the watchdog will start after Powerup automatically. (The watchdog only starts automatically when it is enable and the AutoActiveTime is higher than 0.)
|
DLL_RESULT | TC4GetWatchdogEnable (unsigned int *pWatchdogEnable) |
| This function checks if watchdog is enabled.
|
DLL_RESULT | TC4GetWatchdogSupported (unsigned int *pIsSupported) |
| This function checks if watchdog is supported on actual device.
|
DLL_RESULT | TC4GetWatchdogTimeoutTime (double *pTimeInSeconds) |
| This function gets the watchdog time out. If this time runs out without resetting watchdog, then watchdog error occurs.
|
DLL_RESULT | TC4SetWatchdogActive (unsigned int watchdogActive) |
| This function is used to set watchdog active. The watchdog is active when this parameter and the "watchdogEnable" parameter are both set to 1. The user can turn the watchdog on or off by setting this parameter. To turn the watchdog on or off temporarily, this parameter should be used instead of "watchdogEnable", because it is not permanently stored in the flash.
|
DLL_RESULT | TC4SetWatchdogAutoActiveTime (double timeInSeconds) |
| This function sets the time, at which the watchdog will start after Powerup automatically. (The watchdog only starts automatically when it is enable and the AutoActiveTime is higher than 0.)
|
DLL_RESULT | TC4SetWatchdogEnable (unsigned int watchdogEnable) |
| This function is used to set watchdog enabled.
|
DLL_RESULT | TC4SetWatchdogReset (void) |
| This function is used to reset the internal watchdog timer. The watchdog must be reset at regular intervals. If not the internal watchdog timer runs out and the device is turned off with a watchdog error.
|
DLL_RESULT | TC4SetWatchdogTimeoutTime (double timeInSeconds) |
| This function sets the watchdog time out. If this time runs out without resetting watchdog, then watchdog error occurs.
|
Detailed Description
The watchdog feature is introduced, because the TopCon device can not detect if the RS232 communication failed.
If the watchdog is activated, it must receive a reset command at regular intervals, otherwise the internal watchdog timer runs out and the device is turned off with a watchdog error.
These functions are used to get information about watchdog and configure it.
Function Documentation
DLL_RESULT TC4GetWatchdogActive |
( |
unsigned int * |
pWatchdogActive | ) |
|
This function checks if watchdog is active. The watchdog is active when this parameter and the "WatchdogEnable" parameter are set to 1.
- Parameters:
-
[out] | pWatchdogActive | 0: Inactive
1: Active |
- Returns:
DLL_SUCCESS
for success or DLL_FAIL
or other value if an error occurs
DLL_RESULT TC4GetWatchdogAutoActiveTime |
( |
double * |
pTimeInSeconds | ) |
|
This function gets the time, at which the watchdog will start after Powerup automatically. (The watchdog only starts automatically when it is enable and the AutoActiveTime is higher than 0.)
- Parameters:
-
[out] | pTimeInSeconds | [100ms] |
- Returns:
DLL_SUCCESS
for success or DLL_FAIL
or other value if an error occurs
DLL_RESULT TC4GetWatchdogEnable |
( |
unsigned int * |
pWatchdogEnable | ) |
|
This function checks if watchdog is enabled.
- Parameters:
-
[out] | pWatchdogEnable | 0: Disable
1: Enabled |
- Returns:
DLL_SUCCESS
for success or DLL_FAIL
or other value if an error occurs
DLL_RESULT TC4GetWatchdogSupported |
( |
unsigned int * |
pIsSupported | ) |
|
This function checks if watchdog is supported on actual device.
- Parameters:
-
[out] | pIsSupported | 0: false
1: true |
- Returns:
DLL_SUCCESS
for success or DLL_FAIL
or other value if an error occurs
DLL_RESULT TC4GetWatchdogTimeoutTime |
( |
double * |
pTimeInSeconds | ) |
|
This function gets the watchdog time out. If this time runs out without resetting watchdog, then watchdog error occurs.
- Parameters:
-
[out] | pTimeInSeconds | [100ms] |
- Returns:
DLL_SUCCESS
for success or DLL_FAIL
or other value if an error occurs
DLL_RESULT TC4SetWatchdogActive |
( |
unsigned int |
watchdogActive | ) |
|
This function is used to set watchdog active. The watchdog is active when this parameter and the "watchdogEnable" parameter are both set to 1. The user can turn the watchdog on or off by setting this parameter. To turn the watchdog on or off temporarily, this parameter should be used instead of "watchdogEnable", because it is not permanently stored in the flash.
- Parameters:
-
[in] | watchdogActive | 0: Inactive
1: Active |
- Returns:
DLL_SUCCESS
for success or DLL_FAIL
or other value if an error occurs
DLL_RESULT TC4SetWatchdogAutoActiveTime |
( |
double |
timeInSeconds | ) |
|
This function sets the time, at which the watchdog will start after Powerup automatically. (The watchdog only starts automatically when it is enable and the AutoActiveTime is higher than 0.)
- Parameters:
-
- Returns:
DLL_SUCCESS
for success or DLL_FAIL
or other value if an error occurs
DLL_RESULT TC4SetWatchdogEnable |
( |
unsigned int |
watchdogEnable | ) |
|
This function is used to set watchdog enabled.
- Parameters:
-
[in] | watchdogEnable | 0: Disable
1: Enabled |
- Returns:
DLL_SUCCESS
for success or DLL_FAIL
or other value if an error occurs
DLL_RESULT TC4SetWatchdogReset |
( |
void |
| ) |
|
This function is used to reset the internal watchdog timer. The watchdog must be reset at regular intervals. If not the internal watchdog timer runs out and the device is turned off with a watchdog error.
- Returns:
DLL_SUCCESS
for success or DLL_FAIL
or other value if an error occurs
DLL_RESULT TC4SetWatchdogTimeoutTime |
( |
double |
timeInSeconds | ) |
|
This function sets the watchdog time out. If this time runs out without resetting watchdog, then watchdog error occurs.
- Parameters:
-
- Returns:
DLL_SUCCESS
for success or DLL_FAIL
or other value if an error occurs