rflib
Data Fields
rfc_CMD_IEEE_CSMA_s Struct Reference

IEEE 802.15.4 CSMA-CA Command. More...

#include <rf_ieee_cmd.h>

Collaboration diagram for rfc_CMD_IEEE_CSMA_s:
Collaboration graph
[legend]

Data Fields

uint16_t commandNo
 The command ID number 0x2C02. More...
 
uint16_t status
 An integer telling the status of the command. This value is updated by the radio CPU during operation and may be read by the system CPU at any time. More...
 
rfc_radioOp_tpNextOp
 Pointer to the next operation to run after this operation is done. More...
 
ratmr_t startTime
 Absolute or relative start time (depending on the value of startTrigger) More...
 
struct {
   uint8_t   triggerType:4
 The type of trigger. More...
 
   uint8_t   bEnaCmd:1
 0: No alternative trigger command
1: CMD_TRIGGER can be used as an alternative trigger More...
 
   uint8_t   triggerNo:2
 The trigger number of the CMD_TRIGGER command that triggers this action. More...
 
   uint8_t   pastTrig:1
 0: A trigger in the past is never triggered, or for start of commands, give an error
1: A trigger in the past is triggered as soon as possible More...
 
startTrigger
 Identification of the trigger that starts the operation. More...
 
struct {
   uint8_t   rule:4
 Condition for running next command: Rule for how to proceed. More...
 
   uint8_t   nSkip:4
 Number of skips + 1 if the rule involves skipping. 0: same, 1: next, 2: skip next, ... More...
 
condition
 
uint16_t randomState
 The state of the pseudo-random generator. More...
 
uint8_t macMaxBE
 The IEEE 802.15.4 MAC parameter macMaxBE More...
 
uint8_t macMaxCSMABackoffs
 The IEEE 802.15.4 MAC parameter macMaxCSMABackoffs More...
 
struct {
   uint8_t   initCW:5
 The initialization value for the CW parameter. More...
 
   uint8_t   bSlotted:1
 0: non-slotted CSMA
1: slotted CSMA More...
 
   uint8_t   rxOffMode:2
 0: RX stays on during CSMA backoffs
1: The CSMA-CA algorithm will suspend the receiver if no frame is being received
2: The CSMA-CA algorithm will suspend the receiver if no frame is being received, or after finishing it (including auto ACK) otherwise
3: The CSMA-CA algorithm will suspend the receiver immediately during back-offs More...
 
csmaConfig
 
uint8_t NB
 The NB parameter from the IEEE 802.15.4 CSMA-CA algorithm. More...
 
uint8_t BE
 The BE parameter from the IEEE 802.15.4 CSMA-CA algorithm. More...
 
uint8_t remainingPeriods
 The number of remaining periods from a paused backoff countdown. More...
 
int8_t lastRssi
 RSSI measured at the last CCA operation. More...
 
struct {
   uint8_t   triggerType:4
 The type of trigger. More...
 
   uint8_t   bEnaCmd:1
 0: No alternative trigger command
1: CMD_TRIGGER can be used as an alternative trigger More...
 
   uint8_t   triggerNo:2
 The trigger number of the CMD_TRIGGER command that triggers this action. More...
 
   uint8_t   pastTrig:1
 0: A trigger in the past is never triggered, or for start of commands, give an error
1: A trigger in the past is triggered as soon as possible More...
 
endTrigger
 Trigger that causes the device to end the CSMA-CA operation. More...
 
ratmr_t lastTimeStamp
 Time of the last CCA operation. More...
 
ratmr_t endTime
 Time used together with endTrigger that causes the device to end the CSMA-CA operation. More...
 
struct {
   uint8_t   triggerType:4
 The type of trigger. More...
 
   uint8_t   bEnaCmd:1
 0: No alternative trigger command
1: CMD_TRIGGER can be used as an alternative trigger More...
 
   uint8_t   triggerNo:2
 The trigger number of the CMD_TRIGGER command that triggers this action. More...
 
   uint8_t   pastTrig:1
 0: A trigger in the past is never triggered, or for start of commands, give an error
1: A trigger in the past is triggered as soon as possible More...
 
startTrigger
 Identification of the trigger that starts the operation. More...
 
struct {
   uint8_t   rule:4
 Condition for running next command: Rule for how to proceed. More...
 
   uint8_t   nSkip:4
 Number of skips + 1 if the rule involves skipping. 0: same, 1: next, 2: skip next, ... More...
 
condition
 
struct {
   uint8_t   initCW:5
 The initialization value for the CW parameter. More...
 
   uint8_t   bSlotted:1
 0: non-slotted CSMA
1: slotted CSMA More...
 
   uint8_t   rxOffMode:2
 0: RX stays on during CSMA backoffs
1: The CSMA-CA algorithm will suspend the receiver if no frame is being received
2: The CSMA-CA algorithm will suspend the receiver if no frame is being received, or after finishing it (including auto ACK) otherwise
3: The CSMA-CA algorithm will suspend the receiver immediately during back-offs More...
 
csmaConfig
 
struct {
   uint8_t   triggerType:4
 The type of trigger. More...
 
   uint8_t   bEnaCmd:1
 0: No alternative trigger command
1: CMD_TRIGGER can be used as an alternative trigger More...
 
   uint8_t   triggerNo:2
 The trigger number of the CMD_TRIGGER command that triggers this action. More...
 
   uint8_t   pastTrig:1
 0: A trigger in the past is never triggered, or for start of commands, give an error
1: A trigger in the past is triggered as soon as possible More...
 
endTrigger
 Trigger that causes the device to end the CSMA-CA operation. More...
 
struct {
   uint8_t   triggerType:4
 The type of trigger. More...
 
   uint8_t   bEnaCmd:1
 0: No alternative trigger command
1: CMD_TRIGGER can be used as an alternative trigger More...
 
   uint8_t   triggerNo:2
 The trigger number of the CMD_TRIGGER command that triggers this action. More...
 
   uint8_t   pastTrig:1
 0: A trigger in the past is never triggered, or for start of commands, give an error
1: A trigger in the past is triggered as soon as possible More...
 
startTrigger
 Identification of the trigger that starts the operation. More...
 
struct {
   uint8_t   rule:4
 Condition for running next command: Rule for how to proceed. More...
 
   uint8_t   nSkip:4
 Number of skips + 1 if the rule involves skipping. 0: same, 1: next, 2: skip next, ... More...
 
condition
 
struct {
   uint8_t   initCW:5
 The initialization value for the CW parameter. More...
 
   uint8_t   bSlotted:1
 0: non-slotted CSMA
1: slotted CSMA More...
 
   uint8_t   rxOffMode:2
 0: RX stays on during CSMA backoffs
1: The CSMA-CA algorithm will suspend the receiver if no frame is being received
2: The CSMA-CA algorithm will suspend the receiver if no frame is being received, or after finishing it (including auto ACK) otherwise
3: The CSMA-CA algorithm will suspend the receiver immediately during back-offs More...
 
csmaConfig
 
struct {
   uint8_t   triggerType:4
 The type of trigger. More...
 
   uint8_t   bEnaCmd:1
 0: No alternative trigger command
1: CMD_TRIGGER can be used as an alternative trigger More...
 
   uint8_t   triggerNo:2
 The trigger number of the CMD_TRIGGER command that triggers this action. More...
 
   uint8_t   pastTrig:1
 0: A trigger in the past is never triggered, or for start of commands, give an error
1: A trigger in the past is triggered as soon as possible More...
 
endTrigger
 Trigger that causes the device to end the CSMA-CA operation. More...
 

Detailed Description

IEEE 802.15.4 CSMA-CA Command.

Field Documentation

§ commandNo

uint16_t rfc_CMD_IEEE_CSMA_s::commandNo

The command ID number 0x2C02.

§ status

uint16_t rfc_CMD_IEEE_CSMA_s::status

An integer telling the status of the command. This value is updated by the radio CPU during operation and may be read by the system CPU at any time.

§ pNextOp

rfc_radioOp_t * rfc_CMD_IEEE_CSMA_s::pNextOp

Pointer to the next operation to run after this operation is done.

§ startTime

ratmr_t rfc_CMD_IEEE_CSMA_s::startTime

Absolute or relative start time (depending on the value of startTrigger)

§ triggerType

uint8_t rfc_CMD_IEEE_CSMA_s::triggerType

The type of trigger.

§ bEnaCmd

uint8_t rfc_CMD_IEEE_CSMA_s::bEnaCmd

0: No alternative trigger command
1: CMD_TRIGGER can be used as an alternative trigger

§ triggerNo

uint8_t rfc_CMD_IEEE_CSMA_s::triggerNo

The trigger number of the CMD_TRIGGER command that triggers this action.

§ pastTrig

uint8_t rfc_CMD_IEEE_CSMA_s::pastTrig

0: A trigger in the past is never triggered, or for start of commands, give an error
1: A trigger in the past is triggered as soon as possible

§ startTrigger [1/3]

struct { ... } rfc_CMD_IEEE_CSMA_s::startTrigger

Identification of the trigger that starts the operation.

§ rule

uint8_t rfc_CMD_IEEE_CSMA_s::rule

Condition for running next command: Rule for how to proceed.

§ nSkip

uint8_t rfc_CMD_IEEE_CSMA_s::nSkip

Number of skips + 1 if the rule involves skipping. 0: same, 1: next, 2: skip next, ...

§ condition [1/3]

struct { ... } rfc_CMD_IEEE_CSMA_s::condition

§ randomState

uint16_t rfc_CMD_IEEE_CSMA_s::randomState

The state of the pseudo-random generator.

§ macMaxBE

uint8_t rfc_CMD_IEEE_CSMA_s::macMaxBE

The IEEE 802.15.4 MAC parameter macMaxBE

§ macMaxCSMABackoffs

uint8_t rfc_CMD_IEEE_CSMA_s::macMaxCSMABackoffs

The IEEE 802.15.4 MAC parameter macMaxCSMABackoffs

§ initCW

uint8_t rfc_CMD_IEEE_CSMA_s::initCW

The initialization value for the CW parameter.

§ bSlotted

uint8_t rfc_CMD_IEEE_CSMA_s::bSlotted

0: non-slotted CSMA
1: slotted CSMA

§ rxOffMode

uint8_t rfc_CMD_IEEE_CSMA_s::rxOffMode

0: RX stays on during CSMA backoffs
1: The CSMA-CA algorithm will suspend the receiver if no frame is being received
2: The CSMA-CA algorithm will suspend the receiver if no frame is being received, or after finishing it (including auto ACK) otherwise
3: The CSMA-CA algorithm will suspend the receiver immediately during back-offs

§ csmaConfig [1/3]

struct { ... } rfc_CMD_IEEE_CSMA_s::csmaConfig

§ NB

uint8_t rfc_CMD_IEEE_CSMA_s::NB

The NB parameter from the IEEE 802.15.4 CSMA-CA algorithm.

§ BE

uint8_t rfc_CMD_IEEE_CSMA_s::BE

The BE parameter from the IEEE 802.15.4 CSMA-CA algorithm.

§ remainingPeriods

uint8_t rfc_CMD_IEEE_CSMA_s::remainingPeriods

The number of remaining periods from a paused backoff countdown.

§ lastRssi

int8_t rfc_CMD_IEEE_CSMA_s::lastRssi

RSSI measured at the last CCA operation.

§ endTrigger [1/3]

struct { ... } rfc_CMD_IEEE_CSMA_s::endTrigger

Trigger that causes the device to end the CSMA-CA operation.

§ lastTimeStamp

ratmr_t rfc_CMD_IEEE_CSMA_s::lastTimeStamp

Time of the last CCA operation.

§ endTime

ratmr_t rfc_CMD_IEEE_CSMA_s::endTime

Time used together with endTrigger that causes the device to end the CSMA-CA operation.

§ startTrigger [2/3]

struct { ... } rfc_CMD_IEEE_CSMA_s::startTrigger

Identification of the trigger that starts the operation.

§ condition [2/3]

struct { ... } rfc_CMD_IEEE_CSMA_s::condition

§ csmaConfig [2/3]

struct { ... } rfc_CMD_IEEE_CSMA_s::csmaConfig

§ endTrigger [2/3]

struct { ... } rfc_CMD_IEEE_CSMA_s::endTrigger

Trigger that causes the device to end the CSMA-CA operation.

§ startTrigger [3/3]

struct { ... } rfc_CMD_IEEE_CSMA_s::startTrigger

Identification of the trigger that starts the operation.

§ condition [3/3]

struct { ... } rfc_CMD_IEEE_CSMA_s::condition

§ csmaConfig [3/3]

struct { ... } rfc_CMD_IEEE_CSMA_s::csmaConfig

§ endTrigger [3/3]

struct { ... } rfc_CMD_IEEE_CSMA_s::endTrigger

Trigger that causes the device to end the CSMA-CA operation.


The documentation for this struct was generated from the following file:
© Copyright 1995-2022, Texas Instruments Incorporated. All rights reserved.
Trademarks | Privacy policy | Terms of use | Terms of sale