rflib
Data Fields
rfc_CMD_IEEE_ED_SCAN_s Struct Reference

IEEE 802.15.4 Energy Detect Scan Command. More...

#include <rf_ieee_cmd.h>

Collaboration diagram for rfc_CMD_IEEE_ED_SCAN_s:
Collaboration graph
[legend]

Data Fields

uint16_t commandNo
 The command ID number 0x2802. 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
 
uint8_t channel
 Channel to tune to in the start of the operation
0: Use existing channel
11–26: Use as IEEE 802.15.4 channel, i.e. frequency is (2405 + 5 × (channel - 11)) MHz
60–207: Frequency is (2300 + channel) MHz
Others: Reserved More...
 
struct {
   uint8_t   ccaEnEnergy:1
 Enable energy scan as CCA source. More...
 
   uint8_t   ccaEnCorr:1
 Enable correlator based carrier sense as CCA source. More...
 
   uint8_t   ccaEnSync:1
 Enable sync found based carrier sense as CCA source. More...
 
   uint8_t   ccaCorrOp:1
 Operator to use between energy based and correlator based CCA
0: Report busy channel if either ccaEnergy or ccaCorr are busy
1: Report busy channel if both ccaEnergy and ccaCorr are busy. More...
 
   uint8_t   ccaSyncOp:1
 Operator to use between sync found based CCA and the others
0: Always report busy channel if ccaSync is busy
1: Always report idle channel if ccaSync is idle. More...
 
   uint8_t   ccaCorrThr:2
 Threshold for number of correlation peaks in correlator based carrier sense. More...
 
ccaOpt
 CCA options. More...
 
int8_t ccaRssiThr
 RSSI threshold for CCA. More...
 
uint8_t __dummy0
 
int8_t maxRssi
 The maximum RSSI recorded during the ED scan. 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 Rx operation. More...
 
ratmr_t endTime
 Time used together with endTrigger that causes the device to end the Rx 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   ccaEnEnergy:1
 Enable energy scan as CCA source. More...
 
   uint8_t   ccaEnCorr:1
 Enable correlator based carrier sense as CCA source. More...
 
   uint8_t   ccaEnSync:1
 Enable sync found based carrier sense as CCA source. More...
 
   uint8_t   ccaCorrOp:1
 Operator to use between energy based and correlator based CCA
0: Report busy channel if either ccaEnergy or ccaCorr are busy
1: Report busy channel if both ccaEnergy and ccaCorr are busy. More...
 
   uint8_t   ccaSyncOp:1
 Operator to use between sync found based CCA and the others
0: Always report busy channel if ccaSync is busy
1: Always report idle channel if ccaSync is idle. More...
 
   uint8_t   ccaCorrThr:2
 Threshold for number of correlation peaks in correlator based carrier sense. More...
 
ccaOpt
 CCA options. 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 Rx 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   ccaEnEnergy:1
 Enable energy scan as CCA source. More...
 
   uint8_t   ccaEnCorr:1
 Enable correlator based carrier sense as CCA source. More...
 
   uint8_t   ccaEnSync:1
 Enable sync found based carrier sense as CCA source. More...
 
   uint8_t   ccaCorrOp:1
 Operator to use between energy based and correlator based CCA
0: Report busy channel if either ccaEnergy or ccaCorr are busy
1: Report busy channel if both ccaEnergy and ccaCorr are busy. More...
 
   uint8_t   ccaSyncOp:1
 Operator to use between sync found based CCA and the others
0: Always report busy channel if ccaSync is busy
1: Always report idle channel if ccaSync is idle. More...
 
   uint8_t   ccaCorrThr:2
 Threshold for number of correlation peaks in correlator based carrier sense. More...
 
ccaOpt
 CCA options. 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 Rx operation. More...
 

Detailed Description

IEEE 802.15.4 Energy Detect Scan Command.

Field Documentation

§ commandNo

uint16_t rfc_CMD_IEEE_ED_SCAN_s::commandNo

The command ID number 0x2802.

§ status

uint16_t rfc_CMD_IEEE_ED_SCAN_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_ED_SCAN_s::pNextOp

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

§ startTime

ratmr_t rfc_CMD_IEEE_ED_SCAN_s::startTime

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

§ triggerType

uint8_t rfc_CMD_IEEE_ED_SCAN_s::triggerType

The type of trigger.

§ bEnaCmd

uint8_t rfc_CMD_IEEE_ED_SCAN_s::bEnaCmd

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

§ triggerNo

uint8_t rfc_CMD_IEEE_ED_SCAN_s::triggerNo

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

§ pastTrig

uint8_t rfc_CMD_IEEE_ED_SCAN_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_ED_SCAN_s::startTrigger

Identification of the trigger that starts the operation.

§ rule

uint8_t rfc_CMD_IEEE_ED_SCAN_s::rule

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

§ nSkip

uint8_t rfc_CMD_IEEE_ED_SCAN_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_ED_SCAN_s::condition

§ channel

uint8_t rfc_CMD_IEEE_ED_SCAN_s::channel

Channel to tune to in the start of the operation
0: Use existing channel
11–26: Use as IEEE 802.15.4 channel, i.e. frequency is (2405 + 5 × (channel - 11)) MHz
60–207: Frequency is (2300 + channel) MHz
Others: Reserved

§ ccaEnEnergy

uint8_t rfc_CMD_IEEE_ED_SCAN_s::ccaEnEnergy

Enable energy scan as CCA source.

§ ccaEnCorr

uint8_t rfc_CMD_IEEE_ED_SCAN_s::ccaEnCorr

Enable correlator based carrier sense as CCA source.

§ ccaEnSync

uint8_t rfc_CMD_IEEE_ED_SCAN_s::ccaEnSync

Enable sync found based carrier sense as CCA source.

§ ccaCorrOp

uint8_t rfc_CMD_IEEE_ED_SCAN_s::ccaCorrOp

Operator to use between energy based and correlator based CCA
0: Report busy channel if either ccaEnergy or ccaCorr are busy
1: Report busy channel if both ccaEnergy and ccaCorr are busy.

§ ccaSyncOp

uint8_t rfc_CMD_IEEE_ED_SCAN_s::ccaSyncOp

Operator to use between sync found based CCA and the others
0: Always report busy channel if ccaSync is busy
1: Always report idle channel if ccaSync is idle.

§ ccaCorrThr

uint8_t rfc_CMD_IEEE_ED_SCAN_s::ccaCorrThr

Threshold for number of correlation peaks in correlator based carrier sense.

§ ccaOpt [1/3]

struct { ... } rfc_CMD_IEEE_ED_SCAN_s::ccaOpt

CCA options.

§ ccaRssiThr

int8_t rfc_CMD_IEEE_ED_SCAN_s::ccaRssiThr

RSSI threshold for CCA.

§ __dummy0

uint8_t rfc_CMD_IEEE_ED_SCAN_s::__dummy0

§ maxRssi

int8_t rfc_CMD_IEEE_ED_SCAN_s::maxRssi

The maximum RSSI recorded during the ED scan.

§ endTrigger [1/3]

struct { ... } rfc_CMD_IEEE_ED_SCAN_s::endTrigger

Trigger that causes the device to end the Rx operation.

§ endTime

ratmr_t rfc_CMD_IEEE_ED_SCAN_s::endTime

Time used together with endTrigger that causes the device to end the Rx operation.

§ startTrigger [2/3]

struct { ... } rfc_CMD_IEEE_ED_SCAN_s::startTrigger

Identification of the trigger that starts the operation.

§ condition [2/3]

struct { ... } rfc_CMD_IEEE_ED_SCAN_s::condition

§ ccaOpt [2/3]

struct { ... } rfc_CMD_IEEE_ED_SCAN_s::ccaOpt

CCA options.

§ endTrigger [2/3]

struct { ... } rfc_CMD_IEEE_ED_SCAN_s::endTrigger

Trigger that causes the device to end the Rx operation.

§ startTrigger [3/3]

struct { ... } rfc_CMD_IEEE_ED_SCAN_s::startTrigger

Identification of the trigger that starts the operation.

§ condition [3/3]

struct { ... } rfc_CMD_IEEE_ED_SCAN_s::condition

§ ccaOpt [3/3]

struct { ... } rfc_CMD_IEEE_ED_SCAN_s::ccaOpt

CCA options.

§ endTrigger [3/3]

struct { ... } rfc_CMD_IEEE_ED_SCAN_s::endTrigger

Trigger that causes the device to end the Rx 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