Configures if there is a frame type in your frame and the lengths of each frame.
The number of bits set in the mask determines the number of elements in frameLen. A maximum of 8 different frame types may be specified.
Public Attributes#
A pointer to an array of frame lengths for each frame type.
Zero-indexed location of the byte containing the frame type field.
A bitmask of the frame type field, which determines a number of frames expected based on the number of bits set.
A bitmask that marks if each frame is valid or should be filtered.
A bitmask that marks if each frame should have the address filter applied.
Public Attribute Documentation#
frameLen#
uint16_t* RAIL_FrameType_t::frameLen
A pointer to an array of frame lengths for each frame type.
The length of this array should be equal to the number of frame types. The array that frameLen points to should not change location or be modified.
1639 of file common/rail_types.hoffset#
uint8_t RAIL_FrameType_t::offset
Zero-indexed location of the byte containing the frame type field.
1643 of file common/rail_types.hmask#
uint8_t RAIL_FrameType_t::mask
A bitmask of the frame type field, which determines a number of frames expected based on the number of bits set.
No more than 3 bits can be set in the mask and they must be contiguous ones. For example, if the highest three bits of the byte specified by offset constitute the frame type, then mask should be 0xE0, which has 3 bits set, indicating 8 possible frame types.
1651 of file common/rail_types.hisValid#
uint8_t RAIL_FrameType_t::isValid
A bitmask that marks if each frame is valid or should be filtered.
Frame type 0 corresponds to the lowest bit in isValid. If the frame is filtered, a RAIL_EVENT_RX_PACKET_ABORTED will be raised.
1657 of file common/rail_types.haddressFilter#
uint8_t RAIL_FrameType_t::addressFilter
A bitmask that marks if each frame should have the address filter applied.
Frame type 0 corresponds to the least significant bit in addressFilter.
1662 of file common/rail_types.h