Skip to content

xwr.radar.defines

TI Radar demo firmware common API defines.

See the mmWave SDK user guide, Table 1 (Page 19).

xwr.radar.defines.ADCDepth

Bases: Enum

ADC bit depth.

Attributes:

Name Type Description
BIT12

12-bit mode.
BIT14

14-bit mode.
BIT16

16-bit mode (used by default).
Source code in src/xwr/radar/defines.py 
40
41
42
43
44
45
46
47
48
49
50
51
class ADCDepth(Enum):
    """ADC bit depth.

    Attributes:
        BIT12: 12-bit mode.
        BIT14: 14-bit mode.
        BIT16: 16-bit mode (used by default).
    """

    BIT12 = 0
    BIT14 = 1
    BIT16 = 2

xwr.radar.defines.ADCFormat

Bases: Enum

ADC output format.

COMPLEX_1X has the image band filtered out, while COMPLEX_2X does not.

Attributes:

Name Type Description
REAL

real data.
COMPLEX_1X

complex data, with image band filtered out (default).
COMPLEX_2X

raw complex data.
Source code in src/xwr/radar/defines.py 
54
55
56
57
58
59
60
61
62
63
64
65
66
67
class ADCFormat(Enum):
    """ADC output format.

    COMPLEX_1X has the image band filtered out, while COMPLEX_2X does not.

    Attributes:
        REAL: real data.
        COMPLEX_1X: complex data, with image band filtered out (default).
        COMPLEX_2X: raw complex data.
    """

    REAL = 0
    COMPLEX_1X = 1
    COMPLEX_2X = 2

xwr.radar.defines.DFEMode

Bases: Enum

Frame type; note that continuous chirping is not supported.

Attributes:

Name Type Description
LEGACY

legacy mode (we only support this for now).
ADVANCED

advanced mode.
Source code in src/xwr/radar/defines.py 
27
28
29
30
31
32
33
34
35
36
37
class DFEMode(Enum):
    """Frame type; note that continuous chirping is not supported.

    Attributes:
        LEGACY: legacy mode (we only support this for now).
        ADVANCED: advanced mode.
    """

    LEGACY = 1
    CONTINUOUS_UNSUPPORTED = 2
    ADVANCED = 3

xwr.radar.defines.HPFCornerFreq1

Bases: Enum

High pass filter 1 corner frequency.

Attributes:

Name Type Description
KHZ175

175 kHz (default).
KHZ235

235 kHz.
KHZ350

350 kHz.
KHZ700

700 kHz.
Source code in src/xwr/radar/defines.py 
86
87
88
89
90
91
92
93
94
95
96
97
98
99
class HPFCornerFreq1(Enum):
    """High pass filter 1 corner frequency.

    Attributes:
        KHZ175: 175 kHz (default).
        KHZ235: 235 kHz.
        KHZ350: 350 kHz.
        KHZ700: 700 kHz.
    """

    KHZ175 = 0
    KHZ235 = 1
    KHZ350 = 2
    KHZ700 = 3

xwr.radar.defines.HPFCornerFreq2

Bases: Enum

High pass filter 2 corner frequency.

Attributes:

Name Type Description
KHZ350

350 kHz (default).
KHZ700

700 kHz.
MHZ1_4

1.4 MHz.
MHZ2_8

2.8 MHz.
Source code in src/xwr/radar/defines.py 
102
103
104
105
106
107
108
109
110
111
112
113
114
115
class HPFCornerFreq2(Enum):
    """High pass filter 2 corner frequency.

    Attributes:
        KHZ350: 350 kHz (default).
        KHZ700: 700 kHz.
        MHZ1_4: 1.4 MHz.
        MHZ2_8: 2.8 MHz.
    """

    KHZ350 = 0
    KHZ700 = 1
    MHZ1_4 = 2
    MHZ2_8 = 3

xwr.radar.defines.LVDSFormat

Bases: Enum

LVDS data format.

Attributes:

Name Type Description
DISABLED

LVDS disabled.
ADC

ADC data; we use this mode to get spectrum data.
CP_ADC_CQ

CP ADC and CQ data.
Source code in src/xwr/radar/defines.py 
11
12
13
14
15
16
17
18
19
20
21
22
23
24
class LVDSFormat(Enum):
    """LVDS data format.

    Attributes:
        DISABLED: LVDS disabled.
        ADC: ADC data; we use this mode to get spectrum data.
        CP_ADC_CQ: CP ADC and CQ data.
    """

    DISABLED = 0
    ADC = 1
    _RESERVED2 = 2
    _RESERVED3 = 3
    CP_ADC_CQ = 4

xwr.radar.defines.SampleSwap

Bases: Enum

ADC I/Q bit order.

Bug

MSB_LSB_QI doesn't seem to work, so we've labeled it as _NONFUNCTIONAL.

Attributes:

Name Type Description
MSB_LSB_IQ

I is in the MSB, Q is in the LSB (default).
Source code in src/xwr/radar/defines.py 
70
71
72
73
74
75
76
77
78
79
80
81
82
83
class SampleSwap(Enum):
    """ADC I/Q bit order.

    !!! bug

        MSB_LSB_QI doesn't seem to work, so we've labeled it as
        `_NONFUNCTIONAL`.

    Attributes:
        MSB_LSB_IQ: I is in the MSB, Q is in the LSB (default).
    """

    MSB_LSB_QI_NONFUNCTIONAL = 0
    MSB_LSB_IQ = 1