-
Notifications
You must be signed in to change notification settings - Fork 4
/
wireless_link_parameter_map.yaml
304 lines (302 loc) · 10.9 KB
/
wireless_link_parameter_map.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
#
# Copyright 2022 National Instruments Corporation
#
# SPDX-License-Identifier: MIT
#
# Wireless Link Parameter Map
# Components:
# Transmitter: list of waveform configuration based on standard
# Parameters pair is given via this parameter map dictionary (Parameter name in Waveform creator vs that in the API ~ SigMF meta-data)
# Having a separate dictionary ease of adoption in case of:
# - Adding new parameters
# - Use different waveform creator that has Different naming scheme
# - Define your own customized standard or new wireless system
# - All changes are limited to parameter map dictionary
# the parameter name of waveform generator has the following style:
# StandardName_WaveformGenerator_parameter, i.e.
# if standard = 5gnr, WaveformGenerator: ni_rfmx_rfws, then the parameter name: 5gnr_ni_rfmx_rfws_parameter
# =====================================================================================
# ======== list of parameter pairs between waveform config and API ~ SigMF Meta-Data ===
# =====================================================================================
# List of waveform generators that generate waveforms
# key:
# standard: "name"
# generator: "link or text ... etc"
# key: Used to create parameter names in wireless_link_parameter_map
# Recommended name for each waveform generator to be given as: standard_WaveformGenerator
# Example: 5g NR waveform created using RFmx with RFWS config file: "5gnr_ni_rfmx_rfws"
# Note: The suffix "_parameter" will be added automatically
# standard name: occur in meta-data
# generator: generator description to occur in meta-data
waveform_generator:
# waveform_source: standard
5gnr_ni_rfmx_rfws: # Generated using NI RFmx Tool
standard: "5gnr"
generator: "NI RFmx Waveform Creator: https://www.ni.com/en-ca/shop/wireless-design-test/application-software-for-wireless-design-test-category/what-is-rfmx.html"
lte_ni_rfmx_rfws: # Generated using NI RFmx Tool
standard: "lte"
generator: "NI RFmx Waveform Creator: https://www.ni.com/en-ca/shop/wireless-design-test/application-software-for-wireless-design-test-category/what-is-rfmx.html"
radar_nist:
standard: "radar"
generator: "National Institute of Standards and Technology"
802.11_ieee_gen_matlab:
standard: "802.11"
generator: "ieee_gen_matlab"
transmitter:
# 5G NR subfield
5gnr:
# Frequency Range
- sigmf_parameter_name: "frequency_range"
description: "Frequency Range"
5gnr_ni_rfmx_rfws_parameter:
name: "Frequency Range"
value_map: # simu value : SigMF value
"Range 1": "fr1"
"Range 2": "fr2"
# bandwidth
- sigmf_parameter_name: "bandwidth"
description: "5G NR bandwidth"
5gnr_ni_rfmx_rfws_parameter:
name: "Bandwidth (Hz)"
# Link direction
- sigmf_parameter_name: "link_direction"
description: "Link direction"
5gnr_ni_rfmx_rfws_parameter:
name: "Link Direction"
# cell ID
- sigmf_parameter_name: "cell_id"
description: "cell ID"
5gnr_ni_rfmx_rfws_parameter:
name: "Cell ID"
# Number of frames
- sigmf_parameter_name: "num_frames"
description: Number of transmitted frames
5gnr_ni_rfmx_rfws_parameter:
name: 'Number of Frames'
# Frame structure
- sigmf_parameter_name: "frame_structure"
description: "5G NR duplexing scheme FDD, TDD, user defined"
5gnr_ni_rfmx_rfws_parameter:
name: "Duplex Scheme" # not exact, since it depends if the waveform is for UL or DL
# Subcarrier spacing in Hz
- sigmf_parameter_name: "subcarrier_spacing"
description: "Subcarrier spacing in Hz"
5gnr_ni_rfmx_rfws_parameter:
name: Subcarrier Spacing (Hz)
# Cyclic prefix mode
- sigmf_parameter_name: "cp_mode"
description: "Cyclic prefix mode"
5gnr_ni_rfmx_rfws_parameter:
name: "Cyclic Prefix Mode"
# SSB configuration
- sigmf_parameter_name: "ssb:config"
description: "SSB Configuration set"
5gnr_ni_rfmx_rfws_parameter:
name: "Configuration Set"
# SSB subcarrier spacing
- sigmf_parameter_name: "ssb:subcarrier_spacing"
description: "subcarrier spacing"
5gnr_ni_rfmx_rfws_parameter:
name: "Subcarrier Spacing Common"
# SSB periodicity
- sigmf_parameter_name: "ssb:periodicity"
description: "SSB periodicity in ms"
5gnr_ni_rfmx_rfws_parameter:
name: "Periodicity"
# Sampling rate in Hz
- sigmf_parameter_name: "sample_rate"
description: "Sampling rate in Hz"
5gnr_ni_rfmx_rfws_parameter:
name: "sample_rate_hz"
# Test Model
- sigmf_parameter_name: "test_model"
description: "Test Model"
5gnr_ni_rfmx_rfws_parameter:
name: "Test Model"
# pdsch Modulation
- sigmf_parameter_name: "pdsch:modulation"
description: "PDSCH modulation"
5gnr_ni_rfmx_rfws_parameter:
name: "DL Modulation Type" # not exact name, since it depends if the waveform created based on test model or user customized.
value_map: # simu value : SigMF value
"8PSK": "8_psk"
"QPSK": "qpsk"
"QAM16": "16_qam"
"QAM64": "64_qam"
"QAM256": "256_qam"
"QAM1024": "1024_qam"
"Standard": ""
# pusch Modulation
- sigmf_parameter_name: "pusch:modulation"
description: "PUSCH modulation"
5gnr_ni_rfmx_rfws_parameter:
name: "UL Modulation Type" # not exact name
value_map: # simu value : SigMF value
"8PSK": "8_psk"
"QPSK": "qpsk"
"QAM16": "16_qam"
"QAM64": "64_qam"
"QAM256": "256_qam"
"QAM1024": "1024_qam"
"Standard": ""
# LTE subfield
lte:
# bandwidth
- sigmf_parameter_name: "bandwidth"
description: "LTE bandwidth"
lte_ni_rfmx_rfws_parameter:
name: "Bandwidth"
# Frame structure
- sigmf_parameter_name: "frame_structure"
description: "LTE frame structure"
lte_ni_rfmx_rfws_parameter:
name: "factory"
# Link direction
- sigmf_parameter_name: "link_direction"
description: "Link direction"
lte_ni_rfmx_rfws_parameter:
name: "LinkDirection"
# cell ID
- sigmf_parameter_name: "cell_id"
description: "cell ID"
lte_ni_rfmx_rfws_parameter:
name: "CellID"
# test model
- sigmf_parameter_name: "test_model"
description: "Test Model"
lte_ni_rfmx_rfws_parameter:
name: "TestModel"
# Sampling rate in Hz
- sigmf_parameter_name: "sample_rate"
description: "Sampling rate in Hz"
lte_ni_rfmx_rfws_parameter:
name: "sample_rate"
# Subcarrier spacing in Hz
- sigmf_parameter_name: "subcarrier_spacing"
description: "Subcarrier spacing in Hz"
lte_ni_rfmx_rfws_parameter:
name: "subcarrier_spacing"
# Cyclic prefix mode
- sigmf_parameter_name: "cp_mode"
description: "Cyclic prefix mode"
lte_ni_rfmx_rfws_parameter:
name: "CyclicPrefixType"
value_map: # simu value : SigMF value
"0": "normal"
"1": "extended"
# PDSCH: modulation
- sigmf_parameter_name: "pdsch:modulation"
description: "PDSCH: modulation"
lte_ni_rfmx_rfws_parameter:
name: 'PDSCHCodeWord1ModulationType'
value_map: # simu value : SigMF value
"8PSK": "8_psk"
"QPSK": "qpsk"
"QAM16": "16_qam"
"QAM64": "64_qam"
"QAM256": "256_qam"
"QAM1024": "1024_qam"
"Standard": ""
# PUSCH: modulation
- sigmf_parameter_name: "pusch:modulation"
description: "PUSCH: modulation"
lte_ni_rfmx_rfws_parameter:
name: 'User Defined Modulation Type'
value_map: # simu value : SigMF value
"8PSK": "8_psk"
"QPSK": "qpsk"
"QAM16": "16_qam"
"QAM64": "64_qam"
"QAM256": "256_qam"
"QAM1024": "1024_qam"
"Standard": ""
# Radar
radar:
# Sampling rate in Hz
- sigmf_parameter_name: "sample_rate"
description: "Sampling rate in Hz"
radar_nist_parameter:
name: "sample_rate"
# bandwidth
- sigmf_parameter_name: "bandwidth"
description: "bandwidth in Hz"
radar_nist_parameter:
name: "bandwidth"
# time duration
- sigmf_parameter_name: "time_duration"
description: "Time duration in seconds"
radar_nist_parameter:
name: "time_duration"
# Pulse modulation type
- sigmf_parameter_name: "pulse_modulation_type"
description: "pulse modulation type"
radar_nist_parameter:
name: "pulse_modulation_type"
# Pulse Width
- sigmf_parameter_name: "pulse_width"
description: "pulse width"
radar_nist_parameter:
name: "pulse_width"
# Number of pulses per burst
- sigmf_parameter_name: "pulses_per_burst"
description: "Number of pulses per burst"
radar_nist_parameter:
name: "pulses_per_burst"
# Pulse repetition rate per second
- sigmf_parameter_name: "pulse_repetition_rate_hz"
description: "Pulse repetition rate per second"
radar_nist_parameter:
name: "pulse_repetition_rate_hz"
# 802.11 IEEE Waveform Generator: waveform data config in matlab format
wifi:
# modulation
- sigmf_parameter_name: "modulation"
description: "modulation"
802.11_ieee_gen_matlab_parameter:
name: 'mods'
value_map: # simu value : SigMF value
"1": "bpsk"
"2": "qpsk"
"4": "16_qam"
"6": "64_qam"
"8": "256_qam"
# modulation and coding scheme
- sigmf_parameter_name: "mcs"
description: "modulation and coding scheme"
802.11_ieee_gen_matlab_parameter:
name: 'mcs'
# code rate
- sigmf_parameter_name: "code_rate"
description: "Code rate"
802.11_ieee_gen_matlab_parameter:
name: 'crate'
# Scrampling Seed
- sigmf_parameter_name: "scrambling_seed"
description: "Scrambling Seed"
802.11_ieee_gen_matlab_parameter:
name: 'scram_seed'
# Number of OFDM Symbols
- sigmf_parameter_name: "num_ofdm_symbols"
description: "Number of OFDM Symbols"
802.11_ieee_gen_matlab_parameter:
name: 'N_sym'
# bandwidth
- sigmf_parameter_name: "bandwidth"
description: "bandwidth in Hz"
802.11_ieee_gen_matlab_parameter:
name: "BW_str"
# Sampling rate in Hz
- sigmf_parameter_name: "sample_rate"
description: "Sample rate in Hz"
802.11_ieee_gen_matlab_parameter:
name: "BW_str"
# MAC Frame Type
- sigmf_parameter_name: "mac_frame_format"
description: "MAC Frame format"
802.11_ieee_gen_matlab_parameter:
name: "format"
# MAC Frame Type
- sigmf_parameter_name: "psdu_length_bytes"
description: "PSDU length in bytes"
802.11_ieee_gen_matlab_parameter:
name: "PSDU_length"