Events#
APIs related to events.
Enumerations#
RAIL events passed to the event callback.
Functions#
Configure radio events.
Macros#
Shift position of RAIL_EVENT_SCHEDULED_TX_STARTED bit.
Shift position of RAIL_EVENT_RX_DUTY_CYCLE_RX_END bit.
Shift position of RAIL_EVENT_ZWAVE_LR_ACK_REQUEST_COMMAND_SHIFT bit.
Shift position of RAIL_EVENT_MFM_TX_BUFFER_DONE bit.
A value representing no events.
Occurs when the hardware-averaged RSSI is done in response to RAIL_StartAverageRssi() to indicate that the hardware has completed averaging.
Occurs when the ACK timeout expires while waiting to receive the sync word of an expected ACK.
Keeps occurring as long as the number of bytes in the receive FIFO exceeds the configured threshold value.
Occurs whenever a packet is received with RAIL_RX_PACKET_READY_SUCCESS or RAIL_RX_PACKET_READY_CRC_ERROR.
Occurs when the radio has lost a preamble.
Occurs when the radio has detected a preamble.
Occurs when the first sync word is detected.
Occurs when the second sync word is detected.
Occurs when a receive is aborted with RAIL_RX_PACKET_ABORT_CRC_ERROR which only happens after any filtering has passed.
When using RAIL_RxDataSource_t::RX_PACKET_DATA this event occurs coincident to a receive packet completion event in which the receive FIFO or any supplemental packet metadata FIFO (see Data Management) are full and further packet reception is jeopardized.
When using RAIL_RxDataSource_t::RX_PACKET_DATA this event occurs when a receive is aborted with RAIL_RX_PACKET_ABORT_OVERFLOW due to overflowing the receive FIFO or any supplemental packet metadata FIFO (see Data Management).
Occurs when a receive is aborted with RAIL_RX_PACKET_ABORT_FILTERED because its address does not match the filtering settings.
Occurs when an RX event times out.
Occurs when a scheduled RX begins turning on the receiver.
Occurs when a scheduled TX begins turning on the transmitter.
Occurs when the scheduled RX window ends.
Occurs when start of a scheduled receive is missed.
Occurs when a receive is aborted during filtering with RAIL_RX_PACKET_ABORT_FORMAT or after filtering with RAIL_RX_PACKET_ABORT_ABORTED for reasons other than address filtering mismatch (which triggers RAIL_EVENT_RX_ADDRESS_FILTERED instead).
Occurs when the packet has passed any configured address and frame filtering options.
Occurs when the modem timing is lost.
Occurs when the modem timing is detected.
Occurs when RX Channel Hopping is enabled and channel hopping finishes receiving on the last channel in its sequence.
Occurs during RX duty cycle mode when the radio finishes its time in receive mode.
Indicate a Data Request is received when using IEEE 802.15.4 functionality.
Indicate a Z-Wave Beam Request relevant to the node was received.
Indicate a MFM buffer has completely transmitted.
Indicate a request for populating Z-Wave LR ACK packet.
The mask representing all events that determine the end of a received packet.
Occurs when the number of bytes in the transmit FIFO falls below the configured threshold value.
Occurs after a packet has been transmitted.
Occurs after an ACK packet has been transmitted.
Occurs when a transmit is aborted by the user.
Occurs when an ACK transmit is aborted by the user.
Occurs when a transmit is blocked from occurring because RAIL_EnableTxHoldOff() was called.
Occurs when an ACK transmit is blocked from occurring because RAIL_EnableTxHoldOff() was called.
Occurs when the transmit buffer underflows.
Occurs when the ACK transmit buffer underflows.
Occurs when Carrier Sense Multiple Access (CSMA) or Listen Before Talk (LBT) succeeds.
Occurs when Carrier Sense Multiple Access (CSMA) or Listen Before Talk (LBT) fails.
Occurs during CSMA or LBT when an individual Clear Channel Assessment (CCA) check fails, but there are more tries needed before the overall operation completes.
Occurs when the receiver is activated to perform a Clear Channel Assessment (CCA) check.
Occurs when the radio starts transmitting a normal packet on the air.
A value to pass as RAIL_GetTxTimePreambleStart() totalPacketBytes parameter to retrieve the RAIL_EVENT_TX_STARTED timestamp.
Occurs when the start of a scheduled transmit is missed.
A mask representing all events that determine the end of a transmitted packet.
A mask representing all events that determine the end of a transmitted ACK packet.
Occurs when the scheduler switches away from this configuration.
Occurs when the scheduler switches to this configuration.
Occurs when the scheduler has a status to report.
Occurs when the application needs to run a calibration, as determined by the RAIL library.
Occurs when RF energy is sensed from the radio.
Occurs when PA protection circuit kicks in.
Occurs after enabling the signal detection using RAIL_BLE_EnableSignalDetection or RAIL_IEEE802154_EnableSignalDetection when a signal is detected.
Occurs when a Wi-SUN mode switch packet has been received, after switching to the new PHY.
Occurs when switching back to the original base PHY in effect prior to the Wi-SUN mode switch reception.
Occurs when the sampled RSSI is above the threshold set by RAIL_SetRssiDetectThreshold().
Occurs when the thermistor has finished its measurement in response to RAIL_StartThermistorMeasurement().
Occurs when a Tx has been blocked because of temperature exceeding the safety threshold.
Occurs when die internal temperature exceeds the temperature threshold subtracted by the cool down parameter from RAIL_ChipTempConfig_t.
Occurs when die internal temperature falls below the temperature threshold subtracted by the cool down parameter from RAIL_ChipTempConfig_t.
Occurs when the user received a mailbox message.
A value representing all possible events.
Enumeration Documentation#
RAIL_Events_t#
RAIL_Events_t
RAIL events passed to the event callback.
More than one event may be indicated due to interrupt latency.
Enumerator | |
---|---|
RAIL_EVENT_RSSI_AVERAGE_DONE_SHIFT | Shift position of RAIL_EVENT_RSSI_AVERAGE_DONE bit. |
RAIL_EVENT_RX_ACK_TIMEOUT_SHIFT | Shift position of RAIL_EVENT_RX_ACK_TIMEOUT bit. |
RAIL_EVENT_RX_FIFO_ALMOST_FULL_SHIFT | Shift position of RAIL_EVENT_RX_FIFO_ALMOST_FULL bit. |
RAIL_EVENT_RX_PACKET_RECEIVED_SHIFT | Shift position of RAIL_EVENT_RX_PACKET_RECEIVED bit. |
RAIL_EVENT_RX_PREAMBLE_LOST_SHIFT | Shift position of RAIL_EVENT_RX_PREAMBLE_LOST bit. |
RAIL_EVENT_RX_PREAMBLE_DETECT_SHIFT | Shift position of RAIL_EVENT_RX_PREAMBLE_DETECT bit. |
RAIL_EVENT_RX_SYNC1_DETECT_SHIFT | Shift position of RAIL_EVENT_RX_SYNC1_DETECT bit. |
RAIL_EVENT_RX_SYNC2_DETECT_SHIFT | Shift position of RAIL_EVENT_RX_SYNC2_DETECT bit. |
RAIL_EVENT_RX_FRAME_ERROR_SHIFT | Shift position of RAIL_EVENT_RX_FRAME_ERROR bit. |
RAIL_EVENT_RX_FIFO_FULL_SHIFT | Shift position of RAIL_EVENT_RX_FIFO_FULL bit. |
RAIL_EVENT_RX_FIFO_OVERFLOW_SHIFT | Shift position of RAIL_EVENT_RX_FIFO_OVERFLOW bit. |
RAIL_EVENT_RX_ADDRESS_FILTERED_SHIFT | Shift position of RAIL_EVENT_RX_ADDRESS_FILTERED bit. |
RAIL_EVENT_RX_TIMEOUT_SHIFT | Shift position of RAIL_EVENT_RX_TIMEOUT bit. |
RAIL_EVENT_SCHEDULED_RX_STARTED_SHIFT | Shift position of RAIL_EVENT_SCHEDULED_RX_STARTED bit. |
RAIL_EVENT_RX_SCHEDULED_RX_END_SHIFT | Shift position of RAIL_EVENT_RX_SCHEDULED_RX_END bit. |
RAIL_EVENT_RX_SCHEDULED_RX_MISSED_SHIFT | Shift position of RAIL_EVENT_RX_SCHEDULED_RX_MISSED bit. |
RAIL_EVENT_RX_PACKET_ABORTED_SHIFT | Shift position of RAIL_EVENT_RX_PACKET_ABORTED bit. |
RAIL_EVENT_RX_FILTER_PASSED_SHIFT | Shift position of RAIL_EVENT_RX_FILTER_PASSED bit. |
RAIL_EVENT_RX_TIMING_LOST_SHIFT | Shift position of RAIL_EVENT_RX_TIMING_LOST bit. |
RAIL_EVENT_RX_TIMING_DETECT_SHIFT | Shift position of RAIL_EVENT_RX_TIMING_DETECT bit. |
RAIL_EVENT_RX_CHANNEL_HOPPING_COMPLETE_SHIFT | Shift position of RAIL_EVENT_RX_CHANNEL_HOPPING_COMPLETE bit. |
RAIL_EVENT_IEEE802154_DATA_REQUEST_COMMAND_SHIFT | Shift position of RAIL_EVENT_IEEE802154_DATA_REQUEST_COMMAND bit. |
RAIL_EVENT_ZWAVE_BEAM_SHIFT | Shift position of RAIL_EVENT_ZWAVE_BEAM bit. |
RAIL_EVENT_TX_FIFO_ALMOST_EMPTY_SHIFT | Shift position of RAIL_EVENT_TX_FIFO_ALMOST_EMPTY bit. |
RAIL_EVENT_TX_PACKET_SENT_SHIFT | Shift position of RAIL_EVENT_TX_PACKET_SENT bit. |
RAIL_EVENT_TXACK_PACKET_SENT_SHIFT | Shift position of RAIL_EVENT_TXACK_PACKET_SENT bit. |
RAIL_EVENT_TX_ABORTED_SHIFT | Shift position of RAIL_EVENT_TX_ABORTED bit. |
RAIL_EVENT_TXACK_ABORTED_SHIFT | Shift position of RAIL_EVENT_TXACK_ABORTED bit. |
RAIL_EVENT_TX_BLOCKED_SHIFT | Shift position of RAIL_EVENT_TX_BLOCKED bit. |
RAIL_EVENT_TXACK_BLOCKED_SHIFT | Shift position of RAIL_EVENT_TXACK_BLOCKED bit. |
RAIL_EVENT_TX_UNDERFLOW_SHIFT | Shift position of RAIL_EVENT_TX_UNDERFLOW bit. |
RAIL_EVENT_TXACK_UNDERFLOW_SHIFT | Shift position of RAIL_EVENT_TXACK_UNDERFLOW bit. |
RAIL_EVENT_TX_CHANNEL_CLEAR_SHIFT | Shift position of RAIL_EVENT_TX_CHANNEL_CLEAR bit. |
RAIL_EVENT_TX_CHANNEL_BUSY_SHIFT | Shift position of RAIL_EVENT_TX_CHANNEL_BUSY bit. |
RAIL_EVENT_TX_CCA_RETRY_SHIFT | Shift position of RAIL_EVENT_TX_CCA_RETRY bit. |
RAIL_EVENT_TX_START_CCA_SHIFT | Shift position of RAIL_EVENT_TX_START_CCA bit. |
RAIL_EVENT_TX_STARTED_SHIFT | Shift position of RAIL_EVENT_TX_STARTED bit. |
RAIL_EVENT_TX_SCHEDULED_TX_MISSED_SHIFT | Shift position of RAIL_EVENT_TX_SCHEDULED_TX_MISSED bit. |
RAIL_EVENT_CONFIG_UNSCHEDULED_SHIFT | Shift position of RAIL_EVENT_CONFIG_UNSCHEDULED bit. |
RAIL_EVENT_CONFIG_SCHEDULED_SHIFT | Shift position of RAIL_EVENT_CONFIG_SCHEDULED bit. |
RAIL_EVENT_SCHEDULER_STATUS_SHIFT | Shift position of RAIL_EVENT_SCHEDULER_STATUS bit. |
RAIL_EVENT_CAL_NEEDED_SHIFT | Shift position of RAIL_EVENT_CAL_NEEDED bit. |
RAIL_EVENT_RF_SENSED_SHIFT | Shift position of RAIL_EVENT_RF_SENSED bit. |
RAIL_EVENT_PA_PROTECTION_SHIFT | Shift position of RAIL_EVENT_PA_PROTECTION bit. |
RAIL_EVENT_SIGNAL_DETECTED_SHIFT | Shift position of RAIL_EVENT_SIGNAL_DETECTED bit. |
RAIL_EVENT_IEEE802154_MODESWITCH_START_SHIFT | Shift position of RAIL_EVENT_IEEE802154_MODESWITCH_START bit. |
RAIL_EVENT_IEEE802154_MODESWITCH_END_SHIFT | Shift position of RAIL_EVENT_IEEE802154_MODESWITCH_END bit. |
RAIL_EVENT_DETECT_RSSI_THRESHOLD_SHIFT | Shift position of RAIL_EVENT_DETECT_RSSI_THRESHOLD bit. |
RAIL_EVENT_THERMISTOR_DONE_SHIFT | Shift position of RAIL_EVENT_THERMISTOR_DONE bit. |
RAIL_EVENT_TX_BLOCKED_TOO_HOT_SHIFT | Shift position of RAIL_EVENT_TX_BLOCKED_TOO_HOT bit. |
RAIL_EVENT_TEMPERATURE_TOO_HOT_SHIFT | Shift position of RAIL_EVENT_TEMPERATURE_TOO_HOT bit. |
RAIL_EVENT_TEMPERATURE_COOL_DOWN_SHIFT | Shift position of RAIL_EVENT_TEMPERATURE_COOL_DOWN bit. |
RAIL_EVENT_USER_MBOX_SHIFT | Shift position of RAIL_EVENT_USER_MBOX bit. |
800
of file common/rail_types.h
Function Documentation#
RAIL_ConfigEvents#
RAIL_Status_t RAIL_ConfigEvents (RAIL_Handle_t railHandle, RAIL_Events_t mask, RAIL_Events_t events)
Configure radio events.
[in] | railHandle | A RAIL instance handle. |
[in] | mask | A bitmask of events to configure. |
[in] | events | A bitmask of events to trigger RAIL_Config_t::eventsCallback For a full list of available callbacks, see RAIL_EVENT_* set of defines. |
Returns
Status code indicating success of the function call.
Sets up which radio interrupts generate a RAIL event. The full list of options is in RAIL_Events_t.
1575
of file common/rail.h