Zpal-radio-utils#

Defines a platform abstraction layer for the Z-Wave platform independent radio utils.

Functions#

zpal_radio_protocol_mode_t
zpal_radio_region_get_protocol_mode(uint32_t region)

Function to get region Protocol mode if supported by Radio.

bool
zpal_radio_protocol_mode_supports_long_range(zpal_radio_protocol_mode_t mode)

Function to get if giver Protocol mode supports Z-Wave Long Range.

bool
zpal_radio_region_is_long_range(zpal_radio_region_t region)

Function to check if specified region has a long range channel.

bool
zpal_radio_region_is_long_range_backup(zpal_radio_region_t region)

Function to check if specified region has a backup long range channel.

bool
zpal_radio_region_is_long_range_end_device(zpal_radio_region_t region)

Function to check if specified region has End Device long range channels.

bool
zpal_radio_region_has_long_range_support(zpal_radio_region_t region)

Function to get if specified region has either long range or backup long range channels or both.

zpal_radio_region_t
zpal_radio_get_valid_region(zpal_radio_region_t region)

Function to get valid region value.

Function Documentation#

zpal_radio_region_get_protocol_mode#

zpal_radio_protocol_mode_t zpal_radio_region_get_protocol_mode (uint32_t region)

Function to get region Protocol mode if supported by Radio.

Parameters
[in]region

Describe where radio is located. zpal_radio_region_t or @ ref zpal_radio_region_tf_t.

Returns


Definition at line 38 of file /mnt/raid/workspaces/ws.5ZeoF8fvV/overlay/gsdk/protocol/z-wave/PAL/inc/zpal_radio_utils.h

zpal_radio_protocol_mode_supports_long_range#

bool zpal_radio_protocol_mode_supports_long_range (zpal_radio_protocol_mode_t mode)

Function to get if giver Protocol mode supports Z-Wave Long Range.

Parameters
[in]mode

Protocol mode.

Returns

  • True if given Protocol mode supports Z-Wave Long Range, false if not.


Definition at line 46 of file /mnt/raid/workspaces/ws.5ZeoF8fvV/overlay/gsdk/protocol/z-wave/PAL/inc/zpal_radio_utils.h

zpal_radio_region_is_long_range#

bool zpal_radio_region_is_long_range (zpal_radio_region_t region)

Function to check if specified region has a long range channel.

Parameters
[in]region

Describe where radio is located.

Returns

  • True if specified region has long range channel.


Definition at line 54 of file /mnt/raid/workspaces/ws.5ZeoF8fvV/overlay/gsdk/protocol/z-wave/PAL/inc/zpal_radio_utils.h

zpal_radio_region_is_long_range_backup#

bool zpal_radio_region_is_long_range_backup (zpal_radio_region_t region)

Function to check if specified region has a backup long range channel.

Parameters
[in]region

Describe where radio is located.

Returns

  • True if specified region has backup long range channel.


Definition at line 62 of file /mnt/raid/workspaces/ws.5ZeoF8fvV/overlay/gsdk/protocol/z-wave/PAL/inc/zpal_radio_utils.h

zpal_radio_region_is_long_range_end_device#

bool zpal_radio_region_is_long_range_end_device (zpal_radio_region_t region)

Function to check if specified region has End Device long range channels.

Parameters
[in]region

Describe where radio is located.

Returns

  • True if specified region has End Device long range channels.


Definition at line 71 of file /mnt/raid/workspaces/ws.5ZeoF8fvV/overlay/gsdk/protocol/z-wave/PAL/inc/zpal_radio_utils.h

zpal_radio_region_has_long_range_support#

bool zpal_radio_region_has_long_range_support (zpal_radio_region_t region)

Function to get if specified region has either long range or backup long range channels or both.

Parameters
[in]region

Describe where radio is located.

Returns

  • True if specified region has either long range or backup long range channels or both.


Definition at line 80 of file /mnt/raid/workspaces/ws.5ZeoF8fvV/overlay/gsdk/protocol/z-wave/PAL/inc/zpal_radio_utils.h

zpal_radio_get_valid_region#

zpal_radio_region_t zpal_radio_get_valid_region (zpal_radio_region_t region)

Function to get valid region value.

Parameters
[in]region

Describe where radio is located.

If region is not specified (default value), it would return region set as default.

Returns

  • The valid region value


Definition at line 90 of file /mnt/raid/workspaces/ws.5ZeoF8fvV/overlay/gsdk/protocol/z-wave/PAL/inc/zpal_radio_utils.h