Zpal-radio#

zpal_radio_mode_t#

zpal_radio_mode_t

zpal_radio_wakeup_t#

zpal_radio_wakeup_t

Wakeup interval for the radio.

A FLiRS node will use 250 or 1000 ms interval, all other nodes should be configured as always listening.

zpal_radio_crc_t#

zpal_radio_crc_t

Enumeration containing supported checksum types in Z-Wave.

zpal_radio_speed_t#

zpal_radio_speed_t

Enumeration containing supported baud rates.

zpal_radio_lr_channel_t#

zpal_radio_lr_channel_t

Enumeration containing Long Range Channels.

zpal_radio_zwave_channel_t#

zpal_radio_zwave_channel_t

Enumeration containing Z-Wave channels.

zpal_radio_protocol_mode_t#

zpal_radio_protocol_mode_t

Enumeration containing Z-Wave channels known as protocol modes.

zpal_radio_lr_channel_config_t#

zpal_radio_lr_channel_config_t

List of LR channel configuration.

Used to select the correct phy configuration.

zpal_radio_region_t#

zpal_radio_region_t

Enumeration official Z-Wave regions.

zpal_radio_tx_power_t#

zpal_radio_tx_power_t

Enumeration containing Tx power settings.

zpal_radio_header_type_t#

zpal_radio_header_type_t

Z-Wave Frame header format types.

zpal_radio_event_t#

zpal_radio_event_t

Enumeratio radio events.

zpal_radio_status_t#

zpal_radio_status_t

node_id_t#

typedef uint16_t node_id_t

Node ID type.

zpal_tx_power_t#

typedef int16_t zpal_tx_power_t

Parameter type to store deci dBm values.

zpal_radio_callback_t#

typedef void(* zpal_radio_callback_t) (zpal_radio_event_t event) )(zpal_radio_event_t event)

zpal_radio_receive_handler_t#

typedef void(* zpal_radio_receive_handler_t) (zpal_radio_rx_parameters_t *rx_parameters, zpal_radio_receive_frame_t *frame) )(zpal_radio_rx_parameters_t *rx_parameters, zpal_radio_receive_frame_t *frame)

Function pointer declaration for handling of received frames.

When a frame is received this function will be invoked in order to process the frame.

zpal_radio_set_network_ids#

void zpal_radio_set_network_ids (uint32_t home_id, node_id_t node_id, zpal_radio_mode_t mode, uint8_t home_id_hash)

Sets the home ID, the node ID and the radio mode.

zpal_radio_init#

void zpal_radio_init (zpal_radio_profile_t *const profile)

Initializes the radio.

zpal_radio_change_region#

zpal_status_t zpal_radio_change_region (zpal_radio_region_t eRegion, zpal_radio_lr_channel_config_t eLrChCfg)

Function used to change region and Long Range mode at the same time.

Returns

• ZPAL_STATUS_OK if the region was successfully changed and ZPAL_STATUS_FAIL otherwise.

zpal_radio_get_region#

zpal_radio_region_t zpal_radio_get_region (void )

Function for getting REGION runtime.

Returns

• Current region.

zpal_radio_transmit#

zpal_status_t zpal_radio_transmit (zpal_radio_transmit_parameter_t const *const tx_parameters, uint8_t frame_header_length, uint8_t const *const frame_header_buffer, uint8_t frame_payload_length, uint8_t const *const frame_payload_buffer, uint8_t use_lbt, int8_t tx_power)

Function for transmitting a Z-Wave frame though the radio.

Returns

• ZPAL_STATUS_OK if the data was successfully transmit, ZPAL_STATUS_BUFFER_FULL when queue is full.

zpal_radio_transmit_beam#

zpal_status_t zpal_radio_transmit_beam (zpal_radio_transmit_parameter_t const *const tx_parameters, uint8_t beam_data_len, uint8_t const *const beam_data, int8_t tx_power)

Function for transmitting a Z-Wave Beam frame though the radio.

Returns

• ZPAL_STATUS_OK if the data was successfully transmit, ZPAL_STATUS_BUFFER_FULL when queue is full.

zpal_radio_start_receive#

void zpal_radio_start_receive (void )

Starts the receiver and enables reception of frames.

If the receiver is already started, nothing will happen.

zpal_radio_get_last_received_frame#

void zpal_radio_get_last_received_frame (void )

Function to get last received frame.

If a frame is received, zpal_radio_receive_handler_t will be invoked.

zpal_radio_power_down#

void zpal_radio_power_down (void )

Powers down the radio transceiver.

zpal_radio_get_protocol_mode#

zpal_radio_protocol_mode_t zpal_radio_get_protocol_mode (void )

Function to get the protocol mode used in the configured region.

Returns

• Protocol mode used in the configured region.

zpal_radio_get_last_beam_channel#

zpal_radio_zwave_channel_t zpal_radio_get_last_beam_channel (void )

Get last beam channel.

Retrieve the channel on which we have last received a beam on.

Returns

• Last beam channel.

zpal_radio_get_last_beam_rssi#

int8_t zpal_radio_get_last_beam_rssi (void )

Get last beam RSSI.

Retrieve the RSSI of the last beam received.

Returns

• Last beam rssi.

zpal_radio_set_lbt_level#

void zpal_radio_set_lbt_level (uint8_t channel, int8_t level)

Function for setting the LBT RSSI level.

zpal_radio_enable_rx_broadcast_beam#

void zpal_radio_enable_rx_broadcast_beam (bool enable)

Enable or disables reception of broadcast beam.

Enable or disable FLiRS broadcast address.

zpal_radio_clear_tx_timers#

void zpal_radio_clear_tx_timers (void )

Function for clearing current Channel Transmit timers.

zpal_radio_clear_network_stats#

void zpal_radio_clear_network_stats (void )

Function for clearing current Network statistics.

zpal_radio_rf_channel_statistic_clear#

void zpal_radio_rf_channel_statistic_clear (zpal_radio_zwave_channel_t zwavechannel)

Function for clearing specified rf channel statistics.

zpal_radio_rf_channel_statistic_get#

bool zpal_radio_rf_channel_statistic_get (zpal_radio_zwave_channel_t zwavechannel, zpal_radio_rf_channel_statistic_t * p_radio_channel_statistic)

Returns

• true If delivered structure has been filled with current statistic for specified zwavechannel.

• false If delivered structure has NOT been filled with any channel statistics.

zpal_radio_rf_channel_statistic_tx_channel_set#

void zpal_radio_rf_channel_statistic_tx_channel_set (zpal_radio_zwave_channel_t zwavechannel)

Function for setting the zwavechannel used when calling zpal_radio_rf_channel_statistic_tx_frames, zpal_radio_rf_channel_statistic_tx_retries and zpal_radio_rf_channel_statistic_tx_lbt_failures.

zpal_radio_rf_channel_statistic_tx_frames#

void zpal_radio_rf_channel_statistic_tx_frames (void )

Function for incrementing the rf channel tx frame statistic.

zpal_radio_rf_channel_statistic_tx_retries#

void zpal_radio_rf_channel_statistic_tx_retries (void )

Function for incrementing the rf channel tx retries statistic.

zpal_radio_rf_channel_statistic_tx_lbt_failures#

void zpal_radio_rf_channel_statistic_tx_lbt_failures (void )

Function for incrementing the rf channel tx lbt failures.

zpal_radio_rf_channel_statistic_background_rssi_average_update#

void zpal_radio_rf_channel_statistic_background_rssi_average_update (zpal_radio_zwave_channel_t zwavechannel, int8_t rssi)

Function for updating the rf channel background noise rssi average statistic.

zpal_radio_rf_channel_statistic_end_device_rssi_average_update#

void zpal_radio_rf_channel_statistic_end_device_rssi_average_update (zpal_radio_zwave_channel_t zwavechannel, int8_t rssi)

Function for updating the rf channel end device noise rssi average statistic.

zpal_radio_get_background_rssi#

zpal_status_t zpal_radio_get_background_rssi (uint8_t channel, int8_t * rssi)

Returns the background RSSI.

Returns

• ZPAL_STATUS_OK if a valid RSSI value is available and read. ZPAL_STATUS_FAIL if an RSSI value cannot be read. The value of *rssi is invalid. ZPAL_STATUS_INVALID_ARGUMENT if rssi is NULL.

zpal_radio_get_default_tx_power#

zpal_tx_power_t zpal_radio_get_default_tx_power (void )

Function for getting the default tx power in deci dBm.

Returns

• The default RF TX power in deci dBm

zpal_radio_get_reduce_tx_power#

uint8_t zpal_radio_get_reduce_tx_power (void )

Function for getting the current reduce RF tx power compared to the default normal power in dBm.

Returns

• The current reduce RF TX power in dBm.

zpal_radio_enable_flirs#

void zpal_radio_enable_flirs (void )

Allows the radio to go into FLiRS receive mode.

zpal_radio_is_flirs_enabled#

bool zpal_radio_is_flirs_enabled (void )

Returns whether FLiRS mode is enabled in the radio.

Returns

• True when FLiRS mode is enabled.

zpal_radio_start_receive_after_power_down#

void zpal_radio_start_receive_after_power_down (bool wait_for_beam)

Starts the receiver after power down.

zpal_radio_abort#

void zpal_radio_abort (void )

Turn radio off without changing configuration.

zpal_radio_reset_after_beam_receive#

void zpal_radio_reset_after_beam_receive (bool start_receiver)

Resets the radio configuration to receive mode after having received a beam.

zpal_radio_is_fragmented_beam_enabled#

bool zpal_radio_is_fragmented_beam_enabled (void )

Returns whether use of fragmented beams is enabled or not for the active region.

Returns

• True if use of fragmented beams is enabled, false otherwise.

zpal_radio_is_receive_beam_enabled#

bool zpal_radio_is_receive_beam_enabled (void )

Returns whether use of receive beams is enabled or not for the active region.

Returns

• True if use of fragmented beams is enabled, false otherwise.

zpal_radio_calibrate#

void zpal_radio_calibrate (void )

Calibrates the radio.

Z-Wave expects the radio ZPAL implementation to generate a ZPAL_RADIO_EVENT_RXTX_CALIBRATE event when calibration is required. The event will invoke this function in non-interrupt context.

zpal_radio_is_lbt_enabled#

bool zpal_radio_is_lbt_enabled (void )

Returns whether listen before talk (LBT) is enabled.

Returns

• True if LBT is enabled, false otherwise.

zpal_radio_get_beam_startup_time#

uint16_t zpal_radio_get_beam_startup_time (void )

Returns the time it takes to start transmission of wake up beams.

Includes time spent on LBT.

Returns

• startup time in milli seconds.

zpal_radio_get_beam_node_id#

node_id_t zpal_radio_get_beam_node_id (void )

Returns the node ID associated with most recently received beam frame.

Returns

• Node ID associated with the most recently received beam frame.

zpal_radio_get_minimum_lr_tx_power#

zpal_tx_power_t zpal_radio_get_minimum_lr_tx_power (void )

Returns the minimum transmit power for Z-Wave Long Range.

Returns

• Minimum TX power in dBm.

zpal_radio_get_maximum_lr_tx_power#

zpal_tx_power_t zpal_radio_get_maximum_lr_tx_power (void )

Returns the maximum transmit power for Z-Wave Long Range.

Returns

• Maximum TX power in dBm.

zpal_radio_is_debug_enabled#

bool zpal_radio_is_debug_enabled (void )

Returns whether debug is enabled or disabled.

Returns

• True if debug is enabled, false otherwise.

zpal_radio_get_rf_profile#

const zpal_radio_profile_t * zpal_radio_get_rf_profile (void )

a getter on the current rf profile.

Function return a pointer (instead of a struct) to reduce RAM memory usage and execution time. The pointer target a const structure because it should not be used to modify the content of the structure.

Returns

• pointer on the current rf profile.

zpal_radio_get_lr_channel_config#

zpal_radio_lr_channel_config_t zpal_radio_get_lr_channel_config (void )

Function to read current Long Range Channel Configuration.

Returns

• current long rang channel configuration (ZPAL_RADIO_LR_Ch_CFG if region without lr)

zpal_radio_get_primary_long_range_channel#

zpal_radio_lr_channel_t zpal_radio_get_primary_long_range_channel (void )

Function to read current Primary Long Range Channel.

Returns

• ZPAL_RADIO_LR_CHANNEL_A or ZPAL_RADIO_LR_CHANNEL_B.

zpal_radio_set_primary_long_range_channel#

void zpal_radio_set_primary_long_range_channel (zpal_radio_lr_channel_t channel)

Function to set the Primary Long Range Channel.

zpal_radio_get_long_range_channel_auto_mode#

bool zpal_radio_get_long_range_channel_auto_mode (void )

Function to read current Long Range Channel selection mode.

Returns

• true for automatically slected channel, false for manually selected channel

zpal_radio_set_long_range_channel_auto_mode#

void zpal_radio_set_long_range_channel_auto_mode (bool enable)

Function to set the Long Range Channel selction mode.

zpal_radio_set_long_range_lock#

void zpal_radio_set_long_range_lock (bool lock)

Function to the set Long Range channel Locked status.

zpal_radio_is_long_range_locked#

bool zpal_radio_is_long_range_locked (void )

Function to read the Long Range channel Locked status.

Returns

• True if node shall use Long Range channel only.

zpal_radio_get_flirs_beam_tx_power#

int8_t zpal_radio_get_flirs_beam_tx_power (void )

Read the saved tx power of the last received long-range beam.

Returns

• The tx power of the last received long-range beam.

zpal_radio_is_transmit_allowed#

bool zpal_radio_is_transmit_allowed (uint8_t channel, uint8_t frame_length, uint8_t frame_priority)

Check if transmission is allowed for specified channel.

Returns

• True if node shall use Long Range channel only.

Note

• In Japan all communication must comply to a max 100ms transmit followed by min 100ms silence period.

• Cause a channel shift.

zpal_radio_attenuate#

bool zpal_radio_attenuate (uint8_t adjust_tx_power)

Function to reduce Tx power of classic non-listening devices.

Returns

• True when reduction is allowed, false for listening devices and out of range input.

zpal_radio_get_maximum_tx_power#

zpal_tx_power_t zpal_radio_get_maximum_tx_power (void )

Return the maximum board supported tx power for classic z-wave.

Returns

• The maximum board supported tx power in deci dBm.

zpal_radio_request_calibration#

void zpal_radio_request_calibration (bool forced)

Function to radio calibration.

ZPAL_RADIO_INVALID_RSSI_DBM#

#define ZPAL_RADIO_INVALID_RSSI_DBM

(-128)

RSSI value is invalid or not measured.

ZPAL_RADIO_RSSI_NOT_AVAILABLE#

#define ZPAL_RADIO_RSSI_NOT_AVAILABLE

(127)

ZW_TX_POWER_10DBM#

#define ZW_TX_POWER_10DBM

100

ZW_TX_POWER_14DBM#

#define ZW_TX_POWER_14DBM

140

ZW_TX_POWER_20DBM#

#define ZW_TX_POWER_20DBM

200

REGION_2CH_NUM#

#define REGION_2CH_NUM

= (REGION_2CH_END - REGION_2CH_FIRST)

Number of 2 channel regions.

REGION_3CH_NUM#

#define REGION_3CH_NUM

= (REGION_3CH_END - REGION_3CH_FIRST)

Number of 3 channel regions.