Zpal-watchdog#

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.

Functions#

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.

Function Documentation#

zpal_is_watchdog_enabled#

bool zpal_is_watchdog_enabled (void )

Returns whether the watchdog is enabled.

Parameters
N/A

Returns

  • True if watchdog is enabled, false if not.


Definition at line 45 of file /mnt/raid/workspaces/ws.Mh9rMZz8x/overlay/gsdk/protocol/z-wave/PAL/inc/zpal_watchdog.h

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.


Definition at line 52 of file /mnt/raid/workspaces/ws.Mh9rMZz8x/overlay/gsdk/protocol/z-wave/PAL/inc/zpal_watchdog.h

zpal_feed_watchdog#

void zpal_feed_watchdog (void )

Feeds the watchdog.

Parameters
N/A

Definition at line 57 of file /mnt/raid/workspaces/ws.Mh9rMZz8x/overlay/gsdk/protocol/z-wave/PAL/inc/zpal_watchdog.h