Zpal-radio-utils#
Defines a platform abstraction layer for the Z-Wave platform independent radio utils.
Functions#
Function to get region Protocol mode if supported by Radio.
Function to get if giver Protocol mode supports Z-Wave Long Range.
Function to check if specified region has a long range channel.
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, zpal_radio_lr_channel_config_t eLrChCfg)
Function to get region Protocol mode if supported by Radio.
[in] | region | Describe where radio is located. zpal_radio_region_t or @ ref zpal_radio_region_tf_t. |
[in] | eLrChCfg | Active long range channel configuration. |
Returns
ZPAL_RADIO_PROTOCOL_MODE_1, ZPAL_RADIO_PROTOCOL_MODE_2, ZPAL_RADIO_PROTOCOL_MODE_3 or ZPAL_RADIO_PROTOCOL_MODE_4 if supported by Radio. ZPAL_RADIO_PROTOCOL_MODE_UNDEFINED if not supported by Radio.
39
of file /mnt/raid/workspaces/ws.6QOxxjIBR/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.
[in] | mode | Protocol mode. |
Returns
True if given Protocol mode supports Z-Wave Long Range, false if not.
47
of file /mnt/raid/workspaces/ws.6QOxxjIBR/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.
[in] | region | Describe where radio is located. |
Returns
True if specified region has long range channel.
55
of file /mnt/raid/workspaces/ws.6QOxxjIBR/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.
[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
65
of file /mnt/raid/workspaces/ws.6QOxxjIBR/overlay/gsdk/protocol/z-wave/PAL/inc/zpal_radio_utils.h