Zpal-watchdog

Defines a platform abstraction layer for the Z-Wave watchdog. More...

Collaboration diagram for Zpal-watchdog:

Functions
void	zpal_watchdog_init (void)
	Initialize watchdog before use, typically the next call will be zpal_enable_watchdog.
bool	zpal_is_watchdog_enabled (void)
	Returns whether the watchdog is enabled.
void	zpal_enable_watchdog (bool enable)
	Enables or disables the watchdog based on the input.
void	zpal_feed_watchdog (void)
	Feeds the watchdog.

Detailed Description

Defines a platform abstraction layer for the Z-Wave watchdog.

How to use the watchdog API

The following outlines an example of use:

1. Enable the watchdog functionality with zpal_enable_watchdog().
2. Periodically invoke zpal_feed_watchdog() to restart watchdog.
3. If watchdog needs to be disabled, check current state with zpal_is_watchdog_enabled(), disable it by invoking zpal_enable_watchdog(), then restore previous state.

Note:

• Recommended watchdog timeout period is 1 second.

Function Documentation

zpal_enable_watchdog()

void zpal_enable_watchdog

(

bool

enable

)

Enables or disables the watchdog based on the input.

Parameters

[in]

enable

true enables the watchdog and false disables it.

zpal_feed_watchdog()

void zpal_feed_watchdog

(

void

)

Feeds the watchdog.

zpal_is_watchdog_enabled()

bool zpal_is_watchdog_enabled

(

void

)

Returns whether the watchdog is enabled.

Returns

True if watchdog is enabled, false if not.

zpal_watchdog_init()

void zpal_watchdog_init

(

void

)

Initialize watchdog before use, typically the next call will be zpal_enable_watchdog.