| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1 | <html><body> |
| 2 | <style> |
| 3 | |
| 4 | body, h1, h2, h3, div, span, p, pre, a { |
| 5 | margin: 0; |
| 6 | padding: 0; |
| 7 | border: 0; |
| 8 | font-weight: inherit; |
| 9 | font-style: inherit; |
| 10 | font-size: 100%; |
| 11 | font-family: inherit; |
| 12 | vertical-align: baseline; |
| 13 | } |
| 14 | |
| 15 | body { |
| 16 | font-size: 13px; |
| 17 | padding: 1em; |
| 18 | } |
| 19 | |
| 20 | h1 { |
| 21 | font-size: 26px; |
| 22 | margin-bottom: 1em; |
| 23 | } |
| 24 | |
| 25 | h2 { |
| 26 | font-size: 24px; |
| 27 | margin-bottom: 1em; |
| 28 | } |
| 29 | |
| 30 | h3 { |
| 31 | font-size: 20px; |
| 32 | margin-bottom: 1em; |
| 33 | margin-top: 1em; |
| 34 | } |
| 35 | |
| 36 | pre, code { |
| 37 | line-height: 1.5; |
| 38 | font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| 39 | } |
| 40 | |
| 41 | pre { |
| 42 | margin-top: 0.5em; |
| 43 | } |
| 44 | |
| 45 | h1, h2, h3, p { |
| 46 | font-family: Arial, sans serif; |
| 47 | } |
| 48 | |
| 49 | h1, h2, h3 { |
| 50 | border-bottom: solid #CCC 1px; |
| 51 | } |
| 52 | |
| 53 | .toc_element { |
| 54 | margin-top: 0.5em; |
| 55 | } |
| 56 | |
| 57 | .firstline { |
| 58 | margin-left: 2 em; |
| 59 | } |
| 60 | |
| 61 | .method { |
| 62 | margin-top: 1em; |
| 63 | border: solid 1px #CCC; |
| 64 | padding: 1em; |
| 65 | background: #EEE; |
| 66 | } |
| 67 | |
| 68 | .details { |
| 69 | font-weight: bold; |
| 70 | font-size: 14px; |
| 71 | } |
| 72 | |
| 73 | </style> |
| 74 | |
| 75 | <h1><a href="sasportal_v1alpha1.html">SAS Portal API</a> . <a href="sasportal_v1alpha1.nodes.html">nodes</a> . <a href="sasportal_v1alpha1.nodes.devices.html">devices</a></h1> |
| 76 | <h2>Instance Methods</h2> |
| 77 | <p class="toc_element"> |
| 78 | <code><a href="#bulk">bulk(parent, body=None, x__xgafv=None)</a></code></p> |
| 79 | <p class="firstline">Creates a device under a node or customer. Returned devices are unordered.</p> |
| 80 | <p class="toc_element"> |
| 81 | <code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p> |
| 82 | <p class="firstline">Creates a device under a node or customer.</p> |
| 83 | <p class="toc_element"> |
| 84 | <code><a href="#createSigned">createSigned(parent, body=None, x__xgafv=None)</a></code></p> |
| 85 | <p class="firstline">Creates a signed device under a</p> |
| 86 | <p class="toc_element"> |
| 87 | <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p> |
| 88 | <p class="firstline">Deletes a device.</p> |
| 89 | <p class="toc_element"> |
| 90 | <code><a href="#get">get(name, x__xgafv=None)</a></code></p> |
| 91 | <p class="firstline">Gets details about a device.</p> |
| 92 | <p class="toc_element"> |
| 93 | <code><a href="#list">list(parent, filter=None, pageToken=None, pageSize=None, x__xgafv=None)</a></code></p> |
| 94 | <p class="firstline">Lists devices under a node or customer.</p> |
| 95 | <p class="toc_element"> |
| 96 | <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> |
| 97 | <p class="firstline">Retrieves the next page of results.</p> |
| 98 | <p class="toc_element"> |
| 99 | <code><a href="#move">move(name, body=None, x__xgafv=None)</a></code></p> |
| 100 | <p class="firstline">Moves a device under another node or customer.</p> |
| 101 | <p class="toc_element"> |
| 102 | <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p> |
| 103 | <p class="firstline">Updates a device.</p> |
| 104 | <p class="toc_element"> |
| 105 | <code><a href="#signDevice">signDevice(name, body=None, x__xgafv=None)</a></code></p> |
| 106 | <p class="firstline">Signs a device.</p> |
| 107 | <p class="toc_element"> |
| 108 | <code><a href="#updateSigned">updateSigned(name, body=None, x__xgafv=None)</a></code></p> |
| 109 | <p class="firstline">Updates a signed device.</p> |
| 110 | <h3>Method Details</h3> |
| 111 | <div class="method"> |
| 112 | <code class="details" id="bulk">bulk(parent, body=None, x__xgafv=None)</code> |
| 113 | <pre>Creates a device under a node or customer. Returned devices are unordered. |
| 114 | |
| 115 | Args: |
| 116 | parent: string, Required. The name of the parent resource. (required) |
| 117 | body: object, The request body. |
| 118 | The object takes the form of: |
| 119 | |
| 120 | { # Request for BulkCreateDevice method. |
| 121 | "csv": "A String", # Required. A csv with each row representing a [device]. Each row must |
| 122 | # conform to the regulations described on CreateDeviceRequest's device field. |
| 123 | } |
| 124 | |
| 125 | x__xgafv: string, V1 error format. |
| 126 | Allowed values |
| 127 | 1 - v1 error format |
| 128 | 2 - v2 error format |
| 129 | |
| 130 | Returns: |
| 131 | An object of the form: |
| 132 | |
| 133 | { # Response for BulkCreateDevice method. |
| 134 | "devices": [ # Required. The devices that were imported. |
| 135 | { |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 136 | "activeConfig": { # Information about the device configuration. # Output only. Current configuration of the device as registered to the SAS. |
| 137 | "measurementCapabilities": [ # Measurement reporting capabilities of the device. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 138 | "A String", |
| 139 | ], |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 140 | "callSign": "A String", # The call sign of the device operator. |
| 141 | "installationParams": { # Information about the device installation parameters. # Installation parameters for the device. |
| 142 | "longitude": 3.14, # Longitude of the device antenna location. in degrees relative to |
| 143 | # the WGS 84 datum. The allowed range is from -180.000000 to |
| 144 | # +180.000000. Positive values represent longitudes east of the |
| 145 | # prime meridian; negative values west of the prime |
| 146 | # meridian. |
| 147 | "antennaDowntilt": 42, # Antenna downtilt in degrees and is an integer with a value |
| 148 | # between -90 and +90 inclusive; a negative value means the antenna |
| 149 | # is tilted up (above horizontal). This parameter is optional for |
| 150 | # Category A devices and conditional for Category B devices. |
| 151 | "antennaBeamwidth": 42, # 3-dB antenna beamwidth of the antenna in the horizontal-plane in |
| 152 | # degrees. This parameter is an unsigned integer having a value |
| 153 | # between 0 and 360 (degrees) inclusive; it is optional for |
| 154 | # Category A devices and conditional for Category B devices. |
| 155 | "height": 3.14, # Device antenna height in meters. When the heightType parameter |
| 156 | # value is "AGL", the antenna height should be given relative to |
| 157 | # ground level. When the heightType parameter value is "AMSL", it |
| 158 | # is given with respect to WGS84 datum. |
| 159 | "indoorDeployment": True or False, # Whether the device antenna is indoor or not. True: indoor. False: |
| 160 | # outdoor. |
| 161 | "antennaAzimuth": 42, # Boresight direction of the horizontal plane of the antenna in |
| 162 | # degrees with respect to true north. The value of this parameter |
| 163 | # is an integer with a value between 0 and 359 inclusive. A value |
| 164 | # of 0 degrees means true north; a value of 90 degrees means |
| 165 | # east. This parameter is optional for Category A devices and |
| 166 | # conditional for Category B devices. |
| 167 | "latitude": 3.14, # Latitude of the device antenna location in degrees relative to |
| 168 | # the WGS 84 datum. The allowed range is from -90.000000 to |
| 169 | # +90.000000. Positive values represent latitudes north of the |
| 170 | # equator; negative values south of the equator. |
| 171 | "horizontalAccuracy": 3.14, # A positive number in meters to indicate accuracy of the device |
| 172 | # antenna horizontal location. This optional parameter should only |
| 173 | # be present if its value is less than the FCC requirement of 50 |
| 174 | # meters. |
| 175 | "heightType": "A String", # Specifies how the height is measured. |
| 176 | "antennaGain": 42, # Peak antenna gain in dBi. This parameter is an integer with a |
| 177 | # value between -127 and +128 (dBi) inclusive. |
| 178 | "eirpCapability": 42, # This parameter is the maximum device EIRP in units of dBm/10MHz |
| 179 | # and is an integer with a value between -127 and +47 (dBm/10 MHz) |
| 180 | # inclusive. If not included, SAS interprets it as maximum |
| 181 | # allowable EIRP in units of dBm/10MHz for device category. |
| 182 | "antennaModel": "A String", # If an external antenna is used, the antenna model is optionally |
| 183 | # provided in this field. The string has a maximum length of 128 |
| 184 | # octets. |
| 185 | "verticalAccuracy": 3.14, # A positive number in meters to indicate accuracy of the device |
| 186 | # antenna vertical location. This optional parameter should only be |
| 187 | # present if its value is less than the FCC requirement of 3 |
| 188 | # meters. |
| 189 | "cpeCbsdIndication": True or False, # If present, this parameter specifies whether the CBSD is a CPE-CBSD or not. |
| 190 | }, |
| 191 | "state": "A String", # State of the configuration. |
| 192 | "airInterface": { # Information about the device's air interface. # Information about this device's air interface. |
| 193 | "radioTechnology": "A String", # This field specifies the radio access technology that is used for the CBSD. |
| 194 | # |
| 195 | # Conditional |
| 196 | "supportedSpec": "A String", # This field is related to the radioTechnology field and provides the air |
| 197 | # interface specification that the CBSD is compliant with at the time of |
| 198 | # registration. |
| 199 | # |
| 200 | # Optional |
| 201 | }, |
| 202 | "model": { # Information about the model of the device. # Information about this device model. |
| 203 | "vendor": "A String", # The name of the device vendor. |
| 204 | "hardwareVersion": "A String", # The hardware version of the device. |
| 205 | "firmwareVersion": "A String", # The firmware version of the device. |
| 206 | "name": "A String", # The name of the device model. |
| 207 | "softwareVersion": "A String", # The software version of the device. |
| 208 | }, |
| 209 | "userId": "A String", # The identifier of a device user. |
| 210 | "category": "A String", # FCC category of the device. |
| 211 | "updateTime": "A String", # Output-only. The last time the device configuration was edited. |
| 212 | "isSigned": True or False, # Output-only. Whether the configuration has been signed by a CPI. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 213 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 214 | "displayName": "A String", # Device display name. |
| 215 | "grants": [ # Output only. Grants held by the device. |
| 216 | { # Device grant. It is an authorization provided by the Spectrum |
| 217 | # Access System to a device to transmit using specified operating |
| 218 | # parameters after a successful heartbeat by the device. |
| 219 | "maxEirp": 3.14, # Maximum Equivalent Isotropically Radiated Power (EIRP) permitted |
| 220 | # by the grant. The maximum EIRP is in units of dBm/MHz. The |
| 221 | # value of maxEirp represents the average (RMS) EIRP that would be |
| 222 | # measured by the procedure defined in FCC part 96.41(e)(3). |
| 223 | "frequencyRange": { # Frequency range from `low_frequency` to `high_frequency`. # The transmission frequency range. |
| 224 | "lowFrequencyMhz": 3.14, # The lowest frequency of the frequency range in MHz. |
| 225 | "highFrequencyMhz": 3.14, # The highest frequency of the frequency range in MHz. |
| 226 | }, |
| 227 | "channelType": "A String", # Type of channel used. |
| 228 | "expireTime": "A String", # The expiration time of the grant. |
| 229 | "suspensionReason": [ # If the grant is suspended, the reason(s) for suspension. |
| 230 | "A String", |
| 231 | ], |
| 232 | "moveList": [ # The DPA move lists on which this grant appears. |
| 233 | { # An entry in a DPA's move list. |
| 234 | "dpaId": "A String", # The ID of the DPA. |
| 235 | "frequencyRange": { # Frequency range from `low_frequency` to `high_frequency`. # The frequency range that the move list affects. |
| 236 | "lowFrequencyMhz": 3.14, # The lowest frequency of the frequency range in MHz. |
| 237 | "highFrequencyMhz": 3.14, # The highest frequency of the frequency range in MHz. |
| 238 | }, |
| 239 | }, |
| 240 | ], |
| 241 | "state": "A String", # State of the grant. |
| 242 | }, |
| 243 | ], |
| 244 | "fccId": "A String", # The FCC identifier of the device. |
| 245 | "serialNumber": "A String", # A serial number assigned to the device by the device |
| 246 | # manufacturer. |
| 247 | "state": "A String", # Output only. Device state. |
| 248 | "name": "A String", # Output only. The resource path name. |
| 249 | "preloadedConfig": { # Information about the device configuration. # Configuration of the device, as specified via SAS Portal API. |
| 250 | "measurementCapabilities": [ # Measurement reporting capabilities of the device. |
| 251 | "A String", |
| 252 | ], |
| 253 | "callSign": "A String", # The call sign of the device operator. |
| 254 | "installationParams": { # Information about the device installation parameters. # Installation parameters for the device. |
| 255 | "longitude": 3.14, # Longitude of the device antenna location. in degrees relative to |
| 256 | # the WGS 84 datum. The allowed range is from -180.000000 to |
| 257 | # +180.000000. Positive values represent longitudes east of the |
| 258 | # prime meridian; negative values west of the prime |
| 259 | # meridian. |
| 260 | "antennaDowntilt": 42, # Antenna downtilt in degrees and is an integer with a value |
| 261 | # between -90 and +90 inclusive; a negative value means the antenna |
| 262 | # is tilted up (above horizontal). This parameter is optional for |
| 263 | # Category A devices and conditional for Category B devices. |
| 264 | "antennaBeamwidth": 42, # 3-dB antenna beamwidth of the antenna in the horizontal-plane in |
| 265 | # degrees. This parameter is an unsigned integer having a value |
| 266 | # between 0 and 360 (degrees) inclusive; it is optional for |
| 267 | # Category A devices and conditional for Category B devices. |
| 268 | "height": 3.14, # Device antenna height in meters. When the heightType parameter |
| 269 | # value is "AGL", the antenna height should be given relative to |
| 270 | # ground level. When the heightType parameter value is "AMSL", it |
| 271 | # is given with respect to WGS84 datum. |
| 272 | "indoorDeployment": True or False, # Whether the device antenna is indoor or not. True: indoor. False: |
| 273 | # outdoor. |
| 274 | "antennaAzimuth": 42, # Boresight direction of the horizontal plane of the antenna in |
| 275 | # degrees with respect to true north. The value of this parameter |
| 276 | # is an integer with a value between 0 and 359 inclusive. A value |
| 277 | # of 0 degrees means true north; a value of 90 degrees means |
| 278 | # east. This parameter is optional for Category A devices and |
| 279 | # conditional for Category B devices. |
| 280 | "latitude": 3.14, # Latitude of the device antenna location in degrees relative to |
| 281 | # the WGS 84 datum. The allowed range is from -90.000000 to |
| 282 | # +90.000000. Positive values represent latitudes north of the |
| 283 | # equator; negative values south of the equator. |
| 284 | "horizontalAccuracy": 3.14, # A positive number in meters to indicate accuracy of the device |
| 285 | # antenna horizontal location. This optional parameter should only |
| 286 | # be present if its value is less than the FCC requirement of 50 |
| 287 | # meters. |
| 288 | "heightType": "A String", # Specifies how the height is measured. |
| 289 | "antennaGain": 42, # Peak antenna gain in dBi. This parameter is an integer with a |
| 290 | # value between -127 and +128 (dBi) inclusive. |
| 291 | "eirpCapability": 42, # This parameter is the maximum device EIRP in units of dBm/10MHz |
| 292 | # and is an integer with a value between -127 and +47 (dBm/10 MHz) |
| 293 | # inclusive. If not included, SAS interprets it as maximum |
| 294 | # allowable EIRP in units of dBm/10MHz for device category. |
| 295 | "antennaModel": "A String", # If an external antenna is used, the antenna model is optionally |
| 296 | # provided in this field. The string has a maximum length of 128 |
| 297 | # octets. |
| 298 | "verticalAccuracy": 3.14, # A positive number in meters to indicate accuracy of the device |
| 299 | # antenna vertical location. This optional parameter should only be |
| 300 | # present if its value is less than the FCC requirement of 3 |
| 301 | # meters. |
| 302 | "cpeCbsdIndication": True or False, # If present, this parameter specifies whether the CBSD is a CPE-CBSD or not. |
| 303 | }, |
| 304 | "state": "A String", # State of the configuration. |
| 305 | "airInterface": { # Information about the device's air interface. # Information about this device's air interface. |
| 306 | "radioTechnology": "A String", # This field specifies the radio access technology that is used for the CBSD. |
| 307 | # |
| 308 | # Conditional |
| 309 | "supportedSpec": "A String", # This field is related to the radioTechnology field and provides the air |
| 310 | # interface specification that the CBSD is compliant with at the time of |
| 311 | # registration. |
| 312 | # |
| 313 | # Optional |
| 314 | }, |
| 315 | "model": { # Information about the model of the device. # Information about this device model. |
| 316 | "vendor": "A String", # The name of the device vendor. |
| 317 | "hardwareVersion": "A String", # The hardware version of the device. |
| 318 | "firmwareVersion": "A String", # The firmware version of the device. |
| 319 | "name": "A String", # The name of the device model. |
| 320 | "softwareVersion": "A String", # The software version of the device. |
| 321 | }, |
| 322 | "userId": "A String", # The identifier of a device user. |
| 323 | "category": "A String", # FCC category of the device. |
| 324 | "updateTime": "A String", # Output-only. The last time the device configuration was edited. |
| 325 | "isSigned": True or False, # Output-only. Whether the configuration has been signed by a CPI. |
| 326 | }, |
| 327 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 328 | ], |
| 329 | }</pre> |
| 330 | </div> |
| 331 | |
| 332 | <div class="method"> |
| 333 | <code class="details" id="create">create(parent, body=None, x__xgafv=None)</code> |
| 334 | <pre>Creates a device under a node or customer. |
| 335 | |
| 336 | Args: |
| 337 | parent: string, Required. The name of the parent resource. (required) |
| 338 | body: object, The request body. |
| 339 | The object takes the form of: |
| 340 | |
| 341 | { |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 342 | "activeConfig": { # Information about the device configuration. # Output only. Current configuration of the device as registered to the SAS. |
| 343 | "measurementCapabilities": [ # Measurement reporting capabilities of the device. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 344 | "A String", |
| 345 | ], |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 346 | "callSign": "A String", # The call sign of the device operator. |
| 347 | "installationParams": { # Information about the device installation parameters. # Installation parameters for the device. |
| 348 | "longitude": 3.14, # Longitude of the device antenna location. in degrees relative to |
| 349 | # the WGS 84 datum. The allowed range is from -180.000000 to |
| 350 | # +180.000000. Positive values represent longitudes east of the |
| 351 | # prime meridian; negative values west of the prime |
| 352 | # meridian. |
| 353 | "antennaDowntilt": 42, # Antenna downtilt in degrees and is an integer with a value |
| 354 | # between -90 and +90 inclusive; a negative value means the antenna |
| 355 | # is tilted up (above horizontal). This parameter is optional for |
| 356 | # Category A devices and conditional for Category B devices. |
| 357 | "antennaBeamwidth": 42, # 3-dB antenna beamwidth of the antenna in the horizontal-plane in |
| 358 | # degrees. This parameter is an unsigned integer having a value |
| 359 | # between 0 and 360 (degrees) inclusive; it is optional for |
| 360 | # Category A devices and conditional for Category B devices. |
| 361 | "height": 3.14, # Device antenna height in meters. When the heightType parameter |
| 362 | # value is "AGL", the antenna height should be given relative to |
| 363 | # ground level. When the heightType parameter value is "AMSL", it |
| 364 | # is given with respect to WGS84 datum. |
| 365 | "indoorDeployment": True or False, # Whether the device antenna is indoor or not. True: indoor. False: |
| 366 | # outdoor. |
| 367 | "antennaAzimuth": 42, # Boresight direction of the horizontal plane of the antenna in |
| 368 | # degrees with respect to true north. The value of this parameter |
| 369 | # is an integer with a value between 0 and 359 inclusive. A value |
| 370 | # of 0 degrees means true north; a value of 90 degrees means |
| 371 | # east. This parameter is optional for Category A devices and |
| 372 | # conditional for Category B devices. |
| 373 | "latitude": 3.14, # Latitude of the device antenna location in degrees relative to |
| 374 | # the WGS 84 datum. The allowed range is from -90.000000 to |
| 375 | # +90.000000. Positive values represent latitudes north of the |
| 376 | # equator; negative values south of the equator. |
| 377 | "horizontalAccuracy": 3.14, # A positive number in meters to indicate accuracy of the device |
| 378 | # antenna horizontal location. This optional parameter should only |
| 379 | # be present if its value is less than the FCC requirement of 50 |
| 380 | # meters. |
| 381 | "heightType": "A String", # Specifies how the height is measured. |
| 382 | "antennaGain": 42, # Peak antenna gain in dBi. This parameter is an integer with a |
| 383 | # value between -127 and +128 (dBi) inclusive. |
| 384 | "eirpCapability": 42, # This parameter is the maximum device EIRP in units of dBm/10MHz |
| 385 | # and is an integer with a value between -127 and +47 (dBm/10 MHz) |
| 386 | # inclusive. If not included, SAS interprets it as maximum |
| 387 | # allowable EIRP in units of dBm/10MHz for device category. |
| 388 | "antennaModel": "A String", # If an external antenna is used, the antenna model is optionally |
| 389 | # provided in this field. The string has a maximum length of 128 |
| 390 | # octets. |
| 391 | "verticalAccuracy": 3.14, # A positive number in meters to indicate accuracy of the device |
| 392 | # antenna vertical location. This optional parameter should only be |
| 393 | # present if its value is less than the FCC requirement of 3 |
| 394 | # meters. |
| 395 | "cpeCbsdIndication": True or False, # If present, this parameter specifies whether the CBSD is a CPE-CBSD or not. |
| 396 | }, |
| 397 | "state": "A String", # State of the configuration. |
| 398 | "airInterface": { # Information about the device's air interface. # Information about this device's air interface. |
| 399 | "radioTechnology": "A String", # This field specifies the radio access technology that is used for the CBSD. |
| 400 | # |
| 401 | # Conditional |
| 402 | "supportedSpec": "A String", # This field is related to the radioTechnology field and provides the air |
| 403 | # interface specification that the CBSD is compliant with at the time of |
| 404 | # registration. |
| 405 | # |
| 406 | # Optional |
| 407 | }, |
| 408 | "model": { # Information about the model of the device. # Information about this device model. |
| 409 | "vendor": "A String", # The name of the device vendor. |
| 410 | "hardwareVersion": "A String", # The hardware version of the device. |
| 411 | "firmwareVersion": "A String", # The firmware version of the device. |
| 412 | "name": "A String", # The name of the device model. |
| 413 | "softwareVersion": "A String", # The software version of the device. |
| 414 | }, |
| 415 | "userId": "A String", # The identifier of a device user. |
| 416 | "category": "A String", # FCC category of the device. |
| 417 | "updateTime": "A String", # Output-only. The last time the device configuration was edited. |
| 418 | "isSigned": True or False, # Output-only. Whether the configuration has been signed by a CPI. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 419 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 420 | "displayName": "A String", # Device display name. |
| 421 | "grants": [ # Output only. Grants held by the device. |
| 422 | { # Device grant. It is an authorization provided by the Spectrum |
| 423 | # Access System to a device to transmit using specified operating |
| 424 | # parameters after a successful heartbeat by the device. |
| 425 | "maxEirp": 3.14, # Maximum Equivalent Isotropically Radiated Power (EIRP) permitted |
| 426 | # by the grant. The maximum EIRP is in units of dBm/MHz. The |
| 427 | # value of maxEirp represents the average (RMS) EIRP that would be |
| 428 | # measured by the procedure defined in FCC part 96.41(e)(3). |
| 429 | "frequencyRange": { # Frequency range from `low_frequency` to `high_frequency`. # The transmission frequency range. |
| 430 | "lowFrequencyMhz": 3.14, # The lowest frequency of the frequency range in MHz. |
| 431 | "highFrequencyMhz": 3.14, # The highest frequency of the frequency range in MHz. |
| 432 | }, |
| 433 | "channelType": "A String", # Type of channel used. |
| 434 | "expireTime": "A String", # The expiration time of the grant. |
| 435 | "suspensionReason": [ # If the grant is suspended, the reason(s) for suspension. |
| 436 | "A String", |
| 437 | ], |
| 438 | "moveList": [ # The DPA move lists on which this grant appears. |
| 439 | { # An entry in a DPA's move list. |
| 440 | "dpaId": "A String", # The ID of the DPA. |
| 441 | "frequencyRange": { # Frequency range from `low_frequency` to `high_frequency`. # The frequency range that the move list affects. |
| 442 | "lowFrequencyMhz": 3.14, # The lowest frequency of the frequency range in MHz. |
| 443 | "highFrequencyMhz": 3.14, # The highest frequency of the frequency range in MHz. |
| 444 | }, |
| 445 | }, |
| 446 | ], |
| 447 | "state": "A String", # State of the grant. |
| 448 | }, |
| 449 | ], |
| 450 | "fccId": "A String", # The FCC identifier of the device. |
| 451 | "serialNumber": "A String", # A serial number assigned to the device by the device |
| 452 | # manufacturer. |
| 453 | "state": "A String", # Output only. Device state. |
| 454 | "name": "A String", # Output only. The resource path name. |
| 455 | "preloadedConfig": { # Information about the device configuration. # Configuration of the device, as specified via SAS Portal API. |
| 456 | "measurementCapabilities": [ # Measurement reporting capabilities of the device. |
| 457 | "A String", |
| 458 | ], |
| 459 | "callSign": "A String", # The call sign of the device operator. |
| 460 | "installationParams": { # Information about the device installation parameters. # Installation parameters for the device. |
| 461 | "longitude": 3.14, # Longitude of the device antenna location. in degrees relative to |
| 462 | # the WGS 84 datum. The allowed range is from -180.000000 to |
| 463 | # +180.000000. Positive values represent longitudes east of the |
| 464 | # prime meridian; negative values west of the prime |
| 465 | # meridian. |
| 466 | "antennaDowntilt": 42, # Antenna downtilt in degrees and is an integer with a value |
| 467 | # between -90 and +90 inclusive; a negative value means the antenna |
| 468 | # is tilted up (above horizontal). This parameter is optional for |
| 469 | # Category A devices and conditional for Category B devices. |
| 470 | "antennaBeamwidth": 42, # 3-dB antenna beamwidth of the antenna in the horizontal-plane in |
| 471 | # degrees. This parameter is an unsigned integer having a value |
| 472 | # between 0 and 360 (degrees) inclusive; it is optional for |
| 473 | # Category A devices and conditional for Category B devices. |
| 474 | "height": 3.14, # Device antenna height in meters. When the heightType parameter |
| 475 | # value is "AGL", the antenna height should be given relative to |
| 476 | # ground level. When the heightType parameter value is "AMSL", it |
| 477 | # is given with respect to WGS84 datum. |
| 478 | "indoorDeployment": True or False, # Whether the device antenna is indoor or not. True: indoor. False: |
| 479 | # outdoor. |
| 480 | "antennaAzimuth": 42, # Boresight direction of the horizontal plane of the antenna in |
| 481 | # degrees with respect to true north. The value of this parameter |
| 482 | # is an integer with a value between 0 and 359 inclusive. A value |
| 483 | # of 0 degrees means true north; a value of 90 degrees means |
| 484 | # east. This parameter is optional for Category A devices and |
| 485 | # conditional for Category B devices. |
| 486 | "latitude": 3.14, # Latitude of the device antenna location in degrees relative to |
| 487 | # the WGS 84 datum. The allowed range is from -90.000000 to |
| 488 | # +90.000000. Positive values represent latitudes north of the |
| 489 | # equator; negative values south of the equator. |
| 490 | "horizontalAccuracy": 3.14, # A positive number in meters to indicate accuracy of the device |
| 491 | # antenna horizontal location. This optional parameter should only |
| 492 | # be present if its value is less than the FCC requirement of 50 |
| 493 | # meters. |
| 494 | "heightType": "A String", # Specifies how the height is measured. |
| 495 | "antennaGain": 42, # Peak antenna gain in dBi. This parameter is an integer with a |
| 496 | # value between -127 and +128 (dBi) inclusive. |
| 497 | "eirpCapability": 42, # This parameter is the maximum device EIRP in units of dBm/10MHz |
| 498 | # and is an integer with a value between -127 and +47 (dBm/10 MHz) |
| 499 | # inclusive. If not included, SAS interprets it as maximum |
| 500 | # allowable EIRP in units of dBm/10MHz for device category. |
| 501 | "antennaModel": "A String", # If an external antenna is used, the antenna model is optionally |
| 502 | # provided in this field. The string has a maximum length of 128 |
| 503 | # octets. |
| 504 | "verticalAccuracy": 3.14, # A positive number in meters to indicate accuracy of the device |
| 505 | # antenna vertical location. This optional parameter should only be |
| 506 | # present if its value is less than the FCC requirement of 3 |
| 507 | # meters. |
| 508 | "cpeCbsdIndication": True or False, # If present, this parameter specifies whether the CBSD is a CPE-CBSD or not. |
| 509 | }, |
| 510 | "state": "A String", # State of the configuration. |
| 511 | "airInterface": { # Information about the device's air interface. # Information about this device's air interface. |
| 512 | "radioTechnology": "A String", # This field specifies the radio access technology that is used for the CBSD. |
| 513 | # |
| 514 | # Conditional |
| 515 | "supportedSpec": "A String", # This field is related to the radioTechnology field and provides the air |
| 516 | # interface specification that the CBSD is compliant with at the time of |
| 517 | # registration. |
| 518 | # |
| 519 | # Optional |
| 520 | }, |
| 521 | "model": { # Information about the model of the device. # Information about this device model. |
| 522 | "vendor": "A String", # The name of the device vendor. |
| 523 | "hardwareVersion": "A String", # The hardware version of the device. |
| 524 | "firmwareVersion": "A String", # The firmware version of the device. |
| 525 | "name": "A String", # The name of the device model. |
| 526 | "softwareVersion": "A String", # The software version of the device. |
| 527 | }, |
| 528 | "userId": "A String", # The identifier of a device user. |
| 529 | "category": "A String", # FCC category of the device. |
| 530 | "updateTime": "A String", # Output-only. The last time the device configuration was edited. |
| 531 | "isSigned": True or False, # Output-only. Whether the configuration has been signed by a CPI. |
| 532 | }, |
| 533 | } |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 534 | |
| 535 | x__xgafv: string, V1 error format. |
| 536 | Allowed values |
| 537 | 1 - v1 error format |
| 538 | 2 - v2 error format |
| 539 | |
| 540 | Returns: |
| 541 | An object of the form: |
| 542 | |
| 543 | { |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 544 | "activeConfig": { # Information about the device configuration. # Output only. Current configuration of the device as registered to the SAS. |
| 545 | "measurementCapabilities": [ # Measurement reporting capabilities of the device. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 546 | "A String", |
| 547 | ], |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 548 | "callSign": "A String", # The call sign of the device operator. |
| 549 | "installationParams": { # Information about the device installation parameters. # Installation parameters for the device. |
| 550 | "longitude": 3.14, # Longitude of the device antenna location. in degrees relative to |
| 551 | # the WGS 84 datum. The allowed range is from -180.000000 to |
| 552 | # +180.000000. Positive values represent longitudes east of the |
| 553 | # prime meridian; negative values west of the prime |
| 554 | # meridian. |
| 555 | "antennaDowntilt": 42, # Antenna downtilt in degrees and is an integer with a value |
| 556 | # between -90 and +90 inclusive; a negative value means the antenna |
| 557 | # is tilted up (above horizontal). This parameter is optional for |
| 558 | # Category A devices and conditional for Category B devices. |
| 559 | "antennaBeamwidth": 42, # 3-dB antenna beamwidth of the antenna in the horizontal-plane in |
| 560 | # degrees. This parameter is an unsigned integer having a value |
| 561 | # between 0 and 360 (degrees) inclusive; it is optional for |
| 562 | # Category A devices and conditional for Category B devices. |
| 563 | "height": 3.14, # Device antenna height in meters. When the heightType parameter |
| 564 | # value is "AGL", the antenna height should be given relative to |
| 565 | # ground level. When the heightType parameter value is "AMSL", it |
| 566 | # is given with respect to WGS84 datum. |
| 567 | "indoorDeployment": True or False, # Whether the device antenna is indoor or not. True: indoor. False: |
| 568 | # outdoor. |
| 569 | "antennaAzimuth": 42, # Boresight direction of the horizontal plane of the antenna in |
| 570 | # degrees with respect to true north. The value of this parameter |
| 571 | # is an integer with a value between 0 and 359 inclusive. A value |
| 572 | # of 0 degrees means true north; a value of 90 degrees means |
| 573 | # east. This parameter is optional for Category A devices and |
| 574 | # conditional for Category B devices. |
| 575 | "latitude": 3.14, # Latitude of the device antenna location in degrees relative to |
| 576 | # the WGS 84 datum. The allowed range is from -90.000000 to |
| 577 | # +90.000000. Positive values represent latitudes north of the |
| 578 | # equator; negative values south of the equator. |
| 579 | "horizontalAccuracy": 3.14, # A positive number in meters to indicate accuracy of the device |
| 580 | # antenna horizontal location. This optional parameter should only |
| 581 | # be present if its value is less than the FCC requirement of 50 |
| 582 | # meters. |
| 583 | "heightType": "A String", # Specifies how the height is measured. |
| 584 | "antennaGain": 42, # Peak antenna gain in dBi. This parameter is an integer with a |
| 585 | # value between -127 and +128 (dBi) inclusive. |
| 586 | "eirpCapability": 42, # This parameter is the maximum device EIRP in units of dBm/10MHz |
| 587 | # and is an integer with a value between -127 and +47 (dBm/10 MHz) |
| 588 | # inclusive. If not included, SAS interprets it as maximum |
| 589 | # allowable EIRP in units of dBm/10MHz for device category. |
| 590 | "antennaModel": "A String", # If an external antenna is used, the antenna model is optionally |
| 591 | # provided in this field. The string has a maximum length of 128 |
| 592 | # octets. |
| 593 | "verticalAccuracy": 3.14, # A positive number in meters to indicate accuracy of the device |
| 594 | # antenna vertical location. This optional parameter should only be |
| 595 | # present if its value is less than the FCC requirement of 3 |
| 596 | # meters. |
| 597 | "cpeCbsdIndication": True or False, # If present, this parameter specifies whether the CBSD is a CPE-CBSD or not. |
| 598 | }, |
| 599 | "state": "A String", # State of the configuration. |
| 600 | "airInterface": { # Information about the device's air interface. # Information about this device's air interface. |
| 601 | "radioTechnology": "A String", # This field specifies the radio access technology that is used for the CBSD. |
| 602 | # |
| 603 | # Conditional |
| 604 | "supportedSpec": "A String", # This field is related to the radioTechnology field and provides the air |
| 605 | # interface specification that the CBSD is compliant with at the time of |
| 606 | # registration. |
| 607 | # |
| 608 | # Optional |
| 609 | }, |
| 610 | "model": { # Information about the model of the device. # Information about this device model. |
| 611 | "vendor": "A String", # The name of the device vendor. |
| 612 | "hardwareVersion": "A String", # The hardware version of the device. |
| 613 | "firmwareVersion": "A String", # The firmware version of the device. |
| 614 | "name": "A String", # The name of the device model. |
| 615 | "softwareVersion": "A String", # The software version of the device. |
| 616 | }, |
| 617 | "userId": "A String", # The identifier of a device user. |
| 618 | "category": "A String", # FCC category of the device. |
| 619 | "updateTime": "A String", # Output-only. The last time the device configuration was edited. |
| 620 | "isSigned": True or False, # Output-only. Whether the configuration has been signed by a CPI. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 621 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 622 | "displayName": "A String", # Device display name. |
| 623 | "grants": [ # Output only. Grants held by the device. |
| 624 | { # Device grant. It is an authorization provided by the Spectrum |
| 625 | # Access System to a device to transmit using specified operating |
| 626 | # parameters after a successful heartbeat by the device. |
| 627 | "maxEirp": 3.14, # Maximum Equivalent Isotropically Radiated Power (EIRP) permitted |
| 628 | # by the grant. The maximum EIRP is in units of dBm/MHz. The |
| 629 | # value of maxEirp represents the average (RMS) EIRP that would be |
| 630 | # measured by the procedure defined in FCC part 96.41(e)(3). |
| 631 | "frequencyRange": { # Frequency range from `low_frequency` to `high_frequency`. # The transmission frequency range. |
| 632 | "lowFrequencyMhz": 3.14, # The lowest frequency of the frequency range in MHz. |
| 633 | "highFrequencyMhz": 3.14, # The highest frequency of the frequency range in MHz. |
| 634 | }, |
| 635 | "channelType": "A String", # Type of channel used. |
| 636 | "expireTime": "A String", # The expiration time of the grant. |
| 637 | "suspensionReason": [ # If the grant is suspended, the reason(s) for suspension. |
| 638 | "A String", |
| 639 | ], |
| 640 | "moveList": [ # The DPA move lists on which this grant appears. |
| 641 | { # An entry in a DPA's move list. |
| 642 | "dpaId": "A String", # The ID of the DPA. |
| 643 | "frequencyRange": { # Frequency range from `low_frequency` to `high_frequency`. # The frequency range that the move list affects. |
| 644 | "lowFrequencyMhz": 3.14, # The lowest frequency of the frequency range in MHz. |
| 645 | "highFrequencyMhz": 3.14, # The highest frequency of the frequency range in MHz. |
| 646 | }, |
| 647 | }, |
| 648 | ], |
| 649 | "state": "A String", # State of the grant. |
| 650 | }, |
| 651 | ], |
| 652 | "fccId": "A String", # The FCC identifier of the device. |
| 653 | "serialNumber": "A String", # A serial number assigned to the device by the device |
| 654 | # manufacturer. |
| 655 | "state": "A String", # Output only. Device state. |
| 656 | "name": "A String", # Output only. The resource path name. |
| 657 | "preloadedConfig": { # Information about the device configuration. # Configuration of the device, as specified via SAS Portal API. |
| 658 | "measurementCapabilities": [ # Measurement reporting capabilities of the device. |
| 659 | "A String", |
| 660 | ], |
| 661 | "callSign": "A String", # The call sign of the device operator. |
| 662 | "installationParams": { # Information about the device installation parameters. # Installation parameters for the device. |
| 663 | "longitude": 3.14, # Longitude of the device antenna location. in degrees relative to |
| 664 | # the WGS 84 datum. The allowed range is from -180.000000 to |
| 665 | # +180.000000. Positive values represent longitudes east of the |
| 666 | # prime meridian; negative values west of the prime |
| 667 | # meridian. |
| 668 | "antennaDowntilt": 42, # Antenna downtilt in degrees and is an integer with a value |
| 669 | # between -90 and +90 inclusive; a negative value means the antenna |
| 670 | # is tilted up (above horizontal). This parameter is optional for |
| 671 | # Category A devices and conditional for Category B devices. |
| 672 | "antennaBeamwidth": 42, # 3-dB antenna beamwidth of the antenna in the horizontal-plane in |
| 673 | # degrees. This parameter is an unsigned integer having a value |
| 674 | # between 0 and 360 (degrees) inclusive; it is optional for |
| 675 | # Category A devices and conditional for Category B devices. |
| 676 | "height": 3.14, # Device antenna height in meters. When the heightType parameter |
| 677 | # value is "AGL", the antenna height should be given relative to |
| 678 | # ground level. When the heightType parameter value is "AMSL", it |
| 679 | # is given with respect to WGS84 datum. |
| 680 | "indoorDeployment": True or False, # Whether the device antenna is indoor or not. True: indoor. False: |
| 681 | # outdoor. |
| 682 | "antennaAzimuth": 42, # Boresight direction of the horizontal plane of the antenna in |
| 683 | # degrees with respect to true north. The value of this parameter |
| 684 | # is an integer with a value between 0 and 359 inclusive. A value |
| 685 | # of 0 degrees means true north; a value of 90 degrees means |
| 686 | # east. This parameter is optional for Category A devices and |
| 687 | # conditional for Category B devices. |
| 688 | "latitude": 3.14, # Latitude of the device antenna location in degrees relative to |
| 689 | # the WGS 84 datum. The allowed range is from -90.000000 to |
| 690 | # +90.000000. Positive values represent latitudes north of the |
| 691 | # equator; negative values south of the equator. |
| 692 | "horizontalAccuracy": 3.14, # A positive number in meters to indicate accuracy of the device |
| 693 | # antenna horizontal location. This optional parameter should only |
| 694 | # be present if its value is less than the FCC requirement of 50 |
| 695 | # meters. |
| 696 | "heightType": "A String", # Specifies how the height is measured. |
| 697 | "antennaGain": 42, # Peak antenna gain in dBi. This parameter is an integer with a |
| 698 | # value between -127 and +128 (dBi) inclusive. |
| 699 | "eirpCapability": 42, # This parameter is the maximum device EIRP in units of dBm/10MHz |
| 700 | # and is an integer with a value between -127 and +47 (dBm/10 MHz) |
| 701 | # inclusive. If not included, SAS interprets it as maximum |
| 702 | # allowable EIRP in units of dBm/10MHz for device category. |
| 703 | "antennaModel": "A String", # If an external antenna is used, the antenna model is optionally |
| 704 | # provided in this field. The string has a maximum length of 128 |
| 705 | # octets. |
| 706 | "verticalAccuracy": 3.14, # A positive number in meters to indicate accuracy of the device |
| 707 | # antenna vertical location. This optional parameter should only be |
| 708 | # present if its value is less than the FCC requirement of 3 |
| 709 | # meters. |
| 710 | "cpeCbsdIndication": True or False, # If present, this parameter specifies whether the CBSD is a CPE-CBSD or not. |
| 711 | }, |
| 712 | "state": "A String", # State of the configuration. |
| 713 | "airInterface": { # Information about the device's air interface. # Information about this device's air interface. |
| 714 | "radioTechnology": "A String", # This field specifies the radio access technology that is used for the CBSD. |
| 715 | # |
| 716 | # Conditional |
| 717 | "supportedSpec": "A String", # This field is related to the radioTechnology field and provides the air |
| 718 | # interface specification that the CBSD is compliant with at the time of |
| 719 | # registration. |
| 720 | # |
| 721 | # Optional |
| 722 | }, |
| 723 | "model": { # Information about the model of the device. # Information about this device model. |
| 724 | "vendor": "A String", # The name of the device vendor. |
| 725 | "hardwareVersion": "A String", # The hardware version of the device. |
| 726 | "firmwareVersion": "A String", # The firmware version of the device. |
| 727 | "name": "A String", # The name of the device model. |
| 728 | "softwareVersion": "A String", # The software version of the device. |
| 729 | }, |
| 730 | "userId": "A String", # The identifier of a device user. |
| 731 | "category": "A String", # FCC category of the device. |
| 732 | "updateTime": "A String", # Output-only. The last time the device configuration was edited. |
| 733 | "isSigned": True or False, # Output-only. Whether the configuration has been signed by a CPI. |
| 734 | }, |
| 735 | }</pre> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 736 | </div> |
| 737 | |
| 738 | <div class="method"> |
| 739 | <code class="details" id="createSigned">createSigned(parent, body=None, x__xgafv=None)</code> |
| 740 | <pre>Creates a signed device under a |
| 741 | node or customer. |
| 742 | |
| 743 | Args: |
| 744 | parent: string, Required. The name of the parent resource. (required) |
| 745 | body: object, The request body. |
| 746 | The object takes the form of: |
| 747 | |
| 748 | { # Request for CreateSignedDevice method. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 749 | "encodedDevice": "A String", # Required. JSON Web Token signed using a CPI private key. Payload |
| 750 | # must be the JSON encoding of the [Device]. The user_id field must be set. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 751 | "installerId": "A String", # Required. Unique installer id (cpiId) from the Certified Professional |
| 752 | # Installers database. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 753 | } |
| 754 | |
| 755 | x__xgafv: string, V1 error format. |
| 756 | Allowed values |
| 757 | 1 - v1 error format |
| 758 | 2 - v2 error format |
| 759 | |
| 760 | Returns: |
| 761 | An object of the form: |
| 762 | |
| 763 | { |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 764 | "activeConfig": { # Information about the device configuration. # Output only. Current configuration of the device as registered to the SAS. |
| 765 | "measurementCapabilities": [ # Measurement reporting capabilities of the device. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 766 | "A String", |
| 767 | ], |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 768 | "callSign": "A String", # The call sign of the device operator. |
| 769 | "installationParams": { # Information about the device installation parameters. # Installation parameters for the device. |
| 770 | "longitude": 3.14, # Longitude of the device antenna location. in degrees relative to |
| 771 | # the WGS 84 datum. The allowed range is from -180.000000 to |
| 772 | # +180.000000. Positive values represent longitudes east of the |
| 773 | # prime meridian; negative values west of the prime |
| 774 | # meridian. |
| 775 | "antennaDowntilt": 42, # Antenna downtilt in degrees and is an integer with a value |
| 776 | # between -90 and +90 inclusive; a negative value means the antenna |
| 777 | # is tilted up (above horizontal). This parameter is optional for |
| 778 | # Category A devices and conditional for Category B devices. |
| 779 | "antennaBeamwidth": 42, # 3-dB antenna beamwidth of the antenna in the horizontal-plane in |
| 780 | # degrees. This parameter is an unsigned integer having a value |
| 781 | # between 0 and 360 (degrees) inclusive; it is optional for |
| 782 | # Category A devices and conditional for Category B devices. |
| 783 | "height": 3.14, # Device antenna height in meters. When the heightType parameter |
| 784 | # value is "AGL", the antenna height should be given relative to |
| 785 | # ground level. When the heightType parameter value is "AMSL", it |
| 786 | # is given with respect to WGS84 datum. |
| 787 | "indoorDeployment": True or False, # Whether the device antenna is indoor or not. True: indoor. False: |
| 788 | # outdoor. |
| 789 | "antennaAzimuth": 42, # Boresight direction of the horizontal plane of the antenna in |
| 790 | # degrees with respect to true north. The value of this parameter |
| 791 | # is an integer with a value between 0 and 359 inclusive. A value |
| 792 | # of 0 degrees means true north; a value of 90 degrees means |
| 793 | # east. This parameter is optional for Category A devices and |
| 794 | # conditional for Category B devices. |
| 795 | "latitude": 3.14, # Latitude of the device antenna location in degrees relative to |
| 796 | # the WGS 84 datum. The allowed range is from -90.000000 to |
| 797 | # +90.000000. Positive values represent latitudes north of the |
| 798 | # equator; negative values south of the equator. |
| 799 | "horizontalAccuracy": 3.14, # A positive number in meters to indicate accuracy of the device |
| 800 | # antenna horizontal location. This optional parameter should only |
| 801 | # be present if its value is less than the FCC requirement of 50 |
| 802 | # meters. |
| 803 | "heightType": "A String", # Specifies how the height is measured. |
| 804 | "antennaGain": 42, # Peak antenna gain in dBi. This parameter is an integer with a |
| 805 | # value between -127 and +128 (dBi) inclusive. |
| 806 | "eirpCapability": 42, # This parameter is the maximum device EIRP in units of dBm/10MHz |
| 807 | # and is an integer with a value between -127 and +47 (dBm/10 MHz) |
| 808 | # inclusive. If not included, SAS interprets it as maximum |
| 809 | # allowable EIRP in units of dBm/10MHz for device category. |
| 810 | "antennaModel": "A String", # If an external antenna is used, the antenna model is optionally |
| 811 | # provided in this field. The string has a maximum length of 128 |
| 812 | # octets. |
| 813 | "verticalAccuracy": 3.14, # A positive number in meters to indicate accuracy of the device |
| 814 | # antenna vertical location. This optional parameter should only be |
| 815 | # present if its value is less than the FCC requirement of 3 |
| 816 | # meters. |
| 817 | "cpeCbsdIndication": True or False, # If present, this parameter specifies whether the CBSD is a CPE-CBSD or not. |
| 818 | }, |
| 819 | "state": "A String", # State of the configuration. |
| 820 | "airInterface": { # Information about the device's air interface. # Information about this device's air interface. |
| 821 | "radioTechnology": "A String", # This field specifies the radio access technology that is used for the CBSD. |
| 822 | # |
| 823 | # Conditional |
| 824 | "supportedSpec": "A String", # This field is related to the radioTechnology field and provides the air |
| 825 | # interface specification that the CBSD is compliant with at the time of |
| 826 | # registration. |
| 827 | # |
| 828 | # Optional |
| 829 | }, |
| 830 | "model": { # Information about the model of the device. # Information about this device model. |
| 831 | "vendor": "A String", # The name of the device vendor. |
| 832 | "hardwareVersion": "A String", # The hardware version of the device. |
| 833 | "firmwareVersion": "A String", # The firmware version of the device. |
| 834 | "name": "A String", # The name of the device model. |
| 835 | "softwareVersion": "A String", # The software version of the device. |
| 836 | }, |
| 837 | "userId": "A String", # The identifier of a device user. |
| 838 | "category": "A String", # FCC category of the device. |
| 839 | "updateTime": "A String", # Output-only. The last time the device configuration was edited. |
| 840 | "isSigned": True or False, # Output-only. Whether the configuration has been signed by a CPI. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 841 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 842 | "displayName": "A String", # Device display name. |
| 843 | "grants": [ # Output only. Grants held by the device. |
| 844 | { # Device grant. It is an authorization provided by the Spectrum |
| 845 | # Access System to a device to transmit using specified operating |
| 846 | # parameters after a successful heartbeat by the device. |
| 847 | "maxEirp": 3.14, # Maximum Equivalent Isotropically Radiated Power (EIRP) permitted |
| 848 | # by the grant. The maximum EIRP is in units of dBm/MHz. The |
| 849 | # value of maxEirp represents the average (RMS) EIRP that would be |
| 850 | # measured by the procedure defined in FCC part 96.41(e)(3). |
| 851 | "frequencyRange": { # Frequency range from `low_frequency` to `high_frequency`. # The transmission frequency range. |
| 852 | "lowFrequencyMhz": 3.14, # The lowest frequency of the frequency range in MHz. |
| 853 | "highFrequencyMhz": 3.14, # The highest frequency of the frequency range in MHz. |
| 854 | }, |
| 855 | "channelType": "A String", # Type of channel used. |
| 856 | "expireTime": "A String", # The expiration time of the grant. |
| 857 | "suspensionReason": [ # If the grant is suspended, the reason(s) for suspension. |
| 858 | "A String", |
| 859 | ], |
| 860 | "moveList": [ # The DPA move lists on which this grant appears. |
| 861 | { # An entry in a DPA's move list. |
| 862 | "dpaId": "A String", # The ID of the DPA. |
| 863 | "frequencyRange": { # Frequency range from `low_frequency` to `high_frequency`. # The frequency range that the move list affects. |
| 864 | "lowFrequencyMhz": 3.14, # The lowest frequency of the frequency range in MHz. |
| 865 | "highFrequencyMhz": 3.14, # The highest frequency of the frequency range in MHz. |
| 866 | }, |
| 867 | }, |
| 868 | ], |
| 869 | "state": "A String", # State of the grant. |
| 870 | }, |
| 871 | ], |
| 872 | "fccId": "A String", # The FCC identifier of the device. |
| 873 | "serialNumber": "A String", # A serial number assigned to the device by the device |
| 874 | # manufacturer. |
| 875 | "state": "A String", # Output only. Device state. |
| 876 | "name": "A String", # Output only. The resource path name. |
| 877 | "preloadedConfig": { # Information about the device configuration. # Configuration of the device, as specified via SAS Portal API. |
| 878 | "measurementCapabilities": [ # Measurement reporting capabilities of the device. |
| 879 | "A String", |
| 880 | ], |
| 881 | "callSign": "A String", # The call sign of the device operator. |
| 882 | "installationParams": { # Information about the device installation parameters. # Installation parameters for the device. |
| 883 | "longitude": 3.14, # Longitude of the device antenna location. in degrees relative to |
| 884 | # the WGS 84 datum. The allowed range is from -180.000000 to |
| 885 | # +180.000000. Positive values represent longitudes east of the |
| 886 | # prime meridian; negative values west of the prime |
| 887 | # meridian. |
| 888 | "antennaDowntilt": 42, # Antenna downtilt in degrees and is an integer with a value |
| 889 | # between -90 and +90 inclusive; a negative value means the antenna |
| 890 | # is tilted up (above horizontal). This parameter is optional for |
| 891 | # Category A devices and conditional for Category B devices. |
| 892 | "antennaBeamwidth": 42, # 3-dB antenna beamwidth of the antenna in the horizontal-plane in |
| 893 | # degrees. This parameter is an unsigned integer having a value |
| 894 | # between 0 and 360 (degrees) inclusive; it is optional for |
| 895 | # Category A devices and conditional for Category B devices. |
| 896 | "height": 3.14, # Device antenna height in meters. When the heightType parameter |
| 897 | # value is "AGL", the antenna height should be given relative to |
| 898 | # ground level. When the heightType parameter value is "AMSL", it |
| 899 | # is given with respect to WGS84 datum. |
| 900 | "indoorDeployment": True or False, # Whether the device antenna is indoor or not. True: indoor. False: |
| 901 | # outdoor. |
| 902 | "antennaAzimuth": 42, # Boresight direction of the horizontal plane of the antenna in |
| 903 | # degrees with respect to true north. The value of this parameter |
| 904 | # is an integer with a value between 0 and 359 inclusive. A value |
| 905 | # of 0 degrees means true north; a value of 90 degrees means |
| 906 | # east. This parameter is optional for Category A devices and |
| 907 | # conditional for Category B devices. |
| 908 | "latitude": 3.14, # Latitude of the device antenna location in degrees relative to |
| 909 | # the WGS 84 datum. The allowed range is from -90.000000 to |
| 910 | # +90.000000. Positive values represent latitudes north of the |
| 911 | # equator; negative values south of the equator. |
| 912 | "horizontalAccuracy": 3.14, # A positive number in meters to indicate accuracy of the device |
| 913 | # antenna horizontal location. This optional parameter should only |
| 914 | # be present if its value is less than the FCC requirement of 50 |
| 915 | # meters. |
| 916 | "heightType": "A String", # Specifies how the height is measured. |
| 917 | "antennaGain": 42, # Peak antenna gain in dBi. This parameter is an integer with a |
| 918 | # value between -127 and +128 (dBi) inclusive. |
| 919 | "eirpCapability": 42, # This parameter is the maximum device EIRP in units of dBm/10MHz |
| 920 | # and is an integer with a value between -127 and +47 (dBm/10 MHz) |
| 921 | # inclusive. If not included, SAS interprets it as maximum |
| 922 | # allowable EIRP in units of dBm/10MHz for device category. |
| 923 | "antennaModel": "A String", # If an external antenna is used, the antenna model is optionally |
| 924 | # provided in this field. The string has a maximum length of 128 |
| 925 | # octets. |
| 926 | "verticalAccuracy": 3.14, # A positive number in meters to indicate accuracy of the device |
| 927 | # antenna vertical location. This optional parameter should only be |
| 928 | # present if its value is less than the FCC requirement of 3 |
| 929 | # meters. |
| 930 | "cpeCbsdIndication": True or False, # If present, this parameter specifies whether the CBSD is a CPE-CBSD or not. |
| 931 | }, |
| 932 | "state": "A String", # State of the configuration. |
| 933 | "airInterface": { # Information about the device's air interface. # Information about this device's air interface. |
| 934 | "radioTechnology": "A String", # This field specifies the radio access technology that is used for the CBSD. |
| 935 | # |
| 936 | # Conditional |
| 937 | "supportedSpec": "A String", # This field is related to the radioTechnology field and provides the air |
| 938 | # interface specification that the CBSD is compliant with at the time of |
| 939 | # registration. |
| 940 | # |
| 941 | # Optional |
| 942 | }, |
| 943 | "model": { # Information about the model of the device. # Information about this device model. |
| 944 | "vendor": "A String", # The name of the device vendor. |
| 945 | "hardwareVersion": "A String", # The hardware version of the device. |
| 946 | "firmwareVersion": "A String", # The firmware version of the device. |
| 947 | "name": "A String", # The name of the device model. |
| 948 | "softwareVersion": "A String", # The software version of the device. |
| 949 | }, |
| 950 | "userId": "A String", # The identifier of a device user. |
| 951 | "category": "A String", # FCC category of the device. |
| 952 | "updateTime": "A String", # Output-only. The last time the device configuration was edited. |
| 953 | "isSigned": True or False, # Output-only. Whether the configuration has been signed by a CPI. |
| 954 | }, |
| 955 | }</pre> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 956 | </div> |
| 957 | |
| 958 | <div class="method"> |
| 959 | <code class="details" id="delete">delete(name, x__xgafv=None)</code> |
| 960 | <pre>Deletes a device. |
| 961 | |
| 962 | Args: |
| 963 | name: string, Required. The name of the device. (required) |
| 964 | x__xgafv: string, V1 error format. |
| 965 | Allowed values |
| 966 | 1 - v1 error format |
| 967 | 2 - v2 error format |
| 968 | |
| 969 | Returns: |
| 970 | An object of the form: |
| 971 | |
| 972 | { # A generic empty message that you can re-use to avoid defining duplicated |
| 973 | # empty messages in your APIs. A typical example is to use it as the request |
| 974 | # or the response type of an API method. For instance: |
| 975 | # |
| 976 | # service Foo { |
| 977 | # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); |
| 978 | # } |
| 979 | # |
| 980 | # The JSON representation for `Empty` is empty JSON object `{}`. |
| 981 | }</pre> |
| 982 | </div> |
| 983 | |
| 984 | <div class="method"> |
| 985 | <code class="details" id="get">get(name, x__xgafv=None)</code> |
| 986 | <pre>Gets details about a device. |
| 987 | |
| 988 | Args: |
| 989 | name: string, Required. The name of the device. (required) |
| 990 | x__xgafv: string, V1 error format. |
| 991 | Allowed values |
| 992 | 1 - v1 error format |
| 993 | 2 - v2 error format |
| 994 | |
| 995 | Returns: |
| 996 | An object of the form: |
| 997 | |
| 998 | { |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 999 | "activeConfig": { # Information about the device configuration. # Output only. Current configuration of the device as registered to the SAS. |
| 1000 | "measurementCapabilities": [ # Measurement reporting capabilities of the device. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1001 | "A String", |
| 1002 | ], |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 1003 | "callSign": "A String", # The call sign of the device operator. |
| 1004 | "installationParams": { # Information about the device installation parameters. # Installation parameters for the device. |
| 1005 | "longitude": 3.14, # Longitude of the device antenna location. in degrees relative to |
| 1006 | # the WGS 84 datum. The allowed range is from -180.000000 to |
| 1007 | # +180.000000. Positive values represent longitudes east of the |
| 1008 | # prime meridian; negative values west of the prime |
| 1009 | # meridian. |
| 1010 | "antennaDowntilt": 42, # Antenna downtilt in degrees and is an integer with a value |
| 1011 | # between -90 and +90 inclusive; a negative value means the antenna |
| 1012 | # is tilted up (above horizontal). This parameter is optional for |
| 1013 | # Category A devices and conditional for Category B devices. |
| 1014 | "antennaBeamwidth": 42, # 3-dB antenna beamwidth of the antenna in the horizontal-plane in |
| 1015 | # degrees. This parameter is an unsigned integer having a value |
| 1016 | # between 0 and 360 (degrees) inclusive; it is optional for |
| 1017 | # Category A devices and conditional for Category B devices. |
| 1018 | "height": 3.14, # Device antenna height in meters. When the heightType parameter |
| 1019 | # value is "AGL", the antenna height should be given relative to |
| 1020 | # ground level. When the heightType parameter value is "AMSL", it |
| 1021 | # is given with respect to WGS84 datum. |
| 1022 | "indoorDeployment": True or False, # Whether the device antenna is indoor or not. True: indoor. False: |
| 1023 | # outdoor. |
| 1024 | "antennaAzimuth": 42, # Boresight direction of the horizontal plane of the antenna in |
| 1025 | # degrees with respect to true north. The value of this parameter |
| 1026 | # is an integer with a value between 0 and 359 inclusive. A value |
| 1027 | # of 0 degrees means true north; a value of 90 degrees means |
| 1028 | # east. This parameter is optional for Category A devices and |
| 1029 | # conditional for Category B devices. |
| 1030 | "latitude": 3.14, # Latitude of the device antenna location in degrees relative to |
| 1031 | # the WGS 84 datum. The allowed range is from -90.000000 to |
| 1032 | # +90.000000. Positive values represent latitudes north of the |
| 1033 | # equator; negative values south of the equator. |
| 1034 | "horizontalAccuracy": 3.14, # A positive number in meters to indicate accuracy of the device |
| 1035 | # antenna horizontal location. This optional parameter should only |
| 1036 | # be present if its value is less than the FCC requirement of 50 |
| 1037 | # meters. |
| 1038 | "heightType": "A String", # Specifies how the height is measured. |
| 1039 | "antennaGain": 42, # Peak antenna gain in dBi. This parameter is an integer with a |
| 1040 | # value between -127 and +128 (dBi) inclusive. |
| 1041 | "eirpCapability": 42, # This parameter is the maximum device EIRP in units of dBm/10MHz |
| 1042 | # and is an integer with a value between -127 and +47 (dBm/10 MHz) |
| 1043 | # inclusive. If not included, SAS interprets it as maximum |
| 1044 | # allowable EIRP in units of dBm/10MHz for device category. |
| 1045 | "antennaModel": "A String", # If an external antenna is used, the antenna model is optionally |
| 1046 | # provided in this field. The string has a maximum length of 128 |
| 1047 | # octets. |
| 1048 | "verticalAccuracy": 3.14, # A positive number in meters to indicate accuracy of the device |
| 1049 | # antenna vertical location. This optional parameter should only be |
| 1050 | # present if its value is less than the FCC requirement of 3 |
| 1051 | # meters. |
| 1052 | "cpeCbsdIndication": True or False, # If present, this parameter specifies whether the CBSD is a CPE-CBSD or not. |
| 1053 | }, |
| 1054 | "state": "A String", # State of the configuration. |
| 1055 | "airInterface": { # Information about the device's air interface. # Information about this device's air interface. |
| 1056 | "radioTechnology": "A String", # This field specifies the radio access technology that is used for the CBSD. |
| 1057 | # |
| 1058 | # Conditional |
| 1059 | "supportedSpec": "A String", # This field is related to the radioTechnology field and provides the air |
| 1060 | # interface specification that the CBSD is compliant with at the time of |
| 1061 | # registration. |
| 1062 | # |
| 1063 | # Optional |
| 1064 | }, |
| 1065 | "model": { # Information about the model of the device. # Information about this device model. |
| 1066 | "vendor": "A String", # The name of the device vendor. |
| 1067 | "hardwareVersion": "A String", # The hardware version of the device. |
| 1068 | "firmwareVersion": "A String", # The firmware version of the device. |
| 1069 | "name": "A String", # The name of the device model. |
| 1070 | "softwareVersion": "A String", # The software version of the device. |
| 1071 | }, |
| 1072 | "userId": "A String", # The identifier of a device user. |
| 1073 | "category": "A String", # FCC category of the device. |
| 1074 | "updateTime": "A String", # Output-only. The last time the device configuration was edited. |
| 1075 | "isSigned": True or False, # Output-only. Whether the configuration has been signed by a CPI. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1076 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 1077 | "displayName": "A String", # Device display name. |
| 1078 | "grants": [ # Output only. Grants held by the device. |
| 1079 | { # Device grant. It is an authorization provided by the Spectrum |
| 1080 | # Access System to a device to transmit using specified operating |
| 1081 | # parameters after a successful heartbeat by the device. |
| 1082 | "maxEirp": 3.14, # Maximum Equivalent Isotropically Radiated Power (EIRP) permitted |
| 1083 | # by the grant. The maximum EIRP is in units of dBm/MHz. The |
| 1084 | # value of maxEirp represents the average (RMS) EIRP that would be |
| 1085 | # measured by the procedure defined in FCC part 96.41(e)(3). |
| 1086 | "frequencyRange": { # Frequency range from `low_frequency` to `high_frequency`. # The transmission frequency range. |
| 1087 | "lowFrequencyMhz": 3.14, # The lowest frequency of the frequency range in MHz. |
| 1088 | "highFrequencyMhz": 3.14, # The highest frequency of the frequency range in MHz. |
| 1089 | }, |
| 1090 | "channelType": "A String", # Type of channel used. |
| 1091 | "expireTime": "A String", # The expiration time of the grant. |
| 1092 | "suspensionReason": [ # If the grant is suspended, the reason(s) for suspension. |
| 1093 | "A String", |
| 1094 | ], |
| 1095 | "moveList": [ # The DPA move lists on which this grant appears. |
| 1096 | { # An entry in a DPA's move list. |
| 1097 | "dpaId": "A String", # The ID of the DPA. |
| 1098 | "frequencyRange": { # Frequency range from `low_frequency` to `high_frequency`. # The frequency range that the move list affects. |
| 1099 | "lowFrequencyMhz": 3.14, # The lowest frequency of the frequency range in MHz. |
| 1100 | "highFrequencyMhz": 3.14, # The highest frequency of the frequency range in MHz. |
| 1101 | }, |
| 1102 | }, |
| 1103 | ], |
| 1104 | "state": "A String", # State of the grant. |
| 1105 | }, |
| 1106 | ], |
| 1107 | "fccId": "A String", # The FCC identifier of the device. |
| 1108 | "serialNumber": "A String", # A serial number assigned to the device by the device |
| 1109 | # manufacturer. |
| 1110 | "state": "A String", # Output only. Device state. |
| 1111 | "name": "A String", # Output only. The resource path name. |
| 1112 | "preloadedConfig": { # Information about the device configuration. # Configuration of the device, as specified via SAS Portal API. |
| 1113 | "measurementCapabilities": [ # Measurement reporting capabilities of the device. |
| 1114 | "A String", |
| 1115 | ], |
| 1116 | "callSign": "A String", # The call sign of the device operator. |
| 1117 | "installationParams": { # Information about the device installation parameters. # Installation parameters for the device. |
| 1118 | "longitude": 3.14, # Longitude of the device antenna location. in degrees relative to |
| 1119 | # the WGS 84 datum. The allowed range is from -180.000000 to |
| 1120 | # +180.000000. Positive values represent longitudes east of the |
| 1121 | # prime meridian; negative values west of the prime |
| 1122 | # meridian. |
| 1123 | "antennaDowntilt": 42, # Antenna downtilt in degrees and is an integer with a value |
| 1124 | # between -90 and +90 inclusive; a negative value means the antenna |
| 1125 | # is tilted up (above horizontal). This parameter is optional for |
| 1126 | # Category A devices and conditional for Category B devices. |
| 1127 | "antennaBeamwidth": 42, # 3-dB antenna beamwidth of the antenna in the horizontal-plane in |
| 1128 | # degrees. This parameter is an unsigned integer having a value |
| 1129 | # between 0 and 360 (degrees) inclusive; it is optional for |
| 1130 | # Category A devices and conditional for Category B devices. |
| 1131 | "height": 3.14, # Device antenna height in meters. When the heightType parameter |
| 1132 | # value is "AGL", the antenna height should be given relative to |
| 1133 | # ground level. When the heightType parameter value is "AMSL", it |
| 1134 | # is given with respect to WGS84 datum. |
| 1135 | "indoorDeployment": True or False, # Whether the device antenna is indoor or not. True: indoor. False: |
| 1136 | # outdoor. |
| 1137 | "antennaAzimuth": 42, # Boresight direction of the horizontal plane of the antenna in |
| 1138 | # degrees with respect to true north. The value of this parameter |
| 1139 | # is an integer with a value between 0 and 359 inclusive. A value |
| 1140 | # of 0 degrees means true north; a value of 90 degrees means |
| 1141 | # east. This parameter is optional for Category A devices and |
| 1142 | # conditional for Category B devices. |
| 1143 | "latitude": 3.14, # Latitude of the device antenna location in degrees relative to |
| 1144 | # the WGS 84 datum. The allowed range is from -90.000000 to |
| 1145 | # +90.000000. Positive values represent latitudes north of the |
| 1146 | # equator; negative values south of the equator. |
| 1147 | "horizontalAccuracy": 3.14, # A positive number in meters to indicate accuracy of the device |
| 1148 | # antenna horizontal location. This optional parameter should only |
| 1149 | # be present if its value is less than the FCC requirement of 50 |
| 1150 | # meters. |
| 1151 | "heightType": "A String", # Specifies how the height is measured. |
| 1152 | "antennaGain": 42, # Peak antenna gain in dBi. This parameter is an integer with a |
| 1153 | # value between -127 and +128 (dBi) inclusive. |
| 1154 | "eirpCapability": 42, # This parameter is the maximum device EIRP in units of dBm/10MHz |
| 1155 | # and is an integer with a value between -127 and +47 (dBm/10 MHz) |
| 1156 | # inclusive. If not included, SAS interprets it as maximum |
| 1157 | # allowable EIRP in units of dBm/10MHz for device category. |
| 1158 | "antennaModel": "A String", # If an external antenna is used, the antenna model is optionally |
| 1159 | # provided in this field. The string has a maximum length of 128 |
| 1160 | # octets. |
| 1161 | "verticalAccuracy": 3.14, # A positive number in meters to indicate accuracy of the device |
| 1162 | # antenna vertical location. This optional parameter should only be |
| 1163 | # present if its value is less than the FCC requirement of 3 |
| 1164 | # meters. |
| 1165 | "cpeCbsdIndication": True or False, # If present, this parameter specifies whether the CBSD is a CPE-CBSD or not. |
| 1166 | }, |
| 1167 | "state": "A String", # State of the configuration. |
| 1168 | "airInterface": { # Information about the device's air interface. # Information about this device's air interface. |
| 1169 | "radioTechnology": "A String", # This field specifies the radio access technology that is used for the CBSD. |
| 1170 | # |
| 1171 | # Conditional |
| 1172 | "supportedSpec": "A String", # This field is related to the radioTechnology field and provides the air |
| 1173 | # interface specification that the CBSD is compliant with at the time of |
| 1174 | # registration. |
| 1175 | # |
| 1176 | # Optional |
| 1177 | }, |
| 1178 | "model": { # Information about the model of the device. # Information about this device model. |
| 1179 | "vendor": "A String", # The name of the device vendor. |
| 1180 | "hardwareVersion": "A String", # The hardware version of the device. |
| 1181 | "firmwareVersion": "A String", # The firmware version of the device. |
| 1182 | "name": "A String", # The name of the device model. |
| 1183 | "softwareVersion": "A String", # The software version of the device. |
| 1184 | }, |
| 1185 | "userId": "A String", # The identifier of a device user. |
| 1186 | "category": "A String", # FCC category of the device. |
| 1187 | "updateTime": "A String", # Output-only. The last time the device configuration was edited. |
| 1188 | "isSigned": True or False, # Output-only. Whether the configuration has been signed by a CPI. |
| 1189 | }, |
| 1190 | }</pre> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1191 | </div> |
| 1192 | |
| 1193 | <div class="method"> |
| 1194 | <code class="details" id="list">list(parent, filter=None, pageToken=None, pageSize=None, x__xgafv=None)</code> |
| 1195 | <pre>Lists devices under a node or customer. |
| 1196 | |
| 1197 | Args: |
| 1198 | parent: string, Required. The name of the parent resource. (required) |
| 1199 | filter: string, The filter expression. The filter should have one of the following |
| 1200 | formats: "sn=123454" or "display_name=MyDevice". sn |
| 1201 | corresponds to serial_number of the device. The filter is case insensitive. |
| 1202 | pageToken: string, A pagination token returned from a previous call to ListDevices |
| 1203 | that indicates where this listing should continue from. |
| 1204 | pageSize: integer, The maximum number of devices to return in the response. |
| 1205 | If empty or zero, all devices will be listed. |
| 1206 | Must be in the range [0, 1000]. |
| 1207 | x__xgafv: string, V1 error format. |
| 1208 | Allowed values |
| 1209 | 1 - v1 error format |
| 1210 | 2 - v2 error format |
| 1211 | |
| 1212 | Returns: |
| 1213 | An object of the form: |
| 1214 | |
| 1215 | { # Response for ListDevices method. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 1216 | "devices": [ # The devices that match the request. |
| 1217 | { |
| 1218 | "activeConfig": { # Information about the device configuration. # Output only. Current configuration of the device as registered to the SAS. |
| 1219 | "measurementCapabilities": [ # Measurement reporting capabilities of the device. |
| 1220 | "A String", |
| 1221 | ], |
| 1222 | "callSign": "A String", # The call sign of the device operator. |
| 1223 | "installationParams": { # Information about the device installation parameters. # Installation parameters for the device. |
| 1224 | "longitude": 3.14, # Longitude of the device antenna location. in degrees relative to |
| 1225 | # the WGS 84 datum. The allowed range is from -180.000000 to |
| 1226 | # +180.000000. Positive values represent longitudes east of the |
| 1227 | # prime meridian; negative values west of the prime |
| 1228 | # meridian. |
| 1229 | "antennaDowntilt": 42, # Antenna downtilt in degrees and is an integer with a value |
| 1230 | # between -90 and +90 inclusive; a negative value means the antenna |
| 1231 | # is tilted up (above horizontal). This parameter is optional for |
| 1232 | # Category A devices and conditional for Category B devices. |
| 1233 | "antennaBeamwidth": 42, # 3-dB antenna beamwidth of the antenna in the horizontal-plane in |
| 1234 | # degrees. This parameter is an unsigned integer having a value |
| 1235 | # between 0 and 360 (degrees) inclusive; it is optional for |
| 1236 | # Category A devices and conditional for Category B devices. |
| 1237 | "height": 3.14, # Device antenna height in meters. When the heightType parameter |
| 1238 | # value is "AGL", the antenna height should be given relative to |
| 1239 | # ground level. When the heightType parameter value is "AMSL", it |
| 1240 | # is given with respect to WGS84 datum. |
| 1241 | "indoorDeployment": True or False, # Whether the device antenna is indoor or not. True: indoor. False: |
| 1242 | # outdoor. |
| 1243 | "antennaAzimuth": 42, # Boresight direction of the horizontal plane of the antenna in |
| 1244 | # degrees with respect to true north. The value of this parameter |
| 1245 | # is an integer with a value between 0 and 359 inclusive. A value |
| 1246 | # of 0 degrees means true north; a value of 90 degrees means |
| 1247 | # east. This parameter is optional for Category A devices and |
| 1248 | # conditional for Category B devices. |
| 1249 | "latitude": 3.14, # Latitude of the device antenna location in degrees relative to |
| 1250 | # the WGS 84 datum. The allowed range is from -90.000000 to |
| 1251 | # +90.000000. Positive values represent latitudes north of the |
| 1252 | # equator; negative values south of the equator. |
| 1253 | "horizontalAccuracy": 3.14, # A positive number in meters to indicate accuracy of the device |
| 1254 | # antenna horizontal location. This optional parameter should only |
| 1255 | # be present if its value is less than the FCC requirement of 50 |
| 1256 | # meters. |
| 1257 | "heightType": "A String", # Specifies how the height is measured. |
| 1258 | "antennaGain": 42, # Peak antenna gain in dBi. This parameter is an integer with a |
| 1259 | # value between -127 and +128 (dBi) inclusive. |
| 1260 | "eirpCapability": 42, # This parameter is the maximum device EIRP in units of dBm/10MHz |
| 1261 | # and is an integer with a value between -127 and +47 (dBm/10 MHz) |
| 1262 | # inclusive. If not included, SAS interprets it as maximum |
| 1263 | # allowable EIRP in units of dBm/10MHz for device category. |
| 1264 | "antennaModel": "A String", # If an external antenna is used, the antenna model is optionally |
| 1265 | # provided in this field. The string has a maximum length of 128 |
| 1266 | # octets. |
| 1267 | "verticalAccuracy": 3.14, # A positive number in meters to indicate accuracy of the device |
| 1268 | # antenna vertical location. This optional parameter should only be |
| 1269 | # present if its value is less than the FCC requirement of 3 |
| 1270 | # meters. |
| 1271 | "cpeCbsdIndication": True or False, # If present, this parameter specifies whether the CBSD is a CPE-CBSD or not. |
| 1272 | }, |
| 1273 | "state": "A String", # State of the configuration. |
| 1274 | "airInterface": { # Information about the device's air interface. # Information about this device's air interface. |
| 1275 | "radioTechnology": "A String", # This field specifies the radio access technology that is used for the CBSD. |
| 1276 | # |
| 1277 | # Conditional |
| 1278 | "supportedSpec": "A String", # This field is related to the radioTechnology field and provides the air |
| 1279 | # interface specification that the CBSD is compliant with at the time of |
| 1280 | # registration. |
| 1281 | # |
| 1282 | # Optional |
| 1283 | }, |
| 1284 | "model": { # Information about the model of the device. # Information about this device model. |
| 1285 | "vendor": "A String", # The name of the device vendor. |
| 1286 | "hardwareVersion": "A String", # The hardware version of the device. |
| 1287 | "firmwareVersion": "A String", # The firmware version of the device. |
| 1288 | "name": "A String", # The name of the device model. |
| 1289 | "softwareVersion": "A String", # The software version of the device. |
| 1290 | }, |
| 1291 | "userId": "A String", # The identifier of a device user. |
| 1292 | "category": "A String", # FCC category of the device. |
| 1293 | "updateTime": "A String", # Output-only. The last time the device configuration was edited. |
| 1294 | "isSigned": True or False, # Output-only. Whether the configuration has been signed by a CPI. |
| 1295 | }, |
| 1296 | "displayName": "A String", # Device display name. |
| 1297 | "grants": [ # Output only. Grants held by the device. |
| 1298 | { # Device grant. It is an authorization provided by the Spectrum |
| 1299 | # Access System to a device to transmit using specified operating |
| 1300 | # parameters after a successful heartbeat by the device. |
| 1301 | "maxEirp": 3.14, # Maximum Equivalent Isotropically Radiated Power (EIRP) permitted |
| 1302 | # by the grant. The maximum EIRP is in units of dBm/MHz. The |
| 1303 | # value of maxEirp represents the average (RMS) EIRP that would be |
| 1304 | # measured by the procedure defined in FCC part 96.41(e)(3). |
| 1305 | "frequencyRange": { # Frequency range from `low_frequency` to `high_frequency`. # The transmission frequency range. |
| 1306 | "lowFrequencyMhz": 3.14, # The lowest frequency of the frequency range in MHz. |
| 1307 | "highFrequencyMhz": 3.14, # The highest frequency of the frequency range in MHz. |
| 1308 | }, |
| 1309 | "channelType": "A String", # Type of channel used. |
| 1310 | "expireTime": "A String", # The expiration time of the grant. |
| 1311 | "suspensionReason": [ # If the grant is suspended, the reason(s) for suspension. |
| 1312 | "A String", |
| 1313 | ], |
| 1314 | "moveList": [ # The DPA move lists on which this grant appears. |
| 1315 | { # An entry in a DPA's move list. |
| 1316 | "dpaId": "A String", # The ID of the DPA. |
| 1317 | "frequencyRange": { # Frequency range from `low_frequency` to `high_frequency`. # The frequency range that the move list affects. |
| 1318 | "lowFrequencyMhz": 3.14, # The lowest frequency of the frequency range in MHz. |
| 1319 | "highFrequencyMhz": 3.14, # The highest frequency of the frequency range in MHz. |
| 1320 | }, |
| 1321 | }, |
| 1322 | ], |
| 1323 | "state": "A String", # State of the grant. |
| 1324 | }, |
| 1325 | ], |
| 1326 | "fccId": "A String", # The FCC identifier of the device. |
| 1327 | "serialNumber": "A String", # A serial number assigned to the device by the device |
| 1328 | # manufacturer. |
| 1329 | "state": "A String", # Output only. Device state. |
| 1330 | "name": "A String", # Output only. The resource path name. |
| 1331 | "preloadedConfig": { # Information about the device configuration. # Configuration of the device, as specified via SAS Portal API. |
| 1332 | "measurementCapabilities": [ # Measurement reporting capabilities of the device. |
| 1333 | "A String", |
| 1334 | ], |
| 1335 | "callSign": "A String", # The call sign of the device operator. |
| 1336 | "installationParams": { # Information about the device installation parameters. # Installation parameters for the device. |
| 1337 | "longitude": 3.14, # Longitude of the device antenna location. in degrees relative to |
| 1338 | # the WGS 84 datum. The allowed range is from -180.000000 to |
| 1339 | # +180.000000. Positive values represent longitudes east of the |
| 1340 | # prime meridian; negative values west of the prime |
| 1341 | # meridian. |
| 1342 | "antennaDowntilt": 42, # Antenna downtilt in degrees and is an integer with a value |
| 1343 | # between -90 and +90 inclusive; a negative value means the antenna |
| 1344 | # is tilted up (above horizontal). This parameter is optional for |
| 1345 | # Category A devices and conditional for Category B devices. |
| 1346 | "antennaBeamwidth": 42, # 3-dB antenna beamwidth of the antenna in the horizontal-plane in |
| 1347 | # degrees. This parameter is an unsigned integer having a value |
| 1348 | # between 0 and 360 (degrees) inclusive; it is optional for |
| 1349 | # Category A devices and conditional for Category B devices. |
| 1350 | "height": 3.14, # Device antenna height in meters. When the heightType parameter |
| 1351 | # value is "AGL", the antenna height should be given relative to |
| 1352 | # ground level. When the heightType parameter value is "AMSL", it |
| 1353 | # is given with respect to WGS84 datum. |
| 1354 | "indoorDeployment": True or False, # Whether the device antenna is indoor or not. True: indoor. False: |
| 1355 | # outdoor. |
| 1356 | "antennaAzimuth": 42, # Boresight direction of the horizontal plane of the antenna in |
| 1357 | # degrees with respect to true north. The value of this parameter |
| 1358 | # is an integer with a value between 0 and 359 inclusive. A value |
| 1359 | # of 0 degrees means true north; a value of 90 degrees means |
| 1360 | # east. This parameter is optional for Category A devices and |
| 1361 | # conditional for Category B devices. |
| 1362 | "latitude": 3.14, # Latitude of the device antenna location in degrees relative to |
| 1363 | # the WGS 84 datum. The allowed range is from -90.000000 to |
| 1364 | # +90.000000. Positive values represent latitudes north of the |
| 1365 | # equator; negative values south of the equator. |
| 1366 | "horizontalAccuracy": 3.14, # A positive number in meters to indicate accuracy of the device |
| 1367 | # antenna horizontal location. This optional parameter should only |
| 1368 | # be present if its value is less than the FCC requirement of 50 |
| 1369 | # meters. |
| 1370 | "heightType": "A String", # Specifies how the height is measured. |
| 1371 | "antennaGain": 42, # Peak antenna gain in dBi. This parameter is an integer with a |
| 1372 | # value between -127 and +128 (dBi) inclusive. |
| 1373 | "eirpCapability": 42, # This parameter is the maximum device EIRP in units of dBm/10MHz |
| 1374 | # and is an integer with a value between -127 and +47 (dBm/10 MHz) |
| 1375 | # inclusive. If not included, SAS interprets it as maximum |
| 1376 | # allowable EIRP in units of dBm/10MHz for device category. |
| 1377 | "antennaModel": "A String", # If an external antenna is used, the antenna model is optionally |
| 1378 | # provided in this field. The string has a maximum length of 128 |
| 1379 | # octets. |
| 1380 | "verticalAccuracy": 3.14, # A positive number in meters to indicate accuracy of the device |
| 1381 | # antenna vertical location. This optional parameter should only be |
| 1382 | # present if its value is less than the FCC requirement of 3 |
| 1383 | # meters. |
| 1384 | "cpeCbsdIndication": True or False, # If present, this parameter specifies whether the CBSD is a CPE-CBSD or not. |
| 1385 | }, |
| 1386 | "state": "A String", # State of the configuration. |
| 1387 | "airInterface": { # Information about the device's air interface. # Information about this device's air interface. |
| 1388 | "radioTechnology": "A String", # This field specifies the radio access technology that is used for the CBSD. |
| 1389 | # |
| 1390 | # Conditional |
| 1391 | "supportedSpec": "A String", # This field is related to the radioTechnology field and provides the air |
| 1392 | # interface specification that the CBSD is compliant with at the time of |
| 1393 | # registration. |
| 1394 | # |
| 1395 | # Optional |
| 1396 | }, |
| 1397 | "model": { # Information about the model of the device. # Information about this device model. |
| 1398 | "vendor": "A String", # The name of the device vendor. |
| 1399 | "hardwareVersion": "A String", # The hardware version of the device. |
| 1400 | "firmwareVersion": "A String", # The firmware version of the device. |
| 1401 | "name": "A String", # The name of the device model. |
| 1402 | "softwareVersion": "A String", # The software version of the device. |
| 1403 | }, |
| 1404 | "userId": "A String", # The identifier of a device user. |
| 1405 | "category": "A String", # FCC category of the device. |
| 1406 | "updateTime": "A String", # Output-only. The last time the device configuration was edited. |
| 1407 | "isSigned": True or False, # Output-only. Whether the configuration has been signed by a CPI. |
| 1408 | }, |
| 1409 | }, |
| 1410 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1411 | "nextPageToken": "A String", # A pagination token returned from a previous call to ListDevices method |
| 1412 | # that indicates from where listing should continue. If the field |
| 1413 | # is missing or empty, it means there is no more devices. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1414 | }</pre> |
| 1415 | </div> |
| 1416 | |
| 1417 | <div class="method"> |
| 1418 | <code class="details" id="list_next">list_next(previous_request, previous_response)</code> |
| 1419 | <pre>Retrieves the next page of results. |
| 1420 | |
| 1421 | Args: |
| 1422 | previous_request: The request for the previous page. (required) |
| 1423 | previous_response: The response from the request for the previous page. (required) |
| 1424 | |
| 1425 | Returns: |
| 1426 | A request object that you can call 'execute()' on to request the next |
| 1427 | page. Returns None if there are no more items in the collection. |
| 1428 | </pre> |
| 1429 | </div> |
| 1430 | |
| 1431 | <div class="method"> |
| 1432 | <code class="details" id="move">move(name, body=None, x__xgafv=None)</code> |
| 1433 | <pre>Moves a device under another node or customer. |
| 1434 | |
| 1435 | Args: |
| 1436 | name: string, Required. The name of the device to move. (required) |
| 1437 | body: object, The request body. |
| 1438 | The object takes the form of: |
| 1439 | |
| 1440 | { # Request for MoveDevice method. |
| 1441 | "destination": "A String", # Required. The name of the new parent resource (Node or Customer) to |
| 1442 | # reparent the device under. |
| 1443 | } |
| 1444 | |
| 1445 | x__xgafv: string, V1 error format. |
| 1446 | Allowed values |
| 1447 | 1 - v1 error format |
| 1448 | 2 - v2 error format |
| 1449 | |
| 1450 | Returns: |
| 1451 | An object of the form: |
| 1452 | |
| 1453 | { # This resource represents a long-running operation that is the result of a |
| 1454 | # network API call. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1455 | "name": "A String", # The server-assigned name, which is only unique within the same service that |
| 1456 | # originally returns it. If you use the default HTTP mapping, the |
| 1457 | # `name` should be a resource name ending with `operations/{unique_id}`. |
| 1458 | "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation. |
| 1459 | # different programming environments, including REST APIs and RPC APIs. It is |
| 1460 | # used by [gRPC](https://github.com/grpc). Each `Status` message contains |
| 1461 | # three pieces of data: error code, error message, and error details. |
| 1462 | # |
| 1463 | # You can find out more about this error model and how to work with it in the |
| 1464 | # [API Design Guide](https://cloud.google.com/apis/design/errors). |
| 1465 | "details": [ # A list of messages that carry the error details. There is a common set of |
| 1466 | # message types for APIs to use. |
| 1467 | { |
| 1468 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 1469 | }, |
| 1470 | ], |
| 1471 | "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| 1472 | "message": "A String", # A developer-facing error message, which should be in English. Any |
| 1473 | # user-facing error message should be localized and sent in the |
| 1474 | # google.rpc.Status.details field, or localized by the client. |
| 1475 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 1476 | "response": { # The normal response of the operation in case of success. If the original |
| 1477 | # method returns no data on success, such as `Delete`, the response is |
| 1478 | # `google.protobuf.Empty`. If the original method is standard |
| 1479 | # `Get`/`Create`/`Update`, the response should be the resource. For other |
| 1480 | # methods, the response should have the type `XxxResponse`, where `Xxx` |
| 1481 | # is the original method name. For example, if the original method name |
| 1482 | # is `TakeSnapshot()`, the inferred response type is |
| 1483 | # `TakeSnapshotResponse`. |
| 1484 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 1485 | }, |
| 1486 | "metadata": { # Service-specific metadata associated with the operation. It typically |
| 1487 | # contains progress information and common metadata such as create time. |
| 1488 | # Some services might not provide such metadata. Any method that returns a |
| 1489 | # long-running operation should document the metadata type, if any. |
| 1490 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 1491 | }, |
| 1492 | "done": True or False, # If the value is `false`, it means the operation is still in progress. |
| 1493 | # If `true`, the operation is completed, and either `error` or `response` is |
| 1494 | # available. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1495 | }</pre> |
| 1496 | </div> |
| 1497 | |
| 1498 | <div class="method"> |
| 1499 | <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code> |
| 1500 | <pre>Updates a device. |
| 1501 | |
| 1502 | Args: |
| 1503 | name: string, Output only. The resource path name. (required) |
| 1504 | body: object, The request body. |
| 1505 | The object takes the form of: |
| 1506 | |
| 1507 | { |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 1508 | "activeConfig": { # Information about the device configuration. # Output only. Current configuration of the device as registered to the SAS. |
| 1509 | "measurementCapabilities": [ # Measurement reporting capabilities of the device. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1510 | "A String", |
| 1511 | ], |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 1512 | "callSign": "A String", # The call sign of the device operator. |
| 1513 | "installationParams": { # Information about the device installation parameters. # Installation parameters for the device. |
| 1514 | "longitude": 3.14, # Longitude of the device antenna location. in degrees relative to |
| 1515 | # the WGS 84 datum. The allowed range is from -180.000000 to |
| 1516 | # +180.000000. Positive values represent longitudes east of the |
| 1517 | # prime meridian; negative values west of the prime |
| 1518 | # meridian. |
| 1519 | "antennaDowntilt": 42, # Antenna downtilt in degrees and is an integer with a value |
| 1520 | # between -90 and +90 inclusive; a negative value means the antenna |
| 1521 | # is tilted up (above horizontal). This parameter is optional for |
| 1522 | # Category A devices and conditional for Category B devices. |
| 1523 | "antennaBeamwidth": 42, # 3-dB antenna beamwidth of the antenna in the horizontal-plane in |
| 1524 | # degrees. This parameter is an unsigned integer having a value |
| 1525 | # between 0 and 360 (degrees) inclusive; it is optional for |
| 1526 | # Category A devices and conditional for Category B devices. |
| 1527 | "height": 3.14, # Device antenna height in meters. When the heightType parameter |
| 1528 | # value is "AGL", the antenna height should be given relative to |
| 1529 | # ground level. When the heightType parameter value is "AMSL", it |
| 1530 | # is given with respect to WGS84 datum. |
| 1531 | "indoorDeployment": True or False, # Whether the device antenna is indoor or not. True: indoor. False: |
| 1532 | # outdoor. |
| 1533 | "antennaAzimuth": 42, # Boresight direction of the horizontal plane of the antenna in |
| 1534 | # degrees with respect to true north. The value of this parameter |
| 1535 | # is an integer with a value between 0 and 359 inclusive. A value |
| 1536 | # of 0 degrees means true north; a value of 90 degrees means |
| 1537 | # east. This parameter is optional for Category A devices and |
| 1538 | # conditional for Category B devices. |
| 1539 | "latitude": 3.14, # Latitude of the device antenna location in degrees relative to |
| 1540 | # the WGS 84 datum. The allowed range is from -90.000000 to |
| 1541 | # +90.000000. Positive values represent latitudes north of the |
| 1542 | # equator; negative values south of the equator. |
| 1543 | "horizontalAccuracy": 3.14, # A positive number in meters to indicate accuracy of the device |
| 1544 | # antenna horizontal location. This optional parameter should only |
| 1545 | # be present if its value is less than the FCC requirement of 50 |
| 1546 | # meters. |
| 1547 | "heightType": "A String", # Specifies how the height is measured. |
| 1548 | "antennaGain": 42, # Peak antenna gain in dBi. This parameter is an integer with a |
| 1549 | # value between -127 and +128 (dBi) inclusive. |
| 1550 | "eirpCapability": 42, # This parameter is the maximum device EIRP in units of dBm/10MHz |
| 1551 | # and is an integer with a value between -127 and +47 (dBm/10 MHz) |
| 1552 | # inclusive. If not included, SAS interprets it as maximum |
| 1553 | # allowable EIRP in units of dBm/10MHz for device category. |
| 1554 | "antennaModel": "A String", # If an external antenna is used, the antenna model is optionally |
| 1555 | # provided in this field. The string has a maximum length of 128 |
| 1556 | # octets. |
| 1557 | "verticalAccuracy": 3.14, # A positive number in meters to indicate accuracy of the device |
| 1558 | # antenna vertical location. This optional parameter should only be |
| 1559 | # present if its value is less than the FCC requirement of 3 |
| 1560 | # meters. |
| 1561 | "cpeCbsdIndication": True or False, # If present, this parameter specifies whether the CBSD is a CPE-CBSD or not. |
| 1562 | }, |
| 1563 | "state": "A String", # State of the configuration. |
| 1564 | "airInterface": { # Information about the device's air interface. # Information about this device's air interface. |
| 1565 | "radioTechnology": "A String", # This field specifies the radio access technology that is used for the CBSD. |
| 1566 | # |
| 1567 | # Conditional |
| 1568 | "supportedSpec": "A String", # This field is related to the radioTechnology field and provides the air |
| 1569 | # interface specification that the CBSD is compliant with at the time of |
| 1570 | # registration. |
| 1571 | # |
| 1572 | # Optional |
| 1573 | }, |
| 1574 | "model": { # Information about the model of the device. # Information about this device model. |
| 1575 | "vendor": "A String", # The name of the device vendor. |
| 1576 | "hardwareVersion": "A String", # The hardware version of the device. |
| 1577 | "firmwareVersion": "A String", # The firmware version of the device. |
| 1578 | "name": "A String", # The name of the device model. |
| 1579 | "softwareVersion": "A String", # The software version of the device. |
| 1580 | }, |
| 1581 | "userId": "A String", # The identifier of a device user. |
| 1582 | "category": "A String", # FCC category of the device. |
| 1583 | "updateTime": "A String", # Output-only. The last time the device configuration was edited. |
| 1584 | "isSigned": True or False, # Output-only. Whether the configuration has been signed by a CPI. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1585 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 1586 | "displayName": "A String", # Device display name. |
| 1587 | "grants": [ # Output only. Grants held by the device. |
| 1588 | { # Device grant. It is an authorization provided by the Spectrum |
| 1589 | # Access System to a device to transmit using specified operating |
| 1590 | # parameters after a successful heartbeat by the device. |
| 1591 | "maxEirp": 3.14, # Maximum Equivalent Isotropically Radiated Power (EIRP) permitted |
| 1592 | # by the grant. The maximum EIRP is in units of dBm/MHz. The |
| 1593 | # value of maxEirp represents the average (RMS) EIRP that would be |
| 1594 | # measured by the procedure defined in FCC part 96.41(e)(3). |
| 1595 | "frequencyRange": { # Frequency range from `low_frequency` to `high_frequency`. # The transmission frequency range. |
| 1596 | "lowFrequencyMhz": 3.14, # The lowest frequency of the frequency range in MHz. |
| 1597 | "highFrequencyMhz": 3.14, # The highest frequency of the frequency range in MHz. |
| 1598 | }, |
| 1599 | "channelType": "A String", # Type of channel used. |
| 1600 | "expireTime": "A String", # The expiration time of the grant. |
| 1601 | "suspensionReason": [ # If the grant is suspended, the reason(s) for suspension. |
| 1602 | "A String", |
| 1603 | ], |
| 1604 | "moveList": [ # The DPA move lists on which this grant appears. |
| 1605 | { # An entry in a DPA's move list. |
| 1606 | "dpaId": "A String", # The ID of the DPA. |
| 1607 | "frequencyRange": { # Frequency range from `low_frequency` to `high_frequency`. # The frequency range that the move list affects. |
| 1608 | "lowFrequencyMhz": 3.14, # The lowest frequency of the frequency range in MHz. |
| 1609 | "highFrequencyMhz": 3.14, # The highest frequency of the frequency range in MHz. |
| 1610 | }, |
| 1611 | }, |
| 1612 | ], |
| 1613 | "state": "A String", # State of the grant. |
| 1614 | }, |
| 1615 | ], |
| 1616 | "fccId": "A String", # The FCC identifier of the device. |
| 1617 | "serialNumber": "A String", # A serial number assigned to the device by the device |
| 1618 | # manufacturer. |
| 1619 | "state": "A String", # Output only. Device state. |
| 1620 | "name": "A String", # Output only. The resource path name. |
| 1621 | "preloadedConfig": { # Information about the device configuration. # Configuration of the device, as specified via SAS Portal API. |
| 1622 | "measurementCapabilities": [ # Measurement reporting capabilities of the device. |
| 1623 | "A String", |
| 1624 | ], |
| 1625 | "callSign": "A String", # The call sign of the device operator. |
| 1626 | "installationParams": { # Information about the device installation parameters. # Installation parameters for the device. |
| 1627 | "longitude": 3.14, # Longitude of the device antenna location. in degrees relative to |
| 1628 | # the WGS 84 datum. The allowed range is from -180.000000 to |
| 1629 | # +180.000000. Positive values represent longitudes east of the |
| 1630 | # prime meridian; negative values west of the prime |
| 1631 | # meridian. |
| 1632 | "antennaDowntilt": 42, # Antenna downtilt in degrees and is an integer with a value |
| 1633 | # between -90 and +90 inclusive; a negative value means the antenna |
| 1634 | # is tilted up (above horizontal). This parameter is optional for |
| 1635 | # Category A devices and conditional for Category B devices. |
| 1636 | "antennaBeamwidth": 42, # 3-dB antenna beamwidth of the antenna in the horizontal-plane in |
| 1637 | # degrees. This parameter is an unsigned integer having a value |
| 1638 | # between 0 and 360 (degrees) inclusive; it is optional for |
| 1639 | # Category A devices and conditional for Category B devices. |
| 1640 | "height": 3.14, # Device antenna height in meters. When the heightType parameter |
| 1641 | # value is "AGL", the antenna height should be given relative to |
| 1642 | # ground level. When the heightType parameter value is "AMSL", it |
| 1643 | # is given with respect to WGS84 datum. |
| 1644 | "indoorDeployment": True or False, # Whether the device antenna is indoor or not. True: indoor. False: |
| 1645 | # outdoor. |
| 1646 | "antennaAzimuth": 42, # Boresight direction of the horizontal plane of the antenna in |
| 1647 | # degrees with respect to true north. The value of this parameter |
| 1648 | # is an integer with a value between 0 and 359 inclusive. A value |
| 1649 | # of 0 degrees means true north; a value of 90 degrees means |
| 1650 | # east. This parameter is optional for Category A devices and |
| 1651 | # conditional for Category B devices. |
| 1652 | "latitude": 3.14, # Latitude of the device antenna location in degrees relative to |
| 1653 | # the WGS 84 datum. The allowed range is from -90.000000 to |
| 1654 | # +90.000000. Positive values represent latitudes north of the |
| 1655 | # equator; negative values south of the equator. |
| 1656 | "horizontalAccuracy": 3.14, # A positive number in meters to indicate accuracy of the device |
| 1657 | # antenna horizontal location. This optional parameter should only |
| 1658 | # be present if its value is less than the FCC requirement of 50 |
| 1659 | # meters. |
| 1660 | "heightType": "A String", # Specifies how the height is measured. |
| 1661 | "antennaGain": 42, # Peak antenna gain in dBi. This parameter is an integer with a |
| 1662 | # value between -127 and +128 (dBi) inclusive. |
| 1663 | "eirpCapability": 42, # This parameter is the maximum device EIRP in units of dBm/10MHz |
| 1664 | # and is an integer with a value between -127 and +47 (dBm/10 MHz) |
| 1665 | # inclusive. If not included, SAS interprets it as maximum |
| 1666 | # allowable EIRP in units of dBm/10MHz for device category. |
| 1667 | "antennaModel": "A String", # If an external antenna is used, the antenna model is optionally |
| 1668 | # provided in this field. The string has a maximum length of 128 |
| 1669 | # octets. |
| 1670 | "verticalAccuracy": 3.14, # A positive number in meters to indicate accuracy of the device |
| 1671 | # antenna vertical location. This optional parameter should only be |
| 1672 | # present if its value is less than the FCC requirement of 3 |
| 1673 | # meters. |
| 1674 | "cpeCbsdIndication": True or False, # If present, this parameter specifies whether the CBSD is a CPE-CBSD or not. |
| 1675 | }, |
| 1676 | "state": "A String", # State of the configuration. |
| 1677 | "airInterface": { # Information about the device's air interface. # Information about this device's air interface. |
| 1678 | "radioTechnology": "A String", # This field specifies the radio access technology that is used for the CBSD. |
| 1679 | # |
| 1680 | # Conditional |
| 1681 | "supportedSpec": "A String", # This field is related to the radioTechnology field and provides the air |
| 1682 | # interface specification that the CBSD is compliant with at the time of |
| 1683 | # registration. |
| 1684 | # |
| 1685 | # Optional |
| 1686 | }, |
| 1687 | "model": { # Information about the model of the device. # Information about this device model. |
| 1688 | "vendor": "A String", # The name of the device vendor. |
| 1689 | "hardwareVersion": "A String", # The hardware version of the device. |
| 1690 | "firmwareVersion": "A String", # The firmware version of the device. |
| 1691 | "name": "A String", # The name of the device model. |
| 1692 | "softwareVersion": "A String", # The software version of the device. |
| 1693 | }, |
| 1694 | "userId": "A String", # The identifier of a device user. |
| 1695 | "category": "A String", # FCC category of the device. |
| 1696 | "updateTime": "A String", # Output-only. The last time the device configuration was edited. |
| 1697 | "isSigned": True or False, # Output-only. Whether the configuration has been signed by a CPI. |
| 1698 | }, |
| 1699 | } |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1700 | |
| 1701 | updateMask: string, Fields to be updated. |
| 1702 | x__xgafv: string, V1 error format. |
| 1703 | Allowed values |
| 1704 | 1 - v1 error format |
| 1705 | 2 - v2 error format |
| 1706 | |
| 1707 | Returns: |
| 1708 | An object of the form: |
| 1709 | |
| 1710 | { |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 1711 | "activeConfig": { # Information about the device configuration. # Output only. Current configuration of the device as registered to the SAS. |
| 1712 | "measurementCapabilities": [ # Measurement reporting capabilities of the device. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1713 | "A String", |
| 1714 | ], |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 1715 | "callSign": "A String", # The call sign of the device operator. |
| 1716 | "installationParams": { # Information about the device installation parameters. # Installation parameters for the device. |
| 1717 | "longitude": 3.14, # Longitude of the device antenna location. in degrees relative to |
| 1718 | # the WGS 84 datum. The allowed range is from -180.000000 to |
| 1719 | # +180.000000. Positive values represent longitudes east of the |
| 1720 | # prime meridian; negative values west of the prime |
| 1721 | # meridian. |
| 1722 | "antennaDowntilt": 42, # Antenna downtilt in degrees and is an integer with a value |
| 1723 | # between -90 and +90 inclusive; a negative value means the antenna |
| 1724 | # is tilted up (above horizontal). This parameter is optional for |
| 1725 | # Category A devices and conditional for Category B devices. |
| 1726 | "antennaBeamwidth": 42, # 3-dB antenna beamwidth of the antenna in the horizontal-plane in |
| 1727 | # degrees. This parameter is an unsigned integer having a value |
| 1728 | # between 0 and 360 (degrees) inclusive; it is optional for |
| 1729 | # Category A devices and conditional for Category B devices. |
| 1730 | "height": 3.14, # Device antenna height in meters. When the heightType parameter |
| 1731 | # value is "AGL", the antenna height should be given relative to |
| 1732 | # ground level. When the heightType parameter value is "AMSL", it |
| 1733 | # is given with respect to WGS84 datum. |
| 1734 | "indoorDeployment": True or False, # Whether the device antenna is indoor or not. True: indoor. False: |
| 1735 | # outdoor. |
| 1736 | "antennaAzimuth": 42, # Boresight direction of the horizontal plane of the antenna in |
| 1737 | # degrees with respect to true north. The value of this parameter |
| 1738 | # is an integer with a value between 0 and 359 inclusive. A value |
| 1739 | # of 0 degrees means true north; a value of 90 degrees means |
| 1740 | # east. This parameter is optional for Category A devices and |
| 1741 | # conditional for Category B devices. |
| 1742 | "latitude": 3.14, # Latitude of the device antenna location in degrees relative to |
| 1743 | # the WGS 84 datum. The allowed range is from -90.000000 to |
| 1744 | # +90.000000. Positive values represent latitudes north of the |
| 1745 | # equator; negative values south of the equator. |
| 1746 | "horizontalAccuracy": 3.14, # A positive number in meters to indicate accuracy of the device |
| 1747 | # antenna horizontal location. This optional parameter should only |
| 1748 | # be present if its value is less than the FCC requirement of 50 |
| 1749 | # meters. |
| 1750 | "heightType": "A String", # Specifies how the height is measured. |
| 1751 | "antennaGain": 42, # Peak antenna gain in dBi. This parameter is an integer with a |
| 1752 | # value between -127 and +128 (dBi) inclusive. |
| 1753 | "eirpCapability": 42, # This parameter is the maximum device EIRP in units of dBm/10MHz |
| 1754 | # and is an integer with a value between -127 and +47 (dBm/10 MHz) |
| 1755 | # inclusive. If not included, SAS interprets it as maximum |
| 1756 | # allowable EIRP in units of dBm/10MHz for device category. |
| 1757 | "antennaModel": "A String", # If an external antenna is used, the antenna model is optionally |
| 1758 | # provided in this field. The string has a maximum length of 128 |
| 1759 | # octets. |
| 1760 | "verticalAccuracy": 3.14, # A positive number in meters to indicate accuracy of the device |
| 1761 | # antenna vertical location. This optional parameter should only be |
| 1762 | # present if its value is less than the FCC requirement of 3 |
| 1763 | # meters. |
| 1764 | "cpeCbsdIndication": True or False, # If present, this parameter specifies whether the CBSD is a CPE-CBSD or not. |
| 1765 | }, |
| 1766 | "state": "A String", # State of the configuration. |
| 1767 | "airInterface": { # Information about the device's air interface. # Information about this device's air interface. |
| 1768 | "radioTechnology": "A String", # This field specifies the radio access technology that is used for the CBSD. |
| 1769 | # |
| 1770 | # Conditional |
| 1771 | "supportedSpec": "A String", # This field is related to the radioTechnology field and provides the air |
| 1772 | # interface specification that the CBSD is compliant with at the time of |
| 1773 | # registration. |
| 1774 | # |
| 1775 | # Optional |
| 1776 | }, |
| 1777 | "model": { # Information about the model of the device. # Information about this device model. |
| 1778 | "vendor": "A String", # The name of the device vendor. |
| 1779 | "hardwareVersion": "A String", # The hardware version of the device. |
| 1780 | "firmwareVersion": "A String", # The firmware version of the device. |
| 1781 | "name": "A String", # The name of the device model. |
| 1782 | "softwareVersion": "A String", # The software version of the device. |
| 1783 | }, |
| 1784 | "userId": "A String", # The identifier of a device user. |
| 1785 | "category": "A String", # FCC category of the device. |
| 1786 | "updateTime": "A String", # Output-only. The last time the device configuration was edited. |
| 1787 | "isSigned": True or False, # Output-only. Whether the configuration has been signed by a CPI. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1788 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 1789 | "displayName": "A String", # Device display name. |
| 1790 | "grants": [ # Output only. Grants held by the device. |
| 1791 | { # Device grant. It is an authorization provided by the Spectrum |
| 1792 | # Access System to a device to transmit using specified operating |
| 1793 | # parameters after a successful heartbeat by the device. |
| 1794 | "maxEirp": 3.14, # Maximum Equivalent Isotropically Radiated Power (EIRP) permitted |
| 1795 | # by the grant. The maximum EIRP is in units of dBm/MHz. The |
| 1796 | # value of maxEirp represents the average (RMS) EIRP that would be |
| 1797 | # measured by the procedure defined in FCC part 96.41(e)(3). |
| 1798 | "frequencyRange": { # Frequency range from `low_frequency` to `high_frequency`. # The transmission frequency range. |
| 1799 | "lowFrequencyMhz": 3.14, # The lowest frequency of the frequency range in MHz. |
| 1800 | "highFrequencyMhz": 3.14, # The highest frequency of the frequency range in MHz. |
| 1801 | }, |
| 1802 | "channelType": "A String", # Type of channel used. |
| 1803 | "expireTime": "A String", # The expiration time of the grant. |
| 1804 | "suspensionReason": [ # If the grant is suspended, the reason(s) for suspension. |
| 1805 | "A String", |
| 1806 | ], |
| 1807 | "moveList": [ # The DPA move lists on which this grant appears. |
| 1808 | { # An entry in a DPA's move list. |
| 1809 | "dpaId": "A String", # The ID of the DPA. |
| 1810 | "frequencyRange": { # Frequency range from `low_frequency` to `high_frequency`. # The frequency range that the move list affects. |
| 1811 | "lowFrequencyMhz": 3.14, # The lowest frequency of the frequency range in MHz. |
| 1812 | "highFrequencyMhz": 3.14, # The highest frequency of the frequency range in MHz. |
| 1813 | }, |
| 1814 | }, |
| 1815 | ], |
| 1816 | "state": "A String", # State of the grant. |
| 1817 | }, |
| 1818 | ], |
| 1819 | "fccId": "A String", # The FCC identifier of the device. |
| 1820 | "serialNumber": "A String", # A serial number assigned to the device by the device |
| 1821 | # manufacturer. |
| 1822 | "state": "A String", # Output only. Device state. |
| 1823 | "name": "A String", # Output only. The resource path name. |
| 1824 | "preloadedConfig": { # Information about the device configuration. # Configuration of the device, as specified via SAS Portal API. |
| 1825 | "measurementCapabilities": [ # Measurement reporting capabilities of the device. |
| 1826 | "A String", |
| 1827 | ], |
| 1828 | "callSign": "A String", # The call sign of the device operator. |
| 1829 | "installationParams": { # Information about the device installation parameters. # Installation parameters for the device. |
| 1830 | "longitude": 3.14, # Longitude of the device antenna location. in degrees relative to |
| 1831 | # the WGS 84 datum. The allowed range is from -180.000000 to |
| 1832 | # +180.000000. Positive values represent longitudes east of the |
| 1833 | # prime meridian; negative values west of the prime |
| 1834 | # meridian. |
| 1835 | "antennaDowntilt": 42, # Antenna downtilt in degrees and is an integer with a value |
| 1836 | # between -90 and +90 inclusive; a negative value means the antenna |
| 1837 | # is tilted up (above horizontal). This parameter is optional for |
| 1838 | # Category A devices and conditional for Category B devices. |
| 1839 | "antennaBeamwidth": 42, # 3-dB antenna beamwidth of the antenna in the horizontal-plane in |
| 1840 | # degrees. This parameter is an unsigned integer having a value |
| 1841 | # between 0 and 360 (degrees) inclusive; it is optional for |
| 1842 | # Category A devices and conditional for Category B devices. |
| 1843 | "height": 3.14, # Device antenna height in meters. When the heightType parameter |
| 1844 | # value is "AGL", the antenna height should be given relative to |
| 1845 | # ground level. When the heightType parameter value is "AMSL", it |
| 1846 | # is given with respect to WGS84 datum. |
| 1847 | "indoorDeployment": True or False, # Whether the device antenna is indoor or not. True: indoor. False: |
| 1848 | # outdoor. |
| 1849 | "antennaAzimuth": 42, # Boresight direction of the horizontal plane of the antenna in |
| 1850 | # degrees with respect to true north. The value of this parameter |
| 1851 | # is an integer with a value between 0 and 359 inclusive. A value |
| 1852 | # of 0 degrees means true north; a value of 90 degrees means |
| 1853 | # east. This parameter is optional for Category A devices and |
| 1854 | # conditional for Category B devices. |
| 1855 | "latitude": 3.14, # Latitude of the device antenna location in degrees relative to |
| 1856 | # the WGS 84 datum. The allowed range is from -90.000000 to |
| 1857 | # +90.000000. Positive values represent latitudes north of the |
| 1858 | # equator; negative values south of the equator. |
| 1859 | "horizontalAccuracy": 3.14, # A positive number in meters to indicate accuracy of the device |
| 1860 | # antenna horizontal location. This optional parameter should only |
| 1861 | # be present if its value is less than the FCC requirement of 50 |
| 1862 | # meters. |
| 1863 | "heightType": "A String", # Specifies how the height is measured. |
| 1864 | "antennaGain": 42, # Peak antenna gain in dBi. This parameter is an integer with a |
| 1865 | # value between -127 and +128 (dBi) inclusive. |
| 1866 | "eirpCapability": 42, # This parameter is the maximum device EIRP in units of dBm/10MHz |
| 1867 | # and is an integer with a value between -127 and +47 (dBm/10 MHz) |
| 1868 | # inclusive. If not included, SAS interprets it as maximum |
| 1869 | # allowable EIRP in units of dBm/10MHz for device category. |
| 1870 | "antennaModel": "A String", # If an external antenna is used, the antenna model is optionally |
| 1871 | # provided in this field. The string has a maximum length of 128 |
| 1872 | # octets. |
| 1873 | "verticalAccuracy": 3.14, # A positive number in meters to indicate accuracy of the device |
| 1874 | # antenna vertical location. This optional parameter should only be |
| 1875 | # present if its value is less than the FCC requirement of 3 |
| 1876 | # meters. |
| 1877 | "cpeCbsdIndication": True or False, # If present, this parameter specifies whether the CBSD is a CPE-CBSD or not. |
| 1878 | }, |
| 1879 | "state": "A String", # State of the configuration. |
| 1880 | "airInterface": { # Information about the device's air interface. # Information about this device's air interface. |
| 1881 | "radioTechnology": "A String", # This field specifies the radio access technology that is used for the CBSD. |
| 1882 | # |
| 1883 | # Conditional |
| 1884 | "supportedSpec": "A String", # This field is related to the radioTechnology field and provides the air |
| 1885 | # interface specification that the CBSD is compliant with at the time of |
| 1886 | # registration. |
| 1887 | # |
| 1888 | # Optional |
| 1889 | }, |
| 1890 | "model": { # Information about the model of the device. # Information about this device model. |
| 1891 | "vendor": "A String", # The name of the device vendor. |
| 1892 | "hardwareVersion": "A String", # The hardware version of the device. |
| 1893 | "firmwareVersion": "A String", # The firmware version of the device. |
| 1894 | "name": "A String", # The name of the device model. |
| 1895 | "softwareVersion": "A String", # The software version of the device. |
| 1896 | }, |
| 1897 | "userId": "A String", # The identifier of a device user. |
| 1898 | "category": "A String", # FCC category of the device. |
| 1899 | "updateTime": "A String", # Output-only. The last time the device configuration was edited. |
| 1900 | "isSigned": True or False, # Output-only. Whether the configuration has been signed by a CPI. |
| 1901 | }, |
| 1902 | }</pre> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1903 | </div> |
| 1904 | |
| 1905 | <div class="method"> |
| 1906 | <code class="details" id="signDevice">signDevice(name, body=None, x__xgafv=None)</code> |
| 1907 | <pre>Signs a device. |
| 1908 | |
| 1909 | Args: |
| 1910 | name: string, Output only. The resource path name. (required) |
| 1911 | body: object, The request body. |
| 1912 | The object takes the form of: |
| 1913 | |
| 1914 | { # Request for SignDevice method. |
| 1915 | "device": { # Required. The device to sign. |
| 1916 | # The device fields name, fcc_id and serial_number must be set. |
| 1917 | # The user_id field must be set. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 1918 | "activeConfig": { # Information about the device configuration. # Output only. Current configuration of the device as registered to the SAS. |
| 1919 | "measurementCapabilities": [ # Measurement reporting capabilities of the device. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1920 | "A String", |
| 1921 | ], |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 1922 | "callSign": "A String", # The call sign of the device operator. |
| 1923 | "installationParams": { # Information about the device installation parameters. # Installation parameters for the device. |
| 1924 | "longitude": 3.14, # Longitude of the device antenna location. in degrees relative to |
| 1925 | # the WGS 84 datum. The allowed range is from -180.000000 to |
| 1926 | # +180.000000. Positive values represent longitudes east of the |
| 1927 | # prime meridian; negative values west of the prime |
| 1928 | # meridian. |
| 1929 | "antennaDowntilt": 42, # Antenna downtilt in degrees and is an integer with a value |
| 1930 | # between -90 and +90 inclusive; a negative value means the antenna |
| 1931 | # is tilted up (above horizontal). This parameter is optional for |
| 1932 | # Category A devices and conditional for Category B devices. |
| 1933 | "antennaBeamwidth": 42, # 3-dB antenna beamwidth of the antenna in the horizontal-plane in |
| 1934 | # degrees. This parameter is an unsigned integer having a value |
| 1935 | # between 0 and 360 (degrees) inclusive; it is optional for |
| 1936 | # Category A devices and conditional for Category B devices. |
| 1937 | "height": 3.14, # Device antenna height in meters. When the heightType parameter |
| 1938 | # value is "AGL", the antenna height should be given relative to |
| 1939 | # ground level. When the heightType parameter value is "AMSL", it |
| 1940 | # is given with respect to WGS84 datum. |
| 1941 | "indoorDeployment": True or False, # Whether the device antenna is indoor or not. True: indoor. False: |
| 1942 | # outdoor. |
| 1943 | "antennaAzimuth": 42, # Boresight direction of the horizontal plane of the antenna in |
| 1944 | # degrees with respect to true north. The value of this parameter |
| 1945 | # is an integer with a value between 0 and 359 inclusive. A value |
| 1946 | # of 0 degrees means true north; a value of 90 degrees means |
| 1947 | # east. This parameter is optional for Category A devices and |
| 1948 | # conditional for Category B devices. |
| 1949 | "latitude": 3.14, # Latitude of the device antenna location in degrees relative to |
| 1950 | # the WGS 84 datum. The allowed range is from -90.000000 to |
| 1951 | # +90.000000. Positive values represent latitudes north of the |
| 1952 | # equator; negative values south of the equator. |
| 1953 | "horizontalAccuracy": 3.14, # A positive number in meters to indicate accuracy of the device |
| 1954 | # antenna horizontal location. This optional parameter should only |
| 1955 | # be present if its value is less than the FCC requirement of 50 |
| 1956 | # meters. |
| 1957 | "heightType": "A String", # Specifies how the height is measured. |
| 1958 | "antennaGain": 42, # Peak antenna gain in dBi. This parameter is an integer with a |
| 1959 | # value between -127 and +128 (dBi) inclusive. |
| 1960 | "eirpCapability": 42, # This parameter is the maximum device EIRP in units of dBm/10MHz |
| 1961 | # and is an integer with a value between -127 and +47 (dBm/10 MHz) |
| 1962 | # inclusive. If not included, SAS interprets it as maximum |
| 1963 | # allowable EIRP in units of dBm/10MHz for device category. |
| 1964 | "antennaModel": "A String", # If an external antenna is used, the antenna model is optionally |
| 1965 | # provided in this field. The string has a maximum length of 128 |
| 1966 | # octets. |
| 1967 | "verticalAccuracy": 3.14, # A positive number in meters to indicate accuracy of the device |
| 1968 | # antenna vertical location. This optional parameter should only be |
| 1969 | # present if its value is less than the FCC requirement of 3 |
| 1970 | # meters. |
| 1971 | "cpeCbsdIndication": True or False, # If present, this parameter specifies whether the CBSD is a CPE-CBSD or not. |
| 1972 | }, |
| 1973 | "state": "A String", # State of the configuration. |
| 1974 | "airInterface": { # Information about the device's air interface. # Information about this device's air interface. |
| 1975 | "radioTechnology": "A String", # This field specifies the radio access technology that is used for the CBSD. |
| 1976 | # |
| 1977 | # Conditional |
| 1978 | "supportedSpec": "A String", # This field is related to the radioTechnology field and provides the air |
| 1979 | # interface specification that the CBSD is compliant with at the time of |
| 1980 | # registration. |
| 1981 | # |
| 1982 | # Optional |
| 1983 | }, |
| 1984 | "model": { # Information about the model of the device. # Information about this device model. |
| 1985 | "vendor": "A String", # The name of the device vendor. |
| 1986 | "hardwareVersion": "A String", # The hardware version of the device. |
| 1987 | "firmwareVersion": "A String", # The firmware version of the device. |
| 1988 | "name": "A String", # The name of the device model. |
| 1989 | "softwareVersion": "A String", # The software version of the device. |
| 1990 | }, |
| 1991 | "userId": "A String", # The identifier of a device user. |
| 1992 | "category": "A String", # FCC category of the device. |
| 1993 | "updateTime": "A String", # Output-only. The last time the device configuration was edited. |
| 1994 | "isSigned": True or False, # Output-only. Whether the configuration has been signed by a CPI. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1995 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 1996 | "displayName": "A String", # Device display name. |
| 1997 | "grants": [ # Output only. Grants held by the device. |
| 1998 | { # Device grant. It is an authorization provided by the Spectrum |
| 1999 | # Access System to a device to transmit using specified operating |
| 2000 | # parameters after a successful heartbeat by the device. |
| 2001 | "maxEirp": 3.14, # Maximum Equivalent Isotropically Radiated Power (EIRP) permitted |
| 2002 | # by the grant. The maximum EIRP is in units of dBm/MHz. The |
| 2003 | # value of maxEirp represents the average (RMS) EIRP that would be |
| 2004 | # measured by the procedure defined in FCC part 96.41(e)(3). |
| 2005 | "frequencyRange": { # Frequency range from `low_frequency` to `high_frequency`. # The transmission frequency range. |
| 2006 | "lowFrequencyMhz": 3.14, # The lowest frequency of the frequency range in MHz. |
| 2007 | "highFrequencyMhz": 3.14, # The highest frequency of the frequency range in MHz. |
| 2008 | }, |
| 2009 | "channelType": "A String", # Type of channel used. |
| 2010 | "expireTime": "A String", # The expiration time of the grant. |
| 2011 | "suspensionReason": [ # If the grant is suspended, the reason(s) for suspension. |
| 2012 | "A String", |
| 2013 | ], |
| 2014 | "moveList": [ # The DPA move lists on which this grant appears. |
| 2015 | { # An entry in a DPA's move list. |
| 2016 | "dpaId": "A String", # The ID of the DPA. |
| 2017 | "frequencyRange": { # Frequency range from `low_frequency` to `high_frequency`. # The frequency range that the move list affects. |
| 2018 | "lowFrequencyMhz": 3.14, # The lowest frequency of the frequency range in MHz. |
| 2019 | "highFrequencyMhz": 3.14, # The highest frequency of the frequency range in MHz. |
| 2020 | }, |
| 2021 | }, |
| 2022 | ], |
| 2023 | "state": "A String", # State of the grant. |
| 2024 | }, |
| 2025 | ], |
| 2026 | "fccId": "A String", # The FCC identifier of the device. |
| 2027 | "serialNumber": "A String", # A serial number assigned to the device by the device |
| 2028 | # manufacturer. |
| 2029 | "state": "A String", # Output only. Device state. |
| 2030 | "name": "A String", # Output only. The resource path name. |
| 2031 | "preloadedConfig": { # Information about the device configuration. # Configuration of the device, as specified via SAS Portal API. |
| 2032 | "measurementCapabilities": [ # Measurement reporting capabilities of the device. |
| 2033 | "A String", |
| 2034 | ], |
| 2035 | "callSign": "A String", # The call sign of the device operator. |
| 2036 | "installationParams": { # Information about the device installation parameters. # Installation parameters for the device. |
| 2037 | "longitude": 3.14, # Longitude of the device antenna location. in degrees relative to |
| 2038 | # the WGS 84 datum. The allowed range is from -180.000000 to |
| 2039 | # +180.000000. Positive values represent longitudes east of the |
| 2040 | # prime meridian; negative values west of the prime |
| 2041 | # meridian. |
| 2042 | "antennaDowntilt": 42, # Antenna downtilt in degrees and is an integer with a value |
| 2043 | # between -90 and +90 inclusive; a negative value means the antenna |
| 2044 | # is tilted up (above horizontal). This parameter is optional for |
| 2045 | # Category A devices and conditional for Category B devices. |
| 2046 | "antennaBeamwidth": 42, # 3-dB antenna beamwidth of the antenna in the horizontal-plane in |
| 2047 | # degrees. This parameter is an unsigned integer having a value |
| 2048 | # between 0 and 360 (degrees) inclusive; it is optional for |
| 2049 | # Category A devices and conditional for Category B devices. |
| 2050 | "height": 3.14, # Device antenna height in meters. When the heightType parameter |
| 2051 | # value is "AGL", the antenna height should be given relative to |
| 2052 | # ground level. When the heightType parameter value is "AMSL", it |
| 2053 | # is given with respect to WGS84 datum. |
| 2054 | "indoorDeployment": True or False, # Whether the device antenna is indoor or not. True: indoor. False: |
| 2055 | # outdoor. |
| 2056 | "antennaAzimuth": 42, # Boresight direction of the horizontal plane of the antenna in |
| 2057 | # degrees with respect to true north. The value of this parameter |
| 2058 | # is an integer with a value between 0 and 359 inclusive. A value |
| 2059 | # of 0 degrees means true north; a value of 90 degrees means |
| 2060 | # east. This parameter is optional for Category A devices and |
| 2061 | # conditional for Category B devices. |
| 2062 | "latitude": 3.14, # Latitude of the device antenna location in degrees relative to |
| 2063 | # the WGS 84 datum. The allowed range is from -90.000000 to |
| 2064 | # +90.000000. Positive values represent latitudes north of the |
| 2065 | # equator; negative values south of the equator. |
| 2066 | "horizontalAccuracy": 3.14, # A positive number in meters to indicate accuracy of the device |
| 2067 | # antenna horizontal location. This optional parameter should only |
| 2068 | # be present if its value is less than the FCC requirement of 50 |
| 2069 | # meters. |
| 2070 | "heightType": "A String", # Specifies how the height is measured. |
| 2071 | "antennaGain": 42, # Peak antenna gain in dBi. This parameter is an integer with a |
| 2072 | # value between -127 and +128 (dBi) inclusive. |
| 2073 | "eirpCapability": 42, # This parameter is the maximum device EIRP in units of dBm/10MHz |
| 2074 | # and is an integer with a value between -127 and +47 (dBm/10 MHz) |
| 2075 | # inclusive. If not included, SAS interprets it as maximum |
| 2076 | # allowable EIRP in units of dBm/10MHz for device category. |
| 2077 | "antennaModel": "A String", # If an external antenna is used, the antenna model is optionally |
| 2078 | # provided in this field. The string has a maximum length of 128 |
| 2079 | # octets. |
| 2080 | "verticalAccuracy": 3.14, # A positive number in meters to indicate accuracy of the device |
| 2081 | # antenna vertical location. This optional parameter should only be |
| 2082 | # present if its value is less than the FCC requirement of 3 |
| 2083 | # meters. |
| 2084 | "cpeCbsdIndication": True or False, # If present, this parameter specifies whether the CBSD is a CPE-CBSD or not. |
| 2085 | }, |
| 2086 | "state": "A String", # State of the configuration. |
| 2087 | "airInterface": { # Information about the device's air interface. # Information about this device's air interface. |
| 2088 | "radioTechnology": "A String", # This field specifies the radio access technology that is used for the CBSD. |
| 2089 | # |
| 2090 | # Conditional |
| 2091 | "supportedSpec": "A String", # This field is related to the radioTechnology field and provides the air |
| 2092 | # interface specification that the CBSD is compliant with at the time of |
| 2093 | # registration. |
| 2094 | # |
| 2095 | # Optional |
| 2096 | }, |
| 2097 | "model": { # Information about the model of the device. # Information about this device model. |
| 2098 | "vendor": "A String", # The name of the device vendor. |
| 2099 | "hardwareVersion": "A String", # The hardware version of the device. |
| 2100 | "firmwareVersion": "A String", # The firmware version of the device. |
| 2101 | "name": "A String", # The name of the device model. |
| 2102 | "softwareVersion": "A String", # The software version of the device. |
| 2103 | }, |
| 2104 | "userId": "A String", # The identifier of a device user. |
| 2105 | "category": "A String", # FCC category of the device. |
| 2106 | "updateTime": "A String", # Output-only. The last time the device configuration was edited. |
| 2107 | "isSigned": True or False, # Output-only. Whether the configuration has been signed by a CPI. |
| 2108 | }, |
| 2109 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2110 | } |
| 2111 | |
| 2112 | x__xgafv: string, V1 error format. |
| 2113 | Allowed values |
| 2114 | 1 - v1 error format |
| 2115 | 2 - v2 error format |
| 2116 | |
| 2117 | Returns: |
| 2118 | An object of the form: |
| 2119 | |
| 2120 | { # A generic empty message that you can re-use to avoid defining duplicated |
| 2121 | # empty messages in your APIs. A typical example is to use it as the request |
| 2122 | # or the response type of an API method. For instance: |
| 2123 | # |
| 2124 | # service Foo { |
| 2125 | # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); |
| 2126 | # } |
| 2127 | # |
| 2128 | # The JSON representation for `Empty` is empty JSON object `{}`. |
| 2129 | }</pre> |
| 2130 | </div> |
| 2131 | |
| 2132 | <div class="method"> |
| 2133 | <code class="details" id="updateSigned">updateSigned(name, body=None, x__xgafv=None)</code> |
| 2134 | <pre>Updates a signed device. |
| 2135 | |
| 2136 | Args: |
| 2137 | name: string, Required. The name of the device to update. (required) |
| 2138 | body: object, The request body. |
| 2139 | The object takes the form of: |
| 2140 | |
| 2141 | { # Request for UpdateSignedDevice method. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2142 | "encodedDevice": "A String", # Required. The JSON Web Token signed using a CPI private key. Payload |
| 2143 | # must be the JSON encoding |
| 2144 | # of the device. The user_id field must be set. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 2145 | "installerId": "A String", # Required. Unique installer ID (CPI ID) from the Certified Professional |
| 2146 | # Installers database. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2147 | } |
| 2148 | |
| 2149 | x__xgafv: string, V1 error format. |
| 2150 | Allowed values |
| 2151 | 1 - v1 error format |
| 2152 | 2 - v2 error format |
| 2153 | |
| 2154 | Returns: |
| 2155 | An object of the form: |
| 2156 | |
| 2157 | { |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 2158 | "activeConfig": { # Information about the device configuration. # Output only. Current configuration of the device as registered to the SAS. |
| 2159 | "measurementCapabilities": [ # Measurement reporting capabilities of the device. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2160 | "A String", |
| 2161 | ], |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 2162 | "callSign": "A String", # The call sign of the device operator. |
| 2163 | "installationParams": { # Information about the device installation parameters. # Installation parameters for the device. |
| 2164 | "longitude": 3.14, # Longitude of the device antenna location. in degrees relative to |
| 2165 | # the WGS 84 datum. The allowed range is from -180.000000 to |
| 2166 | # +180.000000. Positive values represent longitudes east of the |
| 2167 | # prime meridian; negative values west of the prime |
| 2168 | # meridian. |
| 2169 | "antennaDowntilt": 42, # Antenna downtilt in degrees and is an integer with a value |
| 2170 | # between -90 and +90 inclusive; a negative value means the antenna |
| 2171 | # is tilted up (above horizontal). This parameter is optional for |
| 2172 | # Category A devices and conditional for Category B devices. |
| 2173 | "antennaBeamwidth": 42, # 3-dB antenna beamwidth of the antenna in the horizontal-plane in |
| 2174 | # degrees. This parameter is an unsigned integer having a value |
| 2175 | # between 0 and 360 (degrees) inclusive; it is optional for |
| 2176 | # Category A devices and conditional for Category B devices. |
| 2177 | "height": 3.14, # Device antenna height in meters. When the heightType parameter |
| 2178 | # value is "AGL", the antenna height should be given relative to |
| 2179 | # ground level. When the heightType parameter value is "AMSL", it |
| 2180 | # is given with respect to WGS84 datum. |
| 2181 | "indoorDeployment": True or False, # Whether the device antenna is indoor or not. True: indoor. False: |
| 2182 | # outdoor. |
| 2183 | "antennaAzimuth": 42, # Boresight direction of the horizontal plane of the antenna in |
| 2184 | # degrees with respect to true north. The value of this parameter |
| 2185 | # is an integer with a value between 0 and 359 inclusive. A value |
| 2186 | # of 0 degrees means true north; a value of 90 degrees means |
| 2187 | # east. This parameter is optional for Category A devices and |
| 2188 | # conditional for Category B devices. |
| 2189 | "latitude": 3.14, # Latitude of the device antenna location in degrees relative to |
| 2190 | # the WGS 84 datum. The allowed range is from -90.000000 to |
| 2191 | # +90.000000. Positive values represent latitudes north of the |
| 2192 | # equator; negative values south of the equator. |
| 2193 | "horizontalAccuracy": 3.14, # A positive number in meters to indicate accuracy of the device |
| 2194 | # antenna horizontal location. This optional parameter should only |
| 2195 | # be present if its value is less than the FCC requirement of 50 |
| 2196 | # meters. |
| 2197 | "heightType": "A String", # Specifies how the height is measured. |
| 2198 | "antennaGain": 42, # Peak antenna gain in dBi. This parameter is an integer with a |
| 2199 | # value between -127 and +128 (dBi) inclusive. |
| 2200 | "eirpCapability": 42, # This parameter is the maximum device EIRP in units of dBm/10MHz |
| 2201 | # and is an integer with a value between -127 and +47 (dBm/10 MHz) |
| 2202 | # inclusive. If not included, SAS interprets it as maximum |
| 2203 | # allowable EIRP in units of dBm/10MHz for device category. |
| 2204 | "antennaModel": "A String", # If an external antenna is used, the antenna model is optionally |
| 2205 | # provided in this field. The string has a maximum length of 128 |
| 2206 | # octets. |
| 2207 | "verticalAccuracy": 3.14, # A positive number in meters to indicate accuracy of the device |
| 2208 | # antenna vertical location. This optional parameter should only be |
| 2209 | # present if its value is less than the FCC requirement of 3 |
| 2210 | # meters. |
| 2211 | "cpeCbsdIndication": True or False, # If present, this parameter specifies whether the CBSD is a CPE-CBSD or not. |
| 2212 | }, |
| 2213 | "state": "A String", # State of the configuration. |
| 2214 | "airInterface": { # Information about the device's air interface. # Information about this device's air interface. |
| 2215 | "radioTechnology": "A String", # This field specifies the radio access technology that is used for the CBSD. |
| 2216 | # |
| 2217 | # Conditional |
| 2218 | "supportedSpec": "A String", # This field is related to the radioTechnology field and provides the air |
| 2219 | # interface specification that the CBSD is compliant with at the time of |
| 2220 | # registration. |
| 2221 | # |
| 2222 | # Optional |
| 2223 | }, |
| 2224 | "model": { # Information about the model of the device. # Information about this device model. |
| 2225 | "vendor": "A String", # The name of the device vendor. |
| 2226 | "hardwareVersion": "A String", # The hardware version of the device. |
| 2227 | "firmwareVersion": "A String", # The firmware version of the device. |
| 2228 | "name": "A String", # The name of the device model. |
| 2229 | "softwareVersion": "A String", # The software version of the device. |
| 2230 | }, |
| 2231 | "userId": "A String", # The identifier of a device user. |
| 2232 | "category": "A String", # FCC category of the device. |
| 2233 | "updateTime": "A String", # Output-only. The last time the device configuration was edited. |
| 2234 | "isSigned": True or False, # Output-only. Whether the configuration has been signed by a CPI. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2235 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 2236 | "displayName": "A String", # Device display name. |
| 2237 | "grants": [ # Output only. Grants held by the device. |
| 2238 | { # Device grant. It is an authorization provided by the Spectrum |
| 2239 | # Access System to a device to transmit using specified operating |
| 2240 | # parameters after a successful heartbeat by the device. |
| 2241 | "maxEirp": 3.14, # Maximum Equivalent Isotropically Radiated Power (EIRP) permitted |
| 2242 | # by the grant. The maximum EIRP is in units of dBm/MHz. The |
| 2243 | # value of maxEirp represents the average (RMS) EIRP that would be |
| 2244 | # measured by the procedure defined in FCC part 96.41(e)(3). |
| 2245 | "frequencyRange": { # Frequency range from `low_frequency` to `high_frequency`. # The transmission frequency range. |
| 2246 | "lowFrequencyMhz": 3.14, # The lowest frequency of the frequency range in MHz. |
| 2247 | "highFrequencyMhz": 3.14, # The highest frequency of the frequency range in MHz. |
| 2248 | }, |
| 2249 | "channelType": "A String", # Type of channel used. |
| 2250 | "expireTime": "A String", # The expiration time of the grant. |
| 2251 | "suspensionReason": [ # If the grant is suspended, the reason(s) for suspension. |
| 2252 | "A String", |
| 2253 | ], |
| 2254 | "moveList": [ # The DPA move lists on which this grant appears. |
| 2255 | { # An entry in a DPA's move list. |
| 2256 | "dpaId": "A String", # The ID of the DPA. |
| 2257 | "frequencyRange": { # Frequency range from `low_frequency` to `high_frequency`. # The frequency range that the move list affects. |
| 2258 | "lowFrequencyMhz": 3.14, # The lowest frequency of the frequency range in MHz. |
| 2259 | "highFrequencyMhz": 3.14, # The highest frequency of the frequency range in MHz. |
| 2260 | }, |
| 2261 | }, |
| 2262 | ], |
| 2263 | "state": "A String", # State of the grant. |
| 2264 | }, |
| 2265 | ], |
| 2266 | "fccId": "A String", # The FCC identifier of the device. |
| 2267 | "serialNumber": "A String", # A serial number assigned to the device by the device |
| 2268 | # manufacturer. |
| 2269 | "state": "A String", # Output only. Device state. |
| 2270 | "name": "A String", # Output only. The resource path name. |
| 2271 | "preloadedConfig": { # Information about the device configuration. # Configuration of the device, as specified via SAS Portal API. |
| 2272 | "measurementCapabilities": [ # Measurement reporting capabilities of the device. |
| 2273 | "A String", |
| 2274 | ], |
| 2275 | "callSign": "A String", # The call sign of the device operator. |
| 2276 | "installationParams": { # Information about the device installation parameters. # Installation parameters for the device. |
| 2277 | "longitude": 3.14, # Longitude of the device antenna location. in degrees relative to |
| 2278 | # the WGS 84 datum. The allowed range is from -180.000000 to |
| 2279 | # +180.000000. Positive values represent longitudes east of the |
| 2280 | # prime meridian; negative values west of the prime |
| 2281 | # meridian. |
| 2282 | "antennaDowntilt": 42, # Antenna downtilt in degrees and is an integer with a value |
| 2283 | # between -90 and +90 inclusive; a negative value means the antenna |
| 2284 | # is tilted up (above horizontal). This parameter is optional for |
| 2285 | # Category A devices and conditional for Category B devices. |
| 2286 | "antennaBeamwidth": 42, # 3-dB antenna beamwidth of the antenna in the horizontal-plane in |
| 2287 | # degrees. This parameter is an unsigned integer having a value |
| 2288 | # between 0 and 360 (degrees) inclusive; it is optional for |
| 2289 | # Category A devices and conditional for Category B devices. |
| 2290 | "height": 3.14, # Device antenna height in meters. When the heightType parameter |
| 2291 | # value is "AGL", the antenna height should be given relative to |
| 2292 | # ground level. When the heightType parameter value is "AMSL", it |
| 2293 | # is given with respect to WGS84 datum. |
| 2294 | "indoorDeployment": True or False, # Whether the device antenna is indoor or not. True: indoor. False: |
| 2295 | # outdoor. |
| 2296 | "antennaAzimuth": 42, # Boresight direction of the horizontal plane of the antenna in |
| 2297 | # degrees with respect to true north. The value of this parameter |
| 2298 | # is an integer with a value between 0 and 359 inclusive. A value |
| 2299 | # of 0 degrees means true north; a value of 90 degrees means |
| 2300 | # east. This parameter is optional for Category A devices and |
| 2301 | # conditional for Category B devices. |
| 2302 | "latitude": 3.14, # Latitude of the device antenna location in degrees relative to |
| 2303 | # the WGS 84 datum. The allowed range is from -90.000000 to |
| 2304 | # +90.000000. Positive values represent latitudes north of the |
| 2305 | # equator; negative values south of the equator. |
| 2306 | "horizontalAccuracy": 3.14, # A positive number in meters to indicate accuracy of the device |
| 2307 | # antenna horizontal location. This optional parameter should only |
| 2308 | # be present if its value is less than the FCC requirement of 50 |
| 2309 | # meters. |
| 2310 | "heightType": "A String", # Specifies how the height is measured. |
| 2311 | "antennaGain": 42, # Peak antenna gain in dBi. This parameter is an integer with a |
| 2312 | # value between -127 and +128 (dBi) inclusive. |
| 2313 | "eirpCapability": 42, # This parameter is the maximum device EIRP in units of dBm/10MHz |
| 2314 | # and is an integer with a value between -127 and +47 (dBm/10 MHz) |
| 2315 | # inclusive. If not included, SAS interprets it as maximum |
| 2316 | # allowable EIRP in units of dBm/10MHz for device category. |
| 2317 | "antennaModel": "A String", # If an external antenna is used, the antenna model is optionally |
| 2318 | # provided in this field. The string has a maximum length of 128 |
| 2319 | # octets. |
| 2320 | "verticalAccuracy": 3.14, # A positive number in meters to indicate accuracy of the device |
| 2321 | # antenna vertical location. This optional parameter should only be |
| 2322 | # present if its value is less than the FCC requirement of 3 |
| 2323 | # meters. |
| 2324 | "cpeCbsdIndication": True or False, # If present, this parameter specifies whether the CBSD is a CPE-CBSD or not. |
| 2325 | }, |
| 2326 | "state": "A String", # State of the configuration. |
| 2327 | "airInterface": { # Information about the device's air interface. # Information about this device's air interface. |
| 2328 | "radioTechnology": "A String", # This field specifies the radio access technology that is used for the CBSD. |
| 2329 | # |
| 2330 | # Conditional |
| 2331 | "supportedSpec": "A String", # This field is related to the radioTechnology field and provides the air |
| 2332 | # interface specification that the CBSD is compliant with at the time of |
| 2333 | # registration. |
| 2334 | # |
| 2335 | # Optional |
| 2336 | }, |
| 2337 | "model": { # Information about the model of the device. # Information about this device model. |
| 2338 | "vendor": "A String", # The name of the device vendor. |
| 2339 | "hardwareVersion": "A String", # The hardware version of the device. |
| 2340 | "firmwareVersion": "A String", # The firmware version of the device. |
| 2341 | "name": "A String", # The name of the device model. |
| 2342 | "softwareVersion": "A String", # The software version of the device. |
| 2343 | }, |
| 2344 | "userId": "A String", # The identifier of a device user. |
| 2345 | "category": "A String", # FCC category of the device. |
| 2346 | "updateTime": "A String", # Output-only. The last time the device configuration was edited. |
| 2347 | "isSigned": True or False, # Output-only. Whether the configuration has been signed by a CPI. |
| 2348 | }, |
| 2349 | }</pre> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2350 | </div> |
| 2351 | |
| 2352 | </body></html> |